1 /*************************************************
2 * Perl-Compatible Regular Expressions *
3 *************************************************/
6 This is a library of functions to support regular expressions whose syntax
7 and semantics are as close as possible to those of the Perl 5 language. See
8 the file Tech.Notes for some information on the internals.
10 This module is a wrapper that provides a POSIX API to the underlying PCRE
13 Written by: Philip Hazel <ph10@cam.ac.uk>
15 Copyright (c) 1997-2004 University of Cambridge
17 -----------------------------------------------------------------------------
18 Redistribution and use in source and binary forms, with or without
19 modification, are permitted provided that the following conditions are met:
21 * Redistributions of source code must retain the above copyright notice,
22 this list of conditions and the following disclaimer.
24 * Redistributions in binary form must reproduce the above copyright
25 notice, this list of conditions and the following disclaimer in the
26 documentation and/or other materials provided with the distribution.
28 * Neither the name of the University of Cambridge nor the names of its
29 contributors may be used to endorse or promote products derived from
30 this software without specific prior written permission.
32 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
33 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
36 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
37 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
38 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
39 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
40 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 POSSIBILITY OF SUCH DAMAGE.
43 -----------------------------------------------------------------------------
47 #include "apr_strings.h"
48 #include "apr_tables.h"
51 #define APR_WANT_STRFUNC
54 #ifndef POSIX_MALLOC_THRESHOLD
55 #define POSIX_MALLOC_THRESHOLD (10)
58 /* Table of error strings corresponding to POSIX error codes; must be
59 * kept in synch with include/ap_regex.h's AP_REG_E* definitions.
62 static const char *const pstring[] = {
63 "", /* Dummy for value 0 */
64 "internal error", /* AP_REG_ASSERT */
65 "failed to get memory", /* AP_REG_ESPACE */
66 "bad argument", /* AP_REG_INVARG */
67 "match failed" /* AP_REG_NOMATCH */
70 AP_DECLARE(const char *) ap_pcre_version_string(int which)
73 case AP_REG_PCRE_COMPILED:
74 return APR_STRINGIFY(PCRE_MAJOR) "." APR_STRINGIFY(PCRE_MINOR) " " APR_STRINGIFY(PCRE_DATE);
75 case AP_REG_PCRE_LOADED:
76 return pcre_version();
82 AP_DECLARE(apr_size_t) ap_regerror(int errcode, const ap_regex_t *preg,
83 char *errbuf, apr_size_t errbuf_size)
85 const char *message, *addmessage;
86 apr_size_t length, addlength;
88 message = (errcode >= (int)(sizeof(pstring) / sizeof(char *))) ?
89 "unknown error code" : pstring[errcode];
90 length = strlen(message) + 1;
92 addmessage = " at offset ";
93 addlength = (preg != NULL && (int)preg->re_erroffset != -1) ?
94 strlen(addmessage) + 6 : 0;
96 if (errbuf_size > 0) {
97 if (addlength > 0 && errbuf_size >= length + addlength)
98 apr_snprintf(errbuf, errbuf_size, "%s%s%-6d", message, addmessage,
99 (int)preg->re_erroffset);
101 apr_cpystrn(errbuf, message, errbuf_size);
104 return length + addlength;
110 /*************************************************
111 * Free store held by a regex *
112 *************************************************/
114 AP_DECLARE(void) ap_regfree(ap_regex_t *preg)
116 (pcre_free)(preg->re_pcre);
122 /*************************************************
123 * Compile a regular expression *
124 *************************************************/
128 * preg points to a structure for recording the compiled expression
129 * pattern the pattern to compile
130 * cflags compilation flags
132 * Returns: 0 on success
133 * various non-zero codes on failure
135 AP_DECLARE(int) ap_regcomp(ap_regex_t * preg, const char *pattern, int cflags)
137 const char *errorptr;
140 int options = PCRE_DUPNAMES;
142 if ((cflags & AP_REG_ICASE) != 0)
143 options |= PCRE_CASELESS;
144 if ((cflags & AP_REG_NEWLINE) != 0)
145 options |= PCRE_MULTILINE;
146 if ((cflags & AP_REG_DOTALL) != 0)
147 options |= PCRE_DOTALL;
150 pcre_compile2(pattern, options, &errcode, &errorptr, &erroffset, NULL);
151 preg->re_erroffset = erroffset;
153 if (preg->re_pcre == NULL) {
155 * There doesn't seem to be constants defined for compile time error
156 * codes. 21 is "failed to get memory" according to pcreapi(3).
159 return AP_REG_ESPACE;
160 return AP_REG_INVARG;
163 pcre_fullinfo((const pcre *)preg->re_pcre, NULL,
164 PCRE_INFO_CAPTURECOUNT, &(preg->re_nsub));
171 /*************************************************
172 * Match a regular expression *
173 *************************************************/
175 /* Unfortunately, PCRE requires 3 ints of working space for each captured
176 * substring, so we have to get and release working store instead of just using
177 * the POSIX structures as was done in earlier releases when PCRE needed only 2
178 * ints. However, if the number of possible capturing brackets is small, use a
179 * block of store on the stack, to reduce the use of malloc/free. The threshold
180 * is in a macro that can be changed at configure time.
182 AP_DECLARE(int) ap_regexec(const ap_regex_t *preg, const char *string,
183 apr_size_t nmatch, ap_regmatch_t *pmatch,
186 return ap_regexec_len(preg, string, strlen(string), nmatch, pmatch,
190 AP_DECLARE(int) ap_regexec_len(const ap_regex_t *preg, const char *buff,
191 apr_size_t len, apr_size_t nmatch,
192 ap_regmatch_t *pmatch, int eflags)
197 int small_ovector[POSIX_MALLOC_THRESHOLD * 3];
198 int allocated_ovector = 0;
200 if ((eflags & AP_REG_NOTBOL) != 0)
201 options |= PCRE_NOTBOL;
202 if ((eflags & AP_REG_NOTEOL) != 0)
203 options |= PCRE_NOTEOL;
205 ((ap_regex_t *)preg)->re_erroffset = (apr_size_t)(-1); /* Only has meaning after compile */
208 if (nmatch <= POSIX_MALLOC_THRESHOLD) {
209 ovector = &(small_ovector[0]);
212 ovector = (int *)malloc(sizeof(int) * nmatch * 3);
214 return AP_REG_ESPACE;
215 allocated_ovector = 1;
219 rc = pcre_exec((const pcre *)preg->re_pcre, NULL, buff, (int)len,
220 0, options, ovector, nmatch * 3);
223 rc = nmatch; /* All captured slots were filled in */
227 for (i = 0; i < (apr_size_t)rc; i++) {
228 pmatch[i].rm_so = ovector[i * 2];
229 pmatch[i].rm_eo = ovector[i * 2 + 1];
231 if (allocated_ovector)
233 for (; i < nmatch; i++)
234 pmatch[i].rm_so = pmatch[i].rm_eo = -1;
239 if (allocated_ovector)
242 case PCRE_ERROR_NOMATCH:
243 return AP_REG_NOMATCH;
244 case PCRE_ERROR_NULL:
245 return AP_REG_INVARG;
246 case PCRE_ERROR_BADOPTION:
247 return AP_REG_INVARG;
248 case PCRE_ERROR_BADMAGIC:
249 return AP_REG_INVARG;
250 case PCRE_ERROR_UNKNOWN_NODE:
251 return AP_REG_ASSERT;
252 case PCRE_ERROR_NOMEMORY:
253 return AP_REG_ESPACE;
254 #ifdef PCRE_ERROR_MATCHLIMIT
255 case PCRE_ERROR_MATCHLIMIT:
256 return AP_REG_ESPACE;
258 #ifdef PCRE_ERROR_BADUTF8
259 case PCRE_ERROR_BADUTF8:
260 return AP_REG_INVARG;
262 #ifdef PCRE_ERROR_BADUTF8_OFFSET
263 case PCRE_ERROR_BADUTF8_OFFSET:
264 return AP_REG_INVARG;
267 return AP_REG_ASSERT;
272 AP_DECLARE(int) ap_regname(const ap_regex_t *preg,
273 apr_array_header_t *names, const char *prefix,
281 pcre_fullinfo((const pcre *)preg->re_pcre, NULL,
282 PCRE_INFO_NAMECOUNT, &namecount);
283 pcre_fullinfo((const pcre *)preg->re_pcre, NULL,
284 PCRE_INFO_NAMEENTRYSIZE, &nameentrysize);
285 pcre_fullinfo((const pcre *)preg->re_pcre, NULL,
286 PCRE_INFO_NAMETABLE, &nametable);
288 for (i = 0; i < namecount; i++) {
289 const char *offset = nametable + i * nameentrysize;
290 int capture = ((offset[0] << 8) + offset[1]);
291 while (names->nelts <= capture) {
292 apr_array_push(names);
294 if (upper || prefix) {
295 char *name = ((char **) names->elts)[capture] =
296 prefix ? apr_pstrcat(names->pool, prefix, offset + 2,
298 apr_pstrdup(names->pool, offset + 2);
300 ap_str_toupper(name);
304 ((const char **)names->elts)[capture] = offset + 2;
311 /* End of pcreposix.c */