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"
45 #include "archive_write_set_format_private.h"
48 uint64_t entry_bytes_remaining;
49 uint64_t entry_padding;
52 char wrote_global_header;
57 * Define structure of the "ar" header.
59 #define AR_name_offset 0
60 #define AR_name_size 16
61 #define AR_date_offset 16
62 #define AR_date_size 12
63 #define AR_uid_offset 28
65 #define AR_gid_offset 34
67 #define AR_mode_offset 40
68 #define AR_mode_size 8
69 #define AR_size_offset 48
70 #define AR_size_size 10
71 #define AR_fmag_offset 58
72 #define AR_fmag_size 2
74 static int archive_write_set_format_ar(struct archive_write *);
75 static int archive_write_ar_header(struct archive_write *,
76 struct archive_entry *);
77 static ssize_t archive_write_ar_data(struct archive_write *,
78 const void *buff, size_t s);
79 static int archive_write_ar_free(struct archive_write *);
80 static int archive_write_ar_close(struct archive_write *);
81 static int archive_write_ar_finish_entry(struct archive_write *);
82 static const char *ar_basename(const char *path);
83 static int format_octal(int64_t v, char *p, int s);
84 static int format_decimal(int64_t v, char *p, int s);
87 archive_write_set_format_ar_bsd(struct archive *_a)
89 struct archive_write *a = (struct archive_write *)_a;
92 archive_check_magic(_a, ARCHIVE_WRITE_MAGIC,
93 ARCHIVE_STATE_NEW, "archive_write_set_format_ar_bsd");
94 r = archive_write_set_format_ar(a);
95 if (r == ARCHIVE_OK) {
96 a->archive.archive_format = ARCHIVE_FORMAT_AR_BSD;
97 a->archive.archive_format_name = "ar (BSD)";
103 archive_write_set_format_ar_svr4(struct archive *_a)
105 struct archive_write *a = (struct archive_write *)_a;
108 archive_check_magic(_a, ARCHIVE_WRITE_MAGIC,
109 ARCHIVE_STATE_NEW, "archive_write_set_format_ar_svr4");
110 r = archive_write_set_format_ar(a);
111 if (r == ARCHIVE_OK) {
112 a->archive.archive_format = ARCHIVE_FORMAT_AR_GNU;
113 a->archive.archive_format_name = "ar (GNU/SVR4)";
119 * Generic initialization.
122 archive_write_set_format_ar(struct archive_write *a)
126 /* If someone else was already registered, unregister them. */
127 if (a->format_free != NULL)
130 ar = (struct ar_w *)calloc(1, sizeof(*ar));
132 archive_set_error(&a->archive, ENOMEM, "Can't allocate ar data");
133 return (ARCHIVE_FATAL);
137 a->format_name = "ar";
138 a->format_write_header = archive_write_ar_header;
139 a->format_write_data = archive_write_ar_data;
140 a->format_close = archive_write_ar_close;
141 a->format_free = archive_write_ar_free;
142 a->format_finish_entry = archive_write_ar_finish_entry;
147 archive_write_ar_header(struct archive_write *a, struct archive_entry *entry)
153 const char *pathname;
154 const char *filename;
158 ar = (struct ar_w *)a->format_data;
161 size = archive_entry_size(entry);
165 * Reject files with empty name.
167 pathname = archive_entry_pathname(entry);
168 if (pathname == NULL || *pathname == '\0') {
169 archive_set_error(&a->archive, EINVAL,
171 return (ARCHIVE_WARN);
175 * If we are now at the beginning of the archive,
176 * we need first write the ar global header.
178 if (!ar->wrote_global_header) {
179 __archive_write_output(a, "!<arch>\n", 8);
180 ar->wrote_global_header = 1;
183 memset(buff, ' ', 60);
184 memcpy(&buff[AR_fmag_offset], "`\n", 2);
186 if (strcmp(pathname, "/") == 0 ) {
187 /* Entry is archive symbol table in GNU format */
188 buff[AR_name_offset] = '/';
191 if (strcmp(pathname, "/SYM64/") == 0) {
192 /* Entry is archive symbol table in GNU 64-bit format */
193 memcpy(buff + AR_name_offset, "/SYM64/", 7);
196 if (strcmp(pathname, "__.SYMDEF") == 0) {
197 /* Entry is archive symbol table in BSD format */
198 memcpy(buff + AR_name_offset, "__.SYMDEF", 9);
201 if (strcmp(pathname, "//") == 0) {
203 * Entry is archive filename table, inform that we should
204 * collect strtab in next _data call.
207 buff[AR_name_offset] = buff[AR_name_offset + 1] = '/';
209 * For archive string table, only ar_size field should
216 * Otherwise, entry is a normal archive member.
217 * Strip leading paths from filenames, if any.
219 if ((filename = ar_basename(pathname)) == NULL) {
220 /* Reject filenames with trailing "/" */
221 archive_set_error(&a->archive, EINVAL,
223 return (ARCHIVE_WARN);
226 if (a->archive.archive_format == ARCHIVE_FORMAT_AR_GNU) {
228 * SVR4/GNU variant use a "/" to mark then end of the filename,
229 * make it possible to have embedded spaces in the filename.
230 * So, the longest filename here (without extension) is
233 if (strlen(filename) <= 15) {
234 memcpy(&buff[AR_name_offset],
235 filename, strlen(filename));
236 buff[AR_name_offset + strlen(filename)] = '/';
239 * For filename longer than 15 bytes, GNU variant
240 * makes use of a string table and instead stores the
241 * offset of the real filename to in the ar_name field.
242 * The string table should have been written before.
244 if (ar->has_strtab <= 0) {
245 archive_set_error(&a->archive, EINVAL,
246 "Can't find string table");
247 return (ARCHIVE_WARN);
250 se = (char *)malloc(strlen(filename) + 3);
252 archive_set_error(&a->archive, ENOMEM,
253 "Can't allocate filename buffer");
254 return (ARCHIVE_FATAL);
257 memcpy(se, filename, strlen(filename));
258 strcpy(se + strlen(filename), "/\n");
260 ss = strstr(ar->strtab, se);
264 archive_set_error(&a->archive, EINVAL,
265 "Invalid string table");
266 return (ARCHIVE_WARN);
270 * GNU variant puts "/" followed by digits into
271 * ar_name field. These digits indicates the real
272 * filename string's offset to the string table.
274 buff[AR_name_offset] = '/';
275 if (format_decimal(ss - ar->strtab,
276 buff + AR_name_offset + 1,
278 archive_set_error(&a->archive, ERANGE,
279 "string table offset too large");
280 return (ARCHIVE_WARN);
283 } else if (a->archive.archive_format == ARCHIVE_FORMAT_AR_BSD) {
285 * BSD variant: for any file name which is more than
286 * 16 chars or contains one or more embedded space(s), the
287 * string "#1/" followed by the ASCII length of the name is
288 * put into the ar_name field. The file size (stored in the
289 * ar_size field) is incremented by the length of the name.
290 * The name is then written immediately following the
293 if (strlen(filename) <= 16 && strchr(filename, ' ') == NULL) {
294 memcpy(&buff[AR_name_offset], filename, strlen(filename));
295 buff[AR_name_offset + strlen(filename)] = ' ';
298 memcpy(buff + AR_name_offset, "#1/", 3);
299 if (format_decimal(strlen(filename),
300 buff + AR_name_offset + 3,
302 archive_set_error(&a->archive, ERANGE,
303 "File name too long");
304 return (ARCHIVE_WARN);
307 size += strlen(filename);
312 if (format_decimal(archive_entry_mtime(entry), buff + AR_date_offset, AR_date_size)) {
313 archive_set_error(&a->archive, ERANGE,
314 "File modification time too large");
315 return (ARCHIVE_WARN);
317 if (format_decimal(archive_entry_uid(entry), buff + AR_uid_offset, AR_uid_size)) {
318 archive_set_error(&a->archive, ERANGE,
319 "Numeric user ID too large");
320 return (ARCHIVE_WARN);
322 if (format_decimal(archive_entry_gid(entry), buff + AR_gid_offset, AR_gid_size)) {
323 archive_set_error(&a->archive, ERANGE,
324 "Numeric group ID too large");
325 return (ARCHIVE_WARN);
327 if (format_octal(archive_entry_mode(entry), buff + AR_mode_offset, AR_mode_size)) {
328 archive_set_error(&a->archive, ERANGE,
329 "Numeric mode too large");
330 return (ARCHIVE_WARN);
333 * Sanity Check: A non-pseudo archive member should always be
336 if (filename != NULL && archive_entry_filetype(entry) != AE_IFREG) {
337 archive_set_error(&a->archive, EINVAL,
338 "Regular file required for non-pseudo member");
339 return (ARCHIVE_WARN);
343 if (format_decimal(size, buff + AR_size_offset, AR_size_size)) {
344 archive_set_error(&a->archive, ERANGE,
345 "File size out of range");
346 return (ARCHIVE_WARN);
349 ret = __archive_write_output(a, buff, 60);
350 if (ret != ARCHIVE_OK)
353 ar->entry_bytes_remaining = size;
354 ar->entry_padding = ar->entry_bytes_remaining % 2;
357 ret = __archive_write_output(a, filename, strlen(filename));
358 if (ret != ARCHIVE_OK)
360 ar->entry_bytes_remaining -= strlen(filename);
367 archive_write_ar_data(struct archive_write *a, const void *buff, size_t s)
372 ar = (struct ar_w *)a->format_data;
373 if (s > ar->entry_bytes_remaining)
374 s = (size_t)ar->entry_bytes_remaining;
376 if (ar->is_strtab > 0) {
377 if (ar->has_strtab > 0) {
378 archive_set_error(&a->archive, EINVAL,
379 "More than one string tables exist");
380 return (ARCHIVE_WARN);
383 ar->strtab = (char *)malloc(s + 1);
384 if (ar->strtab == NULL) {
385 archive_set_error(&a->archive, ENOMEM,
386 "Can't allocate strtab buffer");
387 return (ARCHIVE_FATAL);
389 memcpy(ar->strtab, buff, s);
390 ar->strtab[s] = '\0';
394 ret = __archive_write_output(a, buff, s);
395 if (ret != ARCHIVE_OK)
398 ar->entry_bytes_remaining -= s;
403 archive_write_ar_free(struct archive_write *a)
407 ar = (struct ar_w *)a->format_data;
412 if (ar->has_strtab > 0) {
418 a->format_data = NULL;
423 archive_write_ar_close(struct archive_write *a)
429 * If we haven't written anything yet, we need to write
430 * the ar global header now to make it a valid ar archive.
432 ar = (struct ar_w *)a->format_data;
433 if (!ar->wrote_global_header) {
434 ar->wrote_global_header = 1;
435 ret = __archive_write_output(a, "!<arch>\n", 8);
443 archive_write_ar_finish_entry(struct archive_write *a)
448 ar = (struct ar_w *)a->format_data;
450 if (ar->entry_bytes_remaining != 0) {
451 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
452 "Entry remaining bytes larger than 0");
453 return (ARCHIVE_WARN);
456 if (ar->entry_padding == 0) {
460 if (ar->entry_padding != 1) {
461 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
462 "Padding wrong size: %ju should be 1 or 0",
463 (uintmax_t)ar->entry_padding);
464 return (ARCHIVE_WARN);
467 ret = __archive_write_output(a, "\n", 1);
472 * Format a number into the specified field using base-8.
473 * NB: This version is slightly different from the one in
477 format_octal(int64_t v, char *p, int s)
485 /* Octal values can't be negative, so use 0. */
492 p += s; /* Start at the end and work backwards. */
494 *--p = (char)('0' + (v & 7));
496 } while (--s > 0 && v > 0);
499 memmove(h, p, len - s);
505 /* If it overflowed, fill field with max value. */
513 * Format a number into the specified field using base-10.
516 format_decimal(int64_t v, char *p, int s)
524 /* Negative values in ar header are meaningless, so use 0. */
533 *--p = (char)('0' + (v % 10));
535 } while (--s > 0 && v > 0);
538 memmove(h, p, len - s);
544 /* If it overflowed, fill field with max value. */
552 ar_basename(const char *path)
554 const char *endp, *startp;
556 endp = path + strlen(path) - 1;
558 * For filename with trailing slash(es), we return
559 * NULL indicating an error.
564 /* Find the start of the base */
566 while (startp > path && *(startp - 1) != '/')