| ... | ... | @@ -4,7 +4,6 @@ const testing = std.testing; |
| 4 | 4 | const Writer = @This(); |
| 5 | 5 | |
| 6 | 6 | const block_size = @sizeOf(Header); |
| 7 | | const empty_block: [block_size]u8 = [_]u8{0} ** block_size; |
| 8 | 7 | |
| 9 | 8 | /// Options for writing file/dir/link. If left empty 0o664 is used for |
| 10 | 9 | /// file mode and current time for mtime. |
| ... | ... | @@ -14,80 +13,91 @@ pub const Options = struct { |
| 14 | 13 | /// File system modification time. |
| 15 | 14 | mtime: u64 = 0, |
| 16 | 15 | }; |
| 17 | | const Self = @This(); |
| 18 | 16 | |
| 19 | 17 | underlying_writer: *std.io.BufferedWriter, |
| 20 | 18 | prefix: []const u8 = "", |
| 21 | 19 | mtime_now: u64 = 0, |
| 22 | 20 | |
| 21 | const Error = error{ |
| 22 | WriteFailed, |
| 23 | OctalOverflow, |
| 24 | NameTooLong, |
| 25 | }; |
| 26 | |
| 23 | 27 | /// Sets prefix for all other write* method paths. |
| 24 | | pub fn setRoot(self: *Self, root: []const u8) !void { |
| 28 | pub fn setRoot(w: *Writer, root: []const u8) Error!void { |
| 25 | 29 | if (root.len > 0) |
| 26 | | try self.writeDir(root, .{}); |
| 30 | try w.writeDir(root, .{}); |
| 27 | 31 | |
| 28 | | self.prefix = root; |
| 32 | w.prefix = root; |
| 29 | 33 | } |
| 30 | 34 | |
| 31 | | /// Writes directory. |
| 32 | | pub fn writeDir(self: *Self, sub_path: []const u8, opt: Options) !void { |
| 33 | | try self.writeHeader(.directory, sub_path, "", 0, opt); |
| 35 | pub fn writeDir(w: *Writer, sub_path: []const u8, options: Options) Error!void { |
| 36 | try w.writeHeader(.directory, sub_path, "", 0, options); |
| 34 | 37 | } |
| 35 | 38 | |
| 36 | | /// Writes file system file. |
| 37 | | pub fn writeFile(self: *Self, sub_path: []const u8, file: std.fs.File) !void { |
| 38 | | const stat = try file.stat(); |
| 39 | pub const WriteFileError = std.io.Writer.FileError || Error; |
| 40 | |
| 41 | pub fn writeFile( |
| 42 | w: *Writer, |
| 43 | sub_path: []const u8, |
| 44 | file: std.fs.File, |
| 45 | stat: std.fs.File.Stat, |
| 46 | ) WriteFileError!void { |
| 39 | 47 | const mtime: u64 = @intCast(@divFloor(stat.mtime, std.time.ns_per_s)); |
| 40 | 48 | |
| 41 | | var header = Header{}; |
| 42 | | try self.setPath(&header, sub_path); |
| 49 | var header: Header = .{}; |
| 50 | try w.setPath(&header, sub_path); |
| 43 | 51 | try header.setSize(stat.size); |
| 44 | 52 | try header.setMtime(mtime); |
| 45 | | try header.write(self.underlying_writer); |
| 53 | try header.write(w.underlying_writer); |
| 46 | 54 | |
| 47 | | try self.underlying_writer.writeFileAll(file, .{ .limit = .limited(stat.size) }); |
| 48 | | try self.writePadding(stat.size); |
| 55 | try w.underlying_writer.writeFileAll(file, .{ .limit = .limited(stat.size) }); |
| 56 | try w.writePadding(stat.size); |
| 49 | 57 | } |
| 50 | 58 | |
| 51 | | /// Writes file reading file content from `reader`. Number of bytes in |
| 52 | | /// reader must be equal to `size`. |
| 53 | | pub fn writeFileStream(self: *Self, sub_path: []const u8, size: usize, reader: anytype, opt: Options) !void { |
| 54 | | try self.writeHeader(.regular, sub_path, "", @intCast(size), opt); |
| 55 | | |
| 56 | | var counting_reader = std.io.countingReader(reader); |
| 57 | | var fifo = std.fifo.LinearFifo(u8, .{ .Static = 4096 }).init(); |
| 58 | | try fifo.pump(counting_reader.reader(), self.underlying_writer); |
| 59 | | if (counting_reader.bytes_read != size) return error.WrongReaderSize; |
| 60 | | try self.writePadding(size); |
| 59 | /// Writes file reading file content from `reader`. Reads exactly `size` bytes |
| 60 | /// from `reader`, or returns `error.EndOfStream`. |
| 61 | pub fn writeFileStream( |
| 62 | w: *Writer, |
| 63 | sub_path: []const u8, |
| 64 | size: usize, |
| 65 | reader: *std.io.BufferedReader, |
| 66 | options: Options, |
| 67 | ) std.io.Reader.RwError!void { |
| 68 | try w.writeHeader(.regular, sub_path, "", @intCast(size), options); |
| 69 | try reader.readAll(w.underlying_writer, .limited(size)); |
| 70 | try w.writePadding(size); |
| 61 | 71 | } |
| 62 | 72 | |
| 63 | 73 | /// Writes file using bytes buffer `content` for size and file content. |
| 64 | | pub fn writeFileBytes(self: *Self, sub_path: []const u8, content: []const u8, opt: Options) !void { |
| 65 | | try self.writeHeader(.regular, sub_path, "", @intCast(content.len), opt); |
| 66 | | try self.underlying_writer.writeAll(content); |
| 67 | | try self.writePadding(content.len); |
| 74 | pub fn writeFileBytes(w: *Writer, sub_path: []const u8, content: []const u8, options: Options) Error!void { |
| 75 | try w.writeHeader(.regular, sub_path, "", @intCast(content.len), options); |
| 76 | try w.underlying_writer.writeAll(content); |
| 77 | try w.writePadding(content.len); |
| 68 | 78 | } |
| 69 | 79 | |
| 70 | | /// Writes symlink. |
| 71 | | pub fn writeLink(self: *Self, sub_path: []const u8, link_name: []const u8, opt: Options) !void { |
| 72 | | try self.writeHeader(.symbolic_link, sub_path, link_name, 0, opt); |
| 80 | pub fn writeLink(w: *Writer, sub_path: []const u8, link_name: []const u8, options: Options) Error!void { |
| 81 | try w.writeHeader(.symbolic_link, sub_path, link_name, 0, options); |
| 73 | 82 | } |
| 74 | 83 | |
| 75 | 84 | /// Writes fs.Dir.WalkerEntry. Uses `mtime` from file system entry and |
| 76 | 85 | /// default for entry mode . |
| 77 | | pub fn writeEntry(self: *Self, entry: std.fs.Dir.Walker.Entry) !void { |
| 86 | pub fn writeEntry(w: *Writer, entry: std.fs.Dir.Walker.Entry) Error!void { |
| 78 | 87 | switch (entry.kind) { |
| 79 | 88 | .directory => { |
| 80 | | try self.writeDir(entry.path, .{ .mtime = try entryMtime(entry) }); |
| 89 | try w.writeDir(entry.path, .{ .mtime = try entryMtime(entry) }); |
| 81 | 90 | }, |
| 82 | 91 | .file => { |
| 83 | 92 | var file = try entry.dir.openFile(entry.basename, .{}); |
| 84 | 93 | defer file.close(); |
| 85 | | try self.writeFile(entry.path, file); |
| 94 | const stat = try file.stat(); |
| 95 | try w.writeFile(entry.path, file, stat); |
| 86 | 96 | }, |
| 87 | 97 | .sym_link => { |
| 88 | 98 | var link_name_buffer: [std.fs.max_path_bytes]u8 = undefined; |
| 89 | 99 | const link_name = try entry.dir.readLink(entry.basename, &link_name_buffer); |
| 90 | | try self.writeLink(entry.path, link_name, .{ .mtime = try entryMtime(entry) }); |
| 100 | try w.writeLink(entry.path, link_name, .{ .mtime = try entryMtime(entry) }); |
| 91 | 101 | }, |
| 92 | 102 | else => { |
| 93 | 103 | return error.UnsupportedWalkerEntryKind; |
| ... | ... | @@ -96,31 +106,31 @@ pub fn writeEntry(self: *Self, entry: std.fs.Dir.Walker.Entry) !void { |
| 96 | 106 | } |
| 97 | 107 | |
| 98 | 108 | fn writeHeader( |
| 99 | | self: *Self, |
| 109 | w: *Writer, |
| 100 | 110 | typeflag: Header.FileType, |
| 101 | 111 | sub_path: []const u8, |
| 102 | 112 | link_name: []const u8, |
| 103 | 113 | size: u64, |
| 104 | | opt: Options, |
| 105 | | ) !void { |
| 114 | options: Options, |
| 115 | ) Error!void { |
| 106 | 116 | var header = Header.init(typeflag); |
| 107 | | try self.setPath(&header, sub_path); |
| 117 | try w.setPath(&header, sub_path); |
| 108 | 118 | try header.setSize(size); |
| 109 | | try header.setMtime(if (opt.mtime != 0) opt.mtime else self.mtimeNow()); |
| 110 | | if (opt.mode != 0) |
| 111 | | try header.setMode(opt.mode); |
| 119 | try header.setMtime(if (options.mtime != 0) options.mtime else w.mtimeNow()); |
| 120 | if (options.mode != 0) |
| 121 | try header.setMode(options.mode); |
| 112 | 122 | if (typeflag == .symbolic_link) |
| 113 | 123 | header.setLinkname(link_name) catch |err| switch (err) { |
| 114 | | error.NameTooLong => try self.writeExtendedHeader(.gnu_long_link, &.{link_name}), |
| 124 | error.NameTooLong => try w.writeExtendedHeader(.gnu_long_link, &.{link_name}), |
| 115 | 125 | else => return err, |
| 116 | 126 | }; |
| 117 | | try header.write(self.underlying_writer); |
| 127 | try header.write(w.underlying_writer); |
| 118 | 128 | } |
| 119 | 129 | |
| 120 | | fn mtimeNow(self: *Self) u64 { |
| 121 | | if (self.mtime_now == 0) |
| 122 | | self.mtime_now = @intCast(std.time.timestamp()); |
| 123 | | return self.mtime_now; |
| 130 | fn mtimeNow(w: *Writer) u64 { |
| 131 | if (w.mtime_now == 0) |
| 132 | w.mtime_now = @intCast(std.time.timestamp()); |
| 133 | return w.mtime_now; |
| 124 | 134 | } |
| 125 | 135 | |
| 126 | 136 | fn entryMtime(entry: std.fs.Dir.Walker.Entry) !u64 { |
| ... | ... | @@ -130,52 +140,51 @@ fn entryMtime(entry: std.fs.Dir.Walker.Entry) !u64 { |
| 130 | 140 | |
| 131 | 141 | /// Writes path in posix header, if don't fit (in name+prefix; 100+155 |
| 132 | 142 | /// bytes) writes it in gnu extended header. |
| 133 | | fn setPath(self: *Self, header: *Header, sub_path: []const u8) !void { |
| 134 | | header.setPath(self.prefix, sub_path) catch |err| switch (err) { |
| 143 | fn setPath(w: *Writer, header: *Header, sub_path: []const u8) Error!void { |
| 144 | header.setPath(w.prefix, sub_path) catch |err| switch (err) { |
| 135 | 145 | error.NameTooLong => { |
| 136 | 146 | // write extended header |
| 137 | | const buffers: []const []const u8 = if (self.prefix.len == 0) |
| 147 | const buffers: []const []const u8 = if (w.prefix.len == 0) |
| 138 | 148 | &.{sub_path} |
| 139 | 149 | else |
| 140 | | &.{ self.prefix, "/", sub_path }; |
| 141 | | try self.writeExtendedHeader(.gnu_long_name, buffers); |
| 150 | &.{ w.prefix, "/", sub_path }; |
| 151 | try w.writeExtendedHeader(.gnu_long_name, buffers); |
| 142 | 152 | }, |
| 143 | 153 | else => return err, |
| 144 | 154 | }; |
| 145 | 155 | } |
| 146 | 156 | |
| 147 | 157 | /// Writes gnu extended header: gnu_long_name or gnu_long_link. |
| 148 | | fn writeExtendedHeader(self: *Self, typeflag: Header.FileType, buffers: []const []const u8) !void { |
| 158 | fn writeExtendedHeader(w: *Writer, typeflag: Header.FileType, buffers: []const []const u8) Error!void { |
| 149 | 159 | var len: usize = 0; |
| 150 | | for (buffers) |buf| |
| 151 | | len += buf.len; |
| 160 | for (buffers) |buf| len += buf.len; |
| 152 | 161 | |
| 153 | | var header = Header.init(typeflag); |
| 162 | var header: Header = .init(typeflag); |
| 154 | 163 | try header.setSize(len); |
| 155 | | try header.write(self.underlying_writer); |
| 164 | try header.write(w.underlying_writer); |
| 156 | 165 | for (buffers) |buf| |
| 157 | | try self.underlying_writer.writeAll(buf); |
| 158 | | try self.writePadding(len); |
| 166 | try w.underlying_writer.writeAll(buf); |
| 167 | try w.writePadding(len); |
| 159 | 168 | } |
| 160 | 169 | |
| 161 | | fn writePadding(self: *Self, bytes: u64) !void { |
| 162 | | const pos: usize = @intCast(bytes % block_size); |
| 170 | fn writePadding(w: *Writer, bytes: usize) std.io.Writer.Error!void { |
| 171 | const pos = bytes % block_size; |
| 163 | 172 | if (pos == 0) return; |
| 164 | | try self.underlying_writer.writeAll(empty_block[pos..]); |
| 173 | try w.underlying_writer.splatByteAll(0, block_size - pos); |
| 165 | 174 | } |
| 166 | 175 | |
| 167 | | /// Tar should finish with two zero blocks, but 'reasonable system must |
| 168 | | /// not assume that such a block exists when reading an archive' (from |
| 169 | | /// reference). In practice it is safe to skip this finish. |
| 170 | | pub fn finish(self: *Self) !void { |
| 171 | | try self.underlying_writer.writeAll(&empty_block); |
| 172 | | try self.underlying_writer.writeAll(&empty_block); |
| 176 | /// According to the specification, tar should finish with two zero blocks, but |
| 177 | /// "reasonable system must not assume that such a block exists when reading an |
| 178 | /// archive". Therefore, the Zig standard library recommends to not call this |
| 179 | /// function. |
| 180 | pub fn finishPedantically(w: *Writer) std.io.Writer.Error!void { |
| 181 | try w.underlying_writer.writeSplatAll(&.{&.{0}}, block_size * 2); |
| 173 | 182 | } |
| 174 | 183 | |
| 175 | 184 | /// A struct that is exactly 512 bytes and matches tar file format. This is |
| 176 | 185 | /// intended to be used for outputting tar files; for parsing there is |
| 177 | 186 | /// `std.tar.Header`. |
| 178 | | const Header = extern struct { |
| 187 | pub const Header = extern struct { |
| 179 | 188 | // This struct was originally copied from |
| 180 | 189 | // https://github.com/mattnite/tar/blob/main/src/main.zig which is MIT |
| 181 | 190 | // licensed. |
| ... | ... | @@ -230,11 +239,11 @@ const Header = extern struct { |
| 230 | 239 | }; |
| 231 | 240 | } |
| 232 | 241 | |
| 233 | | pub fn setSize(self: *Header, size: u64) !void { |
| 234 | | try octal(&self.size, size); |
| 242 | pub fn setSize(w: *Header, size: u64) error{OctalOverflow}!void { |
| 243 | try octal(&w.size, size); |
| 235 | 244 | } |
| 236 | 245 | |
| 237 | | fn octal(buf: []u8, value: u64) !void { |
| 246 | fn octal(buf: []u8, value: u64) error{OctalOverflow}!void { |
| 238 | 247 | var remainder: u64 = value; |
| 239 | 248 | var pos: usize = buf.len; |
| 240 | 249 | while (remainder > 0 and pos > 0) { |
| ... | ... | @@ -246,36 +255,36 @@ const Header = extern struct { |
| 246 | 255 | } |
| 247 | 256 | } |
| 248 | 257 | |
| 249 | | pub fn setMode(self: *Header, mode: u32) !void { |
| 250 | | try octal(&self.mode, mode); |
| 258 | pub fn setMode(w: *Header, mode: u32) error{OctalOverflow}!void { |
| 259 | try octal(&w.mode, mode); |
| 251 | 260 | } |
| 252 | 261 | |
| 253 | 262 | // Integer number of seconds since January 1, 1970, 00:00 Coordinated Universal Time. |
| 254 | 263 | // mtime == 0 will use current time |
| 255 | | pub fn setMtime(self: *Header, mtime: u64) !void { |
| 256 | | try octal(&self.mtime, mtime); |
| 264 | pub fn setMtime(w: *Header, mtime: u64) error{OctalOverflow}!void { |
| 265 | try octal(&w.mtime, mtime); |
| 257 | 266 | } |
| 258 | 267 | |
| 259 | | pub fn updateChecksum(self: *Header) !void { |
| 260 | | var checksum: usize = ' '; // other 7 self.checksum bytes are initialized to ' ' |
| 261 | | for (std.mem.asBytes(self)) |val| |
| 268 | pub fn updateChecksum(w: *Header) !void { |
| 269 | var checksum: usize = ' '; // other 7 w.checksum bytes are initialized to ' ' |
| 270 | for (std.mem.asBytes(w)) |val| |
| 262 | 271 | checksum += val; |
| 263 | | try octal(&self.checksum, checksum); |
| 272 | try octal(&w.checksum, checksum); |
| 264 | 273 | } |
| 265 | 274 | |
| 266 | | pub fn write(self: *Header, output_writer: anytype) !void { |
| 267 | | try self.updateChecksum(); |
| 268 | | try output_writer.writeAll(std.mem.asBytes(self)); |
| 275 | pub fn write(h: *Header, bw: *std.io.BufferedWriter) error{ OctalOverflow, WriteFailed }!void { |
| 276 | try h.updateChecksum(); |
| 277 | try bw.writeAll(std.mem.asBytes(h)); |
| 269 | 278 | } |
| 270 | 279 | |
| 271 | | pub fn setLinkname(self: *Header, link: []const u8) !void { |
| 272 | | if (link.len > self.linkname.len) return error.NameTooLong; |
| 273 | | @memcpy(self.linkname[0..link.len], link); |
| 280 | pub fn setLinkname(w: *Header, link: []const u8) !void { |
| 281 | if (link.len > w.linkname.len) return error.NameTooLong; |
| 282 | @memcpy(w.linkname[0..link.len], link); |
| 274 | 283 | } |
| 275 | 284 | |
| 276 | | pub fn setPath(self: *Header, prefix: []const u8, sub_path: []const u8) !void { |
| 277 | | const max_prefix = self.prefix.len; |
| 278 | | const max_name = self.name.len; |
| 285 | pub fn setPath(w: *Header, prefix: []const u8, sub_path: []const u8) !void { |
| 286 | const max_prefix = w.prefix.len; |
| 287 | const max_name = w.name.len; |
| 279 | 288 | const sep = std.fs.path.sep_posix; |
| 280 | 289 | |
| 281 | 290 | if (prefix.len + sub_path.len > max_name + max_prefix or prefix.len > max_prefix) |
| ... | ... | @@ -283,32 +292,32 @@ const Header = extern struct { |
| 283 | 292 | |
| 284 | 293 | // both fit into name |
| 285 | 294 | if (prefix.len > 0 and prefix.len + sub_path.len < max_name) { |
| 286 | | @memcpy(self.name[0..prefix.len], prefix); |
| 287 | | self.name[prefix.len] = sep; |
| 288 | | @memcpy(self.name[prefix.len + 1 ..][0..sub_path.len], sub_path); |
| 295 | @memcpy(w.name[0..prefix.len], prefix); |
| 296 | w.name[prefix.len] = sep; |
| 297 | @memcpy(w.name[prefix.len + 1 ..][0..sub_path.len], sub_path); |
| 289 | 298 | return; |
| 290 | 299 | } |
| 291 | 300 | |
| 292 | 301 | // sub_path fits into name |
| 293 | 302 | // there is no prefix or prefix fits into prefix |
| 294 | 303 | if (sub_path.len <= max_name) { |
| 295 | | @memcpy(self.name[0..sub_path.len], sub_path); |
| 296 | | @memcpy(self.prefix[0..prefix.len], prefix); |
| 304 | @memcpy(w.name[0..sub_path.len], sub_path); |
| 305 | @memcpy(w.prefix[0..prefix.len], prefix); |
| 297 | 306 | return; |
| 298 | 307 | } |
| 299 | 308 | |
| 300 | 309 | if (prefix.len > 0) { |
| 301 | | @memcpy(self.prefix[0..prefix.len], prefix); |
| 302 | | self.prefix[prefix.len] = sep; |
| 310 | @memcpy(w.prefix[0..prefix.len], prefix); |
| 311 | w.prefix[prefix.len] = sep; |
| 303 | 312 | } |
| 304 | 313 | const prefix_pos = if (prefix.len > 0) prefix.len + 1 else 0; |
| 305 | 314 | |
| 306 | 315 | // add as much to prefix as you can, must split at / |
| 307 | 316 | const prefix_remaining = max_prefix - prefix_pos; |
| 308 | 317 | if (std.mem.lastIndexOf(u8, sub_path[0..@min(prefix_remaining, sub_path.len)], &.{'/'})) |sep_pos| { |
| 309 | | @memcpy(self.prefix[prefix_pos..][0..sep_pos], sub_path[0..sep_pos]); |
| 318 | @memcpy(w.prefix[prefix_pos..][0..sep_pos], sub_path[0..sep_pos]); |
| 310 | 319 | if ((sub_path.len - sep_pos - 1) > max_name) return error.NameTooLong; |
| 311 | | @memcpy(self.name[0..][0 .. sub_path.len - sep_pos - 1], sub_path[sep_pos + 1 ..]); |
| 320 | @memcpy(w.name[0..][0 .. sub_path.len - sep_pos - 1], sub_path[sep_pos + 1 ..]); |
| 312 | 321 | return; |
| 313 | 322 | } |
| 314 | 323 | |