xref: /freebsd/contrib/libarchive/libarchive/test/test_archive_pathmatch.c (revision b9128a37faafede823eb456aa65a11ac69997284)
1 /*-
2  * Copyright (c) 2003-2007 Tim Kientzle
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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.
24  */
25 #include "test.h"
26 
27 #define __LIBARCHIVE_TEST
28 #include "archive_pathmatch.h"
29 
30 /*
31  * Verify that the pattern matcher implements the wildcard logic specified
32  * in SUSv2 for the cpio command.  This is essentially the
33  * shell glob syntax:
34  *   * - matches any sequence of chars, including '/'
35  *   ? - matches any single char, including '/'
36  *   [...] - matches any of a set of chars, '-' specifies a range,
37  *        initial '!' is undefined
38  *
39  * The specification in SUSv2 is a bit incomplete, I assume the following:
40  *   Trailing '-' in [...] is not special.
41  *
42  * TODO: Figure out if there's a good way to extend this to handle
43  * Windows paths that use '\' as a path separator.  <sigh>
44  */
45 
46 DEFINE_TEST(test_archive_pathmatch)
47 {
48 	assertEqualInt(1, archive_pathmatch("a/b/c", "a/b/c", 0));
49 	assertEqualInt(0, archive_pathmatch("a/b/", "a/b/c", 0));
50 	assertEqualInt(0, archive_pathmatch("a/b", "a/b/c", 0));
51 	assertEqualInt(0, archive_pathmatch("a/b/c", "a/b/", 0));
52 	assertEqualInt(0, archive_pathmatch("a/b/c", "a/b", 0));
53 
54     /* Null string and non-empty pattern returns false. */
55 	assertEqualInt(0, archive_pathmatch("a/b/c", NULL, 0));
56 	assertEqualInt(0, archive_pathmatch_w(L"a/b/c", NULL, 0));
57 
58 	/* Empty pattern only matches empty string. */
59 	assertEqualInt(1, archive_pathmatch("","", 0));
60 	assertEqualInt(0, archive_pathmatch("","a", 0));
61 	assertEqualInt(1, archive_pathmatch("*","", 0));
62 	assertEqualInt(1, archive_pathmatch("*","a", 0));
63 	assertEqualInt(1, archive_pathmatch("*","abcd", 0));
64 	/* SUSv2: * matches / */
65 	assertEqualInt(1, archive_pathmatch("*","abcd/efgh/ijkl", 0));
66 	assertEqualInt(1, archive_pathmatch("abcd*efgh/ijkl","abcd/efgh/ijkl", 0));
67 	assertEqualInt(1, archive_pathmatch("abcd***efgh/ijkl","abcd/efgh/ijkl", 0));
68 	assertEqualInt(1, archive_pathmatch("abcd***/efgh/ijkl","abcd/efgh/ijkl", 0));
69 	assertEqualInt(0, archive_pathmatch("?", "", 0));
70 	assertEqualInt(0, archive_pathmatch("?", "\0", 0));
71 	assertEqualInt(1, archive_pathmatch("?", "a", 0));
72 	assertEqualInt(0, archive_pathmatch("?", "ab", 0));
73 	assertEqualInt(1, archive_pathmatch("?", ".", 0));
74 	assertEqualInt(1, archive_pathmatch("?", "?", 0));
75 	assertEqualInt(1, archive_pathmatch("a", "a", 0));
76 	assertEqualInt(0, archive_pathmatch("a", "ab", 0));
77 	assertEqualInt(0, archive_pathmatch("a", "ab", 0));
78 	assertEqualInt(1, archive_pathmatch("a?c", "abc", 0));
79 	/* SUSv2: ? matches / */
80 	assertEqualInt(1, archive_pathmatch("a?c", "a/c", 0));
81 	assertEqualInt(1, archive_pathmatch("a?*c*", "a/c", 0));
82 	assertEqualInt(1, archive_pathmatch("*a*", "a/c", 0));
83 	assertEqualInt(1, archive_pathmatch("*a*", "/a/c", 0));
84 	assertEqualInt(1, archive_pathmatch("*a*", "defaaaaaaa", 0));
85 	assertEqualInt(0, archive_pathmatch("a*", "defghi", 0));
86 	assertEqualInt(0, archive_pathmatch("*a*", "defghi", 0));
87 
88 	/* Character classes */
89 	assertEqualInt(1, archive_pathmatch("abc[def", "abc[def", 0));
90 	assertEqualInt(0, archive_pathmatch("abc[def]", "abc[def", 0));
91 	assertEqualInt(0, archive_pathmatch("abc[def", "abcd", 0));
92 	assertEqualInt(1, archive_pathmatch("abc[def]", "abcd", 0));
93 	assertEqualInt(1, archive_pathmatch("abc[def]", "abce", 0));
94 	assertEqualInt(1, archive_pathmatch("abc[def]", "abcf", 0));
95 	assertEqualInt(0, archive_pathmatch("abc[def]", "abcg", 0));
96 	assertEqualInt(1, archive_pathmatch("abc[d*f]", "abcd", 0));
97 	assertEqualInt(1, archive_pathmatch("abc[d*f]", "abc*", 0));
98 	assertEqualInt(0, archive_pathmatch("abc[d*f]", "abcdefghi", 0));
99 	assertEqualInt(0, archive_pathmatch("abc[d*", "abcdefghi", 0));
100 	assertEqualInt(1, archive_pathmatch("abc[d*", "abc[defghi", 0));
101 	assertEqualInt(1, archive_pathmatch("abc[d-f]", "abcd", 0));
102 	assertEqualInt(1, archive_pathmatch("abc[d-f]", "abce", 0));
103 	assertEqualInt(1, archive_pathmatch("abc[d-f]", "abcf", 0));
104 	assertEqualInt(0, archive_pathmatch("abc[d-f]", "abcg", 0));
105 	assertEqualInt(0, archive_pathmatch("abc[d-fh-k]", "abca", 0));
106 	assertEqualInt(1, archive_pathmatch("abc[d-fh-k]", "abcd", 0));
107 	assertEqualInt(1, archive_pathmatch("abc[d-fh-k]", "abce", 0));
108 	assertEqualInt(1, archive_pathmatch("abc[d-fh-k]", "abcf", 0));
109 	assertEqualInt(0, archive_pathmatch("abc[d-fh-k]", "abcg", 0));
110 	assertEqualInt(1, archive_pathmatch("abc[d-fh-k]", "abch", 0));
111 	assertEqualInt(1, archive_pathmatch("abc[d-fh-k]", "abci", 0));
112 	assertEqualInt(1, archive_pathmatch("abc[d-fh-k]", "abcj", 0));
113 	assertEqualInt(1, archive_pathmatch("abc[d-fh-k]", "abck", 0));
114 	assertEqualInt(0, archive_pathmatch("abc[d-fh-k]", "abcl", 0));
115 	assertEqualInt(0, archive_pathmatch("abc[d-fh-k]", "abc-", 0));
116 
117 	/* [] matches nothing, [!] is the same as ? */
118 	assertEqualInt(0, archive_pathmatch("abc[]efg", "abcdefg", 0));
119 	assertEqualInt(0, archive_pathmatch("abc[]efg", "abcqefg", 0));
120 	assertEqualInt(0, archive_pathmatch("abc[]efg", "abcefg", 0));
121 	assertEqualInt(1, archive_pathmatch("abc[!]efg", "abcdefg", 0));
122 	assertEqualInt(1, archive_pathmatch("abc[!]efg", "abcqefg", 0));
123 	assertEqualInt(0, archive_pathmatch("abc[!]efg", "abcefg", 0));
124 
125 	/* I assume: Trailing '-' is non-special. */
126 	assertEqualInt(0, archive_pathmatch("abc[d-fh-]", "abcl", 0));
127 	assertEqualInt(1, archive_pathmatch("abc[d-fh-]", "abch", 0));
128 	assertEqualInt(1, archive_pathmatch("abc[d-fh-]", "abc-", 0));
129 	assertEqualInt(1, archive_pathmatch("abc[d-fh-]", "abc-", 0));
130 
131 	/* ']' can be backslash-quoted within a character class. */
132 	assertEqualInt(1, archive_pathmatch("abc[\\]]", "abc]", 0));
133 	assertEqualInt(1, archive_pathmatch("abc[\\]d]", "abc]", 0));
134 	assertEqualInt(1, archive_pathmatch("abc[\\]d]", "abcd", 0));
135 	assertEqualInt(1, archive_pathmatch("abc[d\\]]", "abc]", 0));
136 	assertEqualInt(1, archive_pathmatch("abc[d\\]]", "abcd", 0));
137 	assertEqualInt(1, archive_pathmatch("abc[d]e]", "abcde]", 0));
138 	assertEqualInt(1, archive_pathmatch("abc[d\\]e]", "abc]", 0));
139 	assertEqualInt(0, archive_pathmatch("abc[d\\]e]", "abcd]e", 0));
140 	assertEqualInt(0, archive_pathmatch("abc[d]e]", "abc]", 0));
141 
142 	/* backslash-quoted chars can appear as either end of a range. */
143 	assertEqualInt(1, archive_pathmatch("abc[\\d-f]gh", "abcegh", 0));
144 	assertEqualInt(0, archive_pathmatch("abc[\\d-f]gh", "abcggh", 0));
145 	assertEqualInt(0, archive_pathmatch("abc[\\d-f]gh", "abc\\gh", 0));
146 	assertEqualInt(1, archive_pathmatch("abc[d-\\f]gh", "abcegh", 0));
147 	assertEqualInt(1, archive_pathmatch("abc[\\d-\\f]gh", "abcegh", 0));
148 	assertEqualInt(1, archive_pathmatch("abc[\\d-\\f]gh", "abcegh", 0));
149 	/* backslash-quoted '-' isn't special. */
150 	assertEqualInt(0, archive_pathmatch("abc[d\\-f]gh", "abcegh", 0));
151 	assertEqualInt(1, archive_pathmatch("abc[d\\-f]gh", "abc-gh", 0));
152 
153 	/* Leading '!' negates a character class. */
154 	assertEqualInt(0, archive_pathmatch("abc[!d]", "abcd", 0));
155 	assertEqualInt(1, archive_pathmatch("abc[!d]", "abce", 0));
156 	assertEqualInt(1, archive_pathmatch("abc[!d]", "abcc", 0));
157 	assertEqualInt(0, archive_pathmatch("abc[!d-z]", "abcq", 0));
158 	assertEqualInt(1, archive_pathmatch("abc[!d-gi-z]", "abch", 0));
159 	assertEqualInt(1, archive_pathmatch("abc[!fgijkl]", "abch", 0));
160 	assertEqualInt(0, archive_pathmatch("abc[!fghijkl]", "abch", 0));
161 
162 	/* Backslash quotes next character. */
163 	assertEqualInt(0, archive_pathmatch("abc\\[def]", "abc\\d", 0));
164 	assertEqualInt(1, archive_pathmatch("abc\\[def]", "abc[def]", 0));
165 	assertEqualInt(0, archive_pathmatch("abc\\\\[def]", "abc[def]", 0));
166 	assertEqualInt(0, archive_pathmatch("abc\\\\[def]", "abc\\[def]", 0));
167 	assertEqualInt(1, archive_pathmatch("abc\\\\[def]", "abc\\d", 0));
168 	assertEqualInt(1, archive_pathmatch("abcd\\", "abcd\\", 0));
169 	assertEqualInt(0, archive_pathmatch("abcd\\", "abcd\\[", 0));
170 	assertEqualInt(0, archive_pathmatch("abcd\\", "abcde", 0));
171 	assertEqualInt(0, archive_pathmatch("abcd\\[", "abcd\\", 0));
172 
173 	/*
174 	 * Because '.' and '/' have special meanings, we can
175 	 * identify many equivalent paths even if they're expressed
176 	 * differently.  (But quoting a character with '\\' suppresses
177 	 * special meanings!)
178 	 */
179 	assertEqualInt(0, archive_pathmatch("a/b/", "a/bc", 0));
180 	assertEqualInt(1, archive_pathmatch("a/./b", "a/b", 0));
181 	assertEqualInt(0, archive_pathmatch("a\\/./b", "a/b", 0));
182 	assertEqualInt(0, archive_pathmatch("a/\\./b", "a/b", 0));
183 	assertEqualInt(0, archive_pathmatch("a/.\\/b", "a/b", 0));
184 	assertEqualInt(0, archive_pathmatch("a\\/\\.\\/b", "a/b", 0));
185 	assertEqualInt(1, archive_pathmatch("./abc/./def/", "abc/def/", 0));
186 	assertEqualInt(1, archive_pathmatch("abc/def", "./././abc/./def", 0));
187 	assertEqualInt(1, archive_pathmatch("abc/def/././//", "./././abc/./def/", 0));
188 	assertEqualInt(1, archive_pathmatch(".////abc/.//def", "./././abc/./def", 0));
189 	assertEqualInt(1, archive_pathmatch("./abc?def/", "abc/def/", 0));
190 	failure("\"?./\" is not the same as \"/./\"");
191 	assertEqualInt(0, archive_pathmatch("./abc?./def/", "abc/def/", 0));
192 	failure("Trailing '/' should match no trailing '/'");
193 	assertEqualInt(1, archive_pathmatch("./abc/./def/", "abc/def", 0));
194 	failure("Trailing '/./' is still the same directory.");
195 	assertEqualInt(1, archive_pathmatch("./abc/./def/./", "abc/def", 0));
196 	failure("Trailing '/.' is still the same directory.");
197 	assertEqualInt(1, archive_pathmatch("./abc/./def/.", "abc/def", 0));
198 	assertEqualInt(1, archive_pathmatch("./abc/./def", "abc/def/", 0));
199 	failure("Trailing '/./' is still the same directory.");
200 	assertEqualInt(1, archive_pathmatch("./abc/./def", "abc/def/./", 0));
201 	failure("Trailing '/.' is still the same directory.");
202 	assertEqualInt(1, archive_pathmatch("./abc*/./def", "abc/def/.", 0));
203 
204 	/* Matches not anchored at beginning. */
205 	assertEqualInt(0,
206 	    archive_pathmatch("bcd", "abcd", PATHMATCH_NO_ANCHOR_START));
207 	assertEqualInt(1,
208 	    archive_pathmatch("abcd", "abcd", PATHMATCH_NO_ANCHOR_START));
209 	assertEqualInt(0,
210 	    archive_pathmatch("^bcd", "abcd", PATHMATCH_NO_ANCHOR_START));
211 	assertEqualInt(1,
212 	    archive_pathmatch("b/c/d", "a/b/c/d", PATHMATCH_NO_ANCHOR_START));
213 	assertEqualInt(0,
214 	    archive_pathmatch("^b/c/d", "a/b/c/d", PATHMATCH_NO_ANCHOR_START));
215 	assertEqualInt(0,
216 	    archive_pathmatch("/b/c/d", "a/b/c/d", PATHMATCH_NO_ANCHOR_START));
217 	assertEqualInt(0,
218 	    archive_pathmatch("a/b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_START));
219 	assertEqualInt(1,
220 	    archive_pathmatch("a/b/c/d", "a/b/c/d", PATHMATCH_NO_ANCHOR_START));
221 	assertEqualInt(0,
222 	    archive_pathmatch("b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_START));
223 	assertEqualInt(0,
224 	    archive_pathmatch("^b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_START));
225 
226 
227 	assertEqualInt(1,
228 	    archive_pathmatch("b/c/d", "a/b/c/d", PATHMATCH_NO_ANCHOR_START));
229 	assertEqualInt(1,
230 	    archive_pathmatch("b/c/d", "/a/b/c/d", PATHMATCH_NO_ANCHOR_START));
231 
232 
233 	/* Matches not anchored at end. */
234 	assertEqualInt(0,
235 	    archive_pathmatch("bcd", "abcd", PATHMATCH_NO_ANCHOR_END));
236 	assertEqualInt(1,
237 	    archive_pathmatch("abcd", "abcd", PATHMATCH_NO_ANCHOR_END));
238 	assertEqualInt(1,
239 	    archive_pathmatch("abcd", "abcd/", PATHMATCH_NO_ANCHOR_END));
240 	assertEqualInt(1,
241 	    archive_pathmatch("abcd", "abcd/.", PATHMATCH_NO_ANCHOR_END));
242 	assertEqualInt(0,
243 	    archive_pathmatch("abc", "abcd", PATHMATCH_NO_ANCHOR_END));
244 	assertEqualInt(1,
245 	    archive_pathmatch("a/b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_END));
246 	assertEqualInt(0,
247 	    archive_pathmatch("a/b/c$", "a/b/c/d", PATHMATCH_NO_ANCHOR_END));
248 	assertEqualInt(1,
249 	    archive_pathmatch("a/b/c$", "a/b/c", PATHMATCH_NO_ANCHOR_END));
250 	assertEqualInt(1,
251 	    archive_pathmatch("a/b/c$", "a/b/c/", PATHMATCH_NO_ANCHOR_END));
252 	assertEqualInt(1,
253 	    archive_pathmatch("a/b/c/", "a/b/c/d", PATHMATCH_NO_ANCHOR_END));
254 	assertEqualInt(0,
255 	    archive_pathmatch("a/b/c/$", "a/b/c/d", PATHMATCH_NO_ANCHOR_END));
256 	assertEqualInt(1,
257 	    archive_pathmatch("a/b/c/$", "a/b/c/", PATHMATCH_NO_ANCHOR_END));
258 	assertEqualInt(1,
259 	    archive_pathmatch("a/b/c/$", "a/b/c", PATHMATCH_NO_ANCHOR_END));
260 	assertEqualInt(0,
261 	    archive_pathmatch("b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_END));
262 
263 	/* Matches not anchored at either end. */
264 	assertEqualInt(1,
265 	    archive_pathmatch("b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
266 	assertEqualInt(0,
267 	    archive_pathmatch("/b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
268 	assertEqualInt(0,
269 	    archive_pathmatch("/a/b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
270 	assertEqualInt(1,
271 	    archive_pathmatch("/a/b/c", "/a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
272 	assertEqualInt(0,
273 	    archive_pathmatch("/a/b/c$", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
274 	assertEqualInt(0,
275 	    archive_pathmatch("/a/b/c/d$", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
276 	assertEqualInt(0,
277 	    archive_pathmatch("/a/b/c/d$", "/a/b/c/d/e", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
278 	assertEqualInt(1,
279 	    archive_pathmatch("/a/b/c/d$", "/a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
280 	assertEqualInt(1,
281 	    archive_pathmatch("^a/b/c", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
282 	assertEqualInt(0,
283 	    archive_pathmatch("^a/b/c$", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
284 	assertEqualInt(0,
285 	    archive_pathmatch("a/b/c$", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
286 	assertEqualInt(1,
287 	    archive_pathmatch("b/c/d$", "a/b/c/d", PATHMATCH_NO_ANCHOR_START | PATHMATCH_NO_ANCHOR_END));
288 }
289