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. */
27 #define obstack_chunk_alloc xmalloc
28 #define obstack_chunk_free free
31 bool xheader_protected_pattern_p (const char *pattern
);
32 bool xheader_protected_keyword_p (const char *keyword
);
34 /* Used by xheader_finish() */
35 static void code_string (char const *string
, char const *keyword
,
36 struct xheader
*xhdr
);
37 static void extended_header_init ();
39 /* Number of global headers written so far. */
40 static size_t global_header_count
;
41 /* FIXME: Possibly it should be reset after changing the volume.
42 POSIX %n specification says that it is expanded to the sequence
43 number of current global header in *the* archive. However, for
44 multi-volume archives this will yield duplicate header names
45 in different volumes, which I'd like to avoid. The best way
46 to solve this would be to use per-archive header count as required
47 by POSIX *and* set globexthdr.name to, say,
48 $TMPDIR/GlobalHead.%p.$NUMVOLUME.%n.
50 However it should wait until buffer.c is finally rewritten */
57 struct keyword_list
*next
;
63 /* List of keyword patterns set by delete= option */
64 static struct keyword_list
*keyword_pattern_list
;
66 /* List of keyword/value pairs set by `keyword=value' option */
67 static struct keyword_list
*keyword_global_override_list
;
69 /* List of keyword/value pairs set by `keyword:=value' option */
70 static struct keyword_list
*keyword_override_list
;
72 /* List of keyword/value pairs decoded from the last 'g' type header */
73 static struct keyword_list
*global_header_override_list
;
75 /* Template for the name field of an 'x' type header */
76 static char *exthdr_name
;
78 /* Template for the name field of a 'g' type header */
79 static char *globexthdr_name
;
82 xheader_keyword_deleted_p (const char *kw
)
84 struct keyword_list
*kp
;
86 for (kp
= keyword_pattern_list
; kp
; kp
= kp
->next
)
87 if (fnmatch (kp
->pattern
, kw
, 0) == 0)
93 xheader_keyword_override_p (const char *keyword
)
95 struct keyword_list
*kp
;
97 for (kp
= keyword_override_list
; kp
; kp
= kp
->next
)
98 if (strcmp (kp
->pattern
, keyword
) == 0)
104 xheader_list_append (struct keyword_list
**root
, char const *kw
,
107 struct keyword_list
*kp
= xmalloc (sizeof *kp
);
108 kp
->pattern
= xstrdup (kw
);
109 kp
->value
= value
? xstrdup (value
) : NULL
;
115 xheader_list_destroy (struct keyword_list
**root
)
119 struct keyword_list
*kw
= *root
;
122 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"), 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 string Includes: Replaced By:
196 %d The directory name of the file,
197 equivalent to the result of the
198 dirname utility on the translated
200 %f The filename of the file, equivalent
201 to the result of the basename
202 utility on the translated pathname.
203 %p The process ID of the pax process.
204 %% A '%' character. */
207 xheader_format_name (struct tar_stat_info
*st
, const char *fmt
, bool allow_n
)
210 size_t len
= strlen (fmt
);
213 char *dirname
= NULL
;
214 char *basename
= NULL
;
218 for (p
= fmt
; *p
&& (p
= strchr (p
, '%')); )
229 dirname
= safer_name_suffix (dir_name (st
->orig_file_name
),
231 len
+= strlen (dirname
) - 1;
238 basename
= base_name (st
->orig_file_name
);
239 len
+= strlen (basename
) - 1;
244 snprintf (pidbuf
, sizeof pidbuf
, "%lu",
245 (unsigned long) getpid ());
246 len
+= strlen (pidbuf
) - 1;
252 snprintf (nbuf
, sizeof nbuf
, "%lu",
253 (unsigned long) global_header_count
+ 1);
254 len
+= strlen (nbuf
) - 1;
261 buf
= xmalloc (len
+ 1);
262 for (q
= buf
, p
= fmt
; *p
; )
275 q
= stpcpy (q
, dirname
);
281 q
= stpcpy (q
, basename
);
286 q
= stpcpy (q
, pidbuf
);
293 q
= stpcpy (q
, nbuf
);
296 /* else fall through */
308 /* Do not allow it to end in a slash */
309 while (q
> buf
&& ISSLASH (q
[-1]))
316 xheader_xhdr_name (struct tar_stat_info
*st
)
319 assign_string (&exthdr_name
, "%d/PaxHeaders.%p/%f");
320 return xheader_format_name (st
, exthdr_name
, false);
323 #define GLOBAL_HEADER_TEMPLATE "/GlobalHead.%p.%n"
328 if (!globexthdr_name
)
331 const char *tmp
= getenv ("TMPDIR");
334 len
= strlen (tmp
) + sizeof (GLOBAL_HEADER_TEMPLATE
); /* Includes nul */
335 globexthdr_name
= xmalloc (len
);
336 strcpy(globexthdr_name
, tmp
);
337 strcat(globexthdr_name
, GLOBAL_HEADER_TEMPLATE
);
340 return xheader_format_name (NULL
, globexthdr_name
, true);
344 xheader_write (char type
, char *name
, struct xheader
*xhdr
)
351 header
= start_private_header (name
, size
);
352 header
->header
.typeflag
= type
;
354 simple_finish_header (header
);
362 header
= find_next_block ();
366 memcpy (header
->buffer
, p
, len
);
368 memset (header
->buffer
+ len
, 0, BLOCKSIZE
- len
);
371 set_next_block_after (header
);
374 xheader_destroy (xhdr
);
378 xheader_write_global ()
381 struct keyword_list
*kp
;
383 if (!keyword_global_override_list
)
386 extended_header_init ();
387 for (kp
= keyword_global_override_list
; kp
; kp
= kp
->next
)
388 code_string (kp
->value
, kp
->pattern
, &extended_header
);
389 xheader_finish (&extended_header
);
390 xheader_write (XGLTYPE
, name
= xheader_ghdr_name (),
393 global_header_count
++;
397 /* General Interface */
402 void (*coder
) (struct tar_stat_info
const *, char const *,
403 struct xheader
*, void *data
);
404 void (*decoder
) (struct tar_stat_info
*, char const *);
408 /* This declaration must be extern, because ISO C99 section 6.9.2
409 prohibits a tentative definition that has both internal linkage and
410 incomplete type. If we made it static, we'd have to declare its
411 size which would be a maintenance pain; if we put its initializer
412 here, we'd need a boatload of forward declarations, which would be
413 even more of a pain. */
414 extern struct xhdr_tab
const xhdr_tab
[];
416 static struct xhdr_tab
const *
417 locate_handler (char const *keyword
)
419 struct xhdr_tab
const *p
;
421 for (p
= xhdr_tab
; p
->keyword
; p
++)
422 if (strcmp (p
->keyword
, keyword
) == 0)
428 xheader_protected_pattern_p (const char *pattern
)
430 struct xhdr_tab
const *p
;
432 for (p
= xhdr_tab
; p
->keyword
; p
++)
433 if (p
->protect
&& fnmatch (pattern
, p
->keyword
, 0) == 0)
439 xheader_protected_keyword_p (const char *keyword
)
441 struct xhdr_tab
const *p
;
443 for (p
= xhdr_tab
; p
->keyword
; p
++)
444 if (p
->protect
&& strcmp (p
->keyword
, keyword
) == 0)
449 /* Decodes a single extended header record. Advances P to the next
451 Returns true on success, false otherwise. */
453 decode_record (char **p
,
454 void (*handler
) (void *, char const *, char const *),
465 len
= strtoul (*p
, p
, 10);
469 _("Malformed extended header: missing whitespace after the length")));
474 for (;*p
< start
+ len
; ++*p
)
480 ERROR ((0, 0, _("Malformed extended header: missing equal sign")));
489 handler (data
, keyword
, *p
+ 1);
498 run_override_list (struct keyword_list
*kp
, struct tar_stat_info
*st
)
500 for (; kp
; kp
= kp
->next
)
502 struct xhdr_tab
const *t
= locate_handler (kp
->pattern
);
504 t
->decoder (st
, kp
->value
);
509 decx (void *data
, char const *keyword
, char const *value
)
511 struct xhdr_tab
const *t
;
512 struct tar_stat_info
*st
= data
;
514 if (xheader_keyword_deleted_p (keyword
)
515 || xheader_keyword_override_p (keyword
))
518 t
= locate_handler (keyword
);
520 t
->decoder (st
, value
);
524 xheader_decode (struct tar_stat_info
*st
)
526 run_override_list (keyword_global_override_list
, st
);
527 run_override_list (global_header_override_list
, st
);
529 if (extended_header
.size
)
531 char *p
= extended_header
.buffer
+ BLOCKSIZE
;
532 char *endp
= &extended_header
.buffer
[extended_header
.size
-1];
535 if (!decode_record (&p
, decx
, st
))
538 run_override_list (keyword_override_list
, st
);
542 decg (void *data
, char const *keyword
, char const *value
)
544 struct keyword_list
**kwl
= data
;
545 xheader_list_append (kwl
, keyword
, value
);
549 xheader_decode_global ()
551 if (extended_header
.size
)
553 char *p
= extended_header
.buffer
+ BLOCKSIZE
;
554 char *endp
= &extended_header
.buffer
[extended_header
.size
-1];
556 xheader_list_destroy (&global_header_override_list
);
558 if (!decode_record (&p
, decg
, &global_header_override_list
))
564 extended_header_init ()
566 if (!extended_header
.stk
)
568 extended_header
.stk
= xmalloc (sizeof *extended_header
.stk
);
569 obstack_init (extended_header
.stk
);
574 xheader_store (char const *keyword
, struct tar_stat_info
const *st
, void *data
)
576 struct xhdr_tab
const *t
;
579 if (extended_header
.buffer
)
581 t
= locate_handler (keyword
);
584 if (xheader_keyword_deleted_p (keyword
)
585 || xheader_keyword_override_p (keyword
))
587 extended_header_init ();
588 t
->coder (st
, keyword
, &extended_header
, data
);
592 xheader_read (union block
*p
, size_t size
)
597 free (extended_header
.buffer
);
599 extended_header
.size
= size
;
600 nblocks
= (size
+ BLOCKSIZE
- 1) / BLOCKSIZE
;
601 extended_header
.buffer
= xmalloc (size
+ 1);
610 memcpy (&extended_header
.buffer
[j
], p
->buffer
, len
);
611 set_next_block_after (p
);
613 p
= find_next_block ();
622 format_uintmax (uintmax_t val
, char *buf
, size_t s
)
629 while ((val
/= 10) != 0);
633 char *p
= buf
+ s
- 1;
637 *p
-- = val
% 10 + '0';
639 while ((val
/= 10) != 0);
648 xheader_print (struct xheader
*xhdr
, char const *keyword
, char const *value
)
650 size_t len
= strlen (keyword
) + strlen (value
) + 3; /* ' ' + '=' + '\n' */
657 n
= format_uintmax (len
+ p
, NULL
, 0);
661 format_uintmax (len
+ n
, nbuf
, n
);
662 obstack_grow (xhdr
->stk
, nbuf
, n
);
663 obstack_1grow (xhdr
->stk
, ' ');
664 obstack_grow (xhdr
->stk
, keyword
, strlen (keyword
));
665 obstack_1grow (xhdr
->stk
, '=');
666 obstack_grow (xhdr
->stk
, value
, strlen (value
));
667 obstack_1grow (xhdr
->stk
, '\n');
671 xheader_finish (struct xheader
*xhdr
)
673 struct keyword_list
*kp
;
675 for (kp
= keyword_override_list
; kp
; kp
= kp
->next
)
676 code_string (kp
->value
, kp
->pattern
, xhdr
);
678 obstack_1grow (xhdr
->stk
, 0);
679 xhdr
->buffer
= obstack_finish (xhdr
->stk
);
680 xhdr
->size
= strlen (xhdr
->buffer
);
684 xheader_destroy (struct xheader
*xhdr
)
688 obstack_free (xhdr
->stk
, NULL
);
699 /* Implementations */
701 code_string (char const *string
, char const *keyword
, struct xheader
*xhdr
)
704 if (!utf8_convert (true, string
, &outstr
))
706 /* FIXME: report error */
707 outstr
= xstrdup (string
);
709 xheader_print (xhdr
, keyword
, outstr
);
714 decode_string (char **string
, char const *arg
)
721 if (!utf8_convert (false, arg
, string
))
723 /* FIXME: report error and act accordingly to --pax invalid=UTF-8 */
724 assign_string (string
, arg
);
729 code_time (time_t t
, unsigned long nano
,
730 char const *keyword
, struct xheader
*xhdr
)
733 size_t s
= format_uintmax (t
, NULL
, 0);
734 if (s
+ 11 >= sizeof sbuf
)
736 format_uintmax (t
, sbuf
, s
);
738 s
+= format_uintmax (nano
, sbuf
+ s
, 9);
740 xheader_print (xhdr
, keyword
, sbuf
);
744 decode_time (char const *arg
, time_t *secs
, unsigned long *nsecs
)
748 if (xstrtoumax (arg
, &p
, 10, &u
, "") == LONGINT_OK
)
751 if (*p
== '.' && xstrtoumax (p
+1, NULL
, 10, &u
, "") == LONGINT_OK
)
757 code_num (uintmax_t value
, char const *keyword
, struct xheader
*xhdr
)
760 size_t s
= format_uintmax (value
, NULL
, 0);
761 format_uintmax (value
, sbuf
, s
);
763 xheader_print (xhdr
, keyword
, sbuf
);
767 dummy_coder (struct tar_stat_info
const *st
, char const *keyword
,
768 struct xheader
*xhdr
, void *data
)
773 dummy_decoder (struct tar_stat_info
*st
, char const *arg
)
778 atime_coder (struct tar_stat_info
const *st
, char const *keyword
,
779 struct xheader
*xhdr
, void *data
)
781 code_time (st
->stat
.st_atime
, st
->atime_nsec
, keyword
, xhdr
);
785 atime_decoder (struct tar_stat_info
*st
, char const *arg
)
787 decode_time (arg
, &st
->stat
.st_atime
, &st
->atime_nsec
);
791 gid_coder (struct tar_stat_info
const *st
, char const *keyword
,
792 struct xheader
*xhdr
, void *data
)
794 code_num (st
->stat
.st_gid
, keyword
, xhdr
);
798 gid_decoder (struct tar_stat_info
*st
, char const *arg
)
801 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
806 gname_coder (struct tar_stat_info
const *st
, char const *keyword
,
807 struct xheader
*xhdr
, void *data
)
809 code_string (st
->gname
, keyword
, xhdr
);
813 gname_decoder (struct tar_stat_info
*st
, char const *arg
)
815 decode_string (&st
->gname
, arg
);
819 linkpath_coder (struct tar_stat_info
const *st
, char const *keyword
,
820 struct xheader
*xhdr
, void *data
)
822 code_string (st
->link_name
, keyword
, xhdr
);
826 linkpath_decoder (struct tar_stat_info
*st
, char const *arg
)
828 decode_string (&st
->link_name
, arg
);
832 ctime_coder (struct tar_stat_info
const *st
, char const *keyword
,
833 struct xheader
*xhdr
, void *data
)
835 code_time (st
->stat
.st_ctime
, st
->ctime_nsec
, keyword
, xhdr
);
839 ctime_decoder (struct tar_stat_info
*st
, char const *arg
)
841 decode_time (arg
, &st
->stat
.st_ctime
, &st
->ctime_nsec
);
845 mtime_coder (struct tar_stat_info
const *st
, char const *keyword
,
846 struct xheader
*xhdr
, void *data
)
848 code_time (st
->stat
.st_mtime
, st
->mtime_nsec
, keyword
, xhdr
);
852 mtime_decoder (struct tar_stat_info
*st
, char const *arg
)
854 decode_time (arg
, &st
->stat
.st_mtime
, &st
->mtime_nsec
);
858 path_coder (struct tar_stat_info
const *st
, char const *keyword
,
859 struct xheader
*xhdr
, void *data
)
861 code_string (st
->file_name
, keyword
, xhdr
);
865 path_decoder (struct tar_stat_info
*st
, char const *arg
)
867 decode_string (&st
->orig_file_name
, arg
);
868 decode_string (&st
->file_name
, arg
);
869 st
->had_trailing_slash
= strip_trailing_slashes (st
->file_name
);
873 size_coder (struct tar_stat_info
const *st
, char const *keyword
,
874 struct xheader
*xhdr
, void *data
)
876 code_num (st
->stat
.st_size
, keyword
, xhdr
);
880 size_decoder (struct tar_stat_info
*st
, char const *arg
)
883 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
884 st
->stat
.st_size
= u
;
888 uid_coder (struct tar_stat_info
const *st
, char const *keyword
,
889 struct xheader
*xhdr
, void *data
)
891 code_num (st
->stat
.st_uid
, keyword
, xhdr
);
895 uid_decoder (struct tar_stat_info
*st
, char const *arg
)
898 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
903 uname_coder (struct tar_stat_info
const *st
, char const *keyword
,
904 struct xheader
*xhdr
, void *data
)
906 code_string (st
->uname
, keyword
, xhdr
);
910 uname_decoder (struct tar_stat_info
*st
, char const *arg
)
912 decode_string (&st
->uname
, arg
);
916 sparse_size_coder (struct tar_stat_info
const *st
, char const *keyword
,
917 struct xheader
*xhdr
, void *data
)
919 size_coder (st
, keyword
, xhdr
, data
);
923 sparse_size_decoder (struct tar_stat_info
*st
, char const *arg
)
926 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
927 st
->archive_file_size
= u
;
931 sparse_numblocks_coder (struct tar_stat_info
const *st
, char const *keyword
,
932 struct xheader
*xhdr
, void *data
)
934 code_num (st
->sparse_map_avail
, keyword
, xhdr
);
938 sparse_numblocks_decoder (struct tar_stat_info
*st
, char const *arg
)
941 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
943 st
->sparse_map_size
= u
;
944 st
->sparse_map
= calloc(st
->sparse_map_size
, sizeof(st
->sparse_map
[0]));
945 st
->sparse_map_avail
= 0;
950 sparse_offset_coder (struct tar_stat_info
const *st
, char const *keyword
,
951 struct xheader
*xhdr
, void *data
)
953 size_t i
= *(size_t*)data
;
954 code_num (st
->sparse_map
[i
].offset
, keyword
, xhdr
);
958 sparse_offset_decoder (struct tar_stat_info
*st
, char const *arg
)
961 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
962 st
->sparse_map
[st
->sparse_map_avail
].offset
= u
;
966 sparse_numbytes_coder (struct tar_stat_info
const *st
, char const *keyword
,
967 struct xheader
*xhdr
, void *data
)
969 size_t i
= *(size_t*)data
;
970 code_num (st
->sparse_map
[i
].numbytes
, keyword
, xhdr
);
974 sparse_numbytes_decoder (struct tar_stat_info
*st
, char const *arg
)
977 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
979 if (st
->sparse_map_avail
== st
->sparse_map_size
)
981 size_t newsize
= st
->sparse_map_size
*= 2;
982 st
->sparse_map
= xrealloc (st
->sparse_map
,
984 * sizeof st
->sparse_map
[0]);
986 st
->sparse_map
[st
->sparse_map_avail
++].numbytes
= u
;
990 struct xhdr_tab
const xhdr_tab
[] = {
991 { "atime", atime_coder
, atime_decoder
},
992 { "comment", dummy_coder
, dummy_decoder
},
993 { "charset", dummy_coder
, dummy_decoder
},
994 { "ctime", ctime_coder
, ctime_decoder
},
995 { "gid", gid_coder
, gid_decoder
},
996 { "gname", gname_coder
, gname_decoder
},
997 { "linkpath", linkpath_coder
, linkpath_decoder
},
998 { "mtime", mtime_coder
, mtime_decoder
},
999 { "path", path_coder
, path_decoder
},
1000 { "size", size_coder
, size_decoder
},
1001 { "uid", uid_coder
, uid_decoder
},
1002 { "uname", uname_coder
, uname_decoder
},
1004 /* Sparse file handling */
1005 { "GNU.sparse.size", sparse_size_coder
, sparse_size_decoder
, true },
1006 { "GNU.sparse.numblocks", sparse_numblocks_coder
, sparse_numblocks_decoder
,
1008 { "GNU.sparse.offset", sparse_offset_coder
, sparse_offset_decoder
,
1010 { "GNU.sparse.numbytes", sparse_numbytes_coder
, sparse_numbytes_decoder
,
1013 #if 0 /* GNU private keywords (not yet implemented) */
1015 /* The next directory entry actually contains the names of files
1016 that were in the directory at the time the dump was made.
1017 Supersedes GNUTYPE_DUMPDIR header type. */
1018 { "GNU.dump.name", dump_name_coder
, dump_name_decoder
},
1019 { "GNU.dump.status", dump_status_coder
, dump_status_decoder
},
1021 /* Keeps the tape/volume header. May be present only in the global headers.
1022 Equivalent to GNUTYPE_VOLHDR. */
1023 { "GNU.volume.header", volume_header_coder
, volume_header_decoder
},
1025 /* These may be present in a first global header of the archive.
1026 They provide the same functionality as GNUTYPE_MULTIVOL header.
1027 The GNU.volume.size keeps the real_s_sizeleft value, which is
1028 otherwise kept in the size field of a multivolume header. The
1029 GNU.volume.offset keeps the offset of the start of this volume,
1030 otherwise kept in oldgnu_header.offset. */
1031 { "GNU.volume.size", volume_size_coder
, volume_size_decoder
},
1032 { "GNU.volume.offset", volume_offset_coder
, volume_offset_decoder
},
1035 { NULL
, NULL
, NULL
}