2 * Copyright (c) 2003-2007 Tim Kientzle
3 * Copyright (c) 2010-2012 Michihiro NAKAJIMA
4 * Copyright (c) 2016 Martin Matuska
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
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_entry_locale.h"
44 #include "archive_private.h"
45 #include "archive_write_private.h"
48 struct sparse_block *next;
55 uint64_t entry_bytes_remaining;
56 uint64_t entry_padding;
57 struct archive_string l_url_encoded_name;
58 struct archive_string pax_header;
59 struct archive_string sparse_map;
60 size_t sparse_map_padding;
61 struct sparse_block *sparse_list;
62 struct sparse_block *sparse_tail;
63 struct archive_string_conv *sconv_utf8;
67 #define WRITE_SCHILY_XATTR (1 << 0)
68 #define WRITE_LIBARCHIVE_XATTR (1 << 1)
71 static void add_pax_attr(struct archive_string *, const char *key,
73 static void add_pax_attr_binary(struct archive_string *,
75 const char *value, size_t value_len);
76 static void add_pax_attr_int(struct archive_string *,
77 const char *key, int64_t value);
78 static void add_pax_attr_time(struct archive_string *,
79 const char *key, int64_t sec,
81 static int add_pax_acl(struct archive_write *,
82 struct archive_entry *, struct pax *, int);
83 static ssize_t archive_write_pax_data(struct archive_write *,
84 const void *, size_t);
85 static int archive_write_pax_close(struct archive_write *);
86 static int archive_write_pax_free(struct archive_write *);
87 static int archive_write_pax_finish_entry(struct archive_write *);
88 static int archive_write_pax_header(struct archive_write *,
89 struct archive_entry *);
90 static int archive_write_pax_options(struct archive_write *,
91 const char *, const char *);
92 static char *base64_encode(const char *src, size_t len);
93 static char *build_gnu_sparse_name(char *dest, const char *src);
94 static char *build_pax_attribute_name(char *dest, const char *src);
95 static char *build_ustar_entry_name(char *dest, const char *src,
96 size_t src_length, const char *insert);
97 static char *format_int(char *dest, int64_t);
98 static int has_non_ASCII(const char *);
99 static void sparse_list_clear(struct pax *);
100 static int sparse_list_add(struct pax *, int64_t, int64_t);
101 static char *url_encode(const char *in);
104 * Set output format to 'restricted pax' format.
106 * This is the same as normal 'pax', but tries to suppress
107 * the pax header whenever possible. This is the default for
108 * bsdtar, for instance.
111 archive_write_set_format_pax_restricted(struct archive *_a)
113 struct archive_write *a = (struct archive_write *)_a;
116 archive_check_magic(_a, ARCHIVE_WRITE_MAGIC,
117 ARCHIVE_STATE_NEW, "archive_write_set_format_pax_restricted");
119 r = archive_write_set_format_pax(&a->archive);
120 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_RESTRICTED;
121 a->archive.archive_format_name = "restricted POSIX pax interchange";
126 * Set output format to 'pax' format.
129 archive_write_set_format_pax(struct archive *_a)
131 struct archive_write *a = (struct archive_write *)_a;
134 archive_check_magic(_a, ARCHIVE_WRITE_MAGIC,
135 ARCHIVE_STATE_NEW, "archive_write_set_format_pax");
137 if (a->format_free != NULL)
140 pax = (struct pax *)calloc(1, sizeof(*pax));
142 archive_set_error(&a->archive, ENOMEM,
143 "Can't allocate pax data");
144 return (ARCHIVE_FATAL);
146 pax->flags = WRITE_LIBARCHIVE_XATTR | WRITE_SCHILY_XATTR;
148 a->format_data = pax;
149 a->format_name = "pax";
150 a->format_options = archive_write_pax_options;
151 a->format_write_header = archive_write_pax_header;
152 a->format_write_data = archive_write_pax_data;
153 a->format_close = archive_write_pax_close;
154 a->format_free = archive_write_pax_free;
155 a->format_finish_entry = archive_write_pax_finish_entry;
156 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
157 a->archive.archive_format_name = "POSIX pax interchange";
162 archive_write_pax_options(struct archive_write *a, const char *key,
165 struct pax *pax = (struct pax *)a->format_data;
166 int ret = ARCHIVE_FAILED;
168 if (strcmp(key, "hdrcharset") == 0) {
170 * The character-set we can use are defined in
171 * IEEE Std 1003.1-2001
173 if (val == NULL || val[0] == 0)
174 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
175 "pax: hdrcharset option needs a character-set name");
176 else if (strcmp(val, "BINARY") == 0 ||
177 strcmp(val, "binary") == 0) {
179 * Specify binary mode. We will not convert
180 * filenames, uname and gname to any charsets.
184 } else if (strcmp(val, "UTF-8") == 0) {
186 * Specify UTF-8 character-set to be used for
187 * filenames. This is almost the test that
188 * running platform supports the string conversion.
189 * Especially libarchive_test needs this trick for
192 pax->sconv_utf8 = archive_string_conversion_to_charset(
193 &(a->archive), "UTF-8", 0);
194 if (pax->sconv_utf8 == NULL)
199 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
200 "pax: invalid charset name");
204 /* Note: The "warn" return is just to inform the options
205 * supervisor that we didn't handle it. It will generate
206 * a suitable error if no one used this option. */
207 return (ARCHIVE_WARN);
211 * Note: This code assumes that 'nanos' has the same sign as 'sec',
212 * which implies that sec=-1, nanos=200000000 represents -1.2 seconds
213 * and not -0.8 seconds. This is a pretty pedantic point, as we're
214 * unlikely to encounter many real files created before Jan 1, 1970,
215 * much less ones with timestamps recorded to sub-second resolution.
218 add_pax_attr_time(struct archive_string *as, const char *key,
219 int64_t sec, unsigned long nanos)
224 * Note that each byte contributes fewer than 3 base-10
225 * digits, so this will always be big enough.
227 char tmp[1 + 3*sizeof(sec) + 1 + 3*sizeof(nanos)];
229 tmp[sizeof(tmp) - 1] = 0;
230 t = tmp + sizeof(tmp) - 1;
232 /* Skip trailing zeros in the fractional part. */
233 for (digit = 0, i = 10; i > 0 && digit == 0; i--) {
238 /* Only format the fraction if it's non-zero. */
241 *--t = "0123456789"[digit];
248 t = format_int(t, sec);
250 add_pax_attr(as, key, t);
254 format_int(char *t, int64_t i)
259 ui = (i == INT64_MIN) ? (uint64_t)(INT64_MAX) + 1 : (uint64_t)(-i);
264 *--t = "0123456789"[ui % 10];
272 add_pax_attr_int(struct archive_string *as, const char *key, int64_t value)
274 char tmp[1 + 3 * sizeof(value)];
276 tmp[sizeof(tmp) - 1] = 0;
277 add_pax_attr(as, key, format_int(tmp + sizeof(tmp) - 1, value));
281 * Add a key/value attribute to the pax header. This function handles
282 * the length field and various other syntactic requirements.
285 add_pax_attr(struct archive_string *as, const char *key, const char *value)
287 add_pax_attr_binary(as, key, value, strlen(value));
291 * Add a key/value attribute to the pax header. This function handles
295 add_pax_attr_binary(struct archive_string *as, const char *key,
296 const char *value, size_t value_len)
298 int digits, i, len, next_ten;
299 char tmp[1 + 3 * sizeof(int)]; /* < 3 base-10 digits per byte */
302 * PAX attributes have the following layout:
303 * <len> <space> <key> <=> <value> <nl>
305 len = 1 + (int)strlen(key) + 1 + (int)value_len + 1;
308 * The <len> field includes the length of the <len> field, so
309 * computing the correct length is tricky. I start by
310 * counting the number of base-10 digits in 'len' and
311 * computing the next higher power of 10.
319 next_ten = next_ten * 10;
322 * For example, if string without the length field is 99
323 * chars, then adding the 2 digit length "99" will force the
324 * total length past 100, requiring an extra digit. The next
325 * statement adjusts for this effect.
327 if (len + digits >= next_ten)
330 /* Now, we have the right length so we can build the line. */
331 tmp[sizeof(tmp) - 1] = 0; /* Null-terminate the work area. */
332 archive_strcat(as, format_int(tmp + sizeof(tmp) - 1, len + digits));
333 archive_strappend_char(as, ' ');
334 archive_strcat(as, key);
335 archive_strappend_char(as, '=');
336 archive_array_append(as, value, value_len);
337 archive_strappend_char(as, '\n');
341 archive_write_pax_header_xattr(struct pax *pax, const char *encoded_name,
342 const void *value, size_t value_len)
344 struct archive_string s;
347 if (pax->flags & WRITE_LIBARCHIVE_XATTR) {
348 encoded_value = base64_encode((const char *)value, value_len);
350 if (encoded_name != NULL && encoded_value != NULL) {
351 archive_string_init(&s);
352 archive_strcpy(&s, "LIBARCHIVE.xattr.");
353 archive_strcat(&s, encoded_name);
354 add_pax_attr(&(pax->pax_header), s.s, encoded_value);
355 archive_string_free(&s);
359 if (pax->flags & WRITE_SCHILY_XATTR) {
360 archive_string_init(&s);
361 archive_strcpy(&s, "SCHILY.xattr.");
362 archive_strcat(&s, encoded_name);
363 add_pax_attr_binary(&(pax->pax_header), s.s, value, value_len);
364 archive_string_free(&s);
369 archive_write_pax_header_xattrs(struct archive_write *a,
370 struct pax *pax, struct archive_entry *entry)
372 int i = archive_entry_xattr_reset(entry);
377 char *url_encoded_name = NULL, *encoded_name = NULL;
381 archive_entry_xattr_next(entry, &name, &value, &size);
382 url_encoded_name = url_encode(name);
383 if (url_encoded_name != NULL) {
384 /* Convert narrow-character to UTF-8. */
385 r = archive_strcpy_l(&(pax->l_url_encoded_name),
386 url_encoded_name, pax->sconv_utf8);
387 free(url_encoded_name); /* Done with this. */
389 encoded_name = pax->l_url_encoded_name.s;
390 else if (errno == ENOMEM) {
391 archive_set_error(&a->archive, ENOMEM,
392 "Can't allocate memory for Linkname");
393 return (ARCHIVE_FATAL);
397 archive_write_pax_header_xattr(pax, encoded_name,
405 get_entry_hardlink(struct archive_write *a, struct archive_entry *entry,
406 const char **name, size_t *length, struct archive_string_conv *sc)
410 r = archive_entry_hardlink_l(entry, name, length, sc);
412 if (errno == ENOMEM) {
413 archive_set_error(&a->archive, ENOMEM,
414 "Can't allocate memory for Linkname");
415 return (ARCHIVE_FATAL);
417 return (ARCHIVE_WARN);
423 get_entry_pathname(struct archive_write *a, struct archive_entry *entry,
424 const char **name, size_t *length, struct archive_string_conv *sc)
428 r = archive_entry_pathname_l(entry, name, length, sc);
430 if (errno == ENOMEM) {
431 archive_set_error(&a->archive, ENOMEM,
432 "Can't allocate memory for Pathname");
433 return (ARCHIVE_FATAL);
435 return (ARCHIVE_WARN);
441 get_entry_uname(struct archive_write *a, struct archive_entry *entry,
442 const char **name, size_t *length, struct archive_string_conv *sc)
446 r = archive_entry_uname_l(entry, name, length, sc);
448 if (errno == ENOMEM) {
449 archive_set_error(&a->archive, ENOMEM,
450 "Can't allocate memory for Uname");
451 return (ARCHIVE_FATAL);
453 return (ARCHIVE_WARN);
459 get_entry_gname(struct archive_write *a, struct archive_entry *entry,
460 const char **name, size_t *length, struct archive_string_conv *sc)
464 r = archive_entry_gname_l(entry, name, length, sc);
466 if (errno == ENOMEM) {
467 archive_set_error(&a->archive, ENOMEM,
468 "Can't allocate memory for Gname");
469 return (ARCHIVE_FATAL);
471 return (ARCHIVE_WARN);
477 get_entry_symlink(struct archive_write *a, struct archive_entry *entry,
478 const char **name, size_t *length, struct archive_string_conv *sc)
482 r = archive_entry_symlink_l(entry, name, length, sc);
484 if (errno == ENOMEM) {
485 archive_set_error(&a->archive, ENOMEM,
486 "Can't allocate memory for Linkname");
487 return (ARCHIVE_FATAL);
489 return (ARCHIVE_WARN);
494 /* Add ACL to pax header */
496 add_pax_acl(struct archive_write *a,
497 struct archive_entry *entry, struct pax *pax, int flags)
503 acl_types = archive_entry_acl_types(entry);
505 if ((acl_types & ARCHIVE_ENTRY_ACL_TYPE_NFS4) != 0)
506 attr = "SCHILY.acl.ace";
507 else if ((flags & ARCHIVE_ENTRY_ACL_TYPE_ACCESS) != 0)
508 attr = "SCHILY.acl.access";
509 else if ((flags & ARCHIVE_ENTRY_ACL_TYPE_DEFAULT) != 0)
510 attr = "SCHILY.acl.default";
512 return (ARCHIVE_FATAL);
514 p = archive_entry_acl_to_text_l(entry, NULL, flags, pax->sconv_utf8);
516 if (errno == ENOMEM) {
517 archive_set_error(&a->archive, ENOMEM, "%s %s",
518 "Can't allocate memory for ", attr);
519 return (ARCHIVE_FATAL);
521 archive_set_error(&a->archive,
522 ARCHIVE_ERRNO_FILE_FORMAT, "%s %s %s",
523 "Can't translate ", attr, " to UTF-8");
524 return(ARCHIVE_WARN);
525 } else if (*p != '\0') {
526 add_pax_attr(&(pax->pax_header),
534 * TODO: Consider adding 'comment' and 'charset' fields to
535 * archive_entry so that clients can specify them. Also, consider
536 * adding generic key/value tags so clients can add arbitrary
539 * TODO: Break up this 700-line function!!!! Yowza!
542 archive_write_pax_header(struct archive_write *a,
543 struct archive_entry *entry_original)
545 struct archive_entry *entry_main;
548 int need_extension, r, ret;
551 uint64_t sparse_total, real_size;
553 const char *hardlink;
554 const char *path = NULL, *linkpath = NULL;
555 const char *uname = NULL, *gname = NULL;
556 const void *mac_metadata;
557 size_t mac_metadata_size;
558 struct archive_string_conv *sconv;
559 size_t hardlink_length, path_length, linkpath_length;
560 size_t uname_length, gname_length;
564 char ustar_entry_name[256];
565 char pax_entry_name[256];
566 char gnu_sparse_name[256];
567 struct archive_string entry_name;
571 pax = (struct pax *)a->format_data;
574 if (archive_entry_pathname(entry_original) == NULL) {
575 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
576 "Can't record entry in tar file without pathname");
577 return (ARCHIVE_FAILED);
581 * Choose a header encoding.
584 sconv = NULL;/* Binary mode. */
586 /* Header encoding is UTF-8. */
587 if (pax->sconv_utf8 == NULL) {
588 /* Initialize the string conversion object
590 pax->sconv_utf8 = archive_string_conversion_to_charset(
591 &(a->archive), "UTF-8", 1);
592 if (pax->sconv_utf8 == NULL)
593 /* Couldn't allocate memory */
594 return (ARCHIVE_FAILED);
596 sconv = pax->sconv_utf8;
599 r = get_entry_hardlink(a, entry_original, &hardlink,
600 &hardlink_length, sconv);
601 if (r == ARCHIVE_FATAL)
603 else if (r != ARCHIVE_OK) {
604 r = get_entry_hardlink(a, entry_original, &hardlink,
605 &hardlink_length, NULL);
606 if (r == ARCHIVE_FATAL)
608 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
609 "Can't translate linkname '%s' to %s", hardlink,
610 archive_string_conversion_charset_name(sconv));
612 sconv = NULL;/* The header charset switches to binary mode. */
615 /* Make sure this is a type of entry that we can handle here */
616 if (hardlink == NULL) {
617 switch (archive_entry_filetype(entry_original)) {
627 * Ensure a trailing '/'. Modify the original
628 * entry so the client sees the change.
630 #if defined(_WIN32) && !defined(__CYGWIN__)
633 wp = archive_entry_pathname_w(entry_original);
634 if (wp != NULL && wp[wcslen(wp) -1] != L'/') {
635 struct archive_wstring ws;
637 archive_string_init(&ws);
638 path_length = wcslen(wp);
639 if (archive_wstring_ensure(&ws,
640 path_length + 2) == NULL) {
641 archive_set_error(&a->archive, ENOMEM,
642 "Can't allocate pax data");
643 archive_wstring_free(&ws);
644 return(ARCHIVE_FATAL);
646 /* Should we keep '\' ? */
647 if (wp[path_length -1] == L'\\')
649 archive_wstrncpy(&ws, wp, path_length);
650 archive_wstrappend_wchar(&ws, L'/');
651 archive_entry_copy_pathname_w(
652 entry_original, ws.s);
653 archive_wstring_free(&ws);
657 p = archive_entry_pathname(entry_original);
659 * On Windows, this is a backup operation just in
660 * case getting WCS failed. On POSIX, this is a
663 if (p != NULL && p[0] != '\0' && p[strlen(p) - 1] != '/') {
664 struct archive_string as;
666 archive_string_init(&as);
667 path_length = strlen(p);
668 if (archive_string_ensure(&as,
669 path_length + 2) == NULL) {
670 archive_set_error(&a->archive, ENOMEM,
671 "Can't allocate pax data");
672 archive_string_free(&as);
673 return(ARCHIVE_FATAL);
675 #if defined(_WIN32) && !defined(__CYGWIN__)
676 /* NOTE: This might break the pathname
677 * if the current code page is CP932 and
678 * the pathname includes a character '\'
679 * as a part of its multibyte pathname. */
680 if (p[strlen(p) -1] == '\\')
684 archive_strncpy(&as, p, path_length);
685 archive_strappend_char(&as, '/');
686 archive_entry_copy_pathname(
687 entry_original, as.s);
688 archive_string_free(&as);
693 archive_set_error(&a->archive,
694 ARCHIVE_ERRNO_FILE_FORMAT,
695 "tar format cannot archive socket");
696 return (ARCHIVE_FAILED);
698 archive_set_error(&a->archive,
699 ARCHIVE_ERRNO_FILE_FORMAT,
700 "tar format cannot archive this (type=0%lo)",
702 archive_entry_filetype(entry_original));
703 return (ARCHIVE_FAILED);
708 * If Mac OS metadata blob is here, recurse to write that
709 * as a separate entry. This is really a pretty poor design:
710 * In particular, it doubles the overhead for long filenames.
711 * TODO: Help Apple folks design something better and figure
712 * out how to transition from this legacy format.
714 * Note that this code is present on every platform; clients
715 * on non-Mac are unlikely to ever provide this data, but
716 * applications that copy entries from one archive to another
717 * should not lose data just because the local filesystem
721 archive_entry_mac_metadata(entry_original, &mac_metadata_size);
722 if (mac_metadata != NULL) {
726 struct archive_entry *extra = archive_entry_new2(&a->archive);
728 oname = archive_entry_pathname(entry_original);
729 name_length = strlen(oname);
730 name = malloc(name_length + 3);
731 if (name == NULL || extra == NULL) {
732 /* XXX error message */
733 archive_entry_free(extra);
735 return (ARCHIVE_FAILED);
738 /* Find last '/'; strip trailing '/' characters */
739 bname = strrchr(name, '/');
740 while (bname != NULL && bname[1] == '\0') {
742 bname = strrchr(name, '/');
745 memmove(name + 2, name, name_length + 1);
746 memmove(name, "._", 2);
749 memmove(bname + 2, bname, strlen(bname) + 1);
750 memmove(bname, "._", 2);
752 archive_entry_copy_pathname(extra, name);
755 archive_entry_set_size(extra, mac_metadata_size);
756 archive_entry_set_filetype(extra, AE_IFREG);
757 archive_entry_set_perm(extra,
758 archive_entry_perm(entry_original));
759 archive_entry_set_mtime(extra,
760 archive_entry_mtime(entry_original),
761 archive_entry_mtime_nsec(entry_original));
762 archive_entry_set_gid(extra,
763 archive_entry_gid(entry_original));
764 archive_entry_set_gname(extra,
765 archive_entry_gname(entry_original));
766 archive_entry_set_uid(extra,
767 archive_entry_uid(entry_original));
768 archive_entry_set_uname(extra,
769 archive_entry_uname(entry_original));
771 /* Recurse to write the special copyfile entry. */
772 r = archive_write_pax_header(a, extra);
773 archive_entry_free(extra);
774 if (r < ARCHIVE_WARN)
778 r = (int)archive_write_pax_data(a, mac_metadata,
780 if (r < ARCHIVE_WARN)
784 r = archive_write_pax_finish_entry(a);
785 if (r < ARCHIVE_WARN)
791 /* Copy entry so we can modify it as needed. */
792 #if defined(_WIN32) && !defined(__CYGWIN__)
793 /* Make sure the path separators in pathname, hardlink and symlink
794 * are all slash '/', not the Windows path separator '\'. */
795 entry_main = __la_win_entry_in_posix_pathseparator(entry_original);
796 if (entry_main == entry_original)
797 entry_main = archive_entry_clone(entry_original);
799 entry_main = archive_entry_clone(entry_original);
801 if (entry_main == NULL) {
802 archive_set_error(&a->archive, ENOMEM,
803 "Can't allocate pax data");
804 return(ARCHIVE_FATAL);
806 archive_string_empty(&(pax->pax_header)); /* Blank our work area. */
807 archive_string_empty(&(pax->sparse_map));
809 sparse_list_clear(pax);
811 if (hardlink == NULL &&
812 archive_entry_filetype(entry_main) == AE_IFREG)
813 sparse_count = archive_entry_sparse_reset(entry_main);
817 int64_t offset, length, last_offset = 0;
818 /* Get the last entry of sparse block. */
819 while (archive_entry_sparse_next(
820 entry_main, &offset, &length) == ARCHIVE_OK)
821 last_offset = offset + length;
823 /* If the last sparse block does not reach the end of file,
824 * We have to add a empty sparse block as the last entry to
825 * manage storing file data. */
826 if (last_offset < archive_entry_size(entry_main))
827 archive_entry_sparse_add_entry(entry_main,
828 archive_entry_size(entry_main), 0);
829 sparse_count = archive_entry_sparse_reset(entry_main);
833 * First, check the name fields and see if any of them
834 * require binary coding. If any of them does, then all of
837 r = get_entry_pathname(a, entry_main, &path, &path_length, sconv);
838 if (r == ARCHIVE_FATAL)
840 else if (r != ARCHIVE_OK) {
841 r = get_entry_pathname(a, entry_main, &path,
843 if (r == ARCHIVE_FATAL)
845 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
846 "Can't translate pathname '%s' to %s", path,
847 archive_string_conversion_charset_name(sconv));
849 sconv = NULL;/* The header charset switches to binary mode. */
851 r = get_entry_uname(a, entry_main, &uname, &uname_length, sconv);
852 if (r == ARCHIVE_FATAL)
854 else if (r != ARCHIVE_OK) {
855 r = get_entry_uname(a, entry_main, &uname, &uname_length, NULL);
856 if (r == ARCHIVE_FATAL)
858 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
859 "Can't translate uname '%s' to %s", uname,
860 archive_string_conversion_charset_name(sconv));
862 sconv = NULL;/* The header charset switches to binary mode. */
864 r = get_entry_gname(a, entry_main, &gname, &gname_length, sconv);
865 if (r == ARCHIVE_FATAL)
867 else if (r != ARCHIVE_OK) {
868 r = get_entry_gname(a, entry_main, &gname, &gname_length, NULL);
869 if (r == ARCHIVE_FATAL)
871 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
872 "Can't translate gname '%s' to %s", gname,
873 archive_string_conversion_charset_name(sconv));
875 sconv = NULL;/* The header charset switches to binary mode. */
878 linkpath_length = hardlink_length;
879 if (linkpath == NULL) {
880 r = get_entry_symlink(a, entry_main, &linkpath,
881 &linkpath_length, sconv);
882 if (r == ARCHIVE_FATAL)
884 else if (r != ARCHIVE_OK) {
885 r = get_entry_symlink(a, entry_main, &linkpath,
886 &linkpath_length, NULL);
887 if (r == ARCHIVE_FATAL)
889 archive_set_error(&a->archive,
890 ARCHIVE_ERRNO_FILE_FORMAT,
891 "Can't translate linkname '%s' to %s", linkpath,
892 archive_string_conversion_charset_name(sconv));
898 /* If any string conversions failed, get all attributes
900 if (sconv == NULL && !pax->opt_binary) {
901 if (hardlink != NULL) {
902 r = get_entry_hardlink(a, entry_main, &hardlink,
903 &hardlink_length, NULL);
904 if (r == ARCHIVE_FATAL)
907 linkpath_length = hardlink_length;
909 r = get_entry_pathname(a, entry_main, &path,
911 if (r == ARCHIVE_FATAL)
913 r = get_entry_uname(a, entry_main, &uname, &uname_length, NULL);
914 if (r == ARCHIVE_FATAL)
916 r = get_entry_gname(a, entry_main, &gname, &gname_length, NULL);
917 if (r == ARCHIVE_FATAL)
921 /* Store the header encoding first, to be nice to readers. */
923 add_pax_attr(&(pax->pax_header), "hdrcharset", "BINARY");
927 * If name is too long, or has non-ASCII characters, add
928 * 'path' to pax extended attrs. (Note that an unconvertible
929 * name must have non-ASCII characters.)
931 if (has_non_ASCII(path)) {
932 /* We have non-ASCII characters. */
933 add_pax_attr(&(pax->pax_header), "path", path);
934 archive_entry_set_pathname(entry_main,
935 build_ustar_entry_name(ustar_entry_name,
936 path, path_length, NULL));
939 /* We have an all-ASCII path; we'd like to just store
940 * it in the ustar header if it will fit. Yes, this
941 * duplicates some of the logic in
942 * archive_write_set_format_ustar.c
944 if (path_length <= 100) {
945 /* Fits in the old 100-char tar name field. */
947 /* Find largest suffix that will fit. */
948 /* Note: strlen() > 100, so strlen() - 100 - 1 >= 0 */
949 suffix = strchr(path + path_length - 100 - 1, '/');
950 /* Don't attempt an empty prefix. */
952 suffix = strchr(suffix + 1, '/');
953 /* We can put it in the ustar header if it's
954 * all ASCII and it's either <= 100 characters
955 * or can be split at a '/' into a prefix <=
956 * 155 chars and a suffix <= 100 chars. (Note
957 * the strchr() above will return NULL exactly
958 * when the path can't be split.)
960 if (suffix == NULL /* Suffix > 100 chars. */
961 || suffix[1] == '\0' /* empty suffix */
962 || suffix - path > 155) /* Prefix > 155 chars */
964 add_pax_attr(&(pax->pax_header), "path", path);
965 archive_entry_set_pathname(entry_main,
966 build_ustar_entry_name(ustar_entry_name,
967 path, path_length, NULL));
973 if (linkpath != NULL) {
974 /* If link name is too long or has non-ASCII characters, add
975 * 'linkpath' to pax extended attrs. */
976 if (linkpath_length > 100 || has_non_ASCII(linkpath)) {
977 add_pax_attr(&(pax->pax_header), "linkpath", linkpath);
978 if (linkpath_length > 100) {
979 if (hardlink != NULL)
980 archive_entry_set_hardlink(entry_main,
981 "././@LongHardLink");
983 archive_entry_set_symlink(entry_main,
989 /* Save a pathname since it will be renamed if `entry_main` has
991 archive_string_init(&entry_name);
992 archive_strcpy(&entry_name, archive_entry_pathname(entry_main));
994 /* If file size is too large, add 'size' to pax extended attrs. */
995 if (archive_entry_size(entry_main) >= (((int64_t)1) << 33)) {
996 add_pax_attr_int(&(pax->pax_header), "size",
997 archive_entry_size(entry_main));
1001 /* If numeric GID is too large, add 'gid' to pax extended attrs. */
1002 if ((unsigned int)archive_entry_gid(entry_main) >= (1 << 18)) {
1003 add_pax_attr_int(&(pax->pax_header), "gid",
1004 archive_entry_gid(entry_main));
1008 /* If group name is too large or has non-ASCII characters, add
1009 * 'gname' to pax extended attrs. */
1010 if (gname != NULL) {
1011 if (gname_length > 31 || has_non_ASCII(gname)) {
1012 add_pax_attr(&(pax->pax_header), "gname", gname);
1017 /* If numeric UID is too large, add 'uid' to pax extended attrs. */
1018 if ((unsigned int)archive_entry_uid(entry_main) >= (1 << 18)) {
1019 add_pax_attr_int(&(pax->pax_header), "uid",
1020 archive_entry_uid(entry_main));
1024 /* Add 'uname' to pax extended attrs if necessary. */
1025 if (uname != NULL) {
1026 if (uname_length > 31 || has_non_ASCII(uname)) {
1027 add_pax_attr(&(pax->pax_header), "uname", uname);
1033 * POSIX/SUSv3 doesn't provide a standard key for large device
1034 * numbers. I use the same keys here that Joerg Schilling
1035 * used for 'star.' (Which, somewhat confusingly, are called
1036 * "devXXX" even though they code "rdev" values.) No doubt,
1037 * other implementations use other keys. Note that there's no
1038 * reason we can't write the same information into a number of
1041 * Of course, this is only needed for block or char device entries.
1043 if (archive_entry_filetype(entry_main) == AE_IFBLK
1044 || archive_entry_filetype(entry_main) == AE_IFCHR) {
1046 * If rdevmajor is too large, add 'SCHILY.devmajor' to
1047 * extended attributes.
1049 int rdevmajor, rdevminor;
1050 rdevmajor = archive_entry_rdevmajor(entry_main);
1051 rdevminor = archive_entry_rdevminor(entry_main);
1052 if (rdevmajor >= (1 << 18)) {
1053 add_pax_attr_int(&(pax->pax_header), "SCHILY.devmajor",
1056 * Non-strict formatting below means we don't
1057 * have to truncate here. Not truncating improves
1058 * the chance that some more modern tar archivers
1059 * (such as GNU tar 1.13) can restore the full
1060 * value even if they don't understand the pax
1061 * extended attributes. See my rant below about
1062 * file size fields for additional details.
1064 /* archive_entry_set_rdevmajor(entry_main,
1065 rdevmajor & ((1 << 18) - 1)); */
1070 * If devminor is too large, add 'SCHILY.devminor' to
1071 * extended attributes.
1073 if (rdevminor >= (1 << 18)) {
1074 add_pax_attr_int(&(pax->pax_header), "SCHILY.devminor",
1076 /* Truncation is not necessary here, either. */
1077 /* archive_entry_set_rdevminor(entry_main,
1078 rdevminor & ((1 << 18) - 1)); */
1084 * Technically, the mtime field in the ustar header can
1085 * support 33 bits, but many platforms use signed 32-bit time
1086 * values. The cutoff of 0x7fffffff here is a compromise.
1087 * Yes, this check is duplicated just below; this helps to
1088 * avoid writing an mtime attribute just to handle a
1089 * high-resolution timestamp in "restricted pax" mode.
1091 if (!need_extension &&
1092 ((archive_entry_mtime(entry_main) < 0)
1093 || (archive_entry_mtime(entry_main) >= 0x7fffffff)))
1096 /* I use a star-compatible file flag attribute. */
1097 p = archive_entry_fflags_text(entry_main);
1098 if (!need_extension && p != NULL && *p != '\0')
1101 /* If there are extended attributes, we need an extension */
1102 if (!need_extension && archive_entry_xattr_count(entry_original) > 0)
1105 /* If there are sparse info, we need an extension */
1106 if (!need_extension && sparse_count > 0)
1109 acl_types = archive_entry_acl_types(entry_original);
1111 /* If there are any ACL entries, we need an extension */
1112 if (!need_extension && acl_types != 0)
1115 /* If the symlink type is defined, we need an extension */
1116 if (!need_extension && archive_entry_symlink_type(entry_main) > 0)
1120 * Libarchive used to include these in extended headers for
1121 * restricted pax format, but that confused people who
1122 * expected ustar-like time semantics. So now we only include
1123 * them in full pax format.
1125 if (a->archive.archive_format != ARCHIVE_FORMAT_TAR_PAX_RESTRICTED) {
1126 if (archive_entry_ctime(entry_main) != 0 ||
1127 archive_entry_ctime_nsec(entry_main) != 0)
1128 add_pax_attr_time(&(pax->pax_header), "ctime",
1129 archive_entry_ctime(entry_main),
1130 archive_entry_ctime_nsec(entry_main));
1132 if (archive_entry_atime(entry_main) != 0 ||
1133 archive_entry_atime_nsec(entry_main) != 0)
1134 add_pax_attr_time(&(pax->pax_header), "atime",
1135 archive_entry_atime(entry_main),
1136 archive_entry_atime_nsec(entry_main));
1138 /* Store birth/creationtime only if it's earlier than mtime */
1139 if (archive_entry_birthtime_is_set(entry_main) &&
1140 archive_entry_birthtime(entry_main)
1141 < archive_entry_mtime(entry_main))
1142 add_pax_attr_time(&(pax->pax_header),
1143 "LIBARCHIVE.creationtime",
1144 archive_entry_birthtime(entry_main),
1145 archive_entry_birthtime_nsec(entry_main));
1149 * The following items are handled differently in "pax
1150 * restricted" format. In particular, in "pax restricted"
1151 * format they won't be added unless need_extension is
1152 * already set (we're already generating an extended header, so
1153 * may as well include these).
1155 if (a->archive.archive_format != ARCHIVE_FORMAT_TAR_PAX_RESTRICTED ||
1157 if (archive_entry_mtime(entry_main) < 0 ||
1158 archive_entry_mtime(entry_main) >= 0x7fffffff ||
1159 archive_entry_mtime_nsec(entry_main) != 0)
1160 add_pax_attr_time(&(pax->pax_header), "mtime",
1161 archive_entry_mtime(entry_main),
1162 archive_entry_mtime_nsec(entry_main));
1164 /* I use a star-compatible file flag attribute. */
1165 p = archive_entry_fflags_text(entry_main);
1166 if (p != NULL && *p != '\0')
1167 add_pax_attr(&(pax->pax_header), "SCHILY.fflags", p);
1169 /* I use star-compatible ACL attributes. */
1170 if ((acl_types & ARCHIVE_ENTRY_ACL_TYPE_NFS4) != 0) {
1171 ret = add_pax_acl(a, entry_original, pax,
1172 ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID |
1173 ARCHIVE_ENTRY_ACL_STYLE_SEPARATOR_COMMA |
1174 ARCHIVE_ENTRY_ACL_STYLE_COMPACT);
1175 if (ret == ARCHIVE_FATAL)
1176 return (ARCHIVE_FATAL);
1178 if (acl_types & ARCHIVE_ENTRY_ACL_TYPE_ACCESS) {
1179 ret = add_pax_acl(a, entry_original, pax,
1180 ARCHIVE_ENTRY_ACL_TYPE_ACCESS |
1181 ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID |
1182 ARCHIVE_ENTRY_ACL_STYLE_SEPARATOR_COMMA);
1183 if (ret == ARCHIVE_FATAL)
1184 return (ARCHIVE_FATAL);
1186 if (acl_types & ARCHIVE_ENTRY_ACL_TYPE_DEFAULT) {
1187 ret = add_pax_acl(a, entry_original, pax,
1188 ARCHIVE_ENTRY_ACL_TYPE_DEFAULT |
1189 ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID |
1190 ARCHIVE_ENTRY_ACL_STYLE_SEPARATOR_COMMA);
1191 if (ret == ARCHIVE_FATAL)
1192 return (ARCHIVE_FATAL);
1195 /* We use GNU-tar-compatible sparse attributes. */
1196 if (sparse_count > 0) {
1197 int64_t soffset, slength;
1199 add_pax_attr_int(&(pax->pax_header),
1200 "GNU.sparse.major", 1);
1201 add_pax_attr_int(&(pax->pax_header),
1202 "GNU.sparse.minor", 0);
1204 * Make sure to store the original path, since
1205 * truncation to ustar limit happened already.
1207 add_pax_attr(&(pax->pax_header),
1208 "GNU.sparse.name", path);
1209 add_pax_attr_int(&(pax->pax_header),
1210 "GNU.sparse.realsize",
1211 archive_entry_size(entry_main));
1213 /* Rename the file name which will be used for
1214 * ustar header to a special name, which GNU
1215 * PAX Format 1.0 requires */
1216 archive_entry_set_pathname(entry_main,
1217 build_gnu_sparse_name(gnu_sparse_name,
1221 * - Make a sparse map, which will precede a file data.
1222 * - Get the total size of available data of sparse.
1224 archive_string_sprintf(&(pax->sparse_map), "%d\n",
1226 while (archive_entry_sparse_next(entry_main,
1227 &soffset, &slength) == ARCHIVE_OK) {
1228 archive_string_sprintf(&(pax->sparse_map),
1232 sparse_total += slength;
1233 if (sparse_list_add(pax, soffset, slength)
1235 archive_set_error(&a->archive,
1237 "Can't allocate memory");
1238 archive_entry_free(entry_main);
1239 archive_string_free(&entry_name);
1240 return (ARCHIVE_FATAL);
1245 /* Store extended attributes */
1246 if (archive_write_pax_header_xattrs(a, pax, entry_original)
1248 archive_entry_free(entry_main);
1249 archive_string_free(&entry_name);
1250 return (ARCHIVE_FATAL);
1253 /* Store extended symlink information */
1254 if (archive_entry_symlink_type(entry_main) ==
1255 AE_SYMLINK_TYPE_FILE) {
1256 add_pax_attr(&(pax->pax_header),
1257 "LIBARCHIVE.symlinktype", "file");
1258 } else if (archive_entry_symlink_type(entry_main) ==
1259 AE_SYMLINK_TYPE_DIRECTORY) {
1260 add_pax_attr(&(pax->pax_header),
1261 "LIBARCHIVE.symlinktype", "dir");
1265 /* Only regular files have data. */
1266 if (archive_entry_filetype(entry_main) != AE_IFREG)
1267 archive_entry_set_size(entry_main, 0);
1270 * Pax-restricted does not store data for hardlinks, in order
1271 * to improve compatibility with ustar.
1273 if (a->archive.archive_format != ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE &&
1275 archive_entry_set_size(entry_main, 0);
1278 * XXX Full pax interchange format does permit a hardlink
1279 * entry to have data associated with it. I'm not supporting
1280 * that here because the client expects me to tell them whether
1281 * or not this format expects data for hardlinks. If I
1282 * don't check here, then every pax archive will end up with
1283 * duplicated data for hardlinks. Someday, there may be
1284 * need to select this behavior, in which case the following
1285 * will need to be revisited. XXX
1287 if (hardlink != NULL)
1288 archive_entry_set_size(entry_main, 0);
1290 /* Save a real file size. */
1291 real_size = archive_entry_size(entry_main);
1293 * Overwrite a file size by the total size of sparse blocks and
1294 * the size of sparse map info. That file size is the length of
1295 * the data, which we will exactly store into an archive file.
1297 if (archive_strlen(&(pax->sparse_map))) {
1298 size_t mapsize = archive_strlen(&(pax->sparse_map));
1299 pax->sparse_map_padding = 0x1ff & (-(ssize_t)mapsize);
1300 archive_entry_set_size(entry_main,
1301 mapsize + pax->sparse_map_padding + sparse_total);
1304 /* Format 'ustar' header for main entry.
1306 * The trouble with file size: If the reader can't understand
1307 * the file size, they may not be able to locate the next
1308 * entry and the rest of the archive is toast. Pax-compliant
1309 * readers are supposed to ignore the file size in the main
1310 * header, so the question becomes how to maximize portability
1311 * for readers that don't support pax attribute extensions.
1312 * For maximum compatibility, I permit numeric extensions in
1313 * the main header so that the file size stored will always be
1314 * correct, even if it's in a format that only some
1315 * implementations understand. The technique used here is:
1317 * a) If possible, follow the standard exactly. This handles
1318 * files up to 8 gigabytes minus 1.
1320 * b) If that fails, try octal but omit the field terminator.
1321 * That handles files up to 64 gigabytes minus 1.
1323 * c) Otherwise, use base-256 extensions. That handles files
1324 * up to 2^63 in this implementation, with the potential to
1325 * go up to 2^94. That should hold us for a while. ;-)
1327 * The non-strict formatter uses similar logic for other
1328 * numeric fields, though they're less critical.
1330 if (__archive_write_format_header_ustar(a, ustarbuff, entry_main, -1, 0,
1331 NULL) == ARCHIVE_FATAL)
1332 return (ARCHIVE_FATAL);
1334 /* If we built any extended attributes, write that entry first. */
1335 if (archive_strlen(&(pax->pax_header)) > 0) {
1336 struct archive_entry *pax_attr_entry;
1341 pax_attr_entry = archive_entry_new2(&a->archive);
1343 archive_entry_set_pathname(pax_attr_entry,
1344 build_pax_attribute_name(pax_entry_name, p));
1345 archive_entry_set_size(pax_attr_entry,
1346 archive_strlen(&(pax->pax_header)));
1347 /* Copy uid/gid (but clip to ustar limits). */
1348 uid = archive_entry_uid(entry_main);
1350 uid = (1 << 18) - 1;
1351 archive_entry_set_uid(pax_attr_entry, uid);
1352 gid = archive_entry_gid(entry_main);
1354 gid = (1 << 18) - 1;
1355 archive_entry_set_gid(pax_attr_entry, gid);
1356 /* Copy mode over (but not setuid/setgid bits) */
1357 mode = archive_entry_mode(entry_main);
1367 archive_entry_set_mode(pax_attr_entry, mode);
1369 /* Copy uname/gname. */
1370 archive_entry_set_uname(pax_attr_entry,
1371 archive_entry_uname(entry_main));
1372 archive_entry_set_gname(pax_attr_entry,
1373 archive_entry_gname(entry_main));
1375 /* Copy mtime, but clip to ustar limits. */
1376 s = archive_entry_mtime(entry_main);
1377 if (s < 0) { s = 0; }
1378 if (s >= 0x7fffffff) { s = 0x7fffffff; }
1379 archive_entry_set_mtime(pax_attr_entry, s, 0);
1381 /* Standard ustar doesn't support atime. */
1382 archive_entry_set_atime(pax_attr_entry, 0, 0);
1384 /* Standard ustar doesn't support ctime. */
1385 archive_entry_set_ctime(pax_attr_entry, 0, 0);
1387 r = __archive_write_format_header_ustar(a, paxbuff,
1388 pax_attr_entry, 'x', 1, NULL);
1390 archive_entry_free(pax_attr_entry);
1392 /* Note that the 'x' header shouldn't ever fail to format */
1393 if (r < ARCHIVE_WARN) {
1394 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1395 "archive_write_pax_header: "
1396 "'x' header failed?! This can't happen.\n");
1397 return (ARCHIVE_FATAL);
1400 r = __archive_write_output(a, paxbuff, 512);
1401 if (r != ARCHIVE_OK) {
1402 sparse_list_clear(pax);
1403 pax->entry_bytes_remaining = 0;
1404 pax->entry_padding = 0;
1405 return (ARCHIVE_FATAL);
1408 pax->entry_bytes_remaining = archive_strlen(&(pax->pax_header));
1409 pax->entry_padding =
1410 0x1ff & (-(int64_t)pax->entry_bytes_remaining);
1412 r = __archive_write_output(a, pax->pax_header.s,
1413 archive_strlen(&(pax->pax_header)));
1414 if (r != ARCHIVE_OK) {
1415 /* If a write fails, we're pretty much toast. */
1416 return (ARCHIVE_FATAL);
1418 /* Pad out the end of the entry. */
1419 r = __archive_write_nulls(a, (size_t)pax->entry_padding);
1420 if (r != ARCHIVE_OK) {
1421 /* If a write fails, we're pretty much toast. */
1422 return (ARCHIVE_FATAL);
1424 pax->entry_bytes_remaining = pax->entry_padding = 0;
1427 /* Write the header for main entry. */
1428 r = __archive_write_output(a, ustarbuff, 512);
1429 if (r != ARCHIVE_OK)
1433 * Inform the client of the on-disk size we're using, so
1434 * they can avoid unnecessarily writing a body for something
1435 * that we're just going to ignore.
1437 archive_entry_set_size(entry_original, real_size);
1438 if (pax->sparse_list == NULL && real_size > 0) {
1439 /* This is not a sparse file but we handle its data as
1440 * a sparse block. */
1441 sparse_list_add(pax, 0, real_size);
1442 sparse_total = real_size;
1444 pax->entry_padding = 0x1ff & (-(int64_t)sparse_total);
1445 archive_entry_free(entry_main);
1446 archive_string_free(&entry_name);
1452 * We need a valid name for the regular 'ustar' entry. This routine
1453 * tries to hack something more-or-less reasonable.
1455 * The approach here tries to preserve leading dir names. We do so by
1456 * working with four sections:
1457 * 1) "prefix" directory names,
1458 * 2) "suffix" directory names,
1459 * 3) inserted dir name (optional),
1462 * These sections must satisfy the following requirements:
1463 * * Parts 1 & 2 together form an initial portion of the dir name.
1464 * * Part 3 is specified by the caller. (It should not contain a leading
1466 * * Part 4 forms an initial portion of the base filename.
1467 * * The filename must be <= 99 chars to fit the ustar 'name' field.
1468 * * Parts 2, 3, 4 together must be <= 99 chars to fit the ustar 'name' fld.
1469 * * Part 1 must be <= 155 chars to fit the ustar 'prefix' field.
1470 * * If the original name ends in a '/', the new name must also end in a '/'
1471 * * Trailing '/.' sequences may be stripped.
1473 * Note: Recall that the ustar format does not store the '/' separating
1474 * parts 1 & 2, but does store the '/' separating parts 2 & 3.
1477 build_ustar_entry_name(char *dest, const char *src, size_t src_length,
1480 const char *prefix, *prefix_end;
1481 const char *suffix, *suffix_end;
1482 const char *filename, *filename_end;
1484 int need_slash = 0; /* Was there a trailing slash? */
1485 size_t suffix_length = 99;
1486 size_t insert_length;
1488 /* Length of additional dir element to be added. */
1492 /* +2 here allows for '/' before and after the insert. */
1493 insert_length = strlen(insert) + 2;
1495 /* Step 0: Quick bailout in a common case. */
1496 if (src_length < 100 && insert == NULL) {
1497 strncpy(dest, src, src_length);
1498 dest[src_length] = '\0';
1502 /* Step 1: Locate filename and enforce the length restriction. */
1503 filename_end = src + src_length;
1504 /* Remove trailing '/' chars and '/.' pairs. */
1506 if (filename_end > src && filename_end[-1] == '/') {
1508 need_slash = 1; /* Remember to restore trailing '/'. */
1511 if (filename_end > src + 1 && filename_end[-1] == '.'
1512 && filename_end[-2] == '/') {
1514 need_slash = 1; /* "foo/." will become "foo/" */
1521 /* Find start of filename. */
1522 filename = filename_end - 1;
1523 while ((filename > src) && (*filename != '/'))
1525 if ((*filename == '/') && (filename < filename_end - 1))
1527 /* Adjust filename_end so that filename + insert fits in 99 chars. */
1528 suffix_length -= insert_length;
1529 if (filename_end > filename + suffix_length)
1530 filename_end = filename + suffix_length;
1531 /* Calculate max size for "suffix" section (#3 above). */
1532 suffix_length -= filename_end - filename;
1534 /* Step 2: Locate the "prefix" section of the dirname, including
1537 prefix_end = prefix + 155;
1538 if (prefix_end > filename)
1539 prefix_end = filename;
1540 while (prefix_end > prefix && *prefix_end != '/')
1542 if ((prefix_end < filename) && (*prefix_end == '/'))
1545 /* Step 3: Locate the "suffix" section of the dirname,
1546 * including trailing '/'. */
1547 suffix = prefix_end;
1548 suffix_end = suffix + suffix_length; /* Enforce limit. */
1549 if (suffix_end > filename)
1550 suffix_end = filename;
1551 if (suffix_end < suffix)
1552 suffix_end = suffix;
1553 while (suffix_end > suffix && *suffix_end != '/')
1555 if ((suffix_end < filename) && (*suffix_end == '/'))
1558 /* Step 4: Build the new name. */
1559 /* The OpenBSD strlcpy function is safer, but less portable. */
1560 /* Rather than maintain two versions, just use the strncpy version. */
1562 if (prefix_end > prefix) {
1563 strncpy(p, prefix, prefix_end - prefix);
1564 p += prefix_end - prefix;
1566 if (suffix_end > suffix) {
1567 strncpy(p, suffix, suffix_end - suffix);
1568 p += suffix_end - suffix;
1570 if (insert != NULL) {
1571 /* Note: assume insert does not have leading or trailing '/' */
1573 p += strlen(insert);
1576 strncpy(p, filename, filename_end - filename);
1577 p += filename_end - filename;
1586 * The ustar header for the pax extended attributes must have a
1587 * reasonable name: SUSv3 requires 'dirname'/PaxHeader.'pid'/'filename'
1588 * where 'pid' is the PID of the archiving process. Unfortunately,
1589 * that makes testing a pain since the output varies for each run,
1590 * so I'm sticking with the simpler 'dirname'/PaxHeader/'filename'
1591 * for now. (Someday, I'll make this settable. Then I can use the
1592 * SUS recommendation as default and test harnesses can override it
1593 * to get predictable results.)
1595 * Joerg Schilling has argued that this is unnecessary because, in
1596 * practice, if the pax extended attributes get extracted as regular
1597 * files, no one is going to bother reading those attributes to
1598 * manually restore them. Based on this, 'star' uses
1599 * /tmp/PaxHeader/'basename' as the ustar header name. This is a
1600 * tempting argument, in part because it's simpler than the SUSv3
1601 * recommendation, but I'm not entirely convinced. I'm also
1602 * uncomfortable with the fact that "/tmp" is a Unix-ism.
1604 * The following routine leverages build_ustar_entry_name() above and
1605 * so is simpler than you might think. It just needs to provide the
1606 * additional path element and handle a few pathological cases).
1609 build_pax_attribute_name(char *dest, const char *src)
1614 /* Handle the null filename case. */
1615 if (src == NULL || *src == '\0') {
1616 strcpy(dest, "PaxHeader/blank");
1620 /* Prune final '/' and other unwanted final elements. */
1621 p = src + strlen(src);
1623 /* Ends in "/", remove the '/' */
1624 if (p > src && p[-1] == '/') {
1628 /* Ends in "/.", remove the '.' */
1629 if (p > src + 1 && p[-1] == '.'
1637 /* Pathological case: After above, there was nothing left.
1638 * This includes "/." "/./." "/.//./." etc. */
1640 strcpy(dest, "/PaxHeader/rootdir");
1644 /* Convert unadorned "." into a suitable filename. */
1645 if (*src == '.' && p == src + 1) {
1646 strcpy(dest, "PaxHeader/currentdir");
1651 * TODO: Push this string into the 'pax' structure to avoid
1652 * recomputing it every time. That will also open the door
1653 * to having clients override it.
1655 #if HAVE_GETPID && 0 /* Disable this for now; see above comment. */
1656 sprintf(buff, "PaxHeader.%d", getpid());
1658 /* If the platform can't fetch the pid, don't include it. */
1659 strcpy(buff, "PaxHeader");
1661 /* General case: build a ustar-compatible name adding
1663 build_ustar_entry_name(dest, src, p - src, buff);
1669 * GNU PAX Format 1.0 requires the special name, which pattern is:
1670 * <dir>/GNUSparseFile.<pid>/<original file name>
1672 * Since reproducible archives are more important, use 0 as pid.
1674 * This function is used for only Sparse file, a file type of which
1678 build_gnu_sparse_name(char *dest, const char *src)
1682 /* Handle the null filename case. */
1683 if (src == NULL || *src == '\0') {
1684 strcpy(dest, "GNUSparseFile/blank");
1688 /* Prune final '/' and other unwanted final elements. */
1689 p = src + strlen(src);
1691 /* Ends in "/", remove the '/' */
1692 if (p > src && p[-1] == '/') {
1696 /* Ends in "/.", remove the '.' */
1697 if (p > src + 1 && p[-1] == '.'
1705 /* General case: build a ustar-compatible name adding
1706 * "/GNUSparseFile/". */
1707 build_ustar_entry_name(dest, src, p - src, "GNUSparseFile.0");
1712 /* Write two null blocks for the end of archive */
1714 archive_write_pax_close(struct archive_write *a)
1716 return (__archive_write_nulls(a, 512 * 2));
1720 archive_write_pax_free(struct archive_write *a)
1724 pax = (struct pax *)a->format_data;
1726 return (ARCHIVE_OK);
1728 archive_string_free(&pax->pax_header);
1729 archive_string_free(&pax->sparse_map);
1730 archive_string_free(&pax->l_url_encoded_name);
1731 sparse_list_clear(pax);
1733 a->format_data = NULL;
1734 return (ARCHIVE_OK);
1738 archive_write_pax_finish_entry(struct archive_write *a)
1744 pax = (struct pax *)a->format_data;
1745 remaining = pax->entry_bytes_remaining;
1746 if (remaining == 0) {
1747 while (pax->sparse_list) {
1748 struct sparse_block *sb;
1749 if (!pax->sparse_list->is_hole)
1750 remaining += pax->sparse_list->remaining;
1751 sb = pax->sparse_list->next;
1752 free(pax->sparse_list);
1753 pax->sparse_list = sb;
1756 ret = __archive_write_nulls(a, (size_t)(remaining + pax->entry_padding));
1757 pax->entry_bytes_remaining = pax->entry_padding = 0;
1762 archive_write_pax_data(struct archive_write *a, const void *buff, size_t s)
1769 pax = (struct pax *)a->format_data;
1772 * According to GNU PAX format 1.0, write a sparse map
1775 if (archive_strlen(&(pax->sparse_map))) {
1776 ret = __archive_write_output(a, pax->sparse_map.s,
1777 archive_strlen(&(pax->sparse_map)));
1778 if (ret != ARCHIVE_OK)
1780 ret = __archive_write_nulls(a, pax->sparse_map_padding);
1781 if (ret != ARCHIVE_OK)
1783 archive_string_empty(&(pax->sparse_map));
1788 const unsigned char *p;
1790 while (pax->sparse_list != NULL &&
1791 pax->sparse_list->remaining == 0) {
1792 struct sparse_block *sb = pax->sparse_list->next;
1793 free(pax->sparse_list);
1794 pax->sparse_list = sb;
1797 if (pax->sparse_list == NULL)
1800 p = ((const unsigned char *)buff) + total;
1802 if (ws > pax->sparse_list->remaining)
1803 ws = (size_t)pax->sparse_list->remaining;
1805 if (pax->sparse_list->is_hole) {
1806 /* Current block is hole thus we do not write
1808 pax->sparse_list->remaining -= ws;
1813 ret = __archive_write_output(a, p, ws);
1814 pax->sparse_list->remaining -= ws;
1816 if (ret != ARCHIVE_OK)
1823 has_non_ASCII(const char *_p)
1825 const unsigned char *p = (const unsigned char *)_p;
1829 while (*p != '\0' && *p < 128)
1831 return (*p != '\0');
1835 * Used by extended attribute support; encodes the name
1836 * so that there will be no '=' characters in the result.
1839 url_encode(const char *in)
1846 for (s = in; *s != '\0'; s++) {
1847 if (*s < 33 || *s > 126 || *s == '%' || *s == '=')
1853 out = (char *)malloc(out_len + 1);
1857 for (s = in, d = out; *s != '\0'; s++) {
1858 /* encode any non-printable ASCII character or '%' or '=' */
1859 if (*s < 33 || *s > 126 || *s == '%' || *s == '=') {
1860 /* URL encoding is '%' followed by two hex digits */
1862 *d++ = "0123456789ABCDEF"[0x0f & (*s >> 4)];
1863 *d++ = "0123456789ABCDEF"[0x0f & *s];
1873 * Encode a sequence of bytes into a C string using base-64 encoding.
1875 * Returns a null-terminated C string allocated with malloc(); caller
1876 * is responsible for freeing the result.
1879 base64_encode(const char *s, size_t len)
1881 static const char digits[64] =
1882 { 'A','B','C','D','E','F','G','H','I','J','K','L','M','N','O',
1883 'P','Q','R','S','T','U','V','W','X','Y','Z','a','b','c','d',
1884 'e','f','g','h','i','j','k','l','m','n','o','p','q','r','s',
1885 't','u','v','w','x','y','z','0','1','2','3','4','5','6','7',
1890 /* 3 bytes becomes 4 chars, but round up and allow for trailing NUL */
1891 out = (char *)malloc((len * 4 + 2) / 3 + 1);
1896 /* Convert each group of 3 bytes into 4 characters. */
1898 v = (((int)s[0] << 16) & 0xff0000)
1899 | (((int)s[1] << 8) & 0xff00)
1900 | (((int)s[2]) & 0x00ff);
1903 *d++ = digits[(v >> 18) & 0x3f];
1904 *d++ = digits[(v >> 12) & 0x3f];
1905 *d++ = digits[(v >> 6) & 0x3f];
1906 *d++ = digits[(v) & 0x3f];
1908 /* Handle final group of 1 byte (2 chars) or 2 bytes (3 chars). */
1912 v = (((int)s[0] << 16) & 0xff0000);
1913 *d++ = digits[(v >> 18) & 0x3f];
1914 *d++ = digits[(v >> 12) & 0x3f];
1917 v = (((int)s[0] << 16) & 0xff0000)
1918 | (((int)s[1] << 8) & 0xff00);
1919 *d++ = digits[(v >> 18) & 0x3f];
1920 *d++ = digits[(v >> 12) & 0x3f];
1921 *d++ = digits[(v >> 6) & 0x3f];
1924 /* Add trailing NUL character so output is a valid C string. */
1930 sparse_list_clear(struct pax *pax)
1932 while (pax->sparse_list != NULL) {
1933 struct sparse_block *sb = pax->sparse_list;
1934 pax->sparse_list = sb->next;
1937 pax->sparse_tail = NULL;
1941 _sparse_list_add_block(struct pax *pax, int64_t offset, int64_t length,
1944 struct sparse_block *sb;
1946 sb = (struct sparse_block *)malloc(sizeof(*sb));
1948 return (ARCHIVE_FATAL);
1950 sb->is_hole = is_hole;
1951 sb->offset = offset;
1952 sb->remaining = length;
1953 if (pax->sparse_list == NULL || pax->sparse_tail == NULL)
1954 pax->sparse_list = pax->sparse_tail = sb;
1956 pax->sparse_tail->next = sb;
1957 pax->sparse_tail = sb;
1959 return (ARCHIVE_OK);
1963 sparse_list_add(struct pax *pax, int64_t offset, int64_t length)
1965 int64_t last_offset;
1968 if (pax->sparse_tail == NULL)
1971 last_offset = pax->sparse_tail->offset +
1972 pax->sparse_tail->remaining;
1974 if (last_offset < offset) {
1975 /* Add a hole block. */
1976 r = _sparse_list_add_block(pax, last_offset,
1977 offset - last_offset, 1);
1978 if (r != ARCHIVE_OK)
1981 /* Add data block. */
1982 return (_sparse_list_add_block(pax, offset, length, 0));