1 /*************************************************
2 * Perl-Compatible Regular Expressions *
3 *************************************************/
4
5 /* PCRE is a library of functions to support regular expressions whose syntax
6 and semantics are as close as possible to those of the Perl 5 language.
7
8 Written by Philip Hazel
9 Copyright (c) 1997-2020 University of Cambridge
10
11 -----------------------------------------------------------------------------
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14
15 * Redistributions of source code must retain the above copyright notice,
16 this list of conditions and the following disclaimer.
17
18 * Redistributions in binary form must reproduce the above copyright
19 notice, this list of conditions and the following disclaimer in the
20 documentation and/or other materials provided with the distribution.
21
22 * Neither the name of the University of Cambridge nor the names of its
23 contributors may be used to endorse or promote products derived from
24 this software without specific prior written permission.
25
26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
30 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 POSSIBILITY OF SUCH DAMAGE.
37 -----------------------------------------------------------------------------
38 */
39
40
41 /* This module is a wrapper that provides a POSIX API to the underlying PCRE
42 functions. */
43
44
45 #ifdef HAVE_CONFIG_H
46 #include "config.h"
47 #endif
48
49 /* We include pcre.h before pcre_internal.h so that the PCRE library functions
50 are declared as "import" for Windows by defining PCRE_EXP_DECL as "import".
51 This is needed even though pcre_internal.h itself includes pcre.h, because it
52 does so after it has set PCRE_EXP_DECL to "export" if it is not already set. */
53
54 #include "pcre.h"
55 #include "pcre_internal.h"
56 #include "pcreposix.h"
57
58
59 /* Table to translate PCRE compile time error codes into POSIX error codes. */
60
61 static const int eint[] = {
62 0, /* no error */
63 PCRE_REG_EESCAPE, /* \ at end of pattern */
64 PCRE_REG_EESCAPE, /* \c at end of pattern */
65 PCRE_REG_EESCAPE, /* unrecognized character follows \ */
66 PCRE_REG_BADBR, /* numbers out of order in {} quantifier */
67 /* 5 */
68 PCRE_REG_BADBR, /* number too big in {} quantifier */
69 PCRE_REG_EBRACK, /* missing terminating ] for character class */
70 PCRE_REG_ECTYPE, /* invalid escape sequence in character class */
71 PCRE_REG_ERANGE, /* range out of order in character class */
72 PCRE_REG_BADRPT, /* nothing to repeat */
73 /* 10 */
74 PCRE_REG_BADRPT, /* operand of unlimited repeat could match the empty string */
75 PCRE_REG_ASSERT, /* internal error: unexpected repeat */
76 PCRE_REG_BADPAT, /* unrecognized character after (? */
77 PCRE_REG_BADPAT, /* POSIX named classes are supported only within a class */
78 PCRE_REG_EPAREN, /* missing ) */
79 /* 15 */
80 PCRE_REG_ESUBREG, /* reference to non-existent subpattern */
81 PCRE_REG_INVARG, /* erroffset passed as NULL */
82 PCRE_REG_INVARG, /* unknown option bit(s) set */
83 PCRE_REG_EPAREN, /* missing ) after comment */
84 PCRE_REG_ESIZE, /* parentheses nested too deeply */
85 /* 20 */
86 PCRE_REG_ESIZE, /* regular expression too large */
87 PCRE_REG_ESPACE, /* failed to get memory */
88 PCRE_REG_EPAREN, /* unmatched parentheses */
89 PCRE_REG_ASSERT, /* internal error: code overflow */
90 PCRE_REG_BADPAT, /* unrecognized character after (?< */
91 /* 25 */
92 PCRE_REG_BADPAT, /* lookbehind assertion is not fixed length */
93 PCRE_REG_BADPAT, /* malformed number or name after (?( */
94 PCRE_REG_BADPAT, /* conditional group contains more than two branches */
95 PCRE_REG_BADPAT, /* assertion expected after (?( */
96 PCRE_REG_BADPAT, /* (?R or (?[+-]digits must be followed by ) */
97 /* 30 */
98 PCRE_REG_ECTYPE, /* unknown POSIX class name */
99 PCRE_REG_BADPAT, /* POSIX collating elements are not supported */
100 PCRE_REG_INVARG, /* this version of PCRE is not compiled with PCRE_UTF8 support */
101 PCRE_REG_BADPAT, /* spare error */
102 PCRE_REG_BADPAT, /* character value in \x{} or \o{} is too large */
103 /* 35 */
104 PCRE_REG_BADPAT, /* invalid condition (?(0) */
105 PCRE_REG_BADPAT, /* \C not allowed in lookbehind assertion */
106 PCRE_REG_EESCAPE, /* PCRE does not support \L, \l, \N, \U, or \u */
107 PCRE_REG_BADPAT, /* number after (?C is > 255 */
108 PCRE_REG_BADPAT, /* closing ) for (?C expected */
109 /* 40 */
110 PCRE_REG_BADPAT, /* recursive call could loop indefinitely */
111 PCRE_REG_BADPAT, /* unrecognized character after (?P */
112 PCRE_REG_BADPAT, /* syntax error in subpattern name (missing terminator) */
113 PCRE_REG_BADPAT, /* two named subpatterns have the same name */
114 PCRE_REG_BADPAT, /* invalid UTF-8 string */
115 /* 45 */
116 PCRE_REG_BADPAT, /* support for \P, \p, and \X has not been compiled */
117 PCRE_REG_BADPAT, /* malformed \P or \p sequence */
118 PCRE_REG_BADPAT, /* unknown property name after \P or \p */
119 PCRE_REG_BADPAT, /* subpattern name is too long (maximum 32 characters) */
120 PCRE_REG_BADPAT, /* too many named subpatterns (maximum 10,000) */
121 /* 50 */
122 PCRE_REG_BADPAT, /* repeated subpattern is too long */
123 PCRE_REG_BADPAT, /* octal value is greater than \377 (not in UTF-8 mode) */
124 PCRE_REG_BADPAT, /* internal error: overran compiling workspace */
125 PCRE_REG_BADPAT, /* internal error: previously-checked referenced subpattern not found */
126 PCRE_REG_BADPAT, /* DEFINE group contains more than one branch */
127 /* 55 */
128 PCRE_REG_BADPAT, /* repeating a DEFINE group is not allowed */
129 PCRE_REG_INVARG, /* inconsistent NEWLINE options */
130 PCRE_REG_BADPAT, /* \g is not followed followed by an (optionally braced) non-zero number */
131 PCRE_REG_BADPAT, /* a numbered reference must not be zero */
132 PCRE_REG_BADPAT, /* an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT) */
133 /* 60 */
134 PCRE_REG_BADPAT, /* (*VERB) not recognized */
135 PCRE_REG_BADPAT, /* number is too big */
136 PCRE_REG_BADPAT, /* subpattern name expected */
137 PCRE_REG_BADPAT, /* digit expected after (?+ */
138 PCRE_REG_BADPAT, /* ] is an invalid data character in JavaScript compatibility mode */
139 /* 65 */
140 PCRE_REG_BADPAT, /* different names for subpatterns of the same number are not allowed */
141 PCRE_REG_BADPAT, /* (*MARK) must have an argument */
142 PCRE_REG_INVARG, /* this version of PCRE is not compiled with PCRE_UCP support */
143 PCRE_REG_BADPAT, /* \c must be followed by an ASCII character */
144 PCRE_REG_BADPAT, /* \k is not followed by a braced, angle-bracketed, or quoted name */
145 /* 70 */
146 PCRE_REG_BADPAT, /* internal error: unknown opcode in find_fixedlength() */
147 PCRE_REG_BADPAT, /* \N is not supported in a class */
148 PCRE_REG_BADPAT, /* too many forward references */
149 PCRE_REG_BADPAT, /* disallowed UTF-8/16/32 code point (>= 0xd800 && <= 0xdfff) */
150 PCRE_REG_BADPAT, /* invalid UTF-16 string (should not occur) */
151 /* 75 */
152 PCRE_REG_BADPAT, /* overlong MARK name */
153 PCRE_REG_BADPAT, /* character value in \u.... sequence is too large */
154 PCRE_REG_BADPAT, /* invalid UTF-32 string (should not occur) */
155 PCRE_REG_BADPAT, /* setting UTF is disabled by the application */
156 PCRE_REG_BADPAT, /* non-hex character in \\x{} (closing brace missing?) */
157 /* 80 */
158 PCRE_REG_BADPAT, /* non-octal character in \o{} (closing brace missing?) */
159 PCRE_REG_BADPAT, /* missing opening brace after \o */
160 PCRE_REG_BADPAT, /* parentheses too deeply nested */
161 PCRE_REG_BADPAT, /* invalid range in character class */
162 PCRE_REG_BADPAT, /* group name must start with a non-digit */
163 /* 85 */
164 PCRE_REG_BADPAT, /* parentheses too deeply nested (stack check) */
165 PCRE_REG_BADPAT, /* missing digits in \x{} or \o{} */
166 PCRE_REG_BADPAT /* pattern too complicated */
167 };
168
169 /* Table of texts corresponding to POSIX error codes */
170
171 static const char *const pstring[] = {
172 "", /* Dummy for value 0 */
173 "internal error", /* REG_ASSERT */
174 "invalid repeat counts in {}", /* BADBR */
175 "pattern error", /* BADPAT */
176 "? * + invalid", /* BADRPT */
177 "unbalanced {}", /* EBRACE */
178 "unbalanced []", /* EBRACK */
179 "collation error - not relevant", /* ECOLLATE */
180 "bad class", /* ECTYPE */
181 "bad escape sequence", /* EESCAPE */
182 "empty expression", /* EMPTY */
183 "unbalanced ()", /* EPAREN */
184 "bad range inside []", /* ERANGE */
185 "expression too big", /* ESIZE */
186 "failed to get memory", /* ESPACE */
187 "bad back reference", /* ESUBREG */
188 "bad argument", /* INVARG */
189 "match failed" /* NOMATCH */
190 };
191
192
193
194
195 /*************************************************
196 * Translate error code to string *
197 *************************************************/
198
199 PCREPOSIX_EXP_DEFN size_t PCRE_CALL_CONVENTION
pcre_regerror(int errcode,const pcre_regex_t * preg,char * errbuf,size_t errbuf_size)200 pcre_regerror(int errcode, const pcre_regex_t *preg, char *errbuf, size_t errbuf_size)
201 {
202 const char *message, *addmessage;
203 size_t length, addlength;
204
205 message = (errcode >= (int)(sizeof(pstring)/sizeof(char *)))?
206 "unknown error code" : pstring[errcode];
207 length = strlen(message) + 1;
208
209 addmessage = " at offset ";
210 addlength = (preg != NULL && (int)preg->re_erroffset != -1)?
211 strlen(addmessage) + 6 : 0;
212
213 if (errbuf_size > 0)
214 {
215 if (addlength > 0 && errbuf_size >= length + addlength)
216 sprintf(errbuf, "%s%s%-6d", message, addmessage, (int)preg->re_erroffset);
217 else
218 {
219 strncpy(errbuf, message, errbuf_size - 1);
220 errbuf[errbuf_size-1] = 0;
221 }
222 }
223
224 return length + addlength;
225 }
226
227
228
229
230 /*************************************************
231 * Free store held by a regex *
232 *************************************************/
233
234 PCREPOSIX_EXP_DEFN void PCRE_CALL_CONVENTION
pcre_regfree(pcre_regex_t * preg)235 pcre_regfree(pcre_regex_t *preg)
236 {
237 (PUBL(free))(preg->re_pcre);
238 }
239
240
241
242
243 /*************************************************
244 * Compile a regular expression *
245 *************************************************/
246
247 /*
248 Arguments:
249 preg points to a structure for recording the compiled expression
250 pattern the pattern to compile
251 cflags compilation flags
252
253 Returns: 0 on success
254 various non-zero codes on failure
255 */
256
257 PCREPOSIX_EXP_DEFN int PCRE_CALL_CONVENTION
pcre_regcomp(pcre_regex_t * preg,const char * pattern,int cflags)258 pcre_regcomp(pcre_regex_t *preg, const char *pattern, int cflags)
259 {
260 const char *errorptr;
261 int erroffset;
262 int errorcode;
263 int options = 0;
264 int re_nsub = 0;
265
266 if ((cflags & PCRE_REG_ICASE) != 0) options |= PCRE_CASELESS;
267 if ((cflags & PCRE_REG_NEWLINE) != 0) options |= PCRE_MULTILINE;
268 if ((cflags & PCRE_REG_DOTALL) != 0) options |= PCRE_DOTALL;
269 if ((cflags & PCRE_REG_NOSUB) != 0) options |= PCRE_NO_AUTO_CAPTURE;
270 if ((cflags & PCRE_REG_UTF8) != 0) options |= PCRE_UTF8;
271 if ((cflags & PCRE_REG_UCP) != 0) options |= PCRE_UCP;
272 if ((cflags & PCRE_REG_UNGREEDY) != 0) options |= PCRE_UNGREEDY;
273
274 preg->re_pcre = pcre_compile2(pattern, options, &errorcode, &errorptr,
275 &erroffset, NULL);
276 preg->re_erroffset = erroffset;
277
278 /* Safety: if the error code is too big for the translation vector (which
279 should not happen, but we all make mistakes), return REG_BADPAT. */
280
281 if (preg->re_pcre == NULL)
282 {
283 return (errorcode < (int)(sizeof(eint)/sizeof(const int)))?
284 eint[errorcode] : PCRE_REG_BADPAT;
285 }
286
287 (void)pcre_fullinfo((const pcre *)preg->re_pcre, NULL, PCRE_INFO_CAPTURECOUNT,
288 &re_nsub);
289 preg->re_nsub = (size_t)re_nsub;
290 preg->re_erroffset = (size_t)(-1); /* No meaning after successful compile */
291 return 0;
292 }
293
294
295
296
297 /*************************************************
298 * Match a regular expression *
299 *************************************************/
300
301 /* Unfortunately, PCRE requires 3 ints of working space for each captured
302 substring, so we have to get and release working store instead of just using
303 the POSIX structures as was done in earlier releases when PCRE needed only 2
304 ints. However, if the number of possible capturing brackets is small, use a
305 block of store on the stack, to reduce the use of malloc/free. The threshold is
306 in a macro that can be changed at configure time.
307
308 If REG_NOSUB was specified at compile time, the PCRE_NO_AUTO_CAPTURE flag will
309 be set. When this is the case, the nmatch and pmatch arguments are ignored, and
310 the only result is yes/no/error. */
311
312 PCREPOSIX_EXP_DEFN int PCRE_CALL_CONVENTION
pcre_regexec(const pcre_regex_t * preg,const char * string,size_t nmatch,pcre_regmatch_t pmatch[],int eflags)313 pcre_regexec(const pcre_regex_t *preg, const char *string, size_t nmatch,
314 pcre_regmatch_t pmatch[], int eflags)
315 {
316 int rc, so, eo;
317 int options = 0;
318 int *ovector = NULL;
319 int small_ovector[POSIX_MALLOC_THRESHOLD * 3];
320 BOOL allocated_ovector = FALSE;
321 BOOL nosub =
322 (REAL_PCRE_OPTIONS((const pcre *)preg->re_pcre) & PCRE_NO_AUTO_CAPTURE) != 0;
323
324 if ((eflags & PCRE_REG_NOTBOL) != 0) options |= PCRE_NOTBOL;
325 if ((eflags & PCRE_REG_NOTEOL) != 0) options |= PCRE_NOTEOL;
326 if ((eflags & PCRE_REG_NOTEMPTY) != 0) options |= PCRE_NOTEMPTY;
327
328 /* When no string data is being returned, or no vector has been passed in which
329 to put it, ensure that nmatch is zero. Otherwise, ensure the vector for holding
330 the return data is large enough. */
331
332 if (nosub || pmatch == NULL) nmatch = 0;
333
334 else if (nmatch > 0)
335 {
336 if (nmatch <= POSIX_MALLOC_THRESHOLD)
337 {
338 ovector = &(small_ovector[0]);
339 }
340 else
341 {
342 if (nmatch > INT_MAX/(sizeof(int) * 3)) return PCRE_REG_ESPACE;
343 ovector = (int *)malloc(sizeof(int) * nmatch * 3);
344 if (ovector == NULL) return PCRE_REG_ESPACE;
345 allocated_ovector = TRUE;
346 }
347 }
348
349 /* REG_STARTEND is a BSD extension, to allow for non-NUL-terminated strings.
350 The man page from OS X says "REG_STARTEND affects only the location of the
351 string, not how it is matched". That is why the "so" value is used to bump the
352 start location rather than being passed as a PCRE "starting offset". */
353
354 if ((eflags & PCRE_REG_STARTEND) != 0)
355 {
356 if (pmatch == NULL) return PCRE_REG_INVARG;
357 so = pmatch[0].rm_so;
358 eo = pmatch[0].rm_eo;
359 }
360 else
361 {
362 so = 0;
363 eo = (int)strlen(string);
364 }
365
366 rc = pcre_exec((const pcre *)preg->re_pcre, NULL, string + so, (eo - so),
367 0, options, ovector, (int)(nmatch * 3));
368
369 if (rc == 0) rc = (int)nmatch; /* All captured slots were filled in */
370
371 /* Successful match */
372
373 if (rc >= 0)
374 {
375 size_t i;
376 if (!nosub)
377 {
378 for (i = 0; i < (size_t)rc; i++)
379 {
380 pmatch[i].rm_so = (ovector[i*2] < 0)? -1 : ovector[i*2] + so;
381 pmatch[i].rm_eo = (ovector[i*2+1] < 0)? -1: ovector[i*2+1] + so;
382 }
383 if (allocated_ovector) free(ovector);
384 for (; i < nmatch; i++) pmatch[i].rm_so = pmatch[i].rm_eo = -1;
385 }
386 return 0;
387 }
388
389 /* Unsuccessful match */
390
391 if (allocated_ovector) free(ovector);
392 switch(rc)
393 {
394 /* ========================================================================== */
395 /* These cases are never obeyed. This is a fudge that causes a compile-time
396 error if the vector eint, which is indexed by compile-time error number, is
397 not the correct length. It seems to be the only way to do such a check at
398 compile time, as the sizeof() operator does not work in the C preprocessor.
399 As all the PCRE_ERROR_xxx values are negative, we can use 0 and 1. */
400
401 case 0:
402 case (sizeof(eint)/sizeof(int) == ERRCOUNT):
403 return PCRE_REG_ASSERT;
404 /* ========================================================================== */
405
406 case PCRE_ERROR_NOMATCH: return PCRE_REG_NOMATCH;
407 case PCRE_ERROR_NULL: return PCRE_REG_INVARG;
408 case PCRE_ERROR_BADOPTION: return PCRE_REG_INVARG;
409 case PCRE_ERROR_BADMAGIC: return PCRE_REG_INVARG;
410 case PCRE_ERROR_UNKNOWN_NODE: return PCRE_REG_ASSERT;
411 case PCRE_ERROR_NOMEMORY: return PCRE_REG_ESPACE;
412 case PCRE_ERROR_MATCHLIMIT: return PCRE_REG_ESPACE;
413 case PCRE_ERROR_BADUTF8: return PCRE_REG_INVARG;
414 case PCRE_ERROR_BADUTF8_OFFSET: return PCRE_REG_INVARG;
415 case PCRE_ERROR_BADMODE: return PCRE_REG_INVARG;
416 default: return PCRE_REG_ASSERT;
417 }
418 }
419
420 /* End of pcreposix.c */
421