granicus.if.org Git - apache/blob - server/util_pcre.c

   1 /*************************************************
   2 *      Perl-Compatible Regular Expressions       *
   3 *************************************************/
   4
   5 /*
   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.
   9
  10 This module is a wrapper that provides a POSIX API to the underlying PCRE
  11 functions.
  12
  13 Written by: Philip Hazel <ph10@cam.ac.uk>
  14
  15            Copyright (c) 1997-2004 University of Cambridge
  16
  17 -----------------------------------------------------------------------------
  18 Redistribution and use in source and binary forms, with or without
  19 modification, are permitted provided that the following conditions are met:
  20
  21     * Redistributions of source code must retain the above copyright notice,
  22       this list of conditions and the following disclaimer.
  23
  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.
  27
  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.
  31
  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 -----------------------------------------------------------------------------
  44 */
  45
  46 #include "httpd.h"
  47 #include "apr_strings.h"
  48 #include "pcre.h"
  49
  50 #define APR_WANT_STRFUNC
  51 #include "apr_want.h"
  52
  53 #ifndef POSIX_MALLOC_THRESHOLD
  54 #define POSIX_MALLOC_THRESHOLD (10)
  55 #endif
  56
  57 /* Table of error strings corresponding to POSIX error codes; must be
  58  * kept in synch with include/ap_regex.h's AP_REG_E* definitions. */
  59
  60 static const char *const pstring[] = {
  61   "",                                /* Dummy for value 0 */
  62   "internal error",                  /* AP_REG_ASSERT */
  63   "failed to get memory",            /* AP_REG_ESPACE */
  64   "bad argument",                    /* AP_REG_INVARG */
  65   "match failed"                     /* AP_REG_NOMATCH */
  66 };
  67
  68 AP_DECLARE(apr_size_t) ap_regerror(int errcode, const ap_regex_t *preg,
  69                                    char *errbuf, apr_size_t errbuf_size)
  70 {
  71 const char *message, *addmessage;
  72 apr_size_t length, addlength;
  73
  74 message = (errcode >= (int)(sizeof(pstring)/sizeof(char *)))?
  75   "unknown error code" : pstring[errcode];
  76 length = strlen(message) + 1;
  77
  78 addmessage = " at offset ";
  79 addlength = (preg != NULL && (int)preg->re_erroffset != -1)?
  80   strlen(addmessage) + 6 : 0;
  81
  82 if (errbuf_size > 0)
  83   {
  84   if (addlength > 0 && errbuf_size >= length + addlength)
  85       apr_snprintf(errbuf, sizeof errbuf,
  86                    "%s%s%-6d", message, addmessage, (int)preg->re_erroffset);
  87   else
  88     apr_cpystrn(errbuf, message, errbuf_size);
  89   }
  90
  91 return length + addlength;
  92 }
  93
  94
  95
  96
  97 /*************************************************
  98 *           Free store held by a regex           *
  99 *************************************************/
 100
 101 AP_DECLARE(void) ap_regfree(ap_regex_t *preg)
 102 {
 103 (pcre_free)(preg->re_pcre);
 104 }
 105
 106
 107
 108
 109 /*************************************************
 110 *            Compile a regular expression        *
 111 *************************************************/
 112
 113 /*
 114 Arguments:
 115   preg        points to a structure for recording the compiled expression
 116   pattern     the pattern to compile
 117   cflags      compilation flags
 118
 119 Returns:      0 on success
 120               various non-zero codes on failure
 121 */
 122
 123 AP_DECLARE(int) ap_regcomp(ap_regex_t *preg, const char *pattern, int cflags)
 124 {
 125 const char *errorptr;
 126 int erroffset;
 127 int options = 0;
 128
 129 if ((cflags & AP_REG_ICASE) != 0) options |= PCRE_CASELESS;
 130 if ((cflags & AP_REG_NEWLINE) != 0) options |= PCRE_MULTILINE;
 131
 132 preg->re_pcre = pcre_compile(pattern, options, &errorptr, &erroffset, NULL);
 133 preg->re_erroffset = erroffset;
 134
 135 if (preg->re_pcre == NULL) return AP_REG_INVARG;
 136
 137 preg->re_nsub = pcre_info((const pcre *)preg->re_pcre, NULL, NULL);
 138 return 0;
 139 }
 140
 141
 142
 143
 144 /*************************************************
 145 *              Match a regular expression        *
 146 *************************************************/
 147
 148 /* Unfortunately, PCRE requires 3 ints of working space for each captured
 149 substring, so we have to get and release working store instead of just using
 150 the POSIX structures as was done in earlier releases when PCRE needed only 2
 151 ints. However, if the number of possible capturing brackets is small, use a
 152 block of store on the stack, to reduce the use of malloc/free. The threshold is
 153 in a macro that can be changed at configure time. */
 154
 155 AP_DECLARE(int) ap_regexec(const ap_regex_t *preg, const char *string,
 156                            apr_size_t nmatch, ap_regmatch_t pmatch[],
 157                            int eflags)
 158 {
 159 int rc;
 160 int options = 0;
 161 int *ovector = NULL;
 162 int small_ovector[POSIX_MALLOC_THRESHOLD * 3];
 163 int allocated_ovector = 0;
 164
 165 if ((eflags & AP_REG_NOTBOL) != 0) options |= PCRE_NOTBOL;
 166 if ((eflags & AP_REG_NOTEOL) != 0) options |= PCRE_NOTEOL;
 167
 168 ((ap_regex_t *)preg)->re_erroffset = (apr_size_t)(-1);  /* Only has meaning after compile */
 169
 170 if (nmatch > 0)
 171   {
 172   if (nmatch <= POSIX_MALLOC_THRESHOLD)
 173     {
 174     ovector = &(small_ovector[0]);
 175     }
 176   else
 177     {
 178     ovector = (int *)malloc(sizeof(int) * nmatch * 3);
 179     if (ovector == NULL) return AP_REG_ESPACE;
 180     allocated_ovector = 1;
 181     }
 182   }
 183
 184 rc = pcre_exec((const pcre *)preg->re_pcre, NULL, string, (int)strlen(string),
 185   0, options, ovector, nmatch * 3);
 186
 187 if (rc == 0) rc = nmatch;    /* All captured slots were filled in */
 188
 189 if (rc >= 0)
 190   {
 191   apr_size_t i;
 192   for (i = 0; i < (apr_size_t)rc; i++)
 193     {
 194     pmatch[i].rm_so = ovector[i*2];
 195     pmatch[i].rm_eo = ovector[i*2+1];
 196     }
 197   if (allocated_ovector) free(ovector);
 198   for (; i < nmatch; i++) pmatch[i].rm_so = pmatch[i].rm_eo = -1;
 199   return 0;
 200   }
 201
 202 else
 203   {
 204   if (allocated_ovector) free(ovector);
 205   switch(rc)
 206     {
 207     case PCRE_ERROR_NOMATCH: return AP_REG_NOMATCH;
 208     case PCRE_ERROR_NULL: return AP_REG_INVARG;
 209     case PCRE_ERROR_BADOPTION: return AP_REG_INVARG;
 210     case PCRE_ERROR_BADMAGIC: return AP_REG_INVARG;
 211     case PCRE_ERROR_UNKNOWN_NODE: return AP_REG_ASSERT;
 212     case PCRE_ERROR_NOMEMORY: return AP_REG_ESPACE;
 213 #ifdef PCRE_ERROR_MATCHLIMIT
 214     case PCRE_ERROR_MATCHLIMIT: return AP_REG_ESPACE;
 215 #endif
 216 #ifdef PCRE_ERROR_BADUTF8
 217     case PCRE_ERROR_BADUTF8: return AP_REG_INVARG;
 218 #endif
 219 #ifdef PCRE_ERROR_BADUTF8_OFFSET
 220     case PCRE_ERROR_BADUTF8_OFFSET: return AP_REG_INVARG;
 221 #endif
 222     default: return AP_REG_ASSERT;
 223     }
 224   }
 225 }
 226
 227 /* End of pcreposix.c */