xref: /illumos-gate/usr/src/lib/libc/port/locale/fnmatch.c (revision 69a119caa6570c7077699161b7c28b6ee9f8b0f4)
1 /*
2  * Copyright (c) 1989, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Guido van Rossum.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright 2010 Nexenta Systems, Inc.  All rights reserved.
35  * Use is subject to license terms.
36  */
37 
38 /*
39  * Function fnmatch() as specified in POSIX 1003.2-1992, section B.6.
40  * Compares a filename or pathname to a pattern.
41  */
42 
43 /*
44  * Some notes on multibyte character support:
45  * 1. Patterns with illegal byte sequences match nothing.
46  * 2. Illegal byte sequences in the "string" argument are handled by treating
47  *    them as single-byte characters with a value of the first byte of the
48  *    sequence cast to wchar_t.
49  * 3. Multibyte conversion state objects (mbstate_t) are passed around and
50  *    used for most, but not all, conversions. Further work will be required
51  *    to support state-dependent encodings.
52  */
53 
54 #include "lint.h"
55 #include <fnmatch.h>
56 #include <limits.h>
57 #include <string.h>
58 #include <wchar.h>
59 #include <wctype.h>
60 
61 #include "collate.h"
62 
63 #define	EOS	'\0'
64 
65 #define	RANGE_MATCH	1
66 #define	RANGE_NOMATCH	0
67 #define	RANGE_ERROR	(-1)
68 
69 static int rangematch(const char *, wchar_t, int, char **, mbstate_t *);
70 static int fnmatch1(const char *, const char *, const char *, int, mbstate_t,
71     mbstate_t);
72 
73 int
74 fnmatch(pattern, string, flags)
75 	const char *pattern, *string;
76 	int flags;
77 {
78 	static const mbstate_t initial = { 0 };
79 
80 	return (fnmatch1(pattern, string, string, flags, initial, initial));
81 }
82 
83 static int
84 fnmatch1(const char *pattern, const char *string, const char *stringstart,
85     int flags, mbstate_t patmbs, mbstate_t strmbs)
86 {
87 	char *newp;
88 	char c;
89 	wchar_t pc, sc;
90 	size_t pclen, sclen;
91 
92 	for (;;) {
93 		pclen = mbrtowc(&pc, pattern, MB_LEN_MAX, &patmbs);
94 		if (pclen == (size_t)-1 || pclen == (size_t)-2)
95 			return (FNM_NOMATCH);
96 		pattern += pclen;
97 		sclen = mbrtowc(&sc, string, MB_LEN_MAX, &strmbs);
98 		if (sclen == (size_t)-1 || sclen == (size_t)-2) {
99 			sc = (unsigned char)*string;
100 			sclen = 1;
101 			(void) memset(&strmbs, 0, sizeof (strmbs));
102 		}
103 		switch (pc) {
104 		case EOS:
105 			/*
106 			 * Removed FNM_LEADING_DIR, as it is not present
107 			 * on Solaris.
108 			 */
109 			return (sc == EOS ? 0 : FNM_NOMATCH);
110 		case '?':
111 			if (sc == EOS)
112 				return (FNM_NOMATCH);
113 			if (sc == '/' && (flags & FNM_PATHNAME))
114 				return (FNM_NOMATCH);
115 			if (sc == '.' && (flags & FNM_PERIOD) &&
116 			    (string == stringstart ||
117 			    ((flags & FNM_PATHNAME) && *(string - 1) == '/')))
118 				return (FNM_NOMATCH);
119 			string += sclen;
120 			break;
121 		case '*':
122 			c = *pattern;
123 			/* Collapse multiple stars. */
124 			while (c == '*')
125 				c = *++pattern;
126 
127 			if (sc == '.' && (flags & FNM_PERIOD) &&
128 			    (string == stringstart ||
129 			    ((flags & FNM_PATHNAME) && *(string - 1) == '/')))
130 				return (FNM_NOMATCH);
131 
132 			/* Optimize for pattern with * at end or before /. */
133 			if (c == EOS)
134 				if (flags & FNM_PATHNAME)
135 					return (strchr(string, '/') == NULL ?
136 					    0 : FNM_NOMATCH);
137 				else
138 					return (0);
139 			else if (c == '/' && flags & FNM_PATHNAME) {
140 				if ((string = strchr(string, '/')) == NULL)
141 					return (FNM_NOMATCH);
142 				break;
143 			}
144 
145 			/* General case, use recursion. */
146 			while (sc != EOS) {
147 				if (!fnmatch1(pattern, string, stringstart,
148 				    flags, patmbs, strmbs))
149 					return (0);
150 				sclen = mbrtowc(&sc, string, MB_LEN_MAX,
151 				    &strmbs);
152 				if (sclen == (size_t)-1 ||
153 				    sclen == (size_t)-2) {
154 					sc = (unsigned char)*string;
155 					sclen = 1;
156 					(void) memset(&strmbs, 0,
157 					    sizeof (strmbs));
158 				}
159 				if (sc == '/' && flags & FNM_PATHNAME)
160 					break;
161 				string += sclen;
162 			}
163 			return (FNM_NOMATCH);
164 		case '[':
165 			if (sc == EOS)
166 				return (FNM_NOMATCH);
167 			if (sc == '/' && (flags & FNM_PATHNAME))
168 				return (FNM_NOMATCH);
169 			if (sc == '.' && (flags & FNM_PERIOD) &&
170 			    (string == stringstart ||
171 			    ((flags & FNM_PATHNAME) && *(string - 1) == '/')))
172 				return (FNM_NOMATCH);
173 
174 			switch (rangematch(pattern, sc, flags, &newp,
175 			    &patmbs)) {
176 			case RANGE_ERROR:
177 				goto norm;
178 			case RANGE_MATCH:
179 				pattern = newp;
180 				break;
181 			case RANGE_NOMATCH:
182 				return (FNM_NOMATCH);
183 			}
184 			string += sclen;
185 			break;
186 		case '\\':
187 			if (!(flags & FNM_NOESCAPE)) {
188 				pclen = mbrtowc(&pc, pattern, MB_LEN_MAX,
189 				    &patmbs);
190 				if (pclen == (size_t)-1 || pclen == (size_t)-2)
191 					return (FNM_NOMATCH);
192 				if (pclen == 0)
193 					pc = '\\';
194 				pattern += pclen;
195 			}
196 			/* FALLTHROUGH */
197 		default:
198 		norm:
199 			if (pc == sc)
200 				string += sclen;
201 
202 			else if ((flags & FNM_IGNORECASE) &&
203 			    (towlower(pc) == towlower(sc)))
204 				string += sclen;
205 			else
206 				return (FNM_NOMATCH);
207 
208 			break;
209 		}
210 	}
211 	/* NOTREACHED */
212 }
213 
214 static int
215 rangematch(pattern, test, flags, newp, patmbs)
216 	const char *pattern;
217 	wchar_t test;
218 	int flags;
219 	char **newp;
220 	mbstate_t *patmbs;
221 {
222 	int negate, ok;
223 	wchar_t c, c2;
224 	size_t pclen;
225 	const char *origpat;
226 
227 	/*
228 	 * A bracket expression starting with an unquoted circumflex
229 	 * character produces unspecified results (IEEE 1003.2-1992,
230 	 * 3.13.2).  This implementation treats it like '!', for
231 	 * consistency with the regular expression syntax.
232 	 * J.T. Conklin (conklin@ngai.kaleida.com)
233 	 */
234 	if ((negate = (*pattern == '!' || *pattern == '^')) != 0)
235 		++pattern;
236 
237 	if (flags & FNM_IGNORECASE)
238 		test = towlower(test);
239 
240 	/*
241 	 * A right bracket shall lose its special meaning and represent
242 	 * itself in a bracket expression if it occurs first in the list.
243 	 * -- POSIX.2 2.8.3.2
244 	 */
245 	ok = 0;
246 	origpat = pattern;
247 	for (;;) {
248 		if (*pattern == ']' && pattern > origpat) {
249 			pattern++;
250 			break;
251 		} else if (*pattern == '\0') {
252 			return (RANGE_ERROR);
253 		} else if (*pattern == '/' && (flags & FNM_PATHNAME)) {
254 			return (RANGE_NOMATCH);
255 		} else if (*pattern == '\\' && !(flags & FNM_NOESCAPE))
256 			pattern++;
257 		pclen = mbrtowc(&c, pattern, MB_LEN_MAX, patmbs);
258 		if (pclen == (size_t)-1 || pclen == (size_t)-2)
259 			return (RANGE_NOMATCH);
260 		pattern += pclen;
261 
262 		if (flags & FNM_IGNORECASE)
263 			c = towlower(c);
264 
265 		if (*pattern == '-' && *(pattern + 1) != EOS &&
266 		    *(pattern + 1) != ']') {
267 			if (*++pattern == '\\' && !(flags & FNM_NOESCAPE))
268 				if (*pattern != EOS)
269 					pattern++;
270 			pclen = mbrtowc(&c2, pattern, MB_LEN_MAX, patmbs);
271 			if (pclen == (size_t)-1 || pclen == (size_t)-2)
272 				return (RANGE_NOMATCH);
273 			pattern += pclen;
274 			if (c2 == EOS)
275 				return (RANGE_ERROR);
276 
277 			if (flags & FNM_IGNORECASE)
278 				c2 = towlower(c2);
279 
280 			if (_collate_load_error ?
281 			    c <= test && test <= c2 :
282 			    _collate_range_cmp(c, test) <= 0 &&
283 			    _collate_range_cmp(test, c2) <= 0)
284 				ok = 1;
285 		} else if (c == test)
286 			ok = 1;
287 	}
288 
289 	*newp = (char *)pattern;
290 	return (ok == negate ? RANGE_NOMATCH : RANGE_MATCH);
291 }
292