1 /* $OpenBSD: pat_rep.c,v 1.41 2016/08/26 04:19:28 guenther 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>
48 * data structure for storing user supplied replacement strings (-s)
50 typedef struct replace
{
51 char *nstr
; /* the new string we will substitute with */
52 regex_t rcmp
; /* compiled regular expression used to match */
53 int flgs
; /* print conversions? global in operation? */
56 struct replace
*fow
; /* pointer to next pattern */
60 * routines to handle pattern matching, name modification (regular expression
61 * substitution and interactive renames), and destination name modification for
62 * copy (-rw). Both file name and link names are adjusted as required in these
66 #define MAXSUBEXP 10 /* max subexpressions, DO NOT CHANGE */
67 static PATTERN
*pathead
= NULL
; /* file pattern match list head */
68 static PATTERN
*pattail
= NULL
; /* file pattern match list tail */
69 static REPLACE
*rephead
= NULL
; /* replacement string list head */
70 static REPLACE
*reptail
= NULL
; /* replacement string list tail */
72 static int rep_name(char *, size_t, int *, int);
73 static int tty_rename(ARCHD
*);
74 static int fix_path(char *, int *, char *, int);
75 static int fn_match(char *, char *, char **);
76 static char * range_match(char *, int);
77 static int resub(regex_t
*, regmatch_t
*, char *, char *, char *, char *);
81 * parses the -s replacement string; compiles the regular expression
82 * and stores the compiled value and it's replacement string together in
83 * replacement string list. Input to this function is of the form:
85 * The first char in the string specifies the delimiter used by this
86 * replacement string. "Old" is a regular expression in "ed" format which
87 * is compiled by regcomp() and is applied to filenames. "new" is the
88 * substitution string; p and g are options flags for printing and global
89 * replacement (over the single filename)
91 * 0 if a proper replacement string and regular expression was added to
92 * the list of replacement patterns; -1 otherwise.
105 * throw out the bad parameters
107 if ((str
== NULL
) || (*str
== '\0')) {
108 paxwarn(1, "Empty replacement string");
113 * first character in the string specifies what the delimiter is for
116 for (pt1
= str
+1; *pt1
; pt1
++) {
125 paxwarn(1, "Invalid replacement string %s", str
);
130 * allocate space for the node that handles this replacement pattern
131 * and split out the regular expression and try to compile it
133 if ((rep
= malloc(sizeof(REPLACE
))) == NULL
) {
134 paxwarn(1, "Unable to allocate memory for replacement string");
139 if ((res
= regcomp(&(rep
->rcmp
), str
+1, 0)) != 0) {
140 regerror(res
, &(rep
->rcmp
), rebuf
, sizeof(rebuf
));
141 paxwarn(1, "%s while compiling regular expression %s", rebuf
, str
);
147 * put the delimiter back in case we need an error message and
148 * locate the delimiter at the end of the replacement string
149 * we then point the node at the new substitution string
152 for (pt2
= pt1
; *pt2
; pt2
++) {
161 regfree(&(rep
->rcmp
));
163 paxwarn(1, "Invalid replacement string %s", str
);
173 * set the options if any
175 while (*pt2
!= '\0') {
186 regfree(&(rep
->rcmp
));
189 paxwarn(1, "Invalid replacement string option %s", str
);
196 * all done, link it in at the end
199 if (rephead
== NULL
) {
200 reptail
= rephead
= rep
;
210 * add a pattern match to the pattern match list. Pattern matches are used
211 * to select which archive members are extracted. (They appear as
212 * arguments to pax in the list and read modes). If no patterns are
213 * supplied to pax, all members in the archive will be selected (and the
214 * pattern match list is empty).
216 * 0 if the pattern was added to the list, -1 otherwise
220 pat_add(char *str
, char *chdirname
)
227 if ((str
== NULL
) || (*str
== '\0')) {
228 paxwarn(1, "Empty pattern string");
233 * allocate space for the pattern and store the pattern. the pattern is
234 * part of argv so do not bother to copy it, just point at it. Add the
235 * node to the end of the pattern list
237 if ((pt
= malloc(sizeof(PATTERN
))) == NULL
) {
238 paxwarn(1, "Unable to allocate memory for pattern string");
244 pt
->plen
= strlen(str
);
247 pt
->chdname
= chdirname
;
249 if (pathead
== NULL
) {
250 pattail
= pathead
= pt
;
260 * complain if any the user supplied pattern did not result in a match to
261 * a selected archive member.
271 * walk down the list checking the flags to make sure MTCH was set,
274 for (pt
= pathead
; pt
!= NULL
; pt
= pt
->fow
) {
278 paxwarn(1, "WARNING! These patterns were not matched:");
281 (void)fprintf(stderr
, "%s\n", pt
->pstr
);
287 * the archive member which matches a pattern was selected. Mark the
288 * pattern as having selected an archive member. arcn->pat points at the
289 * pattern that was matched. arcn->pat is set in pat_match()
291 * NOTE: When the -c option is used, we are called when there was no match
292 * by pat_match() (that means we did match before the inverted sense of
293 * the logic). Now this seems really strange at first, but with -c we
294 * need to keep track of those patterns that cause an archive member to NOT
295 * be selected (it found an archive member with a specified pattern)
297 * 0 if the pattern pointed at by arcn->pat was tagged as creating a
298 * match, -1 otherwise.
309 * if no patterns just return
311 if ((pathead
== NULL
) || ((pt
= arcn
->pat
) == NULL
))
315 * when we are NOT limited to a single match per pattern mark the
324 * we reach this point only when we allow a single selected match per
325 * pattern, if the pattern matches a directory and we do not have -d
326 * (dflag) we are done with this pattern. We may also be handed a file
327 * in the subtree of a directory. in that case when we are operating
328 * with -d, this pattern was already selected and we are done
330 if (pt
->flgs
& DIR_MTCH
)
333 if (!dflag
&& ((pt
->pend
!= NULL
) || (arcn
->type
== PAX_DIR
))) {
335 * ok we matched a directory and we are allowing
336 * subtree matches but because of the -n only its children will
337 * match. This is tagged as a DIR_MTCH type.
338 * WATCH IT, the code assumes that pt->pend points
339 * into arcn->name and arcn->name has not been modified.
340 * If not we will have a big mess. Yup this is another kludge
344 * if this was a prefix match, remove trailing part of path
345 * so we can copy it. Future matches will be exact prefix match
347 if (pt
->pend
!= NULL
)
350 if ((pt
->pstr
= strdup(arcn
->name
)) == NULL
) {
351 paxwarn(1, "Pattern select out of memory");
352 if (pt
->pend
!= NULL
)
359 * put the trailing / back in the source string
361 if (pt
->pend
!= NULL
) {
365 pt
->plen
= strlen(pt
->pstr
);
368 * strip off any trailing /, this should really never happen
371 if (*(pt
->pstr
+ len
) == '/') {
372 *(pt
->pstr
+ len
) = '\0';
375 pt
->flgs
= DIR_MTCH
| MTCH
;
381 * we are then done with this pattern, so we delete it from the list
382 * because it can never be used for another match.
383 * Seems kind of strange to do for a -c, but the pax spec is really
384 * vague on the interaction of -c, -n and -d. We assume that when -c
385 * and the pattern rejects a member (i.e. it matched it) it is done.
386 * In effect we place the order of the flags as having -c last.
390 while ((pt
!= NULL
) && (pt
!= arcn
->pat
)) {
397 * should never happen....
399 paxwarn(1, "Pattern list inconsistent");
410 * see if this archive member matches any supplied pattern, if a match
411 * is found, arcn->pat is set to point at the potential pattern. Later if
412 * this archive member is "selected" we process and mark the pattern as
413 * one which matched a selected archive member (see pat_sel())
415 * 0 if this archive member should be processed, 1 if it should be
416 * skipped and -1 if we are done with all patterns (and pax should quit
417 * looking for more members)
421 pat_match(ARCHD
*arcn
)
428 * if there are no more patterns and we have -n (and not -c) we are
429 * done. otherwise with no patterns to match, matches all
431 if (pathead
== NULL
) {
438 * have to search down the list one at a time looking for a match.
443 * check for a file name match unless we have DIR_MTCH set in
444 * this pattern then we want a prefix match
446 if (pt
->flgs
& DIR_MTCH
) {
448 * this pattern was matched before to a directory
449 * as we must have -n set for this (but not -d). We can
450 * only match CHILDREN of that directory so we must use
451 * an exact prefix match (no wildcards).
453 if ((arcn
->name
[pt
->plen
] == '/') &&
454 (strncmp(pt
->pstr
, arcn
->name
, pt
->plen
) == 0))
456 } else if (fn_match(pt
->pstr
, arcn
->name
, &pt
->pend
) == 0)
462 * return the result, remember that cflag (-c) inverts the sense of a
466 return(cflag
? 0 : 1);
469 * we had a match, now when we invert the sense (-c) we reject this
470 * member. However we have to tag the pattern a being successful, (in a
471 * match, not in selecting a archive member) so we call pat_sel() here.
477 if (pat_sel(arcn
) < 0)
486 * 0 if this archive member should be processed, 1 if it should be
487 * skipped and -1 if we are done with all patterns (and pax should quit
488 * looking for more members)
489 * Note: *pend may be changed to show where the prefix ends.
493 fn_match(char *pattern
, char *string
, char **pend
)
500 switch (c
= *pattern
++) {
503 * Ok we found an exact match
509 * Check if it is a prefix match
511 if ((dflag
== 1) || (*string
!= '/'))
515 * It is a prefix match, remember where the trailing
521 if ((test
= *string
++) == '\0')
527 * Collapse multiple *'s.
533 * Optimized hack for pattern with a * at the end
539 * General case, use recursion.
541 while ((test
= *string
) != '\0') {
542 if (!fn_match(pattern
, string
, pend
))
551 if (((test
= *string
++) == '\0') ||
552 ((pattern
= range_match(pattern
, test
)) == NULL
))
566 range_match(char *pattern
, int test
)
573 if ((negate
= (*pattern
== '!')) != 0)
576 while ((c
= *pattern
++) != ']') {
583 if ((*pattern
== '-') && ((c2
= pattern
[1]) != '\0') &&
585 if ((c
<= test
) && (test
<= c2
))
588 } else if (c
== test
)
591 return (ok
== negate
? NULL
: pattern
);
596 * Returns true iff the supplied path contains a ".." component.
600 has_dotdot(const char *path
)
602 const char *p
= path
;
604 while ((p
= strstr(p
, "..")) != NULL
) {
605 if ((p
== path
|| p
[-1] == '/') &&
606 (p
[2] == '/' || p
[2] == '\0'))
615 * modify a selected file name. first attempt to apply replacement string
616 * expressions, then apply interactive file rename. We apply replacement
617 * string expressions to both filenames and file links (if we didn't the
618 * links would point to the wrong place, and we could never be able to
619 * move an archive that has a file link in it). When we rename files
620 * interactively, we store that mapping (old name to user input name) so
621 * if we spot any file links to the old file name in the future, we will
622 * know exactly how to fix the file link.
624 * 0 continue to process file, 1 skip this file, -1 pax is finished
628 mod_name(ARCHD
*arcn
)
633 * Strip off leading '/' if appropriate.
634 * Currently, this option is only set for the tar format.
636 while (rmleadslash
&& arcn
->name
[0] == '/') {
637 if (arcn
->name
[1] == '\0') {
640 (void)memmove(arcn
->name
, &arcn
->name
[1],
644 if (rmleadslash
< 2) {
646 paxwarn(0, "Removing leading / from absolute path names in the archive");
649 while (rmleadslash
&& arcn
->ln_name
[0] == '/' &&
650 PAX_IS_HARDLINK(arcn
->type
)) {
651 if (arcn
->ln_name
[1] == '\0') {
652 arcn
->ln_name
[0] = '.';
654 (void)memmove(arcn
->ln_name
, &arcn
->ln_name
[1],
655 strlen(arcn
->ln_name
));
658 if (rmleadslash
< 2) {
660 paxwarn(0, "Removing leading / from absolute path names in the archive");
664 const char *last
= NULL
;
665 const char *p
= arcn
->name
;
667 while ((p
= strstr(p
, "..")) != NULL
) {
668 if ((p
== arcn
->name
|| p
[-1] == '/') &&
669 (p
[2] == '/' || p
[2] == '\0'))
675 paxwarn(1, "Removing leading \"%.*s\"",
676 (int)(last
- arcn
->name
), arcn
->name
);
677 arcn
->nlen
= strlen(last
);
679 memmove(arcn
->name
, last
, arcn
->nlen
+ 1);
682 arcn
->name
[1] = '\0';
689 * IMPORTANT: We have a problem. what do we do with symlinks?
690 * Modifying a hard link name makes sense, as we know the file it
691 * points at should have been seen already in the archive (and if it
692 * wasn't seen because of a read error or a bad archive, we lose
693 * anyway). But there are no such requirements for symlinks. On one
694 * hand the symlink that refers to a file in the archive will have to
695 * be modified to so it will still work at its new location in the
696 * file system. On the other hand a symlink that points elsewhere (and
697 * should continue to do so) should not be modified. There is clearly
698 * no perfect solution here. So we handle them like hardlinks. Clearly
699 * a replacement made by the interactive rename mapping is very likely
700 * to be correct since it applies to a single file and is an exact
701 * match. The regular expression replacements are a little harder to
702 * justify though. We claim that the symlink name is only likely
703 * to be replaced when it points within the file tree being moved and
704 * in that case it should be modified. what we really need to do is to
705 * call an oracle here. :)
707 if (rephead
!= NULL
) {
709 * we have replacement strings, modify the name and the link
712 if ((res
= rep_name(arcn
->name
, sizeof(arcn
->name
), &(arcn
->nlen
), 1)) != 0)
715 if (PAX_IS_LINK(arcn
->type
)) {
716 if ((res
= rep_name(arcn
->ln_name
,
717 sizeof(arcn
->ln_name
), &(arcn
->ln_nlen
), 0)) != 0)
724 * perform interactive file rename, then map the link if any
726 if ((res
= tty_rename(arcn
)) != 0)
728 if (PAX_IS_LINK(arcn
->type
))
729 sub_name(arcn
->ln_name
, &(arcn
->ln_nlen
),
730 sizeof(arcn
->ln_name
));
737 * Prompt the user for a replacement file name. A "." keeps the old name,
738 * a empty line skips the file, and an EOF on reading the tty, will cause
739 * pax to stop processing and exit. Otherwise the file name input, replaces
742 * 0 process this file, 1 skip this file, -1 we need to exit pax
746 tty_rename(ARCHD
*arcn
)
748 char tmpname
[PAXPATHLEN
+2];
752 * prompt user for the replacement name for a file, keep trying until
753 * we get some reasonable input. Archives may have more than one file
754 * on them with the same name (from updates etc). We print verbose info
755 * on the file so the user knows what is up.
757 tty_prnt("\nATTENTION: %s interactive file rename operation.\n", argv0
);
761 tty_prnt("Input new name, or a \".\" to keep the old name, ");
762 tty_prnt("or a \"return\" to skip this file.\n");
763 tty_prnt("Input > ");
764 if (tty_read(tmpname
, sizeof(tmpname
)) < 0)
766 if (strcmp(tmpname
, "..") == 0) {
767 tty_prnt("Try again, illegal file name: ..\n");
770 if (strlen(tmpname
) > PAXPATHLEN
) {
771 tty_prnt("Try again, file name too long\n");
778 * empty file name, skips this file. a "." leaves it alone
780 if (tmpname
[0] == '\0') {
781 tty_prnt("Skipping file.\n");
784 if ((tmpname
[0] == '.') && (tmpname
[1] == '\0')) {
785 tty_prnt("Processing continues, name unchanged.\n");
790 * ok the name changed. We may run into links that point at this
791 * file later. we have to remember where the user sent the file
792 * in order to repair any links.
794 tty_prnt("Processing continues, name changed to: %s\n", tmpname
);
795 res
= add_name(arcn
->name
, arcn
->nlen
, tmpname
);
796 arcn
->nlen
= strlcpy(arcn
->name
, tmpname
, sizeof(arcn
->name
));
797 if (arcn
->nlen
>= sizeof(arcn
->name
))
798 arcn
->nlen
= sizeof(arcn
->name
) - 1; /* XXX truncate? */
806 * fix up the file name and the link name (if any) so this file will land
807 * in the destination directory (used during copy() -rw).
809 * 0 if ok, -1 if failure (name too long)
813 set_dest(ARCHD
*arcn
, char *dest_dir
, int dir_len
)
815 if (fix_path(arcn
->name
, &(arcn
->nlen
), dest_dir
, dir_len
) < 0)
819 * It is really hard to deal with symlinks here, we cannot be sure
820 * if the name they point was moved (or will be moved). It is best to
823 if (!PAX_IS_HARDLINK(arcn
->type
))
826 if (fix_path(arcn
->ln_name
, &(arcn
->ln_nlen
), dest_dir
, dir_len
) < 0)
833 * concatenate dir_name and or_name and store the result in or_name (if
834 * it fits). This is one ugly function.
836 * 0 if ok, -1 if the final name is too long
840 fix_path(char *or_name
, int *or_len
, char *dir_name
, int dir_len
)
848 * we shift the or_name to the right enough to tack in the dir_name
849 * at the front. We make sure we have enough space for it all before
850 * we start. since dest always ends in a slash, we skip of or_name
851 * if it also starts with one.
854 src
= start
+ *or_len
;
855 dest
= src
+ dir_len
;
860 if ((len
= dest
- or_name
) > PAXPATHLEN
) {
861 paxwarn(1, "File name %s/%s, too long", dir_name
, start
);
867 * enough space, shift
871 src
= dir_name
+ dir_len
- 1;
874 * splice in the destination directory name
876 while (src
>= dir_name
)
879 *(or_name
+ len
) = '\0';
885 * walk down the list of replacement strings applying each one in order.
886 * when we find one with a successful substitution, we modify the name
887 * as specified. if required, we print the results. if the resulting name
888 * is empty, we will skip this archive member. We use the regexp(3)
889 * routines (regexp() ought to win a prize as having the most cryptic
890 * library function manual page).
892 * name is the file name we are going to apply the regular expressions to
893 * (and may be modified)
894 * nsize is the size of the name buffer.
895 * nlen is the length of this name (and is modified to hold the length of
897 * prnt is a flag that says whether to print the final result.
899 * 0 if substitution was successful, 1 if we are to skip the file (the name
904 rep_name(char *name
, size_t nsize
, int *nlen
, int prnt
)
913 regmatch_t pm
[MAXSUBEXP
];
914 char nname
[PAXPATHLEN
+1]; /* final result of all replacements */
915 char buf1
[PAXPATHLEN
+1]; /* where we work on the name */
918 * copy the name into buf1, where we will work on it. We need to keep
919 * the orig string around so we can print out the result of the final
920 * replacement. We build up the final result in nname. inpt points at
921 * the string we apply the regular expression to. prnt is used to
922 * suppress printing when we handle replacements on the link field
923 * (the user already saw that substitution go by)
926 (void)strlcpy(buf1
, name
, sizeof(buf1
));
929 endpt
= outpt
+ PAXPATHLEN
;
932 * try each replacement string in order
938 * check for a successful substitution, if not go to
939 * the next pattern, or cleanup if we were global
941 if (regexec(&(pt
->rcmp
), inpt
, MAXSUBEXP
, pm
, 0) != 0)
945 * ok we found one. We have three parts, the prefix
946 * which did not match, the section that did and the
947 * tail (that also did not match). Copy the prefix to
948 * the final output buffer (watching to make sure we
949 * do not create a string too long).
952 rpt
= inpt
+ pm
[0].rm_so
;
954 while ((inpt
< rpt
) && (outpt
< endpt
))
960 * for the second part (which matched the regular
961 * expression) apply the substitution using the
962 * replacement string and place it the prefix in the
963 * final output. If we have problems, skip it.
965 if ((res
= resub(&(pt
->rcmp
),pm
,pt
->nstr
,oinpt
,outpt
,endpt
))
968 paxwarn(1, "Replacement name error %s",
975 * we set up to look again starting at the first
976 * character in the tail (of the input string right
977 * after the last character matched by the regular
978 * expression (inpt always points at the first char in
979 * the string to process). If we are not doing a global
980 * substitution, we will use inpt to copy the tail to
981 * the final result. Make sure we do not overrun the
984 inpt
+= pm
[0].rm_eo
- pm
[0].rm_so
;
986 if ((outpt
== endpt
) || (*inpt
== '\0'))
990 * if the user wants global we keep trying to
991 * substitute until it fails, then we are done.
993 } while (pt
->flgs
& GLOB
);
999 * a successful substitution did NOT occur, try the next one
1006 * we had a substitution, copy the last tail piece (if there is
1007 * room) to the final result
1009 while ((outpt
< endpt
) && (*inpt
!= '\0'))
1013 if ((outpt
== endpt
) && (*inpt
!= '\0')) {
1015 paxwarn(1,"Replacement name too long %s >> %s",
1021 * inform the user of the result if wanted
1023 if (prnt
&& (pt
->flgs
& PRNT
)) {
1025 (void)fprintf(stderr
,"%s >> <empty string>\n",
1028 (void)fprintf(stderr
,"%s >> %s\n", name
, nname
);
1032 * if empty inform the caller this file is to be skipped
1033 * otherwise copy the new name over the orig name and return
1037 *nlen
= strlcpy(name
, nname
, nsize
);
1044 * apply the replacement to the matched expression. expand out the old
1045 * style ed(1) subexpression expansion.
1047 * -1 if error, or the number of characters added to the destination.
1051 resub(regex_t
*rp
, regmatch_t
*pm
, char *src
, char *inpt
, char *dest
,
1063 subexcnt
= rp
->re_nsub
;
1064 while ((dpt
< destend
) && ((c
= *spt
++) != '\0')) {
1066 * see if we just have an ordinary replacement character
1067 * or we refer to a subexpression.
1071 } else if ((c
== '\\') && (*spt
>= '0') && (*spt
<= '9')) {
1073 * make sure there is a subexpression as specified
1075 if ((len
= *spt
++ - '0') > subexcnt
)
1080 * Ordinary character, just copy it
1082 if ((c
== '\\') && (*spt
!= '\0'))
1089 * continue if the subexpression is bogus
1091 if ((pmpt
->rm_so
< 0) || (pmpt
->rm_eo
< 0) ||
1092 ((len
= pmpt
->rm_eo
- pmpt
->rm_so
) <= 0))
1096 * copy the subexpression to the destination.
1097 * fail if we run out of space or the match string is damaged
1099 if (len
> (destend
- dpt
))
1101 strncpy(dpt
, inpt
+ pmpt
->rm_so
, len
);