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 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 pathname.
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
);
233 char *dirname
= NULL
;
234 char *basename
= NULL
;
238 for (p
= fmt
; *p
&& (p
= strchr (p
, '%')); )
249 dirname
= safer_name_suffix (dir_name (st
->orig_file_name
),
251 len
+= strlen (dirname
) - 1;
258 basename
= base_name (st
->orig_file_name
);
259 len
+= strlen (basename
) - 1;
264 to_decimal (getpid (), pidbuf
, sizeof pidbuf
);
265 len
+= strlen (pidbuf
) - 1;
271 to_decimal (global_header_count
+ 1, pidbuf
, sizeof pidbuf
);
272 len
+= strlen (nbuf
) - 1;
279 buf
= xmalloc (len
+ 1);
280 for (q
= buf
, p
= fmt
; *p
; )
293 q
= stpcpy (q
, dirname
);
299 q
= stpcpy (q
, basename
);
304 q
= stpcpy (q
, pidbuf
);
311 q
= stpcpy (q
, nbuf
);
314 /* else fall through */
326 /* Do not allow it to end in a slash */
327 while (q
> buf
&& ISSLASH (q
[-1]))
334 xheader_xhdr_name (struct tar_stat_info
*st
)
337 assign_string (&exthdr_name
, "%d/PaxHeaders.%p/%f");
338 return xheader_format_name (st
, exthdr_name
, false);
341 #define GLOBAL_HEADER_TEMPLATE "/GlobalHead.%p.%n"
346 if (!globexthdr_name
)
349 const char *tmp
= getenv ("TMPDIR");
352 len
= strlen (tmp
) + sizeof (GLOBAL_HEADER_TEMPLATE
); /* Includes nul */
353 globexthdr_name
= xmalloc (len
);
354 strcpy(globexthdr_name
, tmp
);
355 strcat(globexthdr_name
, GLOBAL_HEADER_TEMPLATE
);
358 return xheader_format_name (NULL
, globexthdr_name
, true);
362 xheader_write (char type
, char *name
, struct xheader
*xhdr
)
369 header
= start_private_header (name
, size
);
370 header
->header
.typeflag
= type
;
372 simple_finish_header (header
);
380 header
= find_next_block ();
384 memcpy (header
->buffer
, p
, len
);
386 memset (header
->buffer
+ len
, 0, BLOCKSIZE
- len
);
389 set_next_block_after (header
);
392 xheader_destroy (xhdr
);
396 xheader_write_global ()
399 struct keyword_list
*kp
;
401 if (!keyword_global_override_list
)
404 extended_header_init ();
405 for (kp
= keyword_global_override_list
; kp
; kp
= kp
->next
)
406 code_string (kp
->value
, kp
->pattern
, &extended_header
);
407 xheader_finish (&extended_header
);
408 xheader_write (XGLTYPE
, name
= xheader_ghdr_name (),
411 global_header_count
++;
415 /* General Interface */
420 void (*coder
) (struct tar_stat_info
const *, char const *,
421 struct xheader
*, void *data
);
422 void (*decoder
) (struct tar_stat_info
*, char const *);
426 /* This declaration must be extern, because ISO C99 section 6.9.2
427 prohibits a tentative definition that has both internal linkage and
428 incomplete type. If we made it static, we'd have to declare its
429 size which would be a maintenance pain; if we put its initializer
430 here, we'd need a boatload of forward declarations, which would be
431 even more of a pain. */
432 extern struct xhdr_tab
const xhdr_tab
[];
434 static struct xhdr_tab
const *
435 locate_handler (char const *keyword
)
437 struct xhdr_tab
const *p
;
439 for (p
= xhdr_tab
; p
->keyword
; p
++)
440 if (strcmp (p
->keyword
, keyword
) == 0)
446 xheader_protected_pattern_p (const char *pattern
)
448 struct xhdr_tab
const *p
;
450 for (p
= xhdr_tab
; p
->keyword
; p
++)
451 if (p
->protect
&& fnmatch (pattern
, p
->keyword
, 0) == 0)
457 xheader_protected_keyword_p (const char *keyword
)
459 struct xhdr_tab
const *p
;
461 for (p
= xhdr_tab
; p
->keyword
; p
++)
462 if (p
->protect
&& strcmp (p
->keyword
, keyword
) == 0)
467 /* Decodes a single extended header record. Advances P to the next
469 Returns true on success, false otherwise. */
471 decode_record (char **p
,
472 void (*handler
) (void *, char const *, char const *),
483 len
= strtoul (*p
, p
, 10);
487 _("Malformed extended header: missing whitespace after the length")));
492 for (;*p
< start
+ len
; ++*p
)
498 ERROR ((0, 0, _("Malformed extended header: missing equal sign")));
507 handler (data
, keyword
, *p
+ 1);
516 run_override_list (struct keyword_list
*kp
, struct tar_stat_info
*st
)
518 for (; kp
; kp
= kp
->next
)
520 struct xhdr_tab
const *t
= locate_handler (kp
->pattern
);
522 t
->decoder (st
, kp
->value
);
527 decx (void *data
, char const *keyword
, char const *value
)
529 struct xhdr_tab
const *t
;
530 struct tar_stat_info
*st
= data
;
532 if (xheader_keyword_deleted_p (keyword
)
533 || xheader_keyword_override_p (keyword
))
536 t
= locate_handler (keyword
);
538 t
->decoder (st
, value
);
542 xheader_decode (struct tar_stat_info
*st
)
544 run_override_list (keyword_global_override_list
, st
);
545 run_override_list (global_header_override_list
, st
);
547 if (extended_header
.size
)
549 char *p
= extended_header
.buffer
+ BLOCKSIZE
;
550 char *endp
= &extended_header
.buffer
[extended_header
.size
-1];
553 if (!decode_record (&p
, decx
, st
))
556 run_override_list (keyword_override_list
, st
);
560 decg (void *data
, char const *keyword
, char const *value
)
562 struct keyword_list
**kwl
= data
;
563 xheader_list_append (kwl
, keyword
, value
);
567 xheader_decode_global ()
569 if (extended_header
.size
)
571 char *p
= extended_header
.buffer
+ BLOCKSIZE
;
572 char *endp
= &extended_header
.buffer
[extended_header
.size
-1];
574 xheader_list_destroy (&global_header_override_list
);
576 if (!decode_record (&p
, decg
, &global_header_override_list
))
582 extended_header_init ()
584 if (!extended_header
.stk
)
586 extended_header
.stk
= xmalloc (sizeof *extended_header
.stk
);
587 obstack_init (extended_header
.stk
);
592 xheader_store (char const *keyword
, struct tar_stat_info
const *st
, void *data
)
594 struct xhdr_tab
const *t
;
597 if (extended_header
.buffer
)
599 t
= locate_handler (keyword
);
602 if (xheader_keyword_deleted_p (keyword
)
603 || xheader_keyword_override_p (keyword
))
605 extended_header_init ();
606 t
->coder (st
, keyword
, &extended_header
, data
);
610 xheader_read (union block
*p
, size_t size
)
615 free (extended_header
.buffer
);
617 extended_header
.size
= size
;
618 nblocks
= (size
+ BLOCKSIZE
- 1) / BLOCKSIZE
;
619 extended_header
.buffer
= xmalloc (size
+ 1);
628 memcpy (&extended_header
.buffer
[j
], p
->buffer
, len
);
629 set_next_block_after (p
);
631 p
= find_next_block ();
640 format_uintmax (uintmax_t val
, char *buf
, size_t s
)
647 while ((val
/= 10) != 0);
651 char *p
= buf
+ s
- 1;
655 *p
-- = val
% 10 + '0';
657 while ((val
/= 10) != 0);
666 xheader_print (struct xheader
*xhdr
, char const *keyword
, char const *value
)
668 size_t len
= strlen (keyword
) + strlen (value
) + 3; /* ' ' + '=' + '\n' */
675 n
= format_uintmax (len
+ p
, NULL
, 0);
679 format_uintmax (len
+ n
, nbuf
, n
);
680 obstack_grow (xhdr
->stk
, nbuf
, n
);
681 obstack_1grow (xhdr
->stk
, ' ');
682 obstack_grow (xhdr
->stk
, keyword
, strlen (keyword
));
683 obstack_1grow (xhdr
->stk
, '=');
684 obstack_grow (xhdr
->stk
, value
, strlen (value
));
685 obstack_1grow (xhdr
->stk
, '\n');
689 xheader_finish (struct xheader
*xhdr
)
691 struct keyword_list
*kp
;
693 for (kp
= keyword_override_list
; kp
; kp
= kp
->next
)
694 code_string (kp
->value
, kp
->pattern
, xhdr
);
696 obstack_1grow (xhdr
->stk
, 0);
697 xhdr
->buffer
= obstack_finish (xhdr
->stk
);
698 xhdr
->size
= strlen (xhdr
->buffer
);
702 xheader_destroy (struct xheader
*xhdr
)
706 obstack_free (xhdr
->stk
, NULL
);
717 /* Implementations */
719 code_string (char const *string
, char const *keyword
, struct xheader
*xhdr
)
722 if (!utf8_convert (true, string
, &outstr
))
724 /* FIXME: report error */
725 outstr
= xstrdup (string
);
727 xheader_print (xhdr
, keyword
, outstr
);
732 decode_string (char **string
, char const *arg
)
739 if (!utf8_convert (false, arg
, string
))
741 /* FIXME: report error and act accordingly to --pax invalid=UTF-8 */
742 assign_string (string
, arg
);
747 code_time (time_t t
, unsigned long nano
,
748 char const *keyword
, struct xheader
*xhdr
)
751 size_t s
= format_uintmax (t
, NULL
, 0);
752 if (s
+ 11 >= sizeof sbuf
)
754 format_uintmax (t
, sbuf
, s
);
756 s
+= format_uintmax (nano
, sbuf
+ s
, 9);
758 xheader_print (xhdr
, keyword
, sbuf
);
762 decode_time (char const *arg
, time_t *secs
, unsigned long *nsecs
)
766 if (xstrtoumax (arg
, &p
, 10, &u
, "") == LONGINT_OK
)
769 if (*p
== '.' && xstrtoumax (p
+1, NULL
, 10, &u
, "") == LONGINT_OK
)
775 code_num (uintmax_t value
, char const *keyword
, struct xheader
*xhdr
)
778 size_t s
= format_uintmax (value
, NULL
, 0);
779 format_uintmax (value
, sbuf
, s
);
781 xheader_print (xhdr
, keyword
, sbuf
);
785 dummy_coder (struct tar_stat_info
const *st
, char const *keyword
,
786 struct xheader
*xhdr
, void *data
)
791 dummy_decoder (struct tar_stat_info
*st
, char const *arg
)
796 atime_coder (struct tar_stat_info
const *st
, char const *keyword
,
797 struct xheader
*xhdr
, void *data
)
799 code_time (st
->stat
.st_atime
, st
->atime_nsec
, keyword
, xhdr
);
803 atime_decoder (struct tar_stat_info
*st
, char const *arg
)
805 decode_time (arg
, &st
->stat
.st_atime
, &st
->atime_nsec
);
809 gid_coder (struct tar_stat_info
const *st
, char const *keyword
,
810 struct xheader
*xhdr
, void *data
)
812 code_num (st
->stat
.st_gid
, keyword
, xhdr
);
816 gid_decoder (struct tar_stat_info
*st
, char const *arg
)
819 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
824 gname_coder (struct tar_stat_info
const *st
, char const *keyword
,
825 struct xheader
*xhdr
, void *data
)
827 code_string (st
->gname
, keyword
, xhdr
);
831 gname_decoder (struct tar_stat_info
*st
, char const *arg
)
833 decode_string (&st
->gname
, arg
);
837 linkpath_coder (struct tar_stat_info
const *st
, char const *keyword
,
838 struct xheader
*xhdr
, void *data
)
840 code_string (st
->link_name
, keyword
, xhdr
);
844 linkpath_decoder (struct tar_stat_info
*st
, char const *arg
)
846 decode_string (&st
->link_name
, arg
);
850 ctime_coder (struct tar_stat_info
const *st
, char const *keyword
,
851 struct xheader
*xhdr
, void *data
)
853 code_time (st
->stat
.st_ctime
, st
->ctime_nsec
, keyword
, xhdr
);
857 ctime_decoder (struct tar_stat_info
*st
, char const *arg
)
859 decode_time (arg
, &st
->stat
.st_ctime
, &st
->ctime_nsec
);
863 mtime_coder (struct tar_stat_info
const *st
, char const *keyword
,
864 struct xheader
*xhdr
, void *data
)
866 code_time (st
->stat
.st_mtime
, st
->mtime_nsec
, keyword
, xhdr
);
870 mtime_decoder (struct tar_stat_info
*st
, char const *arg
)
872 decode_time (arg
, &st
->stat
.st_mtime
, &st
->mtime_nsec
);
876 path_coder (struct tar_stat_info
const *st
, char const *keyword
,
877 struct xheader
*xhdr
, void *data
)
879 code_string (st
->file_name
, keyword
, xhdr
);
883 path_decoder (struct tar_stat_info
*st
, char const *arg
)
885 decode_string (&st
->orig_file_name
, arg
);
886 decode_string (&st
->file_name
, arg
);
887 st
->had_trailing_slash
= strip_trailing_slashes (st
->file_name
);
891 size_coder (struct tar_stat_info
const *st
, char const *keyword
,
892 struct xheader
*xhdr
, void *data
)
894 code_num (st
->stat
.st_size
, keyword
, xhdr
);
898 size_decoder (struct tar_stat_info
*st
, char const *arg
)
901 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
902 st
->stat
.st_size
= u
;
906 uid_coder (struct tar_stat_info
const *st
, char const *keyword
,
907 struct xheader
*xhdr
, void *data
)
909 code_num (st
->stat
.st_uid
, keyword
, xhdr
);
913 uid_decoder (struct tar_stat_info
*st
, char const *arg
)
916 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
921 uname_coder (struct tar_stat_info
const *st
, char const *keyword
,
922 struct xheader
*xhdr
, void *data
)
924 code_string (st
->uname
, keyword
, xhdr
);
928 uname_decoder (struct tar_stat_info
*st
, char const *arg
)
930 decode_string (&st
->uname
, arg
);
934 sparse_size_coder (struct tar_stat_info
const *st
, char const *keyword
,
935 struct xheader
*xhdr
, void *data
)
937 size_coder (st
, keyword
, xhdr
, data
);
941 sparse_size_decoder (struct tar_stat_info
*st
, char const *arg
)
944 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
945 st
->archive_file_size
= u
;
949 sparse_numblocks_coder (struct tar_stat_info
const *st
, char const *keyword
,
950 struct xheader
*xhdr
, void *data
)
952 code_num (st
->sparse_map_avail
, keyword
, xhdr
);
956 sparse_numblocks_decoder (struct tar_stat_info
*st
, char const *arg
)
959 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
961 st
->sparse_map_size
= u
;
962 st
->sparse_map
= calloc(st
->sparse_map_size
, sizeof(st
->sparse_map
[0]));
963 st
->sparse_map_avail
= 0;
968 sparse_offset_coder (struct tar_stat_info
const *st
, char const *keyword
,
969 struct xheader
*xhdr
, void *data
)
971 size_t i
= *(size_t*)data
;
972 code_num (st
->sparse_map
[i
].offset
, keyword
, xhdr
);
976 sparse_offset_decoder (struct tar_stat_info
*st
, char const *arg
)
979 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
980 st
->sparse_map
[st
->sparse_map_avail
].offset
= u
;
984 sparse_numbytes_coder (struct tar_stat_info
const *st
, char const *keyword
,
985 struct xheader
*xhdr
, void *data
)
987 size_t i
= *(size_t*)data
;
988 code_num (st
->sparse_map
[i
].numbytes
, keyword
, xhdr
);
992 sparse_numbytes_decoder (struct tar_stat_info
*st
, char const *arg
)
995 if (xstrtoumax (arg
, NULL
, 10, &u
, "") == LONGINT_OK
)
997 if (st
->sparse_map_avail
== st
->sparse_map_size
)
999 size_t newsize
= st
->sparse_map_size
*= 2;
1000 st
->sparse_map
= xrealloc (st
->sparse_map
,
1002 * sizeof st
->sparse_map
[0]);
1004 st
->sparse_map
[st
->sparse_map_avail
++].numbytes
= u
;
1008 struct xhdr_tab
const xhdr_tab
[] = {
1009 { "atime", atime_coder
, atime_decoder
},
1010 { "comment", dummy_coder
, dummy_decoder
},
1011 { "charset", dummy_coder
, dummy_decoder
},
1012 { "ctime", ctime_coder
, ctime_decoder
},
1013 { "gid", gid_coder
, gid_decoder
},
1014 { "gname", gname_coder
, gname_decoder
},
1015 { "linkpath", linkpath_coder
, linkpath_decoder
},
1016 { "mtime", mtime_coder
, mtime_decoder
},
1017 { "path", path_coder
, path_decoder
},
1018 { "size", size_coder
, size_decoder
},
1019 { "uid", uid_coder
, uid_decoder
},
1020 { "uname", uname_coder
, uname_decoder
},
1022 /* Sparse file handling */
1023 { "GNU.sparse.size", sparse_size_coder
, sparse_size_decoder
, true },
1024 { "GNU.sparse.numblocks", sparse_numblocks_coder
, sparse_numblocks_decoder
,
1026 { "GNU.sparse.offset", sparse_offset_coder
, sparse_offset_decoder
,
1028 { "GNU.sparse.numbytes", sparse_numbytes_coder
, sparse_numbytes_decoder
,
1031 #if 0 /* GNU private keywords (not yet implemented) */
1033 /* The next directory entry actually contains the names of files
1034 that were in the directory at the time the dump was made.
1035 Supersedes GNUTYPE_DUMPDIR header type. */
1036 { "GNU.dump.name", dump_name_coder
, dump_name_decoder
},
1037 { "GNU.dump.status", dump_status_coder
, dump_status_decoder
},
1039 /* Keeps the tape/volume header. May be present only in the global headers.
1040 Equivalent to GNUTYPE_VOLHDR. */
1041 { "GNU.volume.header", volume_header_coder
, volume_header_decoder
},
1043 /* These may be present in a first global header of the archive.
1044 They provide the same functionality as GNUTYPE_MULTIVOL header.
1045 The GNU.volume.size keeps the real_s_sizeleft value, which is
1046 otherwise kept in the size field of a multivolume header. The
1047 GNU.volume.offset keeps the offset of the start of this volume,
1048 otherwise kept in oldgnu_header.offset. */
1049 { "GNU.volume.size", volume_size_coder
, volume_size_decoder
},
1050 { "GNU.volume.offset", volume_offset_coder
, volume_offset_decoder
},
1053 { NULL
, NULL
, NULL
}