2 * Copyright (c) 2007 Kai Wang
3 * Copyright (c) 2007 Tim Kientzle
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer
11 * in this position and unchanged.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include "archive_platform.h"
29 __FBSDID("$FreeBSD$");
42 #include "archive_entry.h"
43 #include "archive_private.h"
44 #include "archive_write_private.h"
47 uint64_t entry_bytes_remaining;
48 uint64_t entry_padding;
55 * Define structure of the "ar" header.
57 #define AR_name_offset 0
58 #define AR_name_size 16
59 #define AR_date_offset 16
60 #define AR_date_size 12
61 #define AR_uid_offset 28
63 #define AR_gid_offset 34
65 #define AR_mode_offset 40
66 #define AR_mode_size 8
67 #define AR_size_offset 48
68 #define AR_size_size 10
69 #define AR_fmag_offset 58
70 #define AR_fmag_size 2
72 static int archive_write_set_format_ar(struct archive_write *);
73 static int archive_write_ar_header(struct archive_write *,
74 struct archive_entry *);
75 static ssize_t archive_write_ar_data(struct archive_write *,
76 const void *buff, size_t s);
77 static int archive_write_ar_destroy(struct archive_write *);
78 static int archive_write_ar_finish(struct archive_write *);
79 static int archive_write_ar_finish_entry(struct archive_write *);
80 static const char *ar_basename(const char *path);
81 static int format_octal(int64_t v, char *p, int s);
82 static int format_decimal(int64_t v, char *p, int s);
85 archive_write_set_format_ar_bsd(struct archive *_a)
87 struct archive_write *a = (struct archive_write *)_a;
88 int r = archive_write_set_format_ar(a);
89 if (r == ARCHIVE_OK) {
90 a->archive.archive_format = ARCHIVE_FORMAT_AR_BSD;
91 a->archive.archive_format_name = "ar (BSD)";
97 archive_write_set_format_ar_svr4(struct archive *_a)
99 struct archive_write *a = (struct archive_write *)_a;
100 int r = archive_write_set_format_ar(a);
101 if (r == ARCHIVE_OK) {
102 a->archive.archive_format = ARCHIVE_FORMAT_AR_GNU;
103 a->archive.archive_format_name = "ar (GNU/SVR4)";
109 * Generic initialization.
112 archive_write_set_format_ar(struct archive_write *a)
116 /* If someone else was already registered, unregister them. */
117 if (a->format_destroy != NULL)
118 (a->format_destroy)(a);
120 ar = (struct ar_w *)malloc(sizeof(*ar));
122 archive_set_error(&a->archive, ENOMEM, "Can't allocate ar data");
123 return (ARCHIVE_FATAL);
125 memset(ar, 0, sizeof(*ar));
128 a->format_name = "ar";
129 a->format_write_header = archive_write_ar_header;
130 a->format_write_data = archive_write_ar_data;
131 a->format_finish = archive_write_ar_finish;
132 a->format_destroy = archive_write_ar_destroy;
133 a->format_finish_entry = archive_write_ar_finish_entry;
138 archive_write_ar_header(struct archive_write *a, struct archive_entry *entry)
144 const char *pathname;
145 const char *filename;
149 ar = (struct ar_w *)a->format_data;
152 size = archive_entry_size(entry);
156 * Reject files with empty name.
158 pathname = archive_entry_pathname(entry);
159 if (*pathname == '\0') {
160 archive_set_error(&a->archive, EINVAL,
162 return (ARCHIVE_WARN);
166 * If we are now at the beginning of the archive,
167 * we need first write the ar global header.
169 if (a->archive.file_position == 0)
170 (a->compressor.write)(a, "!<arch>\n", 8);
172 memset(buff, ' ', 60);
173 strncpy(&buff[AR_fmag_offset], "`\n", 2);
175 if (strcmp(pathname, "/") == 0 ) {
176 /* Entry is archive symbol table in GNU format */
177 buff[AR_name_offset] = '/';
180 if (strcmp(pathname, "__.SYMDEF") == 0) {
181 /* Entry is archive symbol table in BSD format */
182 strncpy(buff + AR_name_offset, "__.SYMDEF", 9);
185 if (strcmp(pathname, "//") == 0) {
187 * Entry is archive filename table, inform that we should
188 * collect strtab in next _data call.
191 buff[AR_name_offset] = buff[AR_name_offset + 1] = '/';
193 * For archive string table, only ar_size filed should
200 * Otherwise, entry is a normal archive member.
201 * Strip leading paths from filenames, if any.
203 if ((filename = ar_basename(pathname)) == NULL) {
204 /* Reject filenames with trailing "/" */
205 archive_set_error(&a->archive, EINVAL,
207 return (ARCHIVE_WARN);
210 if (a->archive.archive_format == ARCHIVE_FORMAT_AR_GNU) {
212 * SVR4/GNU variant use a "/" to mark then end of the filename,
213 * make it possible to have embedded spaces in the filename.
214 * So, the longest filename here (without extension) is
217 if (strlen(filename) <= 15) {
218 strncpy(&buff[AR_name_offset],
219 filename, strlen(filename));
220 buff[AR_name_offset + strlen(filename)] = '/';
223 * For filename longer than 15 bytes, GNU variant
224 * makes use of a string table and instead stores the
225 * offset of the real filename to in the ar_name field.
226 * The string table should have been written before.
228 if (ar->has_strtab <= 0) {
229 archive_set_error(&a->archive, EINVAL,
230 "Can't find string table");
231 return (ARCHIVE_WARN);
234 se = (char *)malloc(strlen(filename) + 3);
236 archive_set_error(&a->archive, ENOMEM,
237 "Can't allocate filename buffer");
238 return (ARCHIVE_FATAL);
241 strncpy(se, filename, strlen(filename));
242 strcpy(se + strlen(filename), "/\n");
244 ss = strstr(ar->strtab, se);
248 archive_set_error(&a->archive, EINVAL,
249 "Invalid string table");
250 return (ARCHIVE_WARN);
254 * GNU variant puts "/" followed by digits into
255 * ar_name field. These digits indicates the real
256 * filename string's offset to the string table.
258 buff[AR_name_offset] = '/';
259 if (format_decimal(ss - ar->strtab,
260 buff + AR_name_offset + 1,
262 archive_set_error(&a->archive, ERANGE,
263 "string table offset too large");
264 return (ARCHIVE_WARN);
267 } else if (a->archive.archive_format == ARCHIVE_FORMAT_AR_BSD) {
269 * BSD variant: for any file name which is more than
270 * 16 chars or contains one or more embedded space(s), the
271 * string "#1/" followed by the ASCII length of the name is
272 * put into the ar_name field. The file size (stored in the
273 * ar_size field) is incremented by the length of the name.
274 * The name is then written immediately following the
277 if (strlen(filename) <= 16 && strchr(filename, ' ') == NULL) {
278 strncpy(&buff[AR_name_offset], filename, strlen(filename));
279 buff[AR_name_offset + strlen(filename)] = ' ';
282 strncpy(buff + AR_name_offset, "#1/", 3);
283 if (format_decimal(strlen(filename),
284 buff + AR_name_offset + 3,
286 archive_set_error(&a->archive, ERANGE,
287 "File name too long");
288 return (ARCHIVE_WARN);
291 size += strlen(filename);
296 if (format_decimal(archive_entry_mtime(entry), buff + AR_date_offset, AR_date_size)) {
297 archive_set_error(&a->archive, ERANGE,
298 "File modification time too large");
299 return (ARCHIVE_WARN);
301 if (format_decimal(archive_entry_uid(entry), buff + AR_uid_offset, AR_uid_size)) {
302 archive_set_error(&a->archive, ERANGE,
303 "Numeric user ID too large");
304 return (ARCHIVE_WARN);
306 if (format_decimal(archive_entry_gid(entry), buff + AR_gid_offset, AR_gid_size)) {
307 archive_set_error(&a->archive, ERANGE,
308 "Numeric group ID too large");
309 return (ARCHIVE_WARN);
311 if (format_octal(archive_entry_mode(entry), buff + AR_mode_offset, AR_mode_size)) {
312 archive_set_error(&a->archive, ERANGE,
313 "Numeric mode too large");
314 return (ARCHIVE_WARN);
317 * Sanity Check: A non-pseudo archive member should always be
320 if (filename != NULL && archive_entry_filetype(entry) != AE_IFREG) {
321 archive_set_error(&a->archive, EINVAL,
322 "Regular file required for non-pseudo member");
323 return (ARCHIVE_WARN);
327 if (format_decimal(size, buff + AR_size_offset, AR_size_size)) {
328 archive_set_error(&a->archive, ERANGE,
329 "File size out of range");
330 return (ARCHIVE_WARN);
333 ret = (a->compressor.write)(a, buff, 60);
334 if (ret != ARCHIVE_OK)
337 ar->entry_bytes_remaining = size;
338 ar->entry_padding = ar->entry_bytes_remaining % 2;
341 ret = (a->compressor.write)(a, filename, strlen(filename));
342 if (ret != ARCHIVE_OK)
344 ar->entry_bytes_remaining -= strlen(filename);
351 archive_write_ar_data(struct archive_write *a, const void *buff, size_t s)
356 ar = (struct ar_w *)a->format_data;
357 if (s > ar->entry_bytes_remaining)
358 s = ar->entry_bytes_remaining;
360 if (ar->is_strtab > 0) {
361 if (ar->has_strtab > 0) {
362 archive_set_error(&a->archive, EINVAL,
363 "More than one string tables exist");
364 return (ARCHIVE_WARN);
367 ar->strtab = (char *)malloc(s);
368 if (ar->strtab == NULL) {
369 archive_set_error(&a->archive, ENOMEM,
370 "Can't allocate strtab buffer");
371 return (ARCHIVE_FATAL);
373 strncpy(ar->strtab, buff, s);
377 ret = (a->compressor.write)(a, buff, s);
378 if (ret != ARCHIVE_OK)
381 ar->entry_bytes_remaining -= s;
386 archive_write_ar_destroy(struct archive_write *a)
390 ar = (struct ar_w *)a->format_data;
395 if (ar->has_strtab > 0) {
401 a->format_data = NULL;
406 archive_write_ar_finish(struct archive_write *a)
411 * If we haven't written anything yet, we need to write
412 * the ar global header now to make it a valid ar archive.
414 if (a->archive.file_position == 0) {
415 ret = (a->compressor.write)(a, "!<arch>\n", 8);
423 archive_write_ar_finish_entry(struct archive_write *a)
428 ar = (struct ar_w *)a->format_data;
430 if (ar->entry_bytes_remaining != 0) {
431 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
432 "Entry remaining bytes larger than 0");
433 return (ARCHIVE_WARN);
436 if (ar->entry_padding == 0) {
440 if (ar->entry_padding != 1) {
441 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
442 "Padding wrong size: %d should be 1 or 0",
444 return (ARCHIVE_WARN);
447 ret = (a->compressor.write)(a, "\n", 1);
452 * Format a number into the specified field using base-8.
453 * NB: This version is slightly different from the one in
457 format_octal(int64_t v, char *p, int s)
465 /* Octal values can't be negative, so use 0. */
472 p += s; /* Start at the end and work backwards. */
474 *--p = (char)('0' + (v & 7));
476 } while (--s > 0 && v > 0);
479 memmove(h, p, len - s);
485 /* If it overflowed, fill field with max value. */
493 * Format a number into the specified field using base-10.
496 format_decimal(int64_t v, char *p, int s)
504 /* Negative values in ar header are meaningless , so use 0. */
513 *--p = (char)('0' + (v % 10));
515 } while (--s > 0 && v > 0);
518 memmove(h, p, len - s);
524 /* If it overflowed, fill field with max value. */
532 ar_basename(const char *path)
534 const char *endp, *startp;
536 endp = path + strlen(path) - 1;
538 * For filename with trailing slash(es), we return
539 * NULL indicating an error.
544 /* Find the start of the base */
546 while (startp > path && *(startp - 1) != '/')