1 /* Various processing of names.
3 Copyright (C) 1988, 1992, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
4 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 3, or (at your option) any later
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
14 Public License for more details.
16 You should have received a copy of the GNU General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
28 /* User and group names. */
30 struct group
*getgrnam ();
31 struct passwd
*getpwnam ();
32 #if ! HAVE_DECL_GETPWUID
33 struct passwd
*getpwuid ();
35 #if ! HAVE_DECL_GETGRGID
36 struct group
*getgrgid ();
39 /* Make sure you link with the proper libraries if you are running the
40 Yellow Peril (thanks for the good laugh, Ian J.!), or, euh... NIS.
41 This code should also be modified for non-UNIX systems to do something
44 static char *cached_uname
;
45 static char *cached_gname
;
47 static uid_t cached_uid
; /* valid only if cached_uname is not empty */
48 static gid_t cached_gid
; /* valid only if cached_gname is not empty */
50 /* These variables are valid only if nonempty. */
51 static char *cached_no_such_uname
;
52 static char *cached_no_such_gname
;
54 /* These variables are valid only if nonzero. It's not worth optimizing
55 the case for weird systems where 0 is not a valid uid or gid. */
56 static uid_t cached_no_such_uid
;
57 static gid_t cached_no_such_gid
;
59 static void register_individual_file (char const *name
);
61 /* Given UID, find the corresponding UNAME. */
63 uid_to_uname (uid_t uid
, char **uname
)
65 struct passwd
*passwd
;
67 if (uid
!= 0 && uid
== cached_no_such_uid
)
69 *uname
= xstrdup ("");
73 if (!cached_uname
|| uid
!= cached_uid
)
75 passwd
= getpwuid (uid
);
79 assign_string (&cached_uname
, passwd
->pw_name
);
83 cached_no_such_uid
= uid
;
84 *uname
= xstrdup ("");
88 *uname
= xstrdup (cached_uname
);
91 /* Given GID, find the corresponding GNAME. */
93 gid_to_gname (gid_t gid
, char **gname
)
97 if (gid
!= 0 && gid
== cached_no_such_gid
)
99 *gname
= xstrdup ("");
103 if (!cached_gname
|| gid
!= cached_gid
)
105 group
= getgrgid (gid
);
109 assign_string (&cached_gname
, group
->gr_name
);
113 cached_no_such_gid
= gid
;
114 *gname
= xstrdup ("");
118 *gname
= xstrdup (cached_gname
);
121 /* Given UNAME, set the corresponding UID and return 1, or else, return 0. */
123 uname_to_uid (char const *uname
, uid_t
*uidp
)
125 struct passwd
*passwd
;
127 if (cached_no_such_uname
128 && strcmp (uname
, cached_no_such_uname
) == 0)
132 || uname
[0] != cached_uname
[0]
133 || strcmp (uname
, cached_uname
) != 0)
135 passwd
= getpwnam (uname
);
138 cached_uid
= passwd
->pw_uid
;
139 assign_string (&cached_uname
, passwd
->pw_name
);
143 assign_string (&cached_no_such_uname
, uname
);
151 /* Given GNAME, set the corresponding GID and return 1, or else, return 0. */
153 gname_to_gid (char const *gname
, gid_t
*gidp
)
157 if (cached_no_such_gname
158 && strcmp (gname
, cached_no_such_gname
) == 0)
162 || gname
[0] != cached_gname
[0]
163 || strcmp (gname
, cached_gname
) != 0)
165 group
= getgrnam (gname
);
168 cached_gid
= group
->gr_gid
;
169 assign_string (&cached_gname
, gname
);
173 assign_string (&cached_no_such_gname
, gname
);
182 /* Names from the command call. */
184 static struct name
*namelist
; /* first name in list, if any */
185 static struct name
**nametail
= &namelist
; /* end of name list */
187 /* File name arguments are processed in two stages: first a
188 name_array (see below) is filled, then the names from it
189 are moved into the namelist.
191 This awkward process is needed only to implement --same-order option,
192 which is meant to help process large archives on machines with
193 limited memory. With this option on, namelist contains at most one
194 entry, which diminishes the memory consumption.
196 However, I very much doubt if we still need this -- Sergey */
198 /* A name_array element contains entries of three types: */
200 #define NELT_NAME 0 /* File name */
201 #define NELT_CHDIR 1 /* Change directory request */
202 #define NELT_FMASK 2 /* Change fnmatch options request */
204 struct name_elt
/* A name_array element. */
206 char type
; /* Element type, see NELT_* constants above */
209 const char *name
; /* File or directory name */
210 int matching_flags
;/* fnmatch options if type == NELT_FMASK */
214 static struct name_elt
*name_array
; /* store an array of names */
215 static size_t allocated_names
; /* how big is the array? */
216 static size_t names
; /* how many entries does it have? */
217 static size_t name_index
; /* how many of the entries have we scanned? */
219 /* Check the size of name_array, reallocating it as necessary. */
223 if (names
== allocated_names
)
225 if (allocated_names
== 0)
226 allocated_names
= 10; /* Set initial allocation */
227 name_array
= x2nrealloc (name_array
, &allocated_names
,
228 sizeof (name_array
[0]));
232 /* Add to name_array the file NAME with fnmatch options MATCHING_FLAGS */
234 name_add_name (const char *name
, int matching_flags
)
236 static int prev_flags
= 0; /* FIXME: Or EXCLUDE_ANCHORED? */
240 ep
= &name_array
[names
++];
241 if (prev_flags
!= matching_flags
)
243 ep
->type
= NELT_FMASK
;
244 ep
->v
.matching_flags
= matching_flags
;
245 prev_flags
= matching_flags
;
247 ep
= &name_array
[names
++];
249 ep
->type
= NELT_NAME
;
253 /* Add to name_array a chdir request for the directory NAME */
255 name_add_dir (const char *name
)
259 ep
= &name_array
[names
++];
260 ep
->type
= NELT_CHDIR
;
265 /* Names from external name file. */
267 static char *name_buffer
; /* buffer to hold the current file name */
268 static size_t name_buffer_length
; /* allocated length of name_buffer */
270 /* Set up to gather file names for tar. They can either come from a
271 file or were saved from decoding arguments. */
275 name_buffer
= xmalloc (NAME_FIELD_SIZE
+ 2);
276 name_buffer_length
= NAME_FIELD_SIZE
;
286 static int matching_flags
; /* exclude_fnmatch options */
288 /* Get the next NELT_NAME element from name_array. Result is in
289 static storage and can't be relied upon across two calls.
291 If CHANGE_DIRS is true, treat any entries of type NELT_CHDIR as
292 the request to change to the given directory.
294 Entries of type NELT_FMASK cause updates of the matching_flags
297 name_next_elt (int change_dirs
)
299 static struct name_elt entry
;
303 while (name_index
!= names
)
308 ep
= &name_array
[name_index
++];
309 if (ep
->type
== NELT_FMASK
)
311 matching_flags
= ep
->v
.matching_flags
;
316 source_len
= strlen (source
);
317 if (name_buffer_length
< source_len
)
321 name_buffer_length
*= 2;
322 if (! name_buffer_length
)
325 while (name_buffer_length
< source_len
);
328 name_buffer
= xmalloc (name_buffer_length
+ 2);
330 strcpy (name_buffer
, source
);
332 /* Zap trailing slashes. */
334 cursor
= name_buffer
+ strlen (name_buffer
) - 1;
335 while (cursor
> name_buffer
&& ISSLASH (*cursor
))
338 if (change_dirs
&& ep
->type
== NELT_CHDIR
)
340 if (chdir (name_buffer
) < 0)
341 chdir_fatal (name_buffer
);
346 unquote_string (name_buffer
);
347 if (incremental_option
)
348 register_individual_file (name_buffer
);
349 entry
.type
= ep
->type
;
350 entry
.v
.name
= name_buffer
;
359 name_next (int change_dirs
)
361 struct name_elt
*nelt
= name_next_elt (change_dirs
);
362 return nelt
? nelt
->v
.name
: NULL
;
365 /* Gather names in a list for scanning. Could hash them later if we
368 If the names are already sorted to match the archive, we just read
369 them one by one. name_gather reads the first one, and it is called
370 by name_match as appropriate to read the next ones. At EOF, the
371 last name read is just left in the buffer. This option lets users
372 of small machines extract an arbitrary number of files by doing
373 "tar t" and editing down the list of files. */
378 /* Buffer able to hold a single name. */
379 static struct name
*buffer
;
380 static size_t allocated_size
;
384 if (same_order_option
)
386 static int change_dir
;
388 if (allocated_size
== 0)
390 allocated_size
= offsetof (struct name
, name
) + NAME_FIELD_SIZE
+ 1;
391 buffer
= xmalloc (allocated_size
);
392 /* FIXME: This memset is overkill, and ugly... */
393 memset (buffer
, 0, allocated_size
);
396 while ((ep
= name_next_elt (0)) && ep
->type
== NELT_CHDIR
)
397 change_dir
= chdir_arg (xstrdup (ep
->v
.name
));
403 buffer
->length
= strlen (ep
->v
.name
);
404 needed_size
= offsetof (struct name
, name
) + buffer
->length
+ 1;
405 if (allocated_size
< needed_size
)
410 if (! allocated_size
)
413 while (allocated_size
< needed_size
);
415 buffer
= xrealloc (buffer
, allocated_size
);
417 buffer
->change_dir
= change_dir
;
418 strcpy (buffer
->name
, ep
->v
.name
);
420 buffer
->found_count
= 0;
421 buffer
->matching_flags
= matching_flags
;
424 nametail
= &namelist
->next
;
427 addname (0, change_dir
);
431 /* Non sorted names -- read them all in. */
436 int change_dir0
= change_dir
;
437 while ((ep
= name_next_elt (0)) && ep
->type
== NELT_CHDIR
)
438 change_dir
= chdir_arg (xstrdup (ep
->v
.name
));
441 addname (ep
->v
.name
, change_dir
);
444 if (change_dir
!= change_dir0
)
445 addname (0, change_dir
);
452 /* Add a name to the namelist. */
454 addname (char const *string
, int change_dir
)
456 size_t length
= string
? strlen (string
) : 0;
457 struct name
*name
= xmalloc (offsetof (struct name
, name
) + length
+ 1);
460 strcpy (name
->name
, string
);
465 name
->length
= length
;
466 name
->found_count
= 0;
467 name
->matching_flags
= matching_flags
;
468 name
->change_dir
= change_dir
;
469 name
->dir_contents
= NULL
;
472 nametail
= &name
->next
;
476 /* Find a match for FILE_NAME (whose string length is LENGTH) in the name
479 namelist_match (char const *file_name
, size_t length
)
483 for (p
= namelist
; p
; p
= p
->next
)
486 && exclude_fnmatch (p
->name
, file_name
, p
->matching_flags
))
493 /* Return true if and only if name FILE_NAME (from an archive) matches any
494 name from the namelist. */
496 name_match (const char *file_name
)
498 size_t length
= strlen (file_name
);
502 struct name
*cursor
= namelist
;
507 if (cursor
->name
[0] == 0)
509 chdir_do (cursor
->change_dir
);
511 nametail
= &namelist
;
515 cursor
= namelist_match (file_name
, length
);
518 if (!(ISSLASH (file_name
[cursor
->length
]) && recursion_option
)
519 || cursor
->found_count
== 0)
520 cursor
->found_count
++; /* remember it matched */
521 if (starting_file_option
)
525 nametail
= &namelist
;
527 chdir_do (cursor
->change_dir
);
529 /* We got a match. */
530 return ISFOUND (cursor
);
533 /* Filename from archive not found in namelist. If we have the whole
534 namelist here, just return 0. Otherwise, read the next name in and
535 compare it. If this was the last name, namelist->found_count will
536 remain on. If not, we loop to compare the newly read name. */
538 if (same_order_option
&& namelist
->found_count
)
540 name_gather (); /* read one more */
541 if (namelist
->found_count
)
549 /* Returns true if all names from the namelist were processed.
550 P is the stat_info of the most recently processed entry.
551 The decision is postponed until the next entry is read if:
553 1) P ended with a slash (i.e. it was a directory)
554 2) P matches any entry from the namelist *and* represents a subdirectory
555 or a file lying under this entry (in the terms of directory structure).
557 This is necessary to handle contents of directories. */
559 all_names_found (struct tar_stat_info
*p
)
561 struct name
const *cursor
;
564 if (test_label_option
)
566 if (!p
->file_name
|| occurrence_option
== 0 || p
->had_trailing_slash
)
568 len
= strlen (p
->file_name
);
569 for (cursor
= namelist
; cursor
; cursor
= cursor
->next
)
571 if ((cursor
->name
[0] && !WASFOUND (cursor
))
572 || (len
>= cursor
->length
&& ISSLASH (p
->file_name
[cursor
->length
])))
579 is_pattern (const char *string
)
581 return strchr (string
, '*') || strchr (string
, '[') || strchr (string
, '?');
585 regex_usage_warning (const char *name
)
587 static int warned_once
= 0;
589 if (warn_regex_usage
&& is_pattern (name
))
593 /* TRANSLATORS: The following three msgids form a single sentence.
595 _("Pattern matching characters used in file names. Please,")));
597 _("use --wildcards to enable pattern matching, or --no-wildcards to")));
599 _("suppress this warning.")));
603 /* Print the names of things in the namelist that were not matched. */
605 names_notfound (void)
607 struct name
const *cursor
;
609 for (cursor
= namelist
; cursor
; cursor
= cursor
->next
)
610 if (!WASFOUND (cursor
) && cursor
->name
[0])
612 regex_usage_warning (cursor
->name
);
613 if (cursor
->found_count
== 0)
614 ERROR ((0, 0, _("%s: Not found in archive"),
615 quotearg_colon (cursor
->name
)));
617 ERROR ((0, 0, _("%s: Required occurrence not found in archive"),
618 quotearg_colon (cursor
->name
)));
621 /* Don't bother freeing the name list; we're about to exit. */
623 nametail
= &namelist
;
625 if (same_order_option
)
629 while ((name
= name_next (1)) != NULL
)
631 regex_usage_warning (name
);
632 ERROR ((0, 0, _("%s: Not found in archive"),
633 quotearg_colon (name
)));
638 /* Sorting name lists. */
640 /* Sort linked LIST of names, of given LENGTH, using COMPARE to order
641 names. Return the sorted list. Apart from the type `struct name'
642 and the definition of SUCCESSOR, this is a generic list-sorting
643 function, but it's too painful to make it both generic and portable
647 merge_sort (struct name
*list
, int length
,
648 int (*compare
) (struct name
const*, struct name
const*))
650 struct name
*first_list
;
651 struct name
*second_list
;
655 struct name
**merge_point
;
659 # define SUCCESSOR(name) ((name)->next)
666 if ((*compare
) (list
, SUCCESSOR (list
)) > 0)
668 result
= SUCCESSOR (list
);
669 SUCCESSOR (result
) = list
;
670 SUCCESSOR (list
) = 0;
677 first_length
= (length
+ 1) / 2;
678 second_length
= length
/ 2;
679 for (cursor
= list
, counter
= first_length
- 1;
681 cursor
= SUCCESSOR (cursor
), counter
--)
683 second_list
= SUCCESSOR (cursor
);
684 SUCCESSOR (cursor
) = 0;
686 first_list
= merge_sort (first_list
, first_length
, compare
);
687 second_list
= merge_sort (second_list
, second_length
, compare
);
689 merge_point
= &result
;
690 while (first_list
&& second_list
)
691 if ((*compare
) (first_list
, second_list
) < 0)
693 cursor
= SUCCESSOR (first_list
);
694 *merge_point
= first_list
;
695 merge_point
= &SUCCESSOR (first_list
);
700 cursor
= SUCCESSOR (second_list
);
701 *merge_point
= second_list
;
702 merge_point
= &SUCCESSOR (second_list
);
703 second_list
= cursor
;
706 *merge_point
= first_list
;
708 *merge_point
= second_list
;
715 /* A comparison function for sorting names. Put found names last;
716 break ties by string comparison. */
719 compare_names (struct name
const *n1
, struct name
const *n2
)
721 int found_diff
= WASFOUND(n2
) - WASFOUND(n1
);
722 return found_diff
? found_diff
: strcmp (n1
->name
, n2
->name
);
725 /* Add all the dirs under NAME, which names a directory, to the namelist.
726 If any of the files is a directory, recurse on the subdirectory.
727 DEVICE is the device not to leave, if the -l option is specified. */
730 add_hierarchy_to_namelist (struct name
*name
, dev_t device
)
732 char *file_name
= name
->name
;
733 const char *buffer
= get_directory_contents (file_name
, device
);
736 name
->dir_contents
= "\0\0\0\0";
739 size_t name_length
= name
->length
;
740 size_t allocated_length
= (name_length
>= NAME_FIELD_SIZE
741 ? name_length
+ NAME_FIELD_SIZE
743 char *namebuf
= xmalloc (allocated_length
+ 1);
744 /* FIXME: + 2 above? */
746 size_t string_length
;
747 int change_dir
= name
->change_dir
;
749 name
->dir_contents
= buffer
;
750 strcpy (namebuf
, file_name
);
751 if (! ISSLASH (namebuf
[name_length
- 1]))
753 namebuf
[name_length
++] = '/';
754 namebuf
[name_length
] = '\0';
757 for (string
= buffer
; *string
; string
+= string_length
+ 1)
759 string_length
= strlen (string
);
764 if (allocated_length
<= name_length
+ string_length
)
768 allocated_length
*= 2;
769 if (! allocated_length
)
772 while (allocated_length
<= name_length
+ string_length
);
774 namebuf
= xrealloc (namebuf
, allocated_length
+ 1);
776 strcpy (namebuf
+ name_length
, string
+ 1);
777 np
= addname (namebuf
, change_dir
);
778 add_hierarchy_to_namelist (np
, device
);
786 /* Collect all the names from argv[] (or whatever), expand them into a
787 directory tree, and sort them. This gets only subdirectories, not
791 collect_and_sort_names (void)
794 struct name
*next_name
;
800 if (listed_incremental_option
)
801 read_directory_file ();
806 for (name
= namelist
; name
; name
= next_name
)
808 next_name
= name
->next
;
809 if (name
->found_count
|| name
->dir_contents
)
811 if (name
->matching_flags
& EXCLUDE_WILDCARDS
)
812 /* NOTE: EXCLUDE_ANCHORED is not relevant here */
813 /* FIXME: just skip regexps for now */
815 chdir_do (name
->change_dir
);
816 if (name
->name
[0] == 0)
819 if (deref_stat (dereference_option
, name
->name
, &statbuf
) != 0)
821 stat_diag (name
->name
);
824 if (S_ISDIR (statbuf
.st_mode
))
827 add_hierarchy_to_namelist (name
, statbuf
.st_dev
);
832 for (name
= namelist
; name
; name
= name
->next
)
834 namelist
= merge_sort (namelist
, num_names
, compare_names
);
836 for (name
= namelist
; name
; name
= name
->next
)
837 name
->found_count
= 0;
839 if (listed_incremental_option
)
841 for (name
= namelist
; name
&& name
->name
[0] == 0; name
++)
844 name
->dir_contents
= append_incremental_renames (name
->dir_contents
);
848 /* This is like name_match, except that
849 1. It returns a pointer to the name it matched, and doesn't set FOUND
850 in structure. The caller will have to do that if it wants to.
851 2. If the namelist is empty, it returns null, unlike name_match, which
854 name_scan (const char *file_name
)
856 size_t length
= strlen (file_name
);
860 struct name
*cursor
= namelist_match (file_name
, length
);
864 /* Filename from archive not found in namelist. If we have the whole
865 namelist here, just return 0. Otherwise, read the next name in and
866 compare it. If this was the last name, namelist->found_count will
867 remain on. If not, we loop to compare the newly read name. */
869 if (same_order_option
&& namelist
&& namelist
->found_count
)
871 name_gather (); /* read one more */
872 if (namelist
->found_count
)
880 /* This returns a name from the namelist which doesn't have ->found
881 set. It sets ->found before returning, so successive calls will
882 find and return all the non-found names in the namelist. */
883 struct name
*gnu_list_name
;
886 name_from_list (void)
889 gnu_list_name
= namelist
;
891 && (gnu_list_name
->found_count
|| gnu_list_name
->name
[0] == 0))
892 gnu_list_name
= gnu_list_name
->next
;
895 gnu_list_name
->found_count
++;
896 chdir_do (gnu_list_name
->change_dir
);
897 return gnu_list_name
->name
;
903 blank_name_list (void)
908 for (name
= namelist
; name
; name
= name
->next
)
909 name
->found_count
= 0;
912 /* Yield a newly allocated file name consisting of FILE_NAME concatenated to
913 NAME, with an intervening slash if FILE_NAME does not already end in one. */
915 new_name (const char *file_name
, const char *name
)
917 size_t file_name_len
= strlen (file_name
);
918 size_t namesize
= strlen (name
) + 1;
919 int slash
= file_name_len
&& ! ISSLASH (file_name
[file_name_len
- 1]);
920 char *buffer
= xmalloc (file_name_len
+ slash
+ namesize
);
921 memcpy (buffer
, file_name
, file_name_len
);
922 buffer
[file_name_len
] = '/';
923 memcpy (buffer
+ file_name_len
+ slash
, name
, namesize
);
927 /* Return nonzero if file NAME is excluded. */
929 excluded_name (char const *name
)
931 return excluded_file_name (excluded
, name
+ FILE_SYSTEM_PREFIX_LEN (name
));
934 /* Names to avoid dumping. */
935 static Hash_table
*avoided_name_table
;
937 /* Remember to not archive NAME. */
939 add_avoided_name (char const *name
)
941 hash_string_insert (&avoided_name_table
, name
);
944 /* Should NAME be avoided when archiving? */
946 is_avoided_name (char const *name
)
948 return hash_string_lookup (avoided_name_table
, name
);
952 static Hash_table
*individual_file_table
;
955 register_individual_file (char const *name
)
959 if (deref_stat (dereference_option
, name
, &st
) != 0)
960 return; /* Will be complained about later */
961 if (S_ISDIR (st
.st_mode
))
964 hash_string_insert (&individual_file_table
, name
);
968 is_individual_file (char const *name
)
970 return hash_string_lookup (individual_file_table
, name
);
975 /* Return the size of the prefix of FILE_NAME that is removed after
976 stripping NUM leading file name components. NUM must be
980 stripped_prefix_len (char const *file_name
, size_t num
)
982 char const *p
= file_name
+ FILE_SYSTEM_PREFIX_LEN (file_name
);
987 bool slash
= ISSLASH (*p
);
992 return p
- file_name
;
1000 /* Return nonzero if NAME contains ".." as a file name component. */
1002 contains_dot_dot (char const *name
)
1004 char const *p
= name
+ FILE_SYSTEM_PREFIX_LEN (name
);
1008 if (p
[0] == '.' && p
[1] == '.' && (ISSLASH (p
[2]) || !p
[2]))
1011 while (! ISSLASH (*p
))