1 /* Various processing of names.
3 Copyright (C) 1988, 1992, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
4 2003, 2004, 2005, 2006, 2007, 2009 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 /* Make sure you link with the proper libraries if you are running the
31 Yellow Peril (thanks for the good laugh, Ian J.!), or, euh... NIS.
32 This code should also be modified for non-UNIX systems to do something
35 static char *cached_uname;
36 static char *cached_gname;
38 static uid_t cached_uid; /* valid only if cached_uname is not empty */
39 static gid_t cached_gid; /* valid only if cached_gname is not empty */
41 /* These variables are valid only if nonempty. */
42 static char *cached_no_such_uname;
43 static char *cached_no_such_gname;
45 /* These variables are valid only if nonzero. It's not worth optimizing
46 the case for weird systems where 0 is not a valid uid or gid. */
47 static uid_t cached_no_such_uid;
48 static gid_t cached_no_such_gid;
50 /* Given UID, find the corresponding UNAME. */
52 uid_to_uname (uid_t uid, char **uname)
54 struct passwd *passwd;
56 if (uid != 0 && uid == cached_no_such_uid)
58 *uname = xstrdup ("");
62 if (!cached_uname || uid != cached_uid)
64 passwd = getpwuid (uid);
68 assign_string (&cached_uname, passwd->pw_name);
72 cached_no_such_uid = uid;
73 *uname = xstrdup ("");
77 *uname = xstrdup (cached_uname);
80 /* Given GID, find the corresponding GNAME. */
82 gid_to_gname (gid_t gid, char **gname)
86 if (gid != 0 && gid == cached_no_such_gid)
88 *gname = xstrdup ("");
92 if (!cached_gname || gid != cached_gid)
94 group = getgrgid (gid);
98 assign_string (&cached_gname, group->gr_name);
102 cached_no_such_gid = gid;
103 *gname = xstrdup ("");
107 *gname = xstrdup (cached_gname);
110 /* Given UNAME, set the corresponding UID and return 1, or else, return 0. */
112 uname_to_uid (char const *uname, uid_t *uidp)
114 struct passwd *passwd;
116 if (cached_no_such_uname
117 && strcmp (uname, cached_no_such_uname) == 0)
121 || uname[0] != cached_uname[0]
122 || strcmp (uname, cached_uname) != 0)
124 passwd = getpwnam (uname);
127 cached_uid = passwd->pw_uid;
128 assign_string (&cached_uname, passwd->pw_name);
132 assign_string (&cached_no_such_uname, uname);
140 /* Given GNAME, set the corresponding GID and return 1, or else, return 0. */
142 gname_to_gid (char const *gname, gid_t *gidp)
146 if (cached_no_such_gname
147 && strcmp (gname, cached_no_such_gname) == 0)
151 || gname[0] != cached_gname[0]
152 || strcmp (gname, cached_gname) != 0)
154 group = getgrnam (gname);
157 cached_gid = group->gr_gid;
158 assign_string (&cached_gname, gname);
162 assign_string (&cached_no_such_gname, gname);
172 make_name (const char *file_name)
174 struct name *p = xzalloc (sizeof (*p));
177 p->name = xstrdup (file_name);
178 p->length = strlen (p->name);
183 free_name (struct name *p)
194 /* Names from the command call. */
196 static struct name *namelist; /* first name in list, if any */
197 static struct name *nametail; /* end of name list */
199 /* File name arguments are processed in two stages: first a
200 name_array (see below) is filled, then the names from it
201 are moved into the namelist.
203 This awkward process is needed only to implement --same-order option,
204 which is meant to help process large archives on machines with
205 limited memory. With this option on, namelist contains at most one
206 entry, which diminishes the memory consumption.
208 However, I very much doubt if we still need this -- Sergey */
210 /* A name_array element contains entries of three types: */
212 #define NELT_NAME 0 /* File name */
213 #define NELT_CHDIR 1 /* Change directory request */
214 #define NELT_FMASK 2 /* Change fnmatch options request */
216 struct name_elt /* A name_array element. */
218 char type; /* Element type, see NELT_* constants above */
221 const char *name; /* File or directory name */
222 int matching_flags;/* fnmatch options if type == NELT_FMASK */
226 static struct name_elt *name_array; /* store an array of names */
227 static size_t allocated_entries; /* how big is the array? */
228 static size_t entries; /* how many entries does it have? */
229 static size_t scanned; /* how many of the entries have we scanned? */
230 size_t name_count; /* how many of the entries are names? */
232 /* Check the size of name_array, reallocating it as necessary. */
234 check_name_alloc (void)
236 if (entries == allocated_entries)
238 if (allocated_entries == 0)
239 allocated_entries = 10; /* Set initial allocation */
240 name_array = x2nrealloc (name_array, &allocated_entries,
241 sizeof (name_array[0]));
245 /* Add to name_array the file NAME with fnmatch options MATCHING_FLAGS */
247 name_add_name (const char *name, int matching_flags)
249 static int prev_flags = 0; /* FIXME: Or EXCLUDE_ANCHORED? */
253 ep = &name_array[entries++];
254 if (prev_flags != matching_flags)
256 ep->type = NELT_FMASK;
257 ep->v.matching_flags = matching_flags;
258 prev_flags = matching_flags;
260 ep = &name_array[entries++];
262 ep->type = NELT_NAME;
267 /* Add to name_array a chdir request for the directory NAME */
269 name_add_dir (const char *name)
273 ep = &name_array[entries++];
274 ep->type = NELT_CHDIR;
279 /* Names from external name file. */
281 static char *name_buffer; /* buffer to hold the current file name */
282 static size_t name_buffer_length; /* allocated length of name_buffer */
284 /* Set up to gather file names for tar. They can either come from a
285 file or were saved from decoding arguments. */
289 name_buffer = xmalloc (NAME_FIELD_SIZE + 2);
290 name_buffer_length = NAME_FIELD_SIZE;
300 static int matching_flags; /* exclude_fnmatch options */
302 /* Get the next NELT_NAME element from name_array. Result is in
303 static storage and can't be relied upon across two calls.
305 If CHANGE_DIRS is true, treat any entries of type NELT_CHDIR as
306 the request to change to the given directory.
308 Entries of type NELT_FMASK cause updates of the matching_flags
310 static struct name_elt *
311 name_next_elt (int change_dirs)
313 static struct name_elt entry;
317 while (scanned != entries)
322 ep = &name_array[scanned++];
323 if (ep->type == NELT_FMASK)
325 matching_flags = ep->v.matching_flags;
330 source_len = strlen (source);
331 if (name_buffer_length < source_len)
335 name_buffer_length *= 2;
336 if (! name_buffer_length)
339 while (name_buffer_length < source_len);
342 name_buffer = xmalloc (name_buffer_length + 2);
344 strcpy (name_buffer, source);
346 /* Zap trailing slashes. */
348 cursor = name_buffer + strlen (name_buffer) - 1;
349 while (cursor > name_buffer && ISSLASH (*cursor))
352 if (change_dirs && ep->type == NELT_CHDIR)
354 if (chdir (name_buffer) < 0)
355 chdir_fatal (name_buffer);
360 unquote_string (name_buffer);
361 entry.type = ep->type;
362 entry.v.name = name_buffer;
371 name_next (int change_dirs)
373 struct name_elt *nelt = name_next_elt (change_dirs);
374 return nelt ? nelt->v.name : NULL;
377 /* Gather names in a list for scanning. Could hash them later if we
380 If the names are already sorted to match the archive, we just read
381 them one by one. name_gather reads the first one, and it is called
382 by name_match as appropriate to read the next ones. At EOF, the
383 last name read is just left in the buffer. This option lets users
384 of small machines extract an arbitrary number of files by doing
385 "tar t" and editing down the list of files. */
390 /* Buffer able to hold a single name. */
391 static struct name *buffer = NULL;
395 if (same_order_option)
397 static int change_dir;
399 while ((ep = name_next_elt (0)) && ep->type == NELT_CHDIR)
400 change_dir = chdir_arg (xstrdup (ep->v.name));
405 buffer = make_name (ep->v.name);
406 buffer->change_dir = change_dir;
408 buffer->found_count = 0;
409 buffer->matching_flags = matching_flags;
410 buffer->directory = NULL;
411 buffer->parent = NULL;
412 buffer->cmdline = true;
414 namelist = nametail = buffer;
417 addname (0, change_dir, false, NULL);
421 /* Non sorted names -- read them all in. */
426 int change_dir0 = change_dir;
427 while ((ep = name_next_elt (0)) && ep->type == NELT_CHDIR)
428 change_dir = chdir_arg (xstrdup (ep->v.name));
431 addname (ep->v.name, change_dir, true, NULL);
434 if (change_dir != change_dir0)
435 addname (NULL, change_dir, false, NULL);
442 /* Add a name to the namelist. */
444 addname (char const *string, int change_dir, bool cmdline, struct name *parent)
446 struct name *name = make_name (string);
448 name->prev = nametail;
450 name->found_count = 0;
451 name->matching_flags = matching_flags;
452 name->change_dir = change_dir;
453 name->directory = NULL;
454 name->parent = parent;
455 name->cmdline = cmdline;
458 nametail->next = name;
465 /* Find a match for FILE_NAME (whose string length is LENGTH) in the name
468 namelist_match (char const *file_name, size_t length)
472 for (p = namelist; p; p = p->next)
475 && exclude_fnmatch (p->name, file_name, p->matching_flags))
483 remname (struct name *name)
487 if ((p = name->prev) != NULL)
488 p->next = name->next;
490 namelist = name->next;
492 if ((p = name->next) != NULL)
493 p->prev = name->prev;
495 nametail = name->prev;
498 /* Return true if and only if name FILE_NAME (from an archive) matches any
499 name from the namelist. */
501 name_match (const char *file_name)
503 size_t length = strlen (file_name);
507 struct name *cursor = namelist;
512 if (cursor->name[0] == 0)
514 chdir_do (cursor->change_dir);
520 cursor = namelist_match (file_name, length);
523 if (!(ISSLASH (file_name[cursor->length]) && recursion_option)
524 || cursor->found_count == 0)
525 cursor->found_count++; /* remember it matched */
526 if (starting_file_option)
532 chdir_do (cursor->change_dir);
534 /* We got a match. */
535 return ISFOUND (cursor);
538 /* Filename from archive not found in namelist. If we have the whole
539 namelist here, just return 0. Otherwise, read the next name in and
540 compare it. If this was the last name, namelist->found_count will
541 remain on. If not, we loop to compare the newly read name. */
543 if (same_order_option && namelist->found_count)
545 name_gather (); /* read one more */
546 if (namelist->found_count)
554 /* Returns true if all names from the namelist were processed.
555 P is the stat_info of the most recently processed entry.
556 The decision is postponed until the next entry is read if:
558 1) P ended with a slash (i.e. it was a directory)
559 2) P matches any entry from the namelist *and* represents a subdirectory
560 or a file lying under this entry (in the terms of directory structure).
562 This is necessary to handle contents of directories. */
564 all_names_found (struct tar_stat_info *p)
566 struct name const *cursor;
569 if (!p->file_name || occurrence_option == 0 || p->had_trailing_slash)
571 len = strlen (p->file_name);
572 for (cursor = namelist; cursor; cursor = cursor->next)
574 if ((cursor->name[0] && !WASFOUND (cursor))
575 || (len >= cursor->length && ISSLASH (p->file_name[cursor->length])))
582 regex_usage_warning (const char *name)
584 static int warned_once = 0;
586 if (warn_regex_usage && fnmatch_pattern_has_wildcards (name, 0))
590 _("Pattern matching characters used in file names")));
592 _("Use --wildcards to enable pattern matching,"
593 " or --no-wildcards to suppress this warning")));
598 /* Print the names of things in the namelist that were not matched. */
600 names_notfound (void)
602 struct name const *cursor;
604 for (cursor = namelist; cursor; cursor = cursor->next)
605 if (!WASFOUND (cursor) && cursor->name[0])
607 regex_usage_warning (cursor->name);
609 (cursor->found_count == 0) ?
610 _("%s: Not found in archive") :
611 _("%s: Required occurrence not found in archive"),
612 quotearg_colon (cursor->name)));
615 /* Don't bother freeing the name list; we're about to exit. */
619 if (same_order_option)
623 while ((name = name_next (1)) != NULL)
625 regex_usage_warning (name);
626 ERROR ((0, 0, _("%s: Not found in archive"),
627 quotearg_colon (name)));
633 label_notfound (void)
635 struct name const *cursor;
640 for (cursor = namelist; cursor; cursor = cursor->next)
641 if (WASFOUND (cursor))
645 error (0, 0, _("Archive label mismatch"));
646 set_exit_status (TAREXIT_DIFFERS);
648 for (cursor = namelist; cursor; cursor = cursor->next)
650 if (regex_usage_warning (cursor->name))
654 /* Don't bother freeing the name list; we're about to exit. */
658 if (same_order_option)
662 while ((name = name_next (1)) != NULL
663 && regex_usage_warning (name) == 0)
668 /* Sorting name lists. */
670 /* Sort *singly* linked LIST of names, of given LENGTH, using COMPARE
671 to order names. Return the sorted list. Note that after calling
672 this function, the `prev' links in list elements are messed up.
674 Apart from the type `struct name' and the definition of SUCCESSOR,
675 this is a generic list-sorting function, but it's too painful to
676 make it both generic and portable
680 merge_sort_sll (struct name *list, int length,
681 int (*compare) (struct name const*, struct name const*))
683 struct name *first_list;
684 struct name *second_list;
688 struct name **merge_point;
692 # define SUCCESSOR(name) ((name)->next)
699 if ((*compare) (list, SUCCESSOR (list)) > 0)
701 result = SUCCESSOR (list);
702 SUCCESSOR (result) = list;
703 SUCCESSOR (list) = 0;
710 first_length = (length + 1) / 2;
711 second_length = length / 2;
712 for (cursor = list, counter = first_length - 1;
714 cursor = SUCCESSOR (cursor), counter--)
716 second_list = SUCCESSOR (cursor);
717 SUCCESSOR (cursor) = 0;
719 first_list = merge_sort_sll (first_list, first_length, compare);
720 second_list = merge_sort_sll (second_list, second_length, compare);
722 merge_point = &result;
723 while (first_list && second_list)
724 if ((*compare) (first_list, second_list) < 0)
726 cursor = SUCCESSOR (first_list);
727 *merge_point = first_list;
728 merge_point = &SUCCESSOR (first_list);
733 cursor = SUCCESSOR (second_list);
734 *merge_point = second_list;
735 merge_point = &SUCCESSOR (second_list);
736 second_list = cursor;
739 *merge_point = first_list;
741 *merge_point = second_list;
748 /* Sort doubly linked LIST of names, of given LENGTH, using COMPARE
749 to order names. Return the sorted list. */
751 merge_sort (struct name *list, int length,
752 int (*compare) (struct name const*, struct name const*))
754 struct name *head, *p, *prev;
755 head = merge_sort_sll (list, length, compare);
756 /* Fixup prev pointers */
757 for (prev = NULL, p = head; p; prev = p, p = p->next)
762 /* A comparison function for sorting names. Put found names last;
763 break ties by string comparison. */
766 compare_names_found (struct name const *n1, struct name const *n2)
768 int found_diff = WASFOUND (n2) - WASFOUND (n1);
769 return found_diff ? found_diff : strcmp (n1->name, n2->name);
772 /* Simple comparison by names. */
774 compare_names (struct name const *n1, struct name const *n2)
776 return strcmp (n1->name, n2->name);
780 /* Add all the dirs under ST to the namelist NAME, descending the
781 directory hierarchy recursively. */
784 add_hierarchy_to_namelist (struct tar_stat_info *st, struct name *name)
788 name->directory = scan_directory (st);
789 buffer = directory_contents (name->directory);
792 struct name *child_head = NULL, *child_tail = NULL;
793 size_t name_length = name->length;
794 size_t allocated_length = (name_length >= NAME_FIELD_SIZE
795 ? name_length + NAME_FIELD_SIZE
797 char *namebuf = xmalloc (allocated_length + 1);
798 /* FIXME: + 2 above? */
800 size_t string_length;
801 int change_dir = name->change_dir;
803 strcpy (namebuf, name->name);
804 if (! ISSLASH (namebuf[name_length - 1]))
806 namebuf[name_length++] = '/';
807 namebuf[name_length] = '\0';
810 for (string = buffer; *string; string += string_length + 1)
812 string_length = strlen (string);
816 struct tar_stat_info subdir;
819 if (allocated_length <= name_length + string_length)
823 allocated_length *= 2;
824 if (! allocated_length)
827 while (allocated_length <= name_length + string_length);
829 namebuf = xrealloc (namebuf, allocated_length + 1);
831 strcpy (namebuf + name_length, string + 1);
832 np = addname (namebuf, change_dir, false, name);
836 child_tail->sibling = np;
839 tar_stat_init (&subdir);
847 subfd = subfile_open (st, string + 1,
848 open_read_flags | O_DIRECTORY);
854 if (fstat (subfd, &subdir.stat) != 0)
856 else if (! (O_DIRECTORY || S_ISDIR (subdir.stat.st_mode)))
863 subdir.orig_file_name = xstrdup (namebuf);
864 add_hierarchy_to_namelist (&subdir, np);
865 restore_parent_fd (&subdir);
869 tar_stat_destroy (&subdir);
874 name->child = child_head;
878 /* Auxiliary functions for hashed table of struct name's. */
881 name_hash (void const *entry, size_t n_buckets)
883 struct name const *name = entry;
884 return hash_string (name->caname, n_buckets);
887 /* Compare two directories for equality of their names. */
889 name_compare (void const *entry1, void const *entry2)
891 struct name const *name1 = entry1;
892 struct name const *name2 = entry2;
893 return strcmp (name1->caname, name2->caname) == 0;
897 /* Rebase `name' member of CHILD and all its siblings to
900 rebase_child_list (struct name *child, struct name *parent)
902 size_t old_prefix_len = child->parent->length;
903 size_t new_prefix_len = parent->length;
904 char *new_prefix = parent->name;
906 for (; child; child = child->sibling)
908 size_t size = child->length - old_prefix_len + new_prefix_len;
909 char *newp = xmalloc (size + 1);
910 strcpy (newp, new_prefix);
911 strcat (newp, child->name + old_prefix_len);
914 child->length = size;
916 rebase_directory (child->directory,
917 child->parent->name, old_prefix_len,
918 new_prefix, new_prefix_len);
922 /* Collect all the names from argv[] (or whatever), expand them into a
923 directory tree, and sort them. This gets only subdirectories, not
927 collect_and_sort_names (void)
930 struct name *next_name, *prev_name = NULL;
937 addname (".", 0, false, NULL);
939 if (listed_incremental_option)
941 switch (chdir_count ())
947 if (namelist->change_dir == 0)
949 _("Using -C option inside file list is not "
950 "allowed with --listed-incremental")));
955 _("Only one -C option is allowed with "
956 "--listed-incremental")));
959 read_directory_file ();
963 for (name = namelist; name; name = name->next, num_names++)
965 struct tar_stat_info st;
967 if (name->found_count || name->directory)
969 if (name->matching_flags & EXCLUDE_WILDCARDS)
970 /* NOTE: EXCLUDE_ANCHORED is not relevant here */
971 /* FIXME: just skip regexps for now */
973 chdir_do (name->change_dir);
975 if (name->name[0] == 0)
980 if (deref_stat (name->name, &st.stat) != 0)
982 stat_diag (name->name);
985 if (S_ISDIR (st.stat.st_mode))
987 int dir_fd = openat (chdir_fd, name->name,
988 open_read_flags | O_DIRECTORY);
990 open_diag (name->name);
994 if (fstat (dir_fd, &st.stat) != 0)
995 stat_diag (name->name);
996 else if (O_DIRECTORY || S_ISDIR (st.stat.st_mode))
998 st.orig_file_name = xstrdup (name->name);
1000 add_hierarchy_to_namelist (&st, name);
1005 tar_stat_destroy (&st);
1008 namelist = merge_sort (namelist, num_names, compare_names);
1011 nametab = hash_initialize (0, 0,
1013 name_compare, NULL);
1014 for (name = namelist; name; name = next_name)
1016 next_name = name->next;
1017 name->caname = normalize_filename (name->name);
1020 struct name *p = hash_lookup (nametab, name);
1023 /* Keep the one listed in the command line */
1027 rebase_child_list (p->child, name);
1028 hash_delete (nametab, name);
1029 /* FIXME: remove_directory (p->caname); ? */
1037 rebase_child_list (name->child, p);
1038 /* FIXME: remove_directory (name->caname); ? */
1045 name->found_count = 0;
1046 if (!hash_insert (nametab, name))
1051 nametail = prev_name;
1052 hash_free (nametab);
1054 namelist = merge_sort (namelist, num_names, compare_names_found);
1056 if (listed_incremental_option)
1058 for (name = namelist; name && name->name[0] == 0; name++)
1061 append_incremental_renames (name->directory);
1065 /* This is like name_match, except that
1066 1. It returns a pointer to the name it matched, and doesn't set FOUND
1067 in structure. The caller will have to do that if it wants to.
1068 2. If the namelist is empty, it returns null, unlike name_match, which
1071 name_scan (const char *file_name)
1073 size_t length = strlen (file_name);
1077 struct name *cursor = namelist_match (file_name, length);
1081 /* Filename from archive not found in namelist. If we have the whole
1082 namelist here, just return 0. Otherwise, read the next name in and
1083 compare it. If this was the last name, namelist->found_count will
1084 remain on. If not, we loop to compare the newly read name. */
1086 if (same_order_option && namelist && namelist->found_count)
1088 name_gather (); /* read one more */
1089 if (namelist->found_count)
1097 /* This returns a name from the namelist which doesn't have ->found
1098 set. It sets ->found before returning, so successive calls will
1099 find and return all the non-found names in the namelist. */
1100 struct name *gnu_list_name;
1106 gnu_list_name = namelist;
1107 while (gnu_list_name
1108 && (gnu_list_name->found_count || gnu_list_name->name[0] == 0))
1109 gnu_list_name = gnu_list_name->next;
1112 gnu_list_name->found_count++;
1113 chdir_do (gnu_list_name->change_dir);
1114 return gnu_list_name;
1120 blank_name_list (void)
1125 for (name = namelist; name; name = name->next)
1126 name->found_count = 0;
1129 /* Yield a newly allocated file name consisting of FILE_NAME concatenated to
1130 NAME, with an intervening slash if FILE_NAME does not already end in one. */
1132 new_name (const char *file_name, const char *name)
1134 size_t file_name_len = strlen (file_name);
1135 size_t namesize = strlen (name) + 1;
1136 int slash = file_name_len && ! ISSLASH (file_name[file_name_len - 1]);
1137 char *buffer = xmalloc (file_name_len + slash + namesize);
1138 memcpy (buffer, file_name, file_name_len);
1139 buffer[file_name_len] = '/';
1140 memcpy (buffer + file_name_len + slash, name, namesize);
1144 /* Return nonzero if file NAME is excluded. */
1146 excluded_name (char const *name)
1148 return excluded_file_name (excluded, name + FILE_SYSTEM_PREFIX_LEN (name));
1152 /* Return the size of the prefix of FILE_NAME that is removed after
1153 stripping NUM leading file name components. NUM must be
1157 stripped_prefix_len (char const *file_name, size_t num)
1159 char const *p = file_name + FILE_SYSTEM_PREFIX_LEN (file_name);
1160 while (ISSLASH (*p))
1164 bool slash = ISSLASH (*p);
1169 return p - file_name;
1170 while (ISSLASH (*p))
1177 /* Return nonzero if NAME contains ".." as a file name component. */
1179 contains_dot_dot (char const *name)
1181 char const *p = name + FILE_SYSTEM_PREFIX_LEN (name);
1185 if (p[0] == '.' && p[1] == '.' && (ISSLASH (p[2]) || !p[2]))
1188 while (! ISSLASH (*p))