1 /* $OpenBSD: pat_rep.c,v 1.32 2012/12/04 02:24:45 deraadt Exp $ */
2 /* $NetBSD: pat_rep.c,v 1.4 1995/03/21 09:07:33 cgd Exp $ */
5 * Copyright (c) 1992 Keith Muller.
6 * Copyright (c) 1992, 1993
7 * The Regents of the University of California. All rights reserved.
9 * This code is derived from software contributed to Berkeley by
10 * Keith Muller of the University of California, San Diego.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #include <sys/types.h>
51 * routines to handle pattern matching, name modification (regular expression
52 * substitution and interactive renames), and destination name modification for
53 * copy (-rw). Both file name and link names are adjusted as required in these
57 #define MAXSUBEXP 10 /* max subexpressions, DO NOT CHANGE */
58 static PATTERN
*pathead
= NULL
; /* file pattern match list head */
59 static PATTERN
*pattail
= NULL
; /* file pattern match list tail */
60 static REPLACE
*rephead
= NULL
; /* replacement string list head */
61 static REPLACE
*reptail
= NULL
; /* replacement string list tail */
63 static int rep_name(char *, size_t, int *, int);
64 static int tty_rename(ARCHD
*);
65 static int fix_path(char *, int *, char *, int);
66 static int fn_match(char *, char *, char **);
67 static char * range_match(char *, int);
68 static int resub(regex_t
*, regmatch_t
*, char *, char *, char *, char *);
72 * parses the -s replacement string; compiles the regular expression
73 * and stores the compiled value and it's replacement string together in
74 * replacement string list. Input to this function is of the form:
76 * The first char in the string specifies the delimiter used by this
77 * replacement string. "Old" is a regular expression in "ed" format which
78 * is compiled by regcomp() and is applied to filenames. "new" is the
79 * substitution string; p and g are options flags for printing and global
80 * replacement (over the single filename)
82 * 0 if a proper replacement string and regular expression was added to
83 * the list of replacement patterns; -1 otherwise.
96 * throw out the bad parameters
98 if ((str
== NULL
) || (*str
== '\0')) {
99 paxwarn(1, "Empty replacement string");
104 * first character in the string specifies what the delimiter is for
107 for (pt1
= str
+1; *pt1
; pt1
++) {
116 paxwarn(1, "Invalid replacement string %s", str
);
121 * allocate space for the node that handles this replacement pattern
122 * and split out the regular expression and try to compile it
124 if ((rep
= (REPLACE
*)malloc(sizeof(REPLACE
))) == NULL
) {
125 paxwarn(1, "Unable to allocate memory for replacement string");
130 if ((res
= regcomp(&(rep
->rcmp
), str
+1, 0)) != 0) {
131 regerror(res
, &(rep
->rcmp
), rebuf
, sizeof(rebuf
));
132 paxwarn(1, "%s while compiling regular expression %s", rebuf
, str
);
133 (void)free((char *)rep
);
138 * put the delimiter back in case we need an error message and
139 * locate the delimiter at the end of the replacement string
140 * we then point the node at the new substitution string
143 for (pt2
= pt1
; *pt2
; pt2
++) {
152 regfree(&(rep
->rcmp
));
153 (void)free((char *)rep
);
154 paxwarn(1, "Invalid replacement string %s", str
);
164 * set the options if any
166 while (*pt2
!= '\0') {
177 regfree(&(rep
->rcmp
));
178 (void)free((char *)rep
);
180 paxwarn(1, "Invalid replacement string option %s", str
);
187 * all done, link it in at the end
190 if (rephead
== NULL
) {
191 reptail
= rephead
= rep
;
201 * add a pattern match to the pattern match list. Pattern matches are used
202 * to select which archive members are extracted. (They appear as
203 * arguments to pax in the list and read modes). If no patterns are
204 * supplied to pax, all members in the archive will be selected (and the
205 * pattern match list is empty).
207 * 0 if the pattern was added to the list, -1 otherwise
211 pat_add(char *str
, char *chdname
)
218 if ((str
== NULL
) || (*str
== '\0')) {
219 paxwarn(1, "Empty pattern string");
224 * allocate space for the pattern and store the pattern. the pattern is
225 * part of argv so do not bother to copy it, just point at it. Add the
226 * node to the end of the pattern list
228 if ((pt
= (PATTERN
*)malloc(sizeof(PATTERN
))) == NULL
) {
229 paxwarn(1, "Unable to allocate memory for pattern string");
235 pt
->plen
= strlen(str
);
238 pt
->chdname
= chdname
;
240 if (pathead
== NULL
) {
241 pattail
= pathead
= pt
;
251 * complain if any the user supplied pattern did not result in a match to
252 * a selected archive member.
262 * walk down the list checking the flags to make sure MTCH was set,
265 for (pt
= pathead
; pt
!= NULL
; pt
= pt
->fow
) {
269 paxwarn(1, "WARNING! These patterns were not matched:");
272 (void)fprintf(stderr
, "%s\n", pt
->pstr
);
278 * the archive member which matches a pattern was selected. Mark the
279 * pattern as having selected an archive member. arcn->pat points at the
280 * pattern that was matched. arcn->pat is set in pat_match()
282 * NOTE: When the -c option is used, we are called when there was no match
283 * by pat_match() (that means we did match before the inverted sense of
284 * the logic). Now this seems really strange at first, but with -c we
285 * need to keep track of those patterns that cause an archive member to NOT
286 * be selected (it found an archive member with a specified pattern)
288 * 0 if the pattern pointed at by arcn->pat was tagged as creating a
289 * match, -1 otherwise.
300 * if no patterns just return
302 if ((pathead
== NULL
) || ((pt
= arcn
->pat
) == NULL
))
306 * when we are NOT limited to a single match per pattern mark the
315 * we reach this point only when we allow a single selected match per
316 * pattern, if the pattern matches a directory and we do not have -d
317 * (dflag) we are done with this pattern. We may also be handed a file
318 * in the subtree of a directory. in that case when we are operating
319 * with -d, this pattern was already selected and we are done
321 if (pt
->flgs
& DIR_MTCH
)
324 if (!dflag
&& ((pt
->pend
!= NULL
) || (arcn
->type
== PAX_DIR
))) {
326 * ok we matched a directory and we are allowing
327 * subtree matches but because of the -n only its children will
328 * match. This is tagged as a DIR_MTCH type.
329 * WATCH IT, the code assumes that pt->pend points
330 * into arcn->name and arcn->name has not been modified.
331 * If not we will have a big mess. Yup this is another kludge
335 * if this was a prefix match, remove trailing part of path
336 * so we can copy it. Future matches will be exact prefix match
338 if (pt
->pend
!= NULL
)
341 if ((pt
->pstr
= strdup(arcn
->name
)) == NULL
) {
342 paxwarn(1, "Pattern select out of memory");
343 if (pt
->pend
!= NULL
)
350 * put the trailing / back in the source string
352 if (pt
->pend
!= NULL
) {
356 pt
->plen
= strlen(pt
->pstr
);
359 * strip off any trailing /, this should really never happen
362 if (*(pt
->pstr
+ len
) == '/') {
363 *(pt
->pstr
+ len
) = '\0';
366 pt
->flgs
= DIR_MTCH
| MTCH
;
372 * we are then done with this pattern, so we delete it from the list
373 * because it can never be used for another match.
374 * Seems kind of strange to do for a -c, but the pax spec is really
375 * vague on the interaction of -c, -n and -d. We assume that when -c
376 * and the pattern rejects a member (i.e. it matched it) it is done.
377 * In effect we place the order of the flags as having -c last.
381 while ((pt
!= NULL
) && (pt
!= arcn
->pat
)) {
388 * should never happen....
390 paxwarn(1, "Pattern list inconsistent");
394 (void)free((char *)pt
);
401 * see if this archive member matches any supplied pattern, if a match
402 * is found, arcn->pat is set to point at the potential pattern. Later if
403 * this archive member is "selected" we process and mark the pattern as
404 * one which matched a selected archive member (see pat_sel())
406 * 0 if this archive member should be processed, 1 if it should be
407 * skipped and -1 if we are done with all patterns (and pax should quit
408 * looking for more members)
412 pat_match(ARCHD
*arcn
)
419 * if there are no more patterns and we have -n (and not -c) we are
420 * done. otherwise with no patterns to match, matches all
422 if (pathead
== NULL
) {
429 * have to search down the list one at a time looking for a match.
434 * check for a file name match unless we have DIR_MTCH set in
435 * this pattern then we want a prefix match
437 if (pt
->flgs
& DIR_MTCH
) {
439 * this pattern was matched before to a directory
440 * as we must have -n set for this (but not -d). We can
441 * only match CHILDREN of that directory so we must use
442 * an exact prefix match (no wildcards).
444 if ((arcn
->name
[pt
->plen
] == '/') &&
445 (strncmp(pt
->pstr
, arcn
->name
, pt
->plen
) == 0))
447 } else if (fn_match(pt
->pstr
, arcn
->name
, &pt
->pend
) == 0)
453 * return the result, remember that cflag (-c) inverts the sense of a
457 return(cflag
? 0 : 1);
460 * we had a match, now when we invert the sense (-c) we reject this
461 * member. However we have to tag the pattern a being successful, (in a
462 * match, not in selecting a archive member) so we call pat_sel() here.
468 if (pat_sel(arcn
) < 0)
477 * 0 if this archive member should be processed, 1 if it should be
478 * skipped and -1 if we are done with all patterns (and pax should quit
479 * looking for more members)
480 * Note: *pend may be changed to show where the prefix ends.
484 fn_match(char *pattern
, char *string
, char **pend
)
491 switch (c
= *pattern
++) {
494 * Ok we found an exact match
500 * Check if it is a prefix match
502 if ((dflag
== 1) || (*string
!= '/'))
506 * It is a prefix match, remember where the trailing
512 if ((test
= *string
++) == '\0')
518 * Collapse multiple *'s.
524 * Optimized hack for pattern with a * at the end
530 * General case, use recursion.
532 while ((test
= *string
) != '\0') {
533 if (!fn_match(pattern
, string
, pend
))
542 if (((test
= *string
++) == '\0') ||
543 ((pattern
= range_match(pattern
, test
)) == NULL
))
557 range_match(char *pattern
, int test
)
564 if ((negate
= (*pattern
== '!')) != 0)
567 while ((c
= *pattern
++) != ']') {
574 if ((*pattern
== '-') && ((c2
= pattern
[1]) != '\0') &&
576 if ((c
<= test
) && (test
<= c2
))
579 } else if (c
== test
)
582 return (ok
== negate
? NULL
: pattern
);
587 * modify a selected file name. first attempt to apply replacement string
588 * expressions, then apply interactive file rename. We apply replacement
589 * string expressions to both filenames and file links (if we didn't the
590 * links would point to the wrong place, and we could never be able to
591 * move an archive that has a file link in it). When we rename files
592 * interactively, we store that mapping (old name to user input name) so
593 * if we spot any file links to the old file name in the future, we will
594 * know exactly how to fix the file link.
596 * 0 continue to process file, 1 skip this file, -1 pax is finished
600 mod_name(ARCHD
*arcn
)
605 * Strip off leading '/' if appropriate.
606 * Currently, this option is only set for the tar format.
608 while (rmleadslash
&& arcn
->name
[0] == '/') {
609 if (arcn
->name
[1] == '\0') {
612 (void)memmove(arcn
->name
, &arcn
->name
[1],
616 if (rmleadslash
< 2) {
618 paxwarn(0, "Removing leading / from absolute path names in the archive");
621 while (rmleadslash
&& arcn
->ln_name
[0] == '/' &&
622 (arcn
->type
== PAX_HLK
|| arcn
->type
== PAX_HRG
)) {
623 if (arcn
->ln_name
[1] == '\0') {
624 arcn
->ln_name
[0] = '.';
626 (void)memmove(arcn
->ln_name
, &arcn
->ln_name
[1],
627 strlen(arcn
->ln_name
));
630 if (rmleadslash
< 2) {
632 paxwarn(0, "Removing leading / from absolute path names in the archive");
637 * IMPORTANT: We have a problem. what do we do with symlinks?
638 * Modifying a hard link name makes sense, as we know the file it
639 * points at should have been seen already in the archive (and if it
640 * wasn't seen because of a read error or a bad archive, we lose
641 * anyway). But there are no such requirements for symlinks. On one
642 * hand the symlink that refers to a file in the archive will have to
643 * be modified to so it will still work at its new location in the
644 * file system. On the other hand a symlink that points elsewhere (and
645 * should continue to do so) should not be modified. There is clearly
646 * no perfect solution here. So we handle them like hardlinks. Clearly
647 * a replacement made by the interactive rename mapping is very likely
648 * to be correct since it applies to a single file and is an exact
649 * match. The regular expression replacements are a little harder to
650 * justify though. We claim that the symlink name is only likely
651 * to be replaced when it points within the file tree being moved and
652 * in that case it should be modified. what we really need to do is to
653 * call an oracle here. :)
655 if (rephead
!= NULL
) {
657 * we have replacement strings, modify the name and the link
660 if ((res
= rep_name(arcn
->name
, sizeof(arcn
->name
), &(arcn
->nlen
), 1)) != 0)
663 if (((arcn
->type
== PAX_SLK
) || (arcn
->type
== PAX_HLK
) ||
664 (arcn
->type
== PAX_HRG
)) &&
665 ((res
= rep_name(arcn
->ln_name
, sizeof(arcn
->ln_name
), &(arcn
->ln_nlen
), 0)) != 0))
671 * perform interactive file rename, then map the link if any
673 if ((res
= tty_rename(arcn
)) != 0)
675 if ((arcn
->type
== PAX_SLK
) || (arcn
->type
== PAX_HLK
) ||
676 (arcn
->type
== PAX_HRG
))
677 sub_name(arcn
->ln_name
, &(arcn
->ln_nlen
), sizeof(arcn
->ln_name
));
684 * Prompt the user for a replacement file name. A "." keeps the old name,
685 * a empty line skips the file, and an EOF on reading the tty, will cause
686 * pax to stop processing and exit. Otherwise the file name input, replaces
689 * 0 process this file, 1 skip this file, -1 we need to exit pax
693 tty_rename(ARCHD
*arcn
)
695 char tmpname
[PAXPATHLEN
+2];
699 * prompt user for the replacement name for a file, keep trying until
700 * we get some reasonable input. Archives may have more than one file
701 * on them with the same name (from updates etc). We print verbose info
702 * on the file so the user knows what is up.
704 tty_prnt("\nATTENTION: %s interactive file rename operation.\n", argv0
);
708 tty_prnt("Input new name, or a \".\" to keep the old name, ");
709 tty_prnt("or a \"return\" to skip this file.\n");
710 tty_prnt("Input > ");
711 if (tty_read(tmpname
, sizeof(tmpname
)) < 0)
713 if (strcmp(tmpname
, "..") == 0) {
714 tty_prnt("Try again, illegal file name: ..\n");
717 if (strlen(tmpname
) > PAXPATHLEN
) {
718 tty_prnt("Try again, file name too long\n");
725 * empty file name, skips this file. a "." leaves it alone
727 if (tmpname
[0] == '\0') {
728 tty_prnt("Skipping file.\n");
731 if ((tmpname
[0] == '.') && (tmpname
[1] == '\0')) {
732 tty_prnt("Processing continues, name unchanged.\n");
737 * ok the name changed. We may run into links that point at this
738 * file later. we have to remember where the user sent the file
739 * in order to repair any links.
741 tty_prnt("Processing continues, name changed to: %s\n", tmpname
);
742 res
= add_name(arcn
->name
, arcn
->nlen
, tmpname
);
743 arcn
->nlen
= strlcpy(arcn
->name
, tmpname
, sizeof(arcn
->name
));
744 if (arcn
->nlen
>= sizeof(arcn
->name
))
745 arcn
->nlen
= sizeof(arcn
->name
) - 1; /* XXX truncate? */
753 * fix up the file name and the link name (if any) so this file will land
754 * in the destination directory (used during copy() -rw).
756 * 0 if ok, -1 if failure (name too long)
760 set_dest(ARCHD
*arcn
, char *dest_dir
, int dir_len
)
762 if (fix_path(arcn
->name
, &(arcn
->nlen
), dest_dir
, dir_len
) < 0)
766 * It is really hard to deal with symlinks here, we cannot be sure
767 * if the name they point was moved (or will be moved). It is best to
770 if ((arcn
->type
!= PAX_HLK
) && (arcn
->type
!= PAX_HRG
))
773 if (fix_path(arcn
->ln_name
, &(arcn
->ln_nlen
), dest_dir
, dir_len
) < 0)
780 * concatenate dir_name and or_name and store the result in or_name (if
781 * it fits). This is one ugly function.
783 * 0 if ok, -1 if the final name is too long
787 fix_path(char *or_name
, int *or_len
, char *dir_name
, int dir_len
)
795 * we shift the or_name to the right enough to tack in the dir_name
796 * at the front. We make sure we have enough space for it all before
797 * we start. since dest always ends in a slash, we skip of or_name
798 * if it also starts with one.
801 src
= start
+ *or_len
;
802 dest
= src
+ dir_len
;
807 if ((len
= dest
- or_name
) > PAXPATHLEN
) {
808 paxwarn(1, "File name %s/%s, too long", dir_name
, start
);
814 * enough space, shift
818 src
= dir_name
+ dir_len
- 1;
821 * splice in the destination directory name
823 while (src
>= dir_name
)
826 *(or_name
+ len
) = '\0';
832 * walk down the list of replacement strings applying each one in order.
833 * when we find one with a successful substitution, we modify the name
834 * as specified. if required, we print the results. if the resulting name
835 * is empty, we will skip this archive member. We use the regexp(3)
836 * routines (regexp() ought to win a prize as having the most cryptic
837 * library function manual page).
839 * name is the file name we are going to apply the regular expressions to
840 * (and may be modified)
841 * nsize is the size of the name buffer.
842 * nlen is the length of this name (and is modified to hold the length of
844 * prnt is a flag that says whether to print the final result.
846 * 0 if substitution was successful, 1 if we are to skip the file (the name
851 rep_name(char *name
, size_t nsize
, int *nlen
, int prnt
)
860 regmatch_t pm
[MAXSUBEXP
];
861 char nname
[PAXPATHLEN
+1]; /* final result of all replacements */
862 char buf1
[PAXPATHLEN
+1]; /* where we work on the name */
865 * copy the name into buf1, where we will work on it. We need to keep
866 * the orig string around so we can print out the result of the final
867 * replacement. We build up the final result in nname. inpt points at
868 * the string we apply the regular expression to. prnt is used to
869 * suppress printing when we handle replacements on the link field
870 * (the user already saw that substitution go by)
873 (void)strlcpy(buf1
, name
, sizeof(buf1
));
876 endpt
= outpt
+ PAXPATHLEN
;
879 * try each replacement string in order
885 * check for a successful substitution, if not go to
886 * the next pattern, or cleanup if we were global
888 if (regexec(&(pt
->rcmp
), inpt
, MAXSUBEXP
, pm
, 0) != 0)
892 * ok we found one. We have three parts, the prefix
893 * which did not match, the section that did and the
894 * tail (that also did not match). Copy the prefix to
895 * the final output buffer (watching to make sure we
896 * do not create a string too long).
899 rpt
= inpt
+ pm
[0].rm_so
;
901 while ((inpt
< rpt
) && (outpt
< endpt
))
907 * for the second part (which matched the regular
908 * expression) apply the substitution using the
909 * replacement string and place it the prefix in the
910 * final output. If we have problems, skip it.
912 if ((res
= resub(&(pt
->rcmp
),pm
,pt
->nstr
,oinpt
,outpt
,endpt
))
915 paxwarn(1, "Replacement name error %s",
922 * we set up to look again starting at the first
923 * character in the tail (of the input string right
924 * after the last character matched by the regular
925 * expression (inpt always points at the first char in
926 * the string to process). If we are not doing a global
927 * substitution, we will use inpt to copy the tail to
928 * the final result. Make sure we do not overrun the
931 inpt
+= pm
[0].rm_eo
- pm
[0].rm_so
;
933 if ((outpt
== endpt
) || (*inpt
== '\0'))
937 * if the user wants global we keep trying to
938 * substitute until it fails, then we are done.
940 } while (pt
->flgs
& GLOB
);
946 * a successful substitution did NOT occur, try the next one
953 * we had a substitution, copy the last tail piece (if there is
954 * room) to the final result
956 while ((outpt
< endpt
) && (*inpt
!= '\0'))
960 if ((outpt
== endpt
) && (*inpt
!= '\0')) {
962 paxwarn(1,"Replacement name too long %s >> %s",
968 * inform the user of the result if wanted
970 if (prnt
&& (pt
->flgs
& PRNT
)) {
972 (void)fprintf(stderr
,"%s >> <empty string>\n",
975 (void)fprintf(stderr
,"%s >> %s\n", name
, nname
);
979 * if empty inform the caller this file is to be skipped
980 * otherwise copy the new name over the orig name and return
984 *nlen
= strlcpy(name
, nname
, nsize
);
991 * apply the replacement to the matched expression. expand out the old
992 * style ed(1) subexpression expansion.
994 * -1 if error, or the number of characters added to the destination.
998 resub(regex_t
*rp
, regmatch_t
*pm
, char *src
, char *inpt
, char *dest
,
1010 subexcnt
= rp
->re_nsub
;
1011 while ((dpt
< destend
) && ((c
= *spt
++) != '\0')) {
1013 * see if we just have an ordinary replacement character
1014 * or we refer to a subexpression.
1018 } else if ((c
== '\\') && (*spt
>= '0') && (*spt
<= '9')) {
1020 * make sure there is a subexpression as specified
1022 if ((len
= *spt
++ - '0') > subexcnt
)
1027 * Ordinary character, just copy it
1029 if ((c
== '\\') && (*spt
!= '\0'))
1036 * continue if the subexpression is bogus
1038 if ((pmpt
->rm_so
< 0) || (pmpt
->rm_eo
< 0) ||
1039 ((len
= pmpt
->rm_eo
- pmpt
->rm_so
) <= 0))
1043 * copy the subexpression to the destination.
1044 * fail if we run out of space or the match string is damaged
1046 if (len
> (destend
- dpt
))
1048 strncpy(dpt
, inpt
+ pmpt
->rm_so
, len
);