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
  61 static const char *const pstring[] = {
  62     "",                         /* Dummy for value 0 */
  63     "internal error",           /* AP_REG_ASSERT */
  64     "failed to get memory",     /* AP_REG_ESPACE */
  65     "bad argument",             /* AP_REG_INVARG */
  66     "match failed"              /* AP_REG_NOMATCH */
  67 };
  68
  69 AP_DECLARE(apr_size_t) ap_regerror(int errcode, const ap_regex_t *preg,
  70                                    char *errbuf, apr_size_t errbuf_size)
  71 {
  72     const char *message, *addmessage;
  73     apr_size_t length, addlength;
  74
  75     message = (errcode >= (int)(sizeof(pstring) / sizeof(char *))) ?
  76               "unknown error code" : pstring[errcode];
  77     length = strlen(message) + 1;
  78
  79     addmessage = " at offset ";
  80     addlength = (preg != NULL && (int)preg->re_erroffset != -1) ?
  81                 strlen(addmessage) + 6 : 0;
  82
  83     if (errbuf_size > 0) {
  84         if (addlength > 0 && errbuf_size >= length + addlength)
  85             apr_snprintf(errbuf, errbuf_size, "%s%s%-6d", message, addmessage,
  86                          (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 AP_DECLARE(int) ap_regcomp(ap_regex_t * preg, const char *pattern, int cflags)
 123 {
 124     const char *errorptr;
 125     int erroffset;
 126     int options = 0;
 127
 128     if ((cflags & AP_REG_ICASE) != 0)
 129         options |= PCRE_CASELESS;
 130     if ((cflags & AP_REG_NEWLINE) != 0)
 131         options |= PCRE_MULTILINE;
 132     if ((cflags & AP_REG_DOTALL) != 0)
 133         options |= PCRE_DOTALL;
 134
 135     preg->re_pcre =
 136         pcre_compile(pattern, options, &errorptr, &erroffset, NULL);
 137     preg->re_erroffset = erroffset;
 138
 139     if (preg->re_pcre == NULL)
 140         return AP_REG_INVARG;
 141
 142     pcre_fullinfo((const pcre *)preg->re_pcre, NULL,
 143                    PCRE_INFO_CAPTURECOUNT, &(preg->re_nsub));
 144     return 0;
 145 }
 146
 147
 148
 149
 150 /*************************************************
 151  *              Match a regular expression       *
 152  *************************************************/
 153
 154 /* Unfortunately, PCRE requires 3 ints of working space for each captured
 155  * substring, so we have to get and release working store instead of just using
 156  * the POSIX structures as was done in earlier releases when PCRE needed only 2
 157  * ints. However, if the number of possible capturing brackets is small, use a
 158  * block of store on the stack, to reduce the use of malloc/free. The threshold
 159  * is in a macro that can be changed at configure time.
 160  */
 161 AP_DECLARE(int) ap_regexec(const ap_regex_t *preg, const char *string,
 162                            apr_size_t nmatch, ap_regmatch_t *pmatch,
 163                            int eflags)
 164 {
 165     return ap_regexec_len(preg, string, strlen(string), nmatch, pmatch,
 166                           eflags);
 167 }
 168
 169 AP_DECLARE(int) ap_regexec_len(const ap_regex_t *preg, const char *buff,
 170                                apr_size_t len, apr_size_t nmatch,
 171                                ap_regmatch_t *pmatch, int eflags)
 172 {
 173     int rc;
 174     int options = 0;
 175     int *ovector = NULL;
 176     int small_ovector[POSIX_MALLOC_THRESHOLD * 3];
 177     int allocated_ovector = 0;
 178
 179     if ((eflags & AP_REG_NOTBOL) != 0)
 180         options |= PCRE_NOTBOL;
 181     if ((eflags & AP_REG_NOTEOL) != 0)
 182         options |= PCRE_NOTEOL;
 183
 184     ((ap_regex_t *)preg)->re_erroffset = (apr_size_t)(-1);    /* Only has meaning after compile */
 185
 186     if (nmatch > 0) {
 187         if (nmatch <= POSIX_MALLOC_THRESHOLD) {
 188             ovector = &(small_ovector[0]);
 189         }
 190         else {
 191             ovector = (int *)malloc(sizeof(int) * nmatch * 3);
 192             if (ovector == NULL)
 193                 return AP_REG_ESPACE;
 194             allocated_ovector = 1;
 195         }
 196     }
 197
 198     rc = pcre_exec((const pcre *)preg->re_pcre, NULL, buff, (int)len,
 199                    0, options, ovector, nmatch * 3);
 200
 201     if (rc == 0)
 202         rc = nmatch;            /* All captured slots were filled in */
 203
 204     if (rc >= 0) {
 205         apr_size_t i;
 206         for (i = 0; i < (apr_size_t)rc; i++) {
 207             pmatch[i].rm_so = ovector[i * 2];
 208             pmatch[i].rm_eo = ovector[i * 2 + 1];
 209         }
 210         if (allocated_ovector)
 211             free(ovector);
 212         for (; i < nmatch; i++)
 213             pmatch[i].rm_so = pmatch[i].rm_eo = -1;
 214         return 0;
 215     }
 216
 217     else {
 218         if (allocated_ovector)
 219             free(ovector);
 220         switch (rc) {
 221         case PCRE_ERROR_NOMATCH:
 222             return AP_REG_NOMATCH;
 223         case PCRE_ERROR_NULL:
 224             return AP_REG_INVARG;
 225         case PCRE_ERROR_BADOPTION:
 226             return AP_REG_INVARG;
 227         case PCRE_ERROR_BADMAGIC:
 228             return AP_REG_INVARG;
 229         case PCRE_ERROR_UNKNOWN_NODE:
 230             return AP_REG_ASSERT;
 231         case PCRE_ERROR_NOMEMORY:
 232             return AP_REG_ESPACE;
 233 #ifdef PCRE_ERROR_MATCHLIMIT
 234         case PCRE_ERROR_MATCHLIMIT:
 235             return AP_REG_ESPACE;
 236 #endif
 237 #ifdef PCRE_ERROR_BADUTF8
 238         case PCRE_ERROR_BADUTF8:
 239             return AP_REG_INVARG;
 240 #endif
 241 #ifdef PCRE_ERROR_BADUTF8_OFFSET
 242         case PCRE_ERROR_BADUTF8_OFFSET:
 243             return AP_REG_INVARG;
 244 #endif
 245         default:
 246             return AP_REG_ASSERT;
 247         }
 248     }
 249 }
 250
 251 /* End of pcreposix.c */