2 * Copyright (c) 1992 Keith Muller.
3 * Copyright (c) 1992, 1993
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from software contributed to Berkeley by
7 * Keith Muller of the University of California, San Diego.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by the University of
20 * California, Berkeley and its contributors.
21 * 4. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * @(#)pat_rep.c 8.2 (Berkeley) 4/18/94
38 * $FreeBSD: src/bin/pax/pat_rep.c,v 1.15.2.1 2001/08/01 05:03:11 obrien Exp $
39 * $DragonFly: src/bin/pax/pat_rep.c,v 1.8 2006/09/27 21:58:08 pavalos Exp $
42 #include <sys/types.h>
55 * routines to handle pattern matching, name modification (regular expression
56 * substitution and interactive renames), and destination name modification for
57 * copy (-rw). Both file name and link names are adjusted as required in these
61 #define MAXSUBEXP 10 /* max subexpressions, DO NOT CHANGE */
62 static PATTERN *pathead = NULL; /* file pattern match list head */
63 static PATTERN *pattail = NULL; /* file pattern match list tail */
64 static REPLACE *rephead = NULL; /* replacement string list head */
65 static REPLACE *reptail = NULL; /* replacement string list tail */
67 static int rep_name (char *, int *, int);
68 static int tty_rename (ARCHD *);
69 static int fix_path (char *, int *, char *, int);
70 static int fn_match (char *, char *, char **);
71 static char * range_match (char *, int);
72 static int resub (regex_t *, regmatch_t *, char *, char *, char *);
76 * parses the -s replacement string; compiles the regular expression
77 * and stores the compiled value and it's replacement string together in
78 * replacement string list. Input to this function is of the form:
80 * The first char in the string specifies the delimiter used by this
81 * replacement string. "Old" is a regular expression in "ed" format which
82 * is compiled by regcomp() and is applied to filenames. "new" is the
83 * substitution string; p and g are options flags for printing and global
84 * replacement (over the single filename)
86 * 0 if a proper replacement string and regular expression was added to
87 * the list of replacement patterns; -1 otherwise.
100 * throw out the bad parameters
102 if ((str == NULL) || (*str == '\0')) {
103 paxwarn(1, "Empty replacement string");
108 * first character in the string specifies what the delimiter is for
111 if ((pt1 = strchr(str+1, *str)) == NULL) {
112 paxwarn(1, "Invalid replacement string %s", str);
117 * allocate space for the node that handles this replacement pattern
118 * and split out the regular expression and try to compile it
120 if ((rep = (REPLACE *)malloc(sizeof(REPLACE))) == NULL) {
121 paxwarn(1, "Unable to allocate memory for replacement string");
126 if ((res = regcomp(&(rep->rcmp), str+1, 0)) != 0) {
127 regerror(res, &(rep->rcmp), rebuf, sizeof(rebuf));
128 paxwarn(1, "%s while compiling regular expression %s", rebuf, str);
134 * put the delimiter back in case we need an error message and
135 * locate the delimiter at the end of the replacement string
136 * we then point the node at the new substitution string
139 if ((pt2 = strchr(pt1, *str)) == NULL) {
140 regfree(&(rep->rcmp));
142 paxwarn(1, "Invalid replacement string %s", str);
152 * set the options if any
154 while (*pt2 != '\0') {
165 regfree(&(rep->rcmp));
168 paxwarn(1, "Invalid replacement string option %s", str);
175 * all done, link it in at the end
178 if (rephead == NULL) {
179 reptail = rephead = rep;
189 * add a pattern match to the pattern match list. Pattern matches are used
190 * to select which archive members are extracted. (They appear as
191 * arguments to pax in the list and read modes). If no patterns are
192 * supplied to pax, all members in the archive will be selected (and the
193 * pattern match list is empty).
195 * 0 if the pattern was added to the list, -1 otherwise
199 pat_add(char *str, char *chdname)
206 if ((str == NULL) || (*str == '\0')) {
207 paxwarn(1, "Empty pattern string");
212 * allocate space for the pattern and store the pattern. the pattern is
213 * part of argv so do not bother to copy it, just point at it. Add the
214 * node to the end of the pattern list
216 if ((pt = (PATTERN *)malloc(sizeof(PATTERN))) == NULL) {
217 paxwarn(1, "Unable to allocate memory for pattern string");
223 pt->plen = strlen(str);
226 pt->chdname = chdname;
228 if (pathead == NULL) {
229 pattail = pathead = pt;
239 * complain if any the user supplied pattern did not result in a match to
240 * a selected archive member.
250 * walk down the list checking the flags to make sure MTCH was set,
253 for (pt = pathead; pt != NULL; pt = pt->fow) {
257 paxwarn(1, "WARNING! These patterns were not matched:");
260 fprintf(stderr, "%s\n", pt->pstr);
266 * the archive member which matches a pattern was selected. Mark the
267 * pattern as having selected an archive member. arcn->pat points at the
268 * pattern that was matched. arcn->pat is set in pat_match()
270 * NOTE: When the -c option is used, we are called when there was no match
271 * by pat_match() (that means we did match before the inverted sense of
272 * the logic). Now this seems really strange at first, but with -c we
273 * need to keep track of those patterns that cause an archive member to NOT
274 * be selected (it found an archive member with a specified pattern)
276 * 0 if the pattern pointed at by arcn->pat was tagged as creating a
277 * match, -1 otherwise.
288 * if no patterns just return
290 if ((pathead == NULL) || ((pt = arcn->pat) == NULL))
294 * when we are NOT limited to a single match per pattern mark the
303 * we reach this point only when we allow a single selected match per
304 * pattern, if the pattern matches a directory and we do not have -d
305 * (dflag) we are done with this pattern. We may also be handed a file
306 * in the subtree of a directory. in that case when we are operating
307 * with -d, this pattern was already selected and we are done
309 if (pt->flgs & DIR_MTCH)
312 if (!dflag && ((pt->pend != NULL) || (arcn->type == PAX_DIR))) {
314 * ok we matched a directory and we are allowing
315 * subtree matches but because of the -n only its children will
316 * match. This is tagged as a DIR_MTCH type.
317 * WATCH IT, the code assumes that pt->pend points
318 * into arcn->name and arcn->name has not been modified.
319 * If not we will have a big mess. Yup this is another kludge
323 * if this was a prefix match, remove trailing part of path
324 * so we can copy it. Future matches will be exact prefix match
326 if (pt->pend != NULL)
329 if ((pt->pstr = strdup(arcn->name)) == NULL) {
330 paxwarn(1, "Pattern select out of memory");
331 if (pt->pend != NULL)
338 * put the trailing / back in the source string
340 if (pt->pend != NULL) {
344 pt->plen = strlen(pt->pstr);
347 * strip off any trailing /, this should really never happen
350 if (*(pt->pstr + len) == '/') {
351 *(pt->pstr + len) = '\0';
354 pt->flgs = DIR_MTCH | MTCH;
360 * we are then done with this pattern, so we delete it from the list
361 * because it can never be used for another match.
362 * Seems kind of strange to do for a -c, but the pax spec is really
363 * vague on the interaction of -c, -n and -d. We assume that when -c
364 * and the pattern rejects a member (i.e. it matched it) it is done.
365 * In effect we place the order of the flags as having -c last.
369 while ((pt != NULL) && (pt != arcn->pat)) {
376 * should never happen....
378 paxwarn(1, "Pattern list inconsistent");
389 * see if this archive member matches any supplied pattern, if a match
390 * is found, arcn->pat is set to point at the potential pattern. Later if
391 * this archive member is "selected" we process and mark the pattern as
392 * one which matched a selected archive member (see pat_sel())
394 * 0 if this archive member should be processed, 1 if it should be
395 * skipped and -1 if we are done with all patterns (and pax should quit
396 * looking for more members)
400 pat_match(ARCHD *arcn)
407 * if there are no more patterns and we have -n (and not -c) we are
408 * done. otherwise with no patterns to match, matches all
410 if (pathead == NULL) {
417 * have to search down the list one at a time looking for a match.
422 * check for a file name match unless we have DIR_MTCH set in
423 * this pattern then we want a prefix match
425 if (pt->flgs & DIR_MTCH) {
427 * this pattern was matched before to a directory
428 * as we must have -n set for this (but not -d). We can
429 * only match CHILDREN of that directory so we must use
430 * an exact prefix match (no wildcards).
432 if ((arcn->name[pt->plen] == '/') &&
433 (strncmp(pt->pstr, arcn->name, pt->plen) == 0))
435 } else if (fn_match(pt->pstr, arcn->name, &pt->pend) == 0)
441 * return the result, remember that cflag (-c) inverts the sense of a
445 return(cflag ? 0 : 1);
448 * we had a match, now when we invert the sense (-c) we reject this
449 * member. However we have to tag the pattern a being successful, (in a
450 * match, not in selecting a archive member) so we call pat_sel() here.
456 if (pat_sel(arcn) < 0)
465 * 0 if this archive member should be processed, 1 if it should be
466 * skipped and -1 if we are done with all patterns (and pax should quit
467 * looking for more members)
468 * Note: *pend may be changed to show where the prefix ends.
472 fn_match(char *pattern, char *string, char **pend)
479 switch (c = *pattern++) {
482 * Ok we found an exact match
488 * Check if it is a prefix match
490 if ((dflag == 1) || (*string != '/'))
494 * It is a prefix match, remember where the trailing
500 if ((test = *string++) == '\0')
506 * Collapse multiple *'s.
512 * Optimized hack for pattern with a * at the end
518 * General case, use recursion.
520 while ((test = *string) != '\0') {
521 if (!fn_match(pattern, string, pend))
530 if (((test = *string++) == '\0') ||
531 ((pattern = range_match(pattern, test)) == NULL))
545 range_match(char *pattern, int test)
552 if ((negate = (*pattern == '!')) != 0)
555 while ((c = *pattern++) != ']') {
562 if ((*pattern == '-') && ((c2 = pattern[1]) != '\0') &&
564 if ((c <= test) && (test <= c2))
567 } else if (c == test)
570 return (ok == negate ? NULL : pattern);
575 * modify a selected file name. first attempt to apply replacement string
576 * expressions, then apply interactive file rename. We apply replacement
577 * string expressions to both filenames and file links (if we didn't the
578 * links would point to the wrong place, and we could never be able to
579 * move an archive that has a file link in it). When we rename files
580 * interactively, we store that mapping (old name to user input name) so
581 * if we spot any file links to the old file name in the future, we will
582 * know exactly how to fix the file link.
584 * 0 continue to process file, 1 skip this file, -1 pax is finished
588 mod_name(ARCHD *arcn)
593 * Strip off leading '/' if appropriate.
594 * Currently, this option is only set for the tar format.
596 if (rmleadslash && arcn->name[0] == '/') {
597 if (arcn->name[1] == '\0') {
600 memmove(arcn->name, &arcn->name[1],
604 if (rmleadslash < 2) {
606 paxwarn(0, "Removing leading / from absolute path names in the archive");
609 if (rmleadslash && arcn->ln_name[0] == '/' &&
610 (arcn->type == PAX_HLK || arcn->type == PAX_HRG)) {
611 if (arcn->ln_name[1] == '\0') {
612 arcn->ln_name[0] = '.';
614 memmove(arcn->ln_name, &arcn->ln_name[1],
615 strlen(arcn->ln_name));
618 if (rmleadslash < 2) {
620 paxwarn(0, "Removing leading / from absolute path names in the archive");
625 * IMPORTANT: We have a problem. what do we do with symlinks?
626 * Modifying a hard link name makes sense, as we know the file it
627 * points at should have been seen already in the archive (and if it
628 * wasn't seen because of a read error or a bad archive, we lose
629 * anyway). But there are no such requirements for symlinks. On one
630 * hand the symlink that refers to a file in the archive will have to
631 * be modified to so it will still work at its new location in the
632 * file system. On the other hand a symlink that points elsewhere (and
633 * should continue to do so) should not be modified. There is clearly
634 * no perfect solution here. So we handle them like hardlinks. Clearly
635 * a replacement made by the interactive rename mapping is very likely
636 * to be correct since it applies to a single file and is an exact
637 * match. The regular expression replacements are a little harder to
638 * justify though. We claim that the symlink name is only likely
639 * to be replaced when it points within the file tree being moved and
640 * in that case it should be modified. what we really need to do is to
641 * call an oracle here. :)
643 if (rephead != NULL) {
645 * we have replacement strings, modify the name and the link
648 if ((res = rep_name(arcn->name, &(arcn->nlen), 1)) != 0)
651 if (((arcn->type == PAX_SLK) || (arcn->type == PAX_HLK) ||
652 (arcn->type == PAX_HRG)) &&
653 ((res = rep_name(arcn->ln_name, &(arcn->ln_nlen), 0)) != 0))
659 * perform interactive file rename, then map the link if any
661 if ((res = tty_rename(arcn)) != 0)
663 if ((arcn->type == PAX_SLK) || (arcn->type == PAX_HLK) ||
664 (arcn->type == PAX_HRG))
665 sub_name(arcn->ln_name, &(arcn->ln_nlen), sizeof(arcn->ln_name));
672 * Prompt the user for a replacement file name. A "." keeps the old name,
673 * a empty line skips the file, and an EOF on reading the tty, will cause
674 * pax to stop processing and exit. Otherwise the file name input, replaces
677 * 0 process this file, 1 skip this file, -1 we need to exit pax
681 tty_rename(ARCHD *arcn)
683 char tmpname[PAXPATHLEN+2];
687 * prompt user for the replacement name for a file, keep trying until
688 * we get some reasonable input. Archives may have more than one file
689 * on them with the same name (from updates etc). We print verbose info
690 * on the file so the user knows what is up.
692 tty_prnt("\nATTENTION: %s interactive file rename operation.\n", argv0);
696 tty_prnt("Input new name, or a \".\" to keep the old name, ");
697 tty_prnt("or a \"return\" to skip this file.\n");
698 tty_prnt("Input > ");
699 if (tty_read(tmpname, sizeof(tmpname)) < 0)
701 if (strcmp(tmpname, "..") == 0) {
702 tty_prnt("Try again, illegal file name: ..\n");
705 if (strlen(tmpname) > PAXPATHLEN) {
706 tty_prnt("Try again, file name too long\n");
713 * empty file name, skips this file. a "." leaves it alone
715 if (tmpname[0] == '\0') {
716 tty_prnt("Skipping file.\n");
719 if ((tmpname[0] == '.') && (tmpname[1] == '\0')) {
720 tty_prnt("Processing continues, name unchanged.\n");
725 * ok the name changed. We may run into links that point at this
726 * file later. we have to remember where the user sent the file
727 * in order to repair any links.
729 tty_prnt("Processing continues, name changed to: %s\n", tmpname);
730 res = add_name(arcn->name, arcn->nlen, tmpname);
731 arcn->nlen = l_strncpy(arcn->name, tmpname, sizeof(arcn->name) - 1);
732 arcn->name[arcn->nlen] = '\0';
740 * fix up the file name and the link name (if any) so this file will land
741 * in the destination directory (used during copy() -rw).
743 * 0 if ok, -1 if failure (name too long)
747 set_dest(ARCHD *arcn, char *dest_dir, int dir_len)
749 if (fix_path(arcn->name, &(arcn->nlen), dest_dir, dir_len) < 0)
753 * It is really hard to deal with symlinks here, we cannot be sure
754 * if the name they point was moved (or will be moved). It is best to
757 if ((arcn->type != PAX_HLK) && (arcn->type != PAX_HRG))
760 if (fix_path(arcn->ln_name, &(arcn->ln_nlen), dest_dir, dir_len) < 0)
767 * concatenate dir_name and or_name and store the result in or_name (if
768 * it fits). This is one ugly function.
770 * 0 if ok, -1 if the final name is too long
774 fix_path( char *or_name, int *or_len, char *dir_name, int dir_len)
782 * we shift the or_name to the right enough to tack in the dir_name
783 * at the front. We make sure we have enough space for it all before
784 * we start. since dest always ends in a slash, we skip of or_name
785 * if it also starts with one.
788 src = start + *or_len;
789 dest = src + dir_len;
794 if ((len = dest - or_name) > PAXPATHLEN) {
795 paxwarn(1, "File name %s/%s, too long", dir_name, start);
801 * enough space, shift
805 src = dir_name + dir_len - 1;
808 * splice in the destination directory name
810 while (src >= dir_name)
813 *(or_name + len) = '\0';
819 * walk down the list of replacement strings applying each one in order.
820 * when we find one with a successful substitution, we modify the name
821 * as specified. if required, we print the results. if the resulting name
822 * is empty, we will skip this archive member. We use the regexp(3)
823 * routines (regexp() ought to win a prize as having the most cryptic
824 * library function manual page).
826 * name is the file name we are going to apply the regular expressions to
827 * (and may be modified)
828 * nlen is the length of this name (and is modified to hold the length of
830 * prnt is a flag that says whether to print the final result.
832 * 0 if substitution was successful, 1 if we are to skip the file (the name
837 rep_name(char *name, int *nlen, int prnt)
846 regmatch_t pm[MAXSUBEXP];
847 char nname[PAXPATHLEN+1]; /* final result of all replacements */
848 char buf1[PAXPATHLEN+1]; /* where we work on the name */
851 * copy the name into buf1, where we will work on it. We need to keep
852 * the orig string around so we can print out the result of the final
853 * replacement. We build up the final result in nname. inpt points at
854 * the string we apply the regular expression to. prnt is used to
855 * suppress printing when we handle replacements on the link field
856 * (the user already saw that substitution go by)
862 endpt = outpt + PAXPATHLEN;
865 * try each replacement string in order
870 * check for a successful substitution, if not go to
871 * the next pattern, or cleanup if we were global
873 if (regexec(&(pt->rcmp), inpt, MAXSUBEXP, pm, 0) != 0)
877 * ok we found one. We have three parts, the prefix
878 * which did not match, the section that did and the
879 * tail (that also did not match). Copy the prefix to
880 * the final output buffer (watching to make sure we
881 * do not create a string too long).
884 rpt = inpt + pm[0].rm_so;
886 while ((inpt < rpt) && (outpt < endpt))
892 * for the second part (which matched the regular
893 * expression) apply the substitution using the
894 * replacement string and place it the prefix in the
895 * final output. If we have problems, skip it.
897 if ((res = resub(&(pt->rcmp),pm,pt->nstr,outpt,endpt))
900 paxwarn(1, "Replacement name error %s",
907 * we set up to look again starting at the first
908 * character in the tail (of the input string right
909 * after the last character matched by the regular
910 * expression (inpt always points at the first char in
911 * the string to process). If we are not doing a global
912 * substitution, we will use inpt to copy the tail to
913 * the final result. Make sure we do not overrun the
916 inpt += pm[0].rm_eo - pm[0].rm_so;
918 if ((outpt == endpt) || (*inpt == '\0'))
922 * if the user wants global we keep trying to
923 * substitute until it fails, then we are done.
925 } while (pt->flgs & GLOB);
931 * a successful substitution did NOT occur, try the next one
938 * we had a substitution, copy the last tail piece (if there is
939 * room) to the final result
941 while ((outpt < endpt) && (*inpt != '\0'))
945 if ((outpt == endpt) && (*inpt != '\0')) {
947 paxwarn(1,"Replacement name too long %s >> %s",
953 * inform the user of the result if wanted
955 if (prnt && (pt->flgs & PRNT)) {
957 fprintf(stderr,"%s >> <empty string>\n",
960 fprintf(stderr,"%s >> %s\n", name, nname);
964 * if empty inform the caller this file is to be skipped
965 * otherwise copy the new name over the orig name and return
969 *nlen = l_strncpy(name, nname, PAXPATHLEN + 1);
970 name[PAXPATHLEN] = '\0';
977 * apply the replacement to the matched expression. expand out the old
978 * style ed(1) subexpression expansion.
980 * -1 if error, or the number of characters added to the destination.
984 resub(regex_t *rp, regmatch_t *pm, char *src, char *dest,
996 subexcnt = rp->re_nsub;
997 while ((dpt < destend) && ((c = *spt++) != '\0')) {
999 * see if we just have an ordinary replacement character
1000 * or we refer to a subexpression.
1004 } else if ((c == '\\') && (*spt >= '0') && (*spt <= '9')) {
1006 * make sure there is a subexpression as specified
1008 if ((len = *spt++ - '0') > subexcnt)
1013 * Ordinary character, just copy it
1015 if ((c == '\\') && ((*spt == '\\') || (*spt == '&')))
1022 * continue if the subexpression is bogus
1024 if ((pmpt->rm_so < 0) || (pmpt->rm_eo < 0) ||
1025 ((len = pmpt->rm_eo - pmpt->rm_so) <= 0))
1029 * copy the subexpression to the destination.
1030 * fail if we run out of space or the match string is damaged
1032 if (len > (destend - dpt))
1033 len = destend - dpt;
1034 if (l_strncpy(dpt, src + pmpt->rm_so, len) != len)