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. */
31 static bool xheader_protected_pattern_p (char const *pattern);
32 static bool xheader_protected_keyword_p (char const *keyword);
33 static void xheader_set_single_keyword (char *) __attribute__ ((noreturn));
35 /* Used by xheader_finish() */
36 static void code_string (char const *string, char const *keyword,
37 struct xheader *xhdr);
38 static void extended_header_init (void);
40 /* Number of global headers written so far. */
41 static size_t global_header_count;
42 /* FIXME: Possibly it should be reset after changing the volume.
43 POSIX %n specification says that it is expanded to the sequence
44 number of current global header in *the* archive. However, for
45 multi-volume archives this will yield duplicate header names
46 in different volumes, which I'd like to avoid. The best way
47 to solve this would be to use per-archive header count as required
48 by POSIX *and* set globexthdr.name to, say,
49 $TMPDIR/GlobalHead.%p.$NUMVOLUME.%n.
51 However it should wait until buffer.c is finally rewritten */
58 struct keyword_list *next;
64 /* List of keyword patterns set by delete= option */
65 static struct keyword_list *keyword_pattern_list;
67 /* List of keyword/value pairs set by `keyword=value' option */
68 static struct keyword_list *keyword_global_override_list;
70 /* List of keyword/value pairs set by `keyword:=value' option */
71 static struct keyword_list *keyword_override_list;
73 /* List of keyword/value pairs decoded from the last 'g' type header */
74 static struct keyword_list *global_header_override_list;
76 /* Template for the name field of an 'x' type header */
77 static char *exthdr_name;
79 /* Template for the name field of a 'g' type header */
80 static char *globexthdr_name;
83 xheader_keyword_deleted_p (const char *kw)
85 struct keyword_list *kp;
87 for (kp = keyword_pattern_list; kp; kp = kp->next)
88 if (fnmatch (kp->pattern, kw, 0) == 0)
94 xheader_keyword_override_p (const char *keyword)
96 struct keyword_list *kp;
98 for (kp = keyword_override_list; kp; kp = kp->next)
99 if (strcmp (kp->pattern, keyword) == 0)
105 xheader_list_append (struct keyword_list **root, char const *kw,
108 struct keyword_list *kp = xmalloc (sizeof *kp);
109 kp->pattern = xstrdup (kw);
110 kp->value = value ? xstrdup (value) : NULL;
116 xheader_list_destroy (struct keyword_list **root)
120 struct keyword_list *kw = *root;
123 struct keyword_list *next = kw->next;
134 xheader_set_single_keyword (char *kw)
136 USAGE_ERROR ((0, 0, _("Keyword %s is unknown or not yet imlemented"), kw));
140 xheader_set_keyword_equal (char *kw, char *eq)
151 while (p > kw && isspace (*p))
156 for (p = eq + 1; *p && isspace (*p); p++)
159 if (strcmp (kw, "delete") == 0)
161 if (xheader_protected_pattern_p (p))
162 USAGE_ERROR ((0, 0, _("Pattern %s cannot be used"), quote (p)));
163 xheader_list_append (&keyword_pattern_list, p, NULL);
165 else if (strcmp (kw, "exthdr.name") == 0)
166 assign_string (&exthdr_name, p);
167 else if (strcmp (kw, "globexthdr.name") == 0)
168 assign_string (&globexthdr_name, p);
171 if (xheader_protected_keyword_p (kw))
172 USAGE_ERROR ((0, 0, _("Keyword %s cannot be overridden"), kw));
174 xheader_list_append (&keyword_global_override_list, kw, p);
176 xheader_list_append (&keyword_override_list, kw, p);
181 xheader_set_option (char *string)
184 for (token = strtok (string, ","); token; token = strtok (NULL, ","))
186 char *p = strchr (token, '=');
188 xheader_set_single_keyword (token);
190 xheader_set_keyword_equal (token, p);
195 to_decimal (uintmax_t value, char *where, size_t size)
202 where[i++] = '0' + value % 10;
205 while (i < size && value);
206 for (j = 0, i--; j < i; j++, i--)
215 string Includes: Replaced By:
216 %d The directory name of the file,
217 equivalent to the result of the
218 dirname utility on the translated
220 %f The filename of the file, equivalent
221 to the result of the basename
222 utility on the translated file name.
223 %p The process ID of the pax process.
224 %% A '%' character. */
227 xheader_format_name (struct tar_stat_info *st, const char *fmt, bool allow_n)
230 size_t len = strlen (fmt);
238 for (p = fmt; *p && (p = strchr (p, '%')); )
249 dir = safer_name_suffix (dir_name (st->orig_file_name), false);
250 len += strlen (dir) - 1;
257 base = base_name (st->orig_file_name);
258 len += strlen (base) - 1;
263 to_decimal (getpid (), pidbuf, sizeof pidbuf);
264 len += strlen (pidbuf) - 1;
270 to_decimal (global_header_count + 1, pidbuf, sizeof pidbuf);
271 len += strlen (nbuf) - 1;
278 buf = xmalloc (len + 1);
279 for (q = buf, p = fmt; *p; )
298 q = stpcpy (q, base);
303 q = stpcpy (q, pidbuf);
310 q = stpcpy (q, nbuf);
313 /* else fall through */
325 /* Do not allow it to end in a slash */
326 while (q > buf && ISSLASH (q[-1]))
333 xheader_xhdr_name (struct tar_stat_info *st)
336 assign_string (&exthdr_name, "%d/PaxHeaders.%p/%f");
337 return xheader_format_name (st, exthdr_name, false);
340 #define GLOBAL_HEADER_TEMPLATE "/GlobalHead.%p.%n"
343 xheader_ghdr_name (void)
345 if (!globexthdr_name)
348 const char *tmp = getenv ("TMPDIR");
351 len = strlen (tmp) + sizeof (GLOBAL_HEADER_TEMPLATE); /* Includes nul */
352 globexthdr_name = xmalloc (len);
353 strcpy(globexthdr_name, tmp);
354 strcat(globexthdr_name, GLOBAL_HEADER_TEMPLATE);
357 return xheader_format_name (NULL, globexthdr_name, true);
361 xheader_write (char type, char *name, struct xheader *xhdr)
368 header = start_private_header (name, size);
369 header->header.typeflag = type;
371 simple_finish_header (header);
379 header = find_next_block ();
383 memcpy (header->buffer, p, len);
385 memset (header->buffer + len, 0, BLOCKSIZE - len);
388 set_next_block_after (header);
391 xheader_destroy (xhdr);
395 xheader_write_global (void)
398 struct keyword_list *kp;
400 if (!keyword_global_override_list)
403 extended_header_init ();
404 for (kp = keyword_global_override_list; kp; kp = kp->next)
405 code_string (kp->value, kp->pattern, &extended_header);
406 xheader_finish (&extended_header);
407 xheader_write (XGLTYPE, name = xheader_ghdr_name (),
410 global_header_count++;
414 /* General Interface */
419 void (*coder) (struct tar_stat_info const *, char const *,
420 struct xheader *, void *data);
421 void (*decoder) (struct tar_stat_info *, char const *);
425 /* This declaration must be extern, because ISO C99 section 6.9.2
426 prohibits a tentative definition that has both internal linkage and
427 incomplete type. If we made it static, we'd have to declare its
428 size which would be a maintenance pain; if we put its initializer
429 here, we'd need a boatload of forward declarations, which would be
430 even more of a pain. */
431 extern struct xhdr_tab const xhdr_tab[];
433 static struct xhdr_tab const *
434 locate_handler (char const *keyword)
436 struct xhdr_tab const *p;
438 for (p = xhdr_tab; p->keyword; p++)
439 if (strcmp (p->keyword, keyword) == 0)
445 xheader_protected_pattern_p (const char *pattern)
447 struct xhdr_tab const *p;
449 for (p = xhdr_tab; p->keyword; p++)
450 if (p->protect && fnmatch (pattern, p->keyword, 0) == 0)
456 xheader_protected_keyword_p (const char *keyword)
458 struct xhdr_tab const *p;
460 for (p = xhdr_tab; p->keyword; p++)
461 if (p->protect && strcmp (p->keyword, keyword) == 0)
466 /* Decodes a single extended header record. Advances P to the next
468 Returns true on success, false otherwise. */
470 decode_record (char **p,
471 void (*handler) (void *, char const *, char const *),
482 len = strtoul (*p, p, 10);
486 _("Malformed extended header: missing whitespace after the length")));
491 for (;*p < start + len; ++*p)
497 ERROR ((0, 0, _("Malformed extended header: missing equal sign")));
506 handler (data, keyword, *p + 1);
515 run_override_list (struct keyword_list *kp, struct tar_stat_info *st)
517 for (; kp; kp = kp->next)
519 struct xhdr_tab const *t = locate_handler (kp->pattern);
521 t->decoder (st, kp->value);
526 decx (void *data, char const *keyword, char const *value)
528 struct xhdr_tab const *t;
529 struct tar_stat_info *st = data;
531 if (xheader_keyword_deleted_p (keyword)
532 || xheader_keyword_override_p (keyword))
535 t = locate_handler (keyword);
537 t->decoder (st, value);
541 xheader_decode (struct tar_stat_info *st)
543 run_override_list (keyword_global_override_list, st);
544 run_override_list (global_header_override_list, st);
546 if (extended_header.size)
548 char *p = extended_header.buffer + BLOCKSIZE;
549 char *endp = &extended_header.buffer[extended_header.size-1];
552 if (!decode_record (&p, decx, st))
555 run_override_list (keyword_override_list, st);
559 decg (void *data, char const *keyword, char const *value)
561 struct keyword_list **kwl = data;
562 xheader_list_append (kwl, keyword, value);
566 xheader_decode_global (void)
568 if (extended_header.size)
570 char *p = extended_header.buffer + BLOCKSIZE;
571 char *endp = &extended_header.buffer[extended_header.size-1];
573 xheader_list_destroy (&global_header_override_list);
575 if (!decode_record (&p, decg, &global_header_override_list))
581 extended_header_init (void)
583 if (!extended_header.stk)
585 extended_header.stk = xmalloc (sizeof *extended_header.stk);
586 obstack_init (extended_header.stk);
591 xheader_store (char const *keyword, struct tar_stat_info const *st, void *data)
593 struct xhdr_tab const *t;
595 if (extended_header.buffer)
597 t = locate_handler (keyword);
600 if (xheader_keyword_deleted_p (keyword)
601 || xheader_keyword_override_p (keyword))
603 extended_header_init ();
604 t->coder (st, keyword, &extended_header, data);
608 xheader_read (union block *p, size_t size)
613 free (extended_header.buffer);
615 extended_header.size = size;
616 nblocks = (size + BLOCKSIZE - 1) / BLOCKSIZE;
617 extended_header.buffer = xmalloc (size + 1);
626 memcpy (&extended_header.buffer[j], p->buffer, len);
627 set_next_block_after (p);
629 p = find_next_block ();
638 format_uintmax (uintmax_t val, char *buf, size_t s)
645 while ((val /= 10) != 0);
649 char *p = buf + s - 1;
653 *p-- = val % 10 + '0';
655 while ((val /= 10) != 0);
664 xheader_print (struct xheader *xhdr, char const *keyword, char const *value)
666 size_t len = strlen (keyword) + strlen (value) + 3; /* ' ' + '=' + '\n' */
673 n = format_uintmax (len + p, NULL, 0);
677 format_uintmax (len + n, nbuf, n);
678 obstack_grow (xhdr->stk, nbuf, n);
679 obstack_1grow (xhdr->stk, ' ');
680 obstack_grow (xhdr->stk, keyword, strlen (keyword));
681 obstack_1grow (xhdr->stk, '=');
682 obstack_grow (xhdr->stk, value, strlen (value));
683 obstack_1grow (xhdr->stk, '\n');
687 xheader_finish (struct xheader *xhdr)
689 struct keyword_list *kp;
691 for (kp = keyword_override_list; kp; kp = kp->next)
692 code_string (kp->value, kp->pattern, xhdr);
694 obstack_1grow (xhdr->stk, 0);
695 xhdr->buffer = obstack_finish (xhdr->stk);
696 xhdr->size = strlen (xhdr->buffer);
700 xheader_destroy (struct xheader *xhdr)
704 obstack_free (xhdr->stk, NULL);
715 /* Implementations */
717 code_string (char const *string, char const *keyword, struct xheader *xhdr)
720 if (!utf8_convert (true, string, &outstr))
722 /* FIXME: report error */
723 outstr = xstrdup (string);
725 xheader_print (xhdr, keyword, outstr);
730 decode_string (char **string, char const *arg)
737 if (!utf8_convert (false, arg, string))
739 /* FIXME: report error and act accordingly to --pax invalid=UTF-8 */
740 assign_string (string, arg);
745 code_time (time_t t, unsigned long nano,
746 char const *keyword, struct xheader *xhdr)
749 size_t s = format_uintmax (t, NULL, 0);
750 if (s + 11 >= sizeof sbuf)
752 format_uintmax (t, sbuf, s);
754 s += format_uintmax (nano, sbuf + s, 9);
756 xheader_print (xhdr, keyword, sbuf);
760 decode_time (char const *arg, time_t *secs, unsigned long *nsecs)
764 if (xstrtoumax (arg, &p, 10, &u, "") == LONGINT_OK)
767 if (*p == '.' && xstrtoumax (p+1, NULL, 10, &u, "") == LONGINT_OK)
773 code_num (uintmax_t value, char const *keyword, struct xheader *xhdr)
776 size_t s = format_uintmax (value, NULL, 0);
777 format_uintmax (value, sbuf, s);
779 xheader_print (xhdr, keyword, sbuf);
783 dummy_coder (struct tar_stat_info const *st __attribute__ ((unused)),
784 char const *keyword __attribute__ ((unused)),
785 struct xheader *xhdr __attribute__ ((unused)),
786 void *data __attribute__ ((unused)))
791 dummy_decoder (struct tar_stat_info *st __attribute__ ((unused)),
792 char const *arg __attribute__ ((unused)))
797 atime_coder (struct tar_stat_info const *st, char const *keyword,
798 struct xheader *xhdr, void *data __attribute__ ((unused)))
800 code_time (st->stat.st_atime, st->atime_nsec, keyword, xhdr);
804 atime_decoder (struct tar_stat_info *st, char const *arg)
806 decode_time (arg, &st->stat.st_atime, &st->atime_nsec);
810 gid_coder (struct tar_stat_info const *st, char const *keyword,
811 struct xheader *xhdr, void *data __attribute__ ((unused)))
813 code_num (st->stat.st_gid, keyword, xhdr);
817 gid_decoder (struct tar_stat_info *st, char const *arg)
820 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
825 gname_coder (struct tar_stat_info const *st, char const *keyword,
826 struct xheader *xhdr, void *data __attribute__ ((unused)))
828 code_string (st->gname, keyword, xhdr);
832 gname_decoder (struct tar_stat_info *st, char const *arg)
834 decode_string (&st->gname, arg);
838 linkpath_coder (struct tar_stat_info const *st, char const *keyword,
839 struct xheader *xhdr, void *data __attribute__ ((unused)))
841 code_string (st->link_name, keyword, xhdr);
845 linkpath_decoder (struct tar_stat_info *st, char const *arg)
847 decode_string (&st->link_name, arg);
851 ctime_coder (struct tar_stat_info const *st, char const *keyword,
852 struct xheader *xhdr, void *data __attribute__ ((unused)))
854 code_time (st->stat.st_ctime, st->ctime_nsec, keyword, xhdr);
858 ctime_decoder (struct tar_stat_info *st, char const *arg)
860 decode_time (arg, &st->stat.st_ctime, &st->ctime_nsec);
864 mtime_coder (struct tar_stat_info const *st, char const *keyword,
865 struct xheader *xhdr, void *data __attribute__ ((unused)))
867 code_time (st->stat.st_mtime, st->mtime_nsec, keyword, xhdr);
871 mtime_decoder (struct tar_stat_info *st, char const *arg)
873 decode_time (arg, &st->stat.st_mtime, &st->mtime_nsec);
877 path_coder (struct tar_stat_info const *st, char const *keyword,
878 struct xheader *xhdr, void *data __attribute__ ((unused)))
880 code_string (st->file_name, keyword, xhdr);
884 path_decoder (struct tar_stat_info *st, char const *arg)
886 decode_string (&st->orig_file_name, arg);
887 decode_string (&st->file_name, arg);
888 st->had_trailing_slash = strip_trailing_slashes (st->file_name);
892 size_coder (struct tar_stat_info const *st, char const *keyword,
893 struct xheader *xhdr, void *data __attribute__ ((unused)))
895 code_num (st->stat.st_size, keyword, xhdr);
899 size_decoder (struct tar_stat_info *st, char const *arg)
902 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
903 st->archive_file_size = st->stat.st_size = u;
907 uid_coder (struct tar_stat_info const *st, char const *keyword,
908 struct xheader *xhdr, void *data __attribute__ ((unused)))
910 code_num (st->stat.st_uid, keyword, xhdr);
914 uid_decoder (struct tar_stat_info *st, char const *arg)
917 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
922 uname_coder (struct tar_stat_info const *st, char const *keyword,
923 struct xheader *xhdr, void *data __attribute__ ((unused)))
925 code_string (st->uname, keyword, xhdr);
929 uname_decoder (struct tar_stat_info *st, char const *arg)
931 decode_string (&st->uname, arg);
935 sparse_size_coder (struct tar_stat_info const *st, char const *keyword,
936 struct xheader *xhdr, void *data)
938 size_coder (st, keyword, xhdr, data);
942 sparse_size_decoder (struct tar_stat_info *st, char const *arg)
945 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
946 st->stat.st_size = u;
950 sparse_numblocks_coder (struct tar_stat_info const *st, char const *keyword,
951 struct xheader *xhdr,
952 void *data __attribute__ ((unused)))
954 code_num (st->sparse_map_avail, keyword, xhdr);
958 sparse_numblocks_decoder (struct tar_stat_info *st, char const *arg)
961 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
963 st->sparse_map_size = u;
964 st->sparse_map = calloc(st->sparse_map_size, sizeof(st->sparse_map[0]));
965 st->sparse_map_avail = 0;
970 sparse_offset_coder (struct tar_stat_info const *st, char const *keyword,
971 struct xheader *xhdr, void *data)
973 size_t i = *(size_t*)data;
974 code_num (st->sparse_map[i].offset, keyword, xhdr);
978 sparse_offset_decoder (struct tar_stat_info *st, char const *arg)
981 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
982 st->sparse_map[st->sparse_map_avail].offset = u;
986 sparse_numbytes_coder (struct tar_stat_info const *st, char const *keyword,
987 struct xheader *xhdr, void *data)
989 size_t i = *(size_t*)data;
990 code_num (st->sparse_map[i].numbytes, keyword, xhdr);
994 sparse_numbytes_decoder (struct tar_stat_info *st, char const *arg)
997 if (xstrtoumax (arg, NULL, 10, &u, "") == LONGINT_OK)
999 if (st->sparse_map_avail == st->sparse_map_size)
1001 st->sparse_map_size *= 2;
1002 st->sparse_map = xrealloc (st->sparse_map,
1004 * sizeof st->sparse_map[0]);
1006 st->sparse_map[st->sparse_map_avail++].numbytes = u;
1010 struct xhdr_tab const xhdr_tab[] = {
1011 { "atime", atime_coder, atime_decoder, false },
1012 { "comment", dummy_coder, dummy_decoder, false },
1013 { "charset", dummy_coder, dummy_decoder, false },
1014 { "ctime", ctime_coder, ctime_decoder, false },
1015 { "gid", gid_coder, gid_decoder, false },
1016 { "gname", gname_coder, gname_decoder, false },
1017 { "linkpath", linkpath_coder, linkpath_decoder, false },
1018 { "mtime", mtime_coder, mtime_decoder, false },
1019 { "path", path_coder, path_decoder, false },
1020 { "size", size_coder, size_decoder, false },
1021 { "uid", uid_coder, uid_decoder, false },
1022 { "uname", uname_coder, uname_decoder, false },
1024 /* Sparse file handling */
1025 { "GNU.sparse.size", sparse_size_coder, sparse_size_decoder, true },
1026 { "GNU.sparse.numblocks", sparse_numblocks_coder, sparse_numblocks_decoder,
1028 { "GNU.sparse.offset", sparse_offset_coder, sparse_offset_decoder,
1030 { "GNU.sparse.numbytes", sparse_numbytes_coder, sparse_numbytes_decoder,
1033 #if 0 /* GNU private keywords (not yet implemented) */
1035 /* The next directory entry actually contains the names of files
1036 that were in the directory at the time the dump was made.
1037 Supersedes GNUTYPE_DUMPDIR header type. */
1038 { "GNU.dump.name", dump_name_coder, dump_name_decoder, false },
1039 { "GNU.dump.status", dump_status_coder, dump_status_decoder, false },
1041 /* Keeps the tape/volume header. May be present only in the global headers.
1042 Equivalent to GNUTYPE_VOLHDR. */
1043 { "GNU.volume.header", volume_header_coder, volume_header_decoder, false },
1045 /* These may be present in a first global header of the archive.
1046 They provide the same functionality as GNUTYPE_MULTIVOL header.
1047 The GNU.volume.size keeps the real_s_sizeleft value, which is
1048 otherwise kept in the size field of a multivolume header. The
1049 GNU.volume.offset keeps the offset of the start of this volume,
1050 otherwise kept in oldgnu_header.offset. */
1051 { "GNU.volume.size", volume_size_coder, volume_size_decoder, false },
1052 { "GNU.volume.offset", volume_offset_coder, volume_offset_decoder, false },
1055 { NULL, NULL, NULL, false }