2 * Copyright (c) 2003-2007 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include "bsdtar_platform.h"
27 __FBSDID("$FreeBSD$");
49 struct match *exclusions;
51 struct match *inclusions;
53 int inclusions_unmatched_count;
57 static void add_pattern(struct match **list,
59 static int bsdtar_fnmatch(const char *p, const char *s);
60 static void initialize_matching(struct bsdtar *);
61 static int match_exclusion(struct match *, const char *pathname);
62 static int match_inclusion(struct match *, const char *pathname);
63 static int pathmatch(const char *p, const char *s);
66 * The matching logic here needs to be re-thought. I started out to
67 * try to mimic gtar's matching logic, but it's not entirely
68 * consistent. In particular 'tar -t' and 'tar -x' interpret patterns
69 * on the command line as anchored, but --exclude doesn't.
73 * Utility functions to manage exclusion/inclusion patterns
77 exclude(struct bsdtar *bsdtar, const char *pattern)
79 struct matching *matching;
81 if (bsdtar->matching == NULL)
82 initialize_matching(bsdtar);
83 matching = bsdtar->matching;
84 add_pattern(&(matching->exclusions), pattern);
85 matching->exclusions_count++;
90 exclude_from_file(struct bsdtar *bsdtar, const char *pathname)
92 return (process_lines(bsdtar, pathname, &exclude));
96 include(struct bsdtar *bsdtar, const char *pattern)
98 struct matching *matching;
100 if (bsdtar->matching == NULL)
101 initialize_matching(bsdtar);
102 matching = bsdtar->matching;
103 add_pattern(&(matching->inclusions), pattern);
104 matching->inclusions_count++;
105 matching->inclusions_unmatched_count++;
110 include_from_file(struct bsdtar *bsdtar, const char *pathname)
112 return (process_lines(bsdtar, pathname, &include));
116 add_pattern(struct match **list, const char *pattern)
120 match = malloc(sizeof(*match) + strlen(pattern) + 1);
122 bsdtar_errc(1, errno, "Out of memory");
123 strcpy(match->pattern, pattern);
124 /* Both "foo/" and "foo" should match "foo/bar". */
125 if (match->pattern[strlen(match->pattern)-1] == '/')
126 match->pattern[strlen(match->pattern)-1] = '\0';
134 excluded(struct bsdtar *bsdtar, const char *pathname)
136 struct matching *matching;
138 struct match *matched;
140 matching = bsdtar->matching;
141 if (matching == NULL)
144 /* Exclusions take priority */
145 for (match = matching->exclusions; match != NULL; match = match->next){
146 if (match_exclusion(match, pathname))
150 /* Then check for inclusions */
152 for (match = matching->inclusions; match != NULL; match = match->next){
153 if (match_inclusion(match, pathname)) {
155 * If this pattern has never been matched,
158 if (match->matches == 0) {
160 matching->inclusions_unmatched_count--;
164 * Otherwise, remember the match but keep checking
165 * in case we can tick off an unmatched pattern.
171 * We didn't find a pattern that had never been matched, but
172 * we did find a match, so count it and exit.
174 if (matched != NULL) {
179 /* If there were inclusions, default is to exclude. */
180 if (matching->inclusions != NULL)
183 /* No explicit inclusions, default is to match. */
188 * This is a little odd, but it matches the default behavior of
189 * gtar. In particular, 'a*b' will match 'foo/a1111/222b/bar'
193 match_exclusion(struct match *match, const char *pathname)
197 if (*match->pattern == '*' || *match->pattern == '/')
198 return (pathmatch(match->pattern, pathname) == 0);
200 for (p = pathname; p != NULL; p = strchr(p, '/')) {
203 if (pathmatch(match->pattern, p) == 0)
210 * Again, mimic gtar: inclusions are always anchored (have to match
211 * the beginning of the path) even though exclusions are not anchored.
214 match_inclusion(struct match *match, const char *pathname)
216 return (pathmatch(match->pattern, pathname) == 0);
220 cleanup_exclusions(struct bsdtar *bsdtar)
224 if (bsdtar->matching) {
225 p = bsdtar->matching->inclusions;
231 p = bsdtar->matching->exclusions;
237 free(bsdtar->matching);
242 initialize_matching(struct bsdtar *bsdtar)
244 bsdtar->matching = malloc(sizeof(*bsdtar->matching));
245 if (bsdtar->matching == NULL)
246 bsdtar_errc(1, errno, "No memory");
247 memset(bsdtar->matching, 0, sizeof(*bsdtar->matching));
251 unmatched_inclusions(struct bsdtar *bsdtar)
253 struct matching *matching;
255 matching = bsdtar->matching;
256 if (matching == NULL)
258 return (matching->inclusions_unmatched_count);
263 unmatched_inclusions_warn(struct bsdtar *bsdtar, const char *msg)
265 struct matching *matching;
268 matching = bsdtar->matching;
269 if (matching == NULL)
272 p = matching->inclusions;
274 if (p->matches == 0) {
275 bsdtar->return_value = 1;
276 bsdtar_warnc(0, "%s: %s",
281 return (matching->inclusions_unmatched_count);
285 * TODO: Extend this so that the following matches work:
286 * "foo//bar" == "foo/bar"
287 * "foo/./bar" == "foo/bar"
290 * The POSIX fnmatch() function doesn't handle any of these, but
291 * all are common situations that arise when paths are generated within
292 * large scripts. E.g., the following is quite common:
293 * MYPATH=foo/ TARGET=$MYPATH/bar
294 * It may be worthwhile to edit such paths at write time as well,
295 * especially when such editing may avoid the need for long pathname
299 pathmatch(const char *pattern, const char *string)
302 * Strip leading "./" or ".//" so that, e.g.,
303 * "foo" matches "./foo". In particular, this
304 * opens up an optimization for the writer to
305 * elide leading "./".
307 if (pattern[0] == '.' && pattern[1] == '/') {
309 while (pattern[0] == '/')
312 if (string[0] == '.' && string[1] == '/') {
314 while (string[0] == '/')
317 return (bsdtar_fnmatch(pattern, string));
321 #if defined(HAVE_FNMATCH) && defined(HAVE_FNM_LEADING_DIR)
323 /* Use system fnmatch() if it suits our needs. */
324 /* On Linux, _GNU_SOURCE must be defined to get FNM_LEADING_DIR. */
328 bsdtar_fnmatch(const char *pattern, const char *string)
330 return (fnmatch(pattern, string, FNM_LEADING_DIR));
335 * The following was hacked from BSD C library
336 * code: src/lib/libc/gen/fnmatch.c,v 1.15 2002/02/01
338 * In particular, most of the flags were ripped out: this always
339 * behaves like FNM_LEADING_DIR is set and other flags specified
340 * by POSIX are unset.
342 * Normally, I would not conditionally compile something like this: If
343 * I have to support it anyway, everyone may as well use it. ;-)
344 * However, the full POSIX spec for fnmatch() includes a lot of
345 * advanced character handling that I'm not ready to put in here, so
346 * it's probably best if people use a local version when it's available.
350 * Copyright (c) 1989, 1993, 1994
351 * The Regents of the University of California. All rights reserved.
353 * This code is derived from software contributed to Berkeley by
356 * Redistribution and use in source and binary forms, with or without
357 * modification, are permitted provided that the following conditions
359 * 1. Redistributions of source code must retain the above copyright
360 * notice, this list of conditions and the following disclaimer.
361 * 2. Redistributions in binary form must reproduce the above copyright
362 * notice, this list of conditions and the following disclaimer in the
363 * documentation and/or other materials provided with the distribution.
364 * 4. Neither the name of the University nor the names of its contributors
365 * may be used to endorse or promote products derived from this software
366 * without specific prior written permission.
368 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
369 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
370 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
371 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
372 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
373 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
374 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
375 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
376 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
377 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
382 bsdtar_fnmatch(const char *pattern, const char *string)
384 const char *saved_pattern;
389 switch (c = *pattern++) {
391 if (*string == '/' || *string == '\0')
401 /* Collapse multiple stars. */
405 /* Optimize for pattern with * at end. */
409 /* General case, use recursion. */
410 while (*string != '\0') {
411 if (!bsdtar_fnmatch(pattern, string))
419 saved_pattern = pattern;
420 if (*pattern == '!' || *pattern == '^') {
431 pattern = saved_pattern;
435 if (*pattern == '-') {
436 char c2 = *(pattern + 1);
438 pattern = saved_pattern;
443 /* [a-] is not a range. */
454 } else if (c == *string)
458 if (matched == negate)
463 if ((c = *pattern++) == '\0') {