1 /* POSIX extended headers for tar.
3 Copyright (C) 2003, 2004 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option) any later
10 This program is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
13 Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
29 #define obstack_chunk_alloc xmalloc
30 #define obstack_chunk_free free
35 static bool xheader_protected_pattern_p (char const *pattern);
36 static bool xheader_protected_keyword_p (char const *keyword);
37 static void xheader_set_single_keyword (char *) __attribute__ ((noreturn));
39 /* Used by xheader_finish() */
40 static void code_string (char const *string, char const *keyword,
41 struct xheader *xhdr);
42 static void extended_header_init (void);
44 /* Number of global headers written so far. */
45 static size_t global_header_count;
46 /* FIXME: Possibly it should be reset after changing the volume.
47 POSIX %n specification says that it is expanded to the sequence
48 number of current global header in *the* archive. However, for
49 multi-volume archives this will yield duplicate header names
50 in different volumes, which I'd like to avoid. The best way
51 to solve this would be to use per-archive header count as required
52 by POSIX *and* set globexthdr.name to, say,
53 $TMPDIR/GlobalHead.%p.$NUMVOLUME.%n.
55 However it should wait until buffer.c is finally rewritten */
62 struct keyword_list *next;
68 /* List of keyword patterns set by delete= option */
69 static struct keyword_list *keyword_pattern_list;
71 /* List of keyword/value pairs set by `keyword=value' option */
72 static struct keyword_list *keyword_global_override_list;
74 /* List of keyword/value pairs set by `keyword:=value' option */
75 static struct keyword_list *keyword_override_list;
77 /* List of keyword/value pairs decoded from the last 'g' type header */
78 static struct keyword_list *global_header_override_list;
80 /* Template for the name field of an 'x' type header */
81 static char *exthdr_name;
83 /* Template for the name field of a 'g' type header */
84 static char *globexthdr_name;
87 xheader_keyword_deleted_p (const char *kw)
89 struct keyword_list *kp;
91 for (kp = keyword_pattern_list; kp; kp = kp->next)
92 if (fnmatch (kp->pattern, kw, 0) == 0)
98 xheader_keyword_override_p (const char *keyword)
100 struct keyword_list *kp;
102 for (kp = keyword_override_list; kp; kp = kp->next)
103 if (strcmp (kp->pattern, keyword) == 0)
109 xheader_list_append (struct keyword_list **root, char const *kw,
112 struct keyword_list *kp = xmalloc (sizeof *kp);
113 kp->pattern = xstrdup (kw);
114 kp->value = value ? xstrdup (value) : NULL;
120 xheader_list_destroy (struct keyword_list **root)
124 struct keyword_list *kw = *root;
127 struct keyword_list *next = kw->next;
138 xheader_set_single_keyword (char *kw)
140 USAGE_ERROR ((0, 0, _("Keyword %s is unknown or not yet imlemented"), kw));
144 xheader_set_keyword_equal (char *kw, char *eq)
155 while (p > kw && isspace (*p))
160 for (p = eq + 1; *p && isspace (*p); p++)
163 if (strcmp (kw, "delete") == 0)
165 if (xheader_protected_pattern_p (p))
166 USAGE_ERROR ((0, 0, _("Pattern %s cannot be used"), p));
167 xheader_list_append (&keyword_pattern_list, p, NULL);
169 else if (strcmp (kw, "exthdr.name") == 0)
170 assign_string (&exthdr_name, p);
171 else if (strcmp (kw, "globexthdr.name") == 0)
172 assign_string (&globexthdr_name, p);
175 if (xheader_protected_keyword_p (kw))
176 USAGE_ERROR ((0, 0, _("Keyword %s cannot be overridden"), kw));
178 xheader_list_append (&keyword_global_override_list, kw, p);
180 xheader_list_append (&keyword_override_list, kw, p);
185 xheader_set_option (char *string)
188 for (token = strtok (string, ","); token; token = strtok (NULL, ","))
190 char *p = strchr (token, '=');
192 xheader_set_single_keyword (token);
194 xheader_set_keyword_equal (token, p);
199 to_decimal (uintmax_t value, char *where, size_t size)
206 where[i++] = '0' + value % 10;
209 while (i < size && value);
210 for (j = 0, i--; j < i; j++, i--)
219 string Includes: Replaced By:
220 %d The directory name of the file,
221 equivalent to the result of the
222 dirname utility on the translated
224 %f The filename of the file, equivalent
225 to the result of the basename
226 utility on the translated pathname.
227 %p The process ID of the pax process.
228 %% A '%' character. */
231 xheader_format_name (struct tar_stat_info *st, const char *fmt, bool allow_n)
234 size_t len = strlen (fmt);
242 for (p = fmt; *p && (p = strchr (p, '%')); )
253 dir = safer_name_suffix (dir_name (st->orig_file_name), false);
254 len += strlen (dir) - 1;
261 base = base_name (st->orig_file_name);
262 len += strlen (base) - 1;
267 to_decimal (getpid (), pidbuf, sizeof pidbuf);
268 len += strlen (pidbuf) - 1;
274 to_decimal (global_header_count + 1, pidbuf, sizeof pidbuf);
275 len += strlen (nbuf) - 1;
282 buf = xmalloc (len + 1);
283 for (q = buf, p = fmt; *p; )
302 q = stpcpy (q, base);
307 q = stpcpy (q, pidbuf);
314 q = stpcpy (q, nbuf);
317 /* else fall through */
329 /* Do not allow it to end in a slash */
330 while (q > buf && ISSLASH (q[-1]))
337 xheader_xhdr_name (struct tar_stat_info *st)
340 assign_string (&exthdr_name, "%d/PaxHeaders.%p/%f");
341 return xheader_format_name (st, exthdr_name, false);
344 #define GLOBAL_HEADER_TEMPLATE "/GlobalHead.%p.%n"
347 xheader_ghdr_name (void)
349 if (!globexthdr_name)
352 const char *tmp = getenv ("TMPDIR");
355 len = strlen (tmp) + sizeof (GLOBAL_HEADER_TEMPLATE); /* Includes nul */
356 globexthdr_name = xmalloc (len);
357 strcpy(globexthdr_name, tmp);
358 strcat(globexthdr_name, GLOBAL_HEADER_TEMPLATE);
361 return xheader_format_name (NULL, globexthdr_name, true);
365 xheader_write (char type, char *name, struct xheader *xhdr)
372 header = start_private_header (name, size);
373 header->header.typeflag = type;
375 simple_finish_header (header);
383 header = find_next_block ();
387 memcpy (header->buffer, p, len);
389 memset (header->buffer + len, 0, BLOCKSIZE - len);
392 set_next_block_after (header);
395 xheader_destroy (xhdr);
399 xheader_write_global (void)
402 struct keyword_list *kp;
404 if (!keyword_global_override_list)
407 extended_header_init ();
408 for (kp = keyword_global_override_list; kp; kp = kp->next)
409 code_string (kp->value, kp->pattern, &extended_header);
410 xheader_finish (&extended_header);
411 xheader_write (XGLTYPE, name = xheader_ghdr_name (),
414 global_header_count++;
418 /* General Interface */
423 void (*coder) (struct tar_stat_info const *, char const *,
424 struct xheader *, void *data);
425 void (*decoder) (struct tar_stat_info *, char const *);
429 /* This declaration must be extern, because ISO C99 section 6.9.2
430 prohibits a tentative definition that has both internal linkage and
431 incomplete type. If we made it static, we'd have to declare its
432 size which would be a maintenance pain; if we put its initializer
433 here, we'd need a boatload of forward declarations, which would be
434 even more of a pain. */
435 extern struct xhdr_tab const xhdr_tab[];
437 static struct xhdr_tab const *
438 locate_handler (char const *keyword)
440 struct xhdr_tab const *p;
442 for (p = xhdr_tab; p->keyword; p++)
443 if (strcmp (p->keyword, keyword) == 0)
449 xheader_protected_pattern_p (const char *pattern)
451 struct xhdr_tab const *p;
453 for (p = xhdr_tab; p->keyword; p++)
454 if (p->protect && fnmatch (pattern, p->keyword, 0) == 0)
460 xheader_protected_keyword_p (const char *keyword)
462 struct xhdr_tab const *p;
464 for (p = xhdr_tab; p->keyword; p++)
465 if (p->protect && strcmp (p->keyword, keyword) == 0)
470 /* Decodes a single extended header record. Advances P to the next
472 Returns true on success, false otherwise. */
474 decode_record (char **p,
475 void (*handler) (void *, char const *, char const *),
486 len = strtoul (*p, p, 10);
490 _("Malformed extended header: missing whitespace after the length")));
495 for (;*p < start + len; ++*p)
501 ERROR ((0, 0, _("Malformed extended header: missing equal sign")));
510 handler (data, keyword, *p + 1);
519 run_override_list (struct keyword_list *kp, struct tar_stat_info *st)
521 for (; kp; kp = kp->next)
523 struct xhdr_tab const *t = locate_handler (kp->pattern);
525 t->decoder (st, kp->value);
530 decx (void *data, char const *keyword, char const *value)
532 struct xhdr_tab const *t;
533 struct tar_stat_info *st = data;
535 if (xheader_keyword_deleted_p (keyword)
536 || xheader_keyword_override_p (keyword))
539 t = locate_handler (keyword);
541 t->decoder (st, value);
545 xheader_decode (struct tar_stat_info *st)
547 run_override_list (keyword_global_override_list, st);
548 run_override_list (global_header_override_list, st);
550 if (extended_header.size)
552 char *p = extended_header.buffer + BLOCKSIZE;
553 char *endp = &extended_header.buffer[extended_header.size-1];
556 if (!decode_record (&p, decx, st))
559 run_override_list (keyword_override_list, st);
563 decg (void *data, char const *keyword, char const *value)
565 struct keyword_list **kwl = data;
566 xheader_list_append (kwl, keyword, value);
570 xheader_decode_global (void)
572 if (extended_header.size)
574 char *p = extended_header.buffer + BLOCKSIZE;
575 char *endp = &extended_header.buffer[extended_header.size-1];
577 xheader_list_destroy (&global_header_override_list);
579 if (!decode_record (&p, decg, &global_header_override_list))
585 extended_header_init (void)
587 if (!extended_header.stk)
589 extended_header.stk = xmalloc (sizeof *extended_header.stk);
590 obstack_init (extended_header.stk);
595 xheader_store (char const *keyword, struct tar_stat_info const *st, void *data)
597 struct xhdr_tab const *t;
599 if (extended_header.buffer)
601 t = locate_handler (keyword);
604 if (xheader_keyword_deleted_p (keyword)
605 || xheader_keyword_override_p (keyword))
607 extended_header_init ();
608 t->coder (st, keyword, &extended_header, data);
612 xheader_read (union block *p, size_t size)
617 free (extended_header.buffer);
619 extended_header.size = size;
620 nblocks = (size + BLOCKSIZE - 1) / BLOCKSIZE;
621 extended_header.buffer = xmalloc (size + 1);
630 memcpy (&extended_header.buffer[j], p->buffer, len);
631 set_next_block_after (p);
633 p = find_next_block ();
642 format_uintmax (uintmax_t val, char *buf, size_t s)
649 while ((val /= 10) != 0);
653 char *p = buf + s - 1;
657 *p-- = val % 10 + '0';
659 while ((val /= 10) != 0);
668 xheader_print (struct xheader *xhdr, char const *keyword, char const *value)
670 size_t len = strlen (keyword) + strlen (value) + 3; /* ' ' + '=' + '\n' */
677 n = format_uintmax (len + p, NULL, 0);
681 format_uintmax (len + n, nbuf, n);
682 obstack_grow (xhdr->stk, nbuf, n);
683 obstack_1grow (xhdr->stk, ' ');
684 obstack_grow (xhdr->stk, keyword, strlen (keyword));
685 obstack_1grow (xhdr->stk, '=');
686 obstack_grow (xhdr->stk, value, strlen (value));
687 obstack_1grow (xhdr->stk, '\n');
691 xheader_finish (struct xheader *xhdr)
693 struct keyword_list *kp;
695 for (kp = keyword_override_list; kp; kp = kp->next)
696 code_string (kp->value, kp->pattern, xhdr);
698 obstack_1grow (xhdr->stk, 0);
699 xhdr->buffer = obstack_finish (xhdr->stk);
700 xhdr->size = strlen (xhdr->buffer);
704 xheader_destroy (struct xheader *xhdr)
708 obstack_free (xhdr->stk, NULL);
719 /* Implementations */
721 code_string (char const *string, char const *keyword, struct xheader *xhdr)
724 if (!utf8_convert (true, string, &outstr))
726 /* FIXME: report error */
727 outstr = xstrdup (string);
729 xheader_print (xhdr, keyword, outstr);
734 decode_string (char **string, char const *arg)
741 if (!utf8_convert (false, arg, string))
743 /* FIXME: report error and act accordingly to --pax invalid=UTF-8 */
744 assign_string (string, arg);
749 code_time (time_t t, unsigned long nano,
750 char const *keyword, struct xheader *xhdr)
753 size_t s = format_uintmax (t, NULL, 0);
754 if (s + 11 >= sizeof sbuf)
756 format_uintmax (t, sbuf, s);
758 s += format_uintmax (nano, sbuf + s, 9);
760 xheader_print (xhdr, keyword, sbuf);
764 decode_time (char const *arg, time_t *secs, unsigned long *nsecs)
768 if (xstrtoumax (arg, &p, 10, &u, "") == LONGINT_OK)
771 if (*p == '.' && xstrtoumax (p+1, NULL, 10, &u, "") == LONGINT_OK)
777 code_num (uintmax_t value, char const *keyword, struct xheader *xhdr)
780 size_t s = format_uintmax (value, NULL, 0);
781 format_uintmax (value, sbuf, s);
783 xheader_print (xhdr, keyword, sbuf);
787 dummy_coder (struct tar_stat_info const *st __attribute__ ((unused)),
788 char const *keyword __attribute__ ((unused)),
789 struct xheader *xhdr __attribute__ ((unused)),
790 void *data __attribute__ ((unused)))
795 dummy_decoder (struct tar_stat_info *st __attribute__ ((unused)),
796 char const *arg __attribute__ ((unused)))
801 atime_coder (struct tar_stat_info const *st, char const *keyword,
802 struct xheader *xhdr, void *data __attribute__ ((unused)))
804 code_time (st->stat.st_atime, st->atime_nsec, keyword, xhdr);
808 atime_decoder (struct tar_stat_info *st, char const *arg)
810 decode_time (arg, &st->stat.st_atime, &st->atime_nsec);
814 gid_coder (struct tar_stat_info const *st, char const *keyword,
815 struct xheader *xhdr, void *data __attribute__ ((unused)))
817 code_num (st->stat.st_gid, keyword, xhdr);
821 gid_decoder (struct tar_stat_info *st, char const *arg)
824 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
829 gname_coder (struct tar_stat_info const *st, char const *keyword,
830 struct xheader *xhdr, void *data __attribute__ ((unused)))
832 code_string (st->gname, keyword, xhdr);
836 gname_decoder (struct tar_stat_info *st, char const *arg)
838 decode_string (&st->gname, arg);
842 linkpath_coder (struct tar_stat_info const *st, char const *keyword,
843 struct xheader *xhdr, void *data __attribute__ ((unused)))
845 code_string (st->link_name, keyword, xhdr);
849 linkpath_decoder (struct tar_stat_info *st, char const *arg)
851 decode_string (&st->link_name, arg);
855 ctime_coder (struct tar_stat_info const *st, char const *keyword,
856 struct xheader *xhdr, void *data __attribute__ ((unused)))
858 code_time (st->stat.st_ctime, st->ctime_nsec, keyword, xhdr);
862 ctime_decoder (struct tar_stat_info *st, char const *arg)
864 decode_time (arg, &st->stat.st_ctime, &st->ctime_nsec);
868 mtime_coder (struct tar_stat_info const *st, char const *keyword,
869 struct xheader *xhdr, void *data __attribute__ ((unused)))
871 code_time (st->stat.st_mtime, st->mtime_nsec, keyword, xhdr);
875 mtime_decoder (struct tar_stat_info *st, char const *arg)
877 decode_time (arg, &st->stat.st_mtime, &st->mtime_nsec);
881 path_coder (struct tar_stat_info const *st, char const *keyword,
882 struct xheader *xhdr, void *data __attribute__ ((unused)))
884 code_string (st->file_name, keyword, xhdr);
888 path_decoder (struct tar_stat_info *st, char const *arg)
890 decode_string (&st->orig_file_name, arg);
891 decode_string (&st->file_name, arg);
892 st->had_trailing_slash = strip_trailing_slashes (st->file_name);
896 size_coder (struct tar_stat_info const *st, char const *keyword,
897 struct xheader *xhdr, void *data __attribute__ ((unused)))
899 code_num (st->stat.st_size, keyword, xhdr);
903 size_decoder (struct tar_stat_info *st, char const *arg)
906 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
907 st->archive_file_size = st->stat.st_size = u;
911 uid_coder (struct tar_stat_info const *st, char const *keyword,
912 struct xheader *xhdr, void *data __attribute__ ((unused)))
914 code_num (st->stat.st_uid, keyword, xhdr);
918 uid_decoder (struct tar_stat_info *st, char const *arg)
921 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
926 uname_coder (struct tar_stat_info const *st, char const *keyword,
927 struct xheader *xhdr, void *data __attribute__ ((unused)))
929 code_string (st->uname, keyword, xhdr);
933 uname_decoder (struct tar_stat_info *st, char const *arg)
935 decode_string (&st->uname, arg);
939 sparse_size_coder (struct tar_stat_info const *st, char const *keyword,
940 struct xheader *xhdr, void *data)
942 size_coder (st, keyword, xhdr, data);
946 sparse_size_decoder (struct tar_stat_info *st, char const *arg)
949 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
950 st->stat.st_size = u;
954 sparse_numblocks_coder (struct tar_stat_info const *st, char const *keyword,
955 struct xheader *xhdr,
956 void *data __attribute__ ((unused)))
958 code_num (st->sparse_map_avail, keyword, xhdr);
962 sparse_numblocks_decoder (struct tar_stat_info *st, char const *arg)
965 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
967 st->sparse_map_size = u;
968 st->sparse_map = calloc(st->sparse_map_size, sizeof(st->sparse_map[0]));
969 st->sparse_map_avail = 0;
974 sparse_offset_coder (struct tar_stat_info const *st, char const *keyword,
975 struct xheader *xhdr, void *data)
977 size_t i = *(size_t*)data;
978 code_num (st->sparse_map[i].offset, keyword, xhdr);
982 sparse_offset_decoder (struct tar_stat_info *st, char const *arg)
985 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
986 st->sparse_map[st->sparse_map_avail].offset = u;
990 sparse_numbytes_coder (struct tar_stat_info const *st, char const *keyword,
991 struct xheader *xhdr, void *data)
993 size_t i = *(size_t*)data;
994 code_num (st->sparse_map[i].numbytes, keyword, xhdr);
998 sparse_numbytes_decoder (struct tar_stat_info *st, char const *arg)
1001 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
1003 if (st->sparse_map_avail == st->sparse_map_size)
1005 st->sparse_map_size *= 2;
1006 st->sparse_map = xrealloc (st->sparse_map,
1008 * sizeof st->sparse_map[0]);
1010 st->sparse_map[st->sparse_map_avail++].numbytes = u;
1014 struct xhdr_tab const xhdr_tab[] = {
1015 { "atime", atime_coder, atime_decoder, false },
1016 { "comment", dummy_coder, dummy_decoder, false },
1017 { "charset", dummy_coder, dummy_decoder, false },
1018 { "ctime", ctime_coder, ctime_decoder, false },
1019 { "gid", gid_coder, gid_decoder, false },
1020 { "gname", gname_coder, gname_decoder, false },
1021 { "linkpath", linkpath_coder, linkpath_decoder, false },
1022 { "mtime", mtime_coder, mtime_decoder, false },
1023 { "path", path_coder, path_decoder, false },
1024 { "size", size_coder, size_decoder, false },
1025 { "uid", uid_coder, uid_decoder, false },
1026 { "uname", uname_coder, uname_decoder, false },
1028 /* Sparse file handling */
1029 { "GNU.sparse.size", sparse_size_coder, sparse_size_decoder, true },
1030 { "GNU.sparse.numblocks", sparse_numblocks_coder, sparse_numblocks_decoder,
1032 { "GNU.sparse.offset", sparse_offset_coder, sparse_offset_decoder,
1034 { "GNU.sparse.numbytes", sparse_numbytes_coder, sparse_numbytes_decoder,
1037 #if 0 /* GNU private keywords (not yet implemented) */
1039 /* The next directory entry actually contains the names of files
1040 that were in the directory at the time the dump was made.
1041 Supersedes GNUTYPE_DUMPDIR header type. */
1042 { "GNU.dump.name", dump_name_coder, dump_name_decoder, false },
1043 { "GNU.dump.status", dump_status_coder, dump_status_decoder, false },
1045 /* Keeps the tape/volume header. May be present only in the global headers.
1046 Equivalent to GNUTYPE_VOLHDR. */
1047 { "GNU.volume.header", volume_header_coder, volume_header_decoder, false },
1049 /* These may be present in a first global header of the archive.
1050 They provide the same functionality as GNUTYPE_MULTIVOL header.
1051 The GNU.volume.size keeps the real_s_sizeleft value, which is
1052 otherwise kept in the size field of a multivolume header. The
1053 GNU.volume.offset keeps the offset of the start of this volume,
1054 otherwise kept in oldgnu_header.offset. */
1055 { "GNU.volume.size", volume_size_coder, volume_size_decoder, false },
1056 { "GNU.volume.offset", volume_offset_coder, volume_offset_decoder, false },
1059 { NULL, NULL, NULL, false }