pcrs.c

   1 const char pcrs_rcs[] = "$Id: pcrs.c,v 1.25 2007/04/30 15:02:18 fabiankeil Exp $";
   2
   3 /*********************************************************************
   4  *
   5  * File        :  $Source: /cvsroot/ijbswa/current/pcrs.c,v $
   6  *
   7  * Purpose     :  pcrs is a supplement to the pcre library by Philip Hazel
   8  *                <ph10@cam.ac.uk> and adds Perl-style substitution. That
   9  *                is, it mimics Perl's 's' operator. See pcrs(3) for details.
  10  *
  11  *                WARNING: This file contains additional functions and bug
  12  *                fixes that aren't part of the latest official pcrs package
  13  *                (which apparently is no longer maintained).
  14  *
  15  * Copyright   :  Written and Copyright (C) 2000, 2001 by Andreas S. Oesterhelt
  16  *                <andreas@oesterhelt.org>
  17  *
  18  *                Copyright (C) 2006, 2007 Fabian Keil <fk@fabiankeil.de>
  19  *
  20  *                This program is free software; you can redistribute it
  21  *                and/or modify it under the terms of the GNU Lesser
  22  *                General Public License (LGPL), version 2.1, which  should
  23  *                be included in this distribution (see LICENSE.txt), with
  24  *                the exception that the permission to replace that license
  25  *                with the GNU General Public License (GPL) given in section
  26  *                3 is restricted to version 2 of the GPL.
  27  *
  28  *                This program is distributed in the hope that it will
  29  *                be useful, but WITHOUT ANY WARRANTY; without even the
  30  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  31  *                PARTICULAR PURPOSE.  See the license for more details.
  32  *
  33  *                The GNU Lesser General Public License should be included
  34  *                with this file.  If not, you can view it at
  35  *                http://www.gnu.org/licenses/lgpl.html
  36  *                or write to the Free Software Foundation, Inc., 59
  37  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  38  *
  39  * Revisions   :
  40  *    $Log: pcrs.c,v $
  41  *    Revision 1.25  2007/04/30 15:02:18  fabiankeil
  42  *    Introduce dynamic pcrs jobs that can resolve variables.
  43  *
  44  *    Revision 1.24  2007/01/05 15:46:12  fabiankeil
  45  *    Don't use strlen() to calculate the length of
  46  *    the pcrs substitutes. They don't have to be valid C
  47  *    strings and getting their length wrong can result in
  48  *    user-controlled memory corruption.
  49  *
  50  *    Thanks to Felix Gröbert for reporting the problem
  51  *    and providing the fix [#1627140].
  52  *
  53  *    Revision 1.23  2006/12/29 17:53:05  fabiankeil
  54  *    Fixed gcc43 conversion warnings.
  55  *
  56  *    Revision 1.22  2006/12/24 17:34:20  fabiankeil
  57  *    Add pcrs_strerror() message for PCRE_ERROR_MATCHLIMIT
  58  *    and give a hint why an error code might be unknown.
  59  *
  60  *    Catch NULL subjects early in pcrs_execute().
  61  *
  62  *    Revision 1.21  2006/07/18 14:48:47  david__schmidt
  63  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  64  *    with what was really the latest development (the v_3_0_branch branch)
  65  *
  66  *    Revision 1.19.2.4  2005/05/07 21:50:55  david__schmidt
  67  *    A few memory leaks plugged (mostly on error paths)
  68  *
  69  *    Revision 1.19.2.3  2003/12/04 12:32:45  oes
  70  *    Append a trailing nullbyte to result to facilitate string processing
  71  *
  72  *    Revision 1.19.2.2  2002/10/08 16:22:28  oes
  73  *    Bugfix: Need to check validity of backreferences explicitly,
  74  *    because when max_matches are reached and matches is expanded,
  75  *    realloc() does not zero the memory. Fixes Bug # 606227
  76  *
  77  *    Revision 1.19.2.1  2002/08/10 11:23:40  oes
  78  *    Include prce.h via project.h, where the appropriate
  79  *    source will have been selected
  80  *
  81  *    Revision 1.19  2002/03/08 14:47:48  oes
  82  *    Cosmetics
  83  *
  84  *    Revision 1.18  2002/03/08 14:17:14  oes
  85  *    Fixing -Wconversion warnings
  86  *
  87  *    Revision 1.17  2002/03/08 13:45:48  oes
  88  *    Hiding internal functions
  89  *
  90  *    Revision 1.16  2001/11/30 21:32:14  jongfoster
  91  *    Fixing signed/unsigned comparison (Andreas please check this!)
  92  *    One tab->space
  93  *
  94  *    Revision 1.15  2001/09/20 16:11:06  steudten
  95  *
  96  *    Add casting for some string functions.
  97  *
  98  *    Revision 1.14  2001/09/09 21:41:57  oes
  99  *    Fixing yet another silly bug
 100  *
 101  *    Revision 1.13  2001/09/06 14:05:59  oes
 102  *    Fixed silly bug
 103  *
 104  *    Revision 1.12  2001/08/18 11:35:00  oes
 105  *    - Introduced pcrs_strerror()
 106  *    - made some NULL arguments non-fatal
 107  *    - added support for \n \r \e \b \t \f \a \0 in substitute
 108  *    - made quoting adhere to standard rules
 109  *    - added warning for bad backrefs
 110  *    - added pcrs_execute_list()
 111  *    - fixed comments
 112  *    - bugfix & cosmetics
 113  *
 114  *    Revision 1.11  2001/08/15 15:32:03  oes
 115  *     - Added support for Perl's special variables $+, $' and $`
 116  *     - Improved the substitute parser
 117  *     - Replaced the hard limit for the maximum number of matches
 118  *       by dynamic reallocation
 119  *
 120  *    Revision 1.10  2001/08/05 13:13:11  jongfoster
 121  *    Making parameters "const" where possible.
 122  *
 123  *    Revision 1.9  2001/07/18 17:27:00  oes
 124  *    Changed interface; Cosmetics
 125  *
 126  *    Revision 1.8  2001/06/29 21:45:41  oes
 127  *    Indentation, CRLF->LF, Tab-> Space
 128  *
 129  *    Revision 1.7  2001/06/29 13:33:04  oes
 130  *    - Cleaned up, renamed and reordered functions,
 131  *      improved comments
 132  *    - Removed my_strsep
 133  *    - Replaced globalflag with a general flags int
 134  *      that holds PCRS_GLOBAL, PCRS_SUCCESS, and PCRS_TRIVIAL
 135  *    - Introduced trivial option that will prevent pcrs
 136  *      from honouring backreferences in the substitute,
 137  *      which is useful for large substitutes that are
 138  *      red in from somewhere and saves the pain of escaping
 139  *      the backrefs
 140  *    - Introduced convenience function pcrs_free_joblist()
 141  *    - Split pcrs_make_job() into pcrs_compile(), which still
 142  *      takes a complete s/// comand as argument and parses it,
 143  *      and a new function pcrs_make_job, which takes the
 144  *      three separate components. This should make for a
 145  *      much friendlier frontend.
 146  *    - Removed create_pcrs_job() which was useless
 147  *    - Fixed a bug in pcrs_execute
 148  *    - Success flag is now handled by pcrs instead of user
 149  *
 150  *    Revision 1.6  2001/06/03 19:12:45  oes
 151  *    added FIXME
 152  *
 153  *    Revision 1.5  2001/05/29 09:50:24  jongfoster
 154  *    (Fixed one int -> size_t)
 155  *
 156  *    Revision 1.4  2001/05/25 14:12:40  oes
 157  *    Fixed bug: Empty substitutes now detected
 158  *
 159  *    Revision 1.3  2001/05/25 11:03:55  oes
 160  *    Added sanity check for NULL jobs to pcrs_exec_substitution
 161  *
 162  *    Revision 1.2  2001/05/22 18:46:04  oes
 163  *
 164  *      Added support for PCRE_UNGREEDY behaviour to pcrs,
 165  *      which is selected by the (nonstandard and therefore
 166  *      capital) letter 'U' in the option string.
 167  *      It causes the quantifiers to be ungreedy by default.
 168  *      Appending a ? turns back to greedy (!).
 169  *
 170  *    Revision 1.1.1.1  2001/05/15 13:59:02  oes
 171  *    Initial import of version 2.9.3 source tree
 172  *
 173  *
 174  *********************************************************************/
 175 \f
 176
 177 /*
 178  * Include project.h just so that the right pcre.h gets
 179  * included from there
 180  */
 181 #include "project.h"
 182
 183 /* For snprintf only */
 184 #include "miscutil.h"
 185
 186 #include <string.h>
 187 #include <ctype.h>
 188 #include <assert.h>
 189
 190 #include "pcrs.h"
 191
 192 const char pcrs_h_rcs[] = PCRS_H_VERSION;
 193
 194 /*
 195  * Internal prototypes
 196  */
 197
 198 static int              pcrs_parse_perl_options(const char *optstring, int *flags);
 199 static pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag,
 200                         int capturecount, int *errptr);
 201 static int              is_hex_sequence(const char *sequence);
 202 static char             hex_to_byte(const char *sequence);
 203
 204 /*********************************************************************
 205  *
 206  * Function    :  pcrs_strerror
 207  *
 208  * Description :  Return a string describing a given error code.
 209  *
 210  * Parameters  :
 211  *          1  :  error = the error code
 212  *
 213  * Returns     :  char * to the descriptive string
 214  *
 215  *********************************************************************/
 216 const char *pcrs_strerror(const int error)
 217 {
 218    if (error < 0)
 219    {
 220       switch (error)
 221       {
 222          /* Passed-through PCRE error: */
 223          case PCRE_ERROR_NOMEMORY:     return "(pcre:) No memory";
 224
 225          /* Shouldn't happen unless PCRE or PCRS bug, or user messed with compiled job: */
 226          case PCRE_ERROR_NULL:         return "(pcre:) NULL code or subject or ovector";
 227          case PCRE_ERROR_BADOPTION:    return "(pcre:) Unrecognized option bit";
 228          case PCRE_ERROR_BADMAGIC:     return "(pcre:) Bad magic number in code";
 229          case PCRE_ERROR_UNKNOWN_NODE: return "(pcre:) Bad node in pattern";
 230
 231          /* Can't happen / not passed: */
 232          case PCRE_ERROR_NOSUBSTRING:  return "(pcre:) Fire in power supply";
 233          case PCRE_ERROR_NOMATCH:      return "(pcre:) Water in power supply";
 234
 235 #ifdef PCRE_ERROR_MATCHLIMIT
 236          /*
 237           * Only reported by PCRE versions newer than our own.
 238           */
 239          case PCRE_ERROR_MATCHLIMIT:   return "(pcre:) Match limit reached";
 240 #endif /* def PCRE_ERROR_MATCHLIMIT */
 241
 242          /* PCRS errors: */
 243          case PCRS_ERR_NOMEM:          return "(pcrs:) No memory";
 244          case PCRS_ERR_CMDSYNTAX:      return "(pcrs:) Syntax error while parsing command";
 245          case PCRS_ERR_STUDY:          return "(pcrs:) PCRE error while studying the pattern";
 246          case PCRS_ERR_BADJOB:         return "(pcrs:) Bad job - NULL job, pattern or substitute";
 247          case PCRS_WARN_BADREF:        return "(pcrs:) Backreference out of range";
 248          case PCRS_WARN_TRUNCATION:
 249             return "(pcrs:) At least one variable was too big and has been truncated before compilation";
 250
 251          /*
 252           * XXX: With the exception of PCRE_ERROR_MATCHLIMIT we
 253           * only catch PCRE errors that can happen with our internal
 254           * version. If Privoxy is linked against a newer
 255           * PCRE version all bets are off ...
 256           */
 257          default:  return "Unknown error. Privoxy out of sync with PCRE?";
 258       }
 259    }
 260    /* error >= 0: No error */
 261    return "(pcrs:) Everything's just fine. Thanks for asking.";
 262
 263 }
 264
 265
 266 /*********************************************************************
 267  *
 268  * Function    :  pcrs_parse_perl_options
 269  *
 270  * Description :  This function parses a string containing the options to
 271  *                Perl's s/// operator. It returns an integer that is the
 272  *                pcre equivalent of the symbolic optstring.
 273  *                Since pcre doesn't know about Perl's 'g' (global) or pcrs',
 274  *                'T' (trivial) options but pcrs needs them, the corresponding
 275  *                flags are set if 'g'or 'T' is encountered.
 276  *                Note: The 'T' and 'U' options do not conform to Perl.
 277  *
 278  * Parameters  :
 279  *          1  :  optstring = string with options in perl syntax
 280  *          2  :  flags = see description
 281  *
 282  * Returns     :  option integer suitable for pcre
 283  *
 284  *********************************************************************/
 285 static int pcrs_parse_perl_options(const char *optstring, int *flags)
 286 {
 287    size_t i;
 288    int rc = 0;
 289    *flags = 0;
 290
 291    if (NULL == optstring) return 0;
 292
 293    for (i = 0; i < strlen(optstring); i++)
 294    {
 295       switch(optstring[i])
 296       {
 297          case 'e': break; /* ToDo ;-) */
 298          case 'g': *flags |= PCRS_GLOBAL; break;
 299          case 'i': rc |= PCRE_CASELESS; break;
 300          case 'm': rc |= PCRE_MULTILINE; break;
 301          case 'o': break;
 302          case 's': rc |= PCRE_DOTALL; break;
 303          case 'x': rc |= PCRE_EXTENDED; break;
 304          case 'U': rc |= PCRE_UNGREEDY; break;
 305          case 'T': *flags |= PCRS_TRIVIAL; break;
 306          default: break;
 307       }
 308    }
 309    return rc;
 310
 311 }
 312
 313
 314 /*********************************************************************
 315  *
 316  * Function    :  pcrs_compile_replacement
 317  *
 318  * Description :  This function takes a Perl-style replacement (2nd argument
 319  *                to the s/// operator and returns a compiled pcrs_substitute,
 320  *                or NULL if memory allocation for the substitute structure
 321  *                fails.
 322  *
 323  * Parameters  :
 324  *          1  :  replacement = replacement part of s/// operator
 325  *                              in perl syntax
 326  *          2  :  trivialflag = Flag that causes backreferences to be
 327  *                              ignored.
 328  *          3  :  capturecount = Number of capturing subpatterns in
 329  *                               the pattern. Needed for $+ handling.
 330  *          4  :  errptr = pointer to an integer in which error
 331  *                         conditions can be returned.
 332  *
 333  * Returns     :  pcrs_substitute data structure, or NULL if an
 334  *                error is encountered. In that case, *errptr has
 335  *                the reason.
 336  *
 337  *********************************************************************/
 338 static pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag, int capturecount, int *errptr)
 339 {
 340    int i, k, l, quoted;
 341    size_t length;
 342    char *text;
 343    pcrs_substitute *r;
 344
 345    i = k = l = quoted = 0;
 346
 347    /*
 348     * Sanity check
 349     */
 350    if (NULL == replacement)
 351    {
 352       replacement = "";
 353    }
 354
 355    /*
 356     * Get memory or fail
 357     */
 358    if (NULL == (r = (pcrs_substitute *)malloc(sizeof(pcrs_substitute))))
 359    {
 360       *errptr = PCRS_ERR_NOMEM;
 361       return NULL;
 362    }
 363    memset(r, '\0', sizeof(pcrs_substitute));
 364
 365    length = strlen(replacement);
 366
 367    if (NULL == (text = (char *)malloc(length + 1)))
 368    {
 369       free(r);
 370       *errptr = PCRS_ERR_NOMEM;
 371       return NULL;
 372    }
 373    memset(text, '\0', length + 1);
 374
 375
 376    /*
 377     * In trivial mode, just copy the substitute text
 378     */
 379    if (trivialflag)
 380    {
 381       text = strncpy(text, replacement, length + 1);
 382       k = (int)length;
 383    }
 384
 385    /*
 386     * Else, parse, cut out and record all backreferences
 387     */
 388    else
 389    {
 390       while (i < (int)length)
 391       {
 392          /* Quoting */
 393          if (replacement[i] == '\\')
 394          {
 395             if (quoted)
 396             {
 397                text[k++] = replacement[i++];
 398                quoted = 0;
 399             }
 400             else
 401             {
 402                if (replacement[i+1] && strchr("tnrfae0", replacement[i+1]))
 403                {
 404                   switch (replacement[++i])
 405                   {
 406                   case 't':
 407                      text[k++] = '\t';
 408                      break;
 409                   case 'n':
 410                      text[k++] = '\n';
 411                      break;
 412                   case 'r':
 413                      text[k++] = '\r';
 414                      break;
 415                   case 'f':
 416                      text[k++] = '\f';
 417                      break;
 418                   case 'a':
 419                      text[k++] = 7;
 420                      break;
 421                   case 'e':
 422                      text[k++] = 27;
 423                      break;
 424                   case '0':
 425                      text[k++] = '\0';
 426                      break;
 427                   }
 428                   i++;
 429                }
 430                else if (is_hex_sequence(&replacement[i]))
 431                {
 432                   text[k++] = hex_to_byte(&replacement[i+2]);
 433                   i += 4;
 434                }
 435                else
 436                {
 437                   quoted = 1;
 438                   i++;
 439                }
 440             }
 441             continue;
 442          }
 443
 444          /* Backreferences */
 445          if (replacement[i] == '$' && !quoted && i < (int)(length - 1))
 446          {
 447             char *symbol, symbols[] = "'`+&";
 448             r->block_length[l] = (size_t)(k - r->block_offset[l]);
 449
 450             /* Numerical backreferences */
 451             if (isdigit((int)replacement[i + 1]))
 452             {
 453                while (i < (int)length && isdigit((int)replacement[++i]))
 454                {
 455                   r->backref[l] = r->backref[l] * 10 + replacement[i] - 48;
 456                }
 457                if (r->backref[l] > capturecount)
 458                {
 459                   *errptr = PCRS_WARN_BADREF;
 460                }
 461             }
 462
 463             /* Symbolic backreferences: */
 464             else if (NULL != (symbol = strchr(symbols, replacement[i + 1])))
 465             {
 466
 467                if (symbol - symbols == 2) /* $+ */
 468                {
 469                   r->backref[l] = capturecount;
 470                }
 471                else if (symbol - symbols == 3) /* $& */
 472                {
 473                   r->backref[l] = 0;
 474                }
 475                else /* $' or $` */
 476                {
 477                   r->backref[l] = PCRS_MAX_SUBMATCHES + 1 - (symbol - symbols);
 478                }
 479                i += 2;
 480             }
 481
 482             /* Invalid backref -> plain '$' */
 483             else
 484             {
 485                goto plainchar;
 486             }
 487
 488             /* Valid and in range? -> record */
 489             if (r->backref[l] < PCRS_MAX_SUBMATCHES + 2)
 490             {
 491                r->backref_count[r->backref[l]] += 1;
 492                r->block_offset[++l] = k;
 493             }
 494             else
 495             {
 496                *errptr = PCRS_WARN_BADREF;
 497             }
 498             continue;
 499          }
 500
 501 plainchar:
 502          /* Plain chars are copied */
 503          text[k++] = replacement[i++];
 504          quoted = 0;
 505       }
 506    } /* -END- if (!trivialflag) */
 507
 508    /*
 509     * Finish & return
 510     */
 511    r->text = text;
 512    r->backrefs = l;
 513    r->length = (size_t)k;
 514    r->block_length[l] = (size_t)(k - r->block_offset[l]);
 515
 516    return r;
 517
 518 }
 519
 520
 521 /*********************************************************************
 522  *
 523  * Function    :  pcrs_free_job
 524  *
 525  * Description :  Frees the memory used by a pcrs_job struct and its
 526  *                dependant structures.
 527  *
 528  * Parameters  :
 529  *          1  :  job = pointer to the pcrs_job structure to be freed
 530  *
 531  * Returns     :  a pointer to the next job, if there was any, or
 532  *                NULL otherwise.
 533  *
 534  *********************************************************************/
 535 pcrs_job *pcrs_free_job(pcrs_job *job)
 536 {
 537    pcrs_job *next;
 538
 539    if (job == NULL)
 540    {
 541       return NULL;
 542    }
 543    else
 544    {
 545       next = job->next;
 546       if (job->pattern != NULL) free(job->pattern);
 547       if (job->hints != NULL) free(job->hints);
 548       if (job->substitute != NULL)
 549       {
 550          if (job->substitute->text != NULL) free(job->substitute->text);
 551          free(job->substitute);
 552       }
 553       free(job);
 554    }
 555    return next;
 556
 557 }
 558
 559
 560 /*********************************************************************
 561  *
 562  * Function    :  pcrs_free_joblist
 563  *
 564  * Description :  Iterates through a chained list of pcrs_job's and
 565  *                frees them using pcrs_free_job.
 566  *
 567  * Parameters  :
 568  *          1  :  joblist = pointer to the first pcrs_job structure to
 569  *                be freed
 570  *
 571  * Returns     :  N/A
 572  *
 573  *********************************************************************/
 574 void pcrs_free_joblist(pcrs_job *joblist)
 575 {
 576    while ( NULL != (joblist = pcrs_free_job(joblist)) ) {};
 577
 578    return;
 579
 580 }
 581
 582
 583 /*********************************************************************
 584  *
 585  * Function    :  pcrs_compile_command
 586  *
 587  * Description :  Parses a string with a Perl-style s/// command,
 588  *                calls pcrs_compile, and returns a corresponding
 589  *                pcrs_job, or NULL if parsing or compiling the job
 590  *                fails.
 591  *
 592  * Parameters  :
 593  *          1  :  command = string with perl-style s/// command
 594  *          2  :  errptr = pointer to an integer in which error
 595  *                         conditions can be returned.
 596  *
 597  * Returns     :  a corresponding pcrs_job data structure, or NULL
 598  *                if an error was encountered. In that case, *errptr
 599  *                has the reason.
 600  *
 601  *********************************************************************/
 602 pcrs_job *pcrs_compile_command(const char *command, int *errptr)
 603 {
 604    int i, k, l, quoted = FALSE;
 605    size_t limit;
 606    char delimiter;
 607    char *tokens[4];
 608    pcrs_job *newjob;
 609
 610    i = k = l = 0;
 611
 612    /*
 613     * Tokenize the perl command
 614     */
 615    limit = strlen(command);
 616    if (limit < 4)
 617    {
 618       *errptr = PCRS_ERR_CMDSYNTAX;
 619       return NULL;
 620    }
 621    else
 622    {
 623       delimiter = command[1];
 624    }
 625
 626    tokens[l] = (char *) malloc(limit + 1);
 627
 628    for (i = 0; i <= (int)limit; i++)
 629    {
 630
 631       if (command[i] == delimiter && !quoted)
 632       {
 633          if (l == 3)
 634          {
 635             l = -1;
 636             break;
 637          }
 638          tokens[0][k++] = '\0';
 639          tokens[++l] = tokens[0] + k;
 640          continue;
 641       }
 642
 643       else if (command[i] == '\\' && !quoted)
 644       {
 645          quoted = TRUE;
 646          if (command[i+1] == delimiter) continue;
 647       }
 648       else
 649       {
 650          quoted = FALSE;
 651       }
 652       tokens[0][k++] = command[i];
 653    }
 654
 655    /*
 656     * Syntax error ?
 657     */
 658    if (l != 3)
 659    {
 660       *errptr = PCRS_ERR_CMDSYNTAX;
 661       free(tokens[0]);
 662       return NULL;
 663    }
 664
 665    newjob = pcrs_compile(tokens[1], tokens[2], tokens[3], errptr);
 666    free(tokens[0]);
 667    return newjob;
 668
 669 }
 670
 671
 672 /*********************************************************************
 673  *
 674  * Function    :  pcrs_compile
 675  *
 676  * Description :  Takes the three arguments to a perl s/// command
 677  *                and compiles a pcrs_job structure from them.
 678  *
 679  * Parameters  :
 680  *          1  :  pattern = string with perl-style pattern
 681  *          2  :  substitute = string with perl-style substitute
 682  *          3  :  options = string with perl-style options
 683  *          4  :  errptr = pointer to an integer in which error
 684  *                         conditions can be returned.
 685  *
 686  * Returns     :  a corresponding pcrs_job data structure, or NULL
 687  *                if an error was encountered. In that case, *errptr
 688  *                has the reason.
 689  *
 690  *********************************************************************/
 691 pcrs_job *pcrs_compile(const char *pattern, const char *substitute, const char *options, int *errptr)
 692 {
 693    pcrs_job *newjob;
 694    int flags;
 695    int capturecount;
 696    const char *error;
 697
 698    *errptr = 0;
 699
 700    /*
 701     * Handle NULL arguments
 702     */
 703    if (pattern == NULL) pattern = "";
 704    if (substitute == NULL) substitute = "";
 705
 706
 707    /*
 708     * Get and init memory
 709     */
 710    if (NULL == (newjob = (pcrs_job *)malloc(sizeof(pcrs_job))))
 711    {
 712       *errptr = PCRS_ERR_NOMEM;
 713       return NULL;
 714    }
 715    memset(newjob, '\0', sizeof(pcrs_job));
 716
 717
 718    /*
 719     * Evaluate the options
 720     */
 721    newjob->options = pcrs_parse_perl_options(options, &flags);
 722    newjob->flags = flags;
 723
 724
 725    /*
 726     * Compile the pattern
 727     */
 728    newjob->pattern = pcre_compile(pattern, newjob->options, &error, errptr, NULL);
 729    if (newjob->pattern == NULL)
 730    {
 731       pcrs_free_job(newjob);
 732       return NULL;
 733    }
 734
 735
 736    /*
 737     * Generate hints. This has little overhead, since the
 738     * hints will be NULL for a boring pattern anyway.
 739     */
 740    newjob->hints = pcre_study(newjob->pattern, 0, &error);
 741    if (error != NULL)
 742    {
 743       *errptr = PCRS_ERR_STUDY;
 744       pcrs_free_job(newjob);
 745       return NULL;
 746    }
 747
 748
 749    /*
 750     * Determine the number of capturing subpatterns.
 751     * This is needed for handling $+ in the substitute.
 752     */
 753    if (0 > (*errptr = pcre_fullinfo(newjob->pattern, newjob->hints, PCRE_INFO_CAPTURECOUNT, &capturecount)))
 754    {
 755       pcrs_free_job(newjob);
 756       return NULL;
 757    }
 758
 759
 760    /*
 761     * Compile the substitute
 762     */
 763    if (NULL == (newjob->substitute = pcrs_compile_replacement(substitute, newjob->flags & PCRS_TRIVIAL, capturecount, errptr)))
 764    {
 765       pcrs_free_job(newjob);
 766       return NULL;
 767    }
 768
 769    return newjob;
 770
 771 }
 772
 773
 774 /*********************************************************************
 775  *
 776  * Function    :  pcrs_execute_list
 777  *
 778  * Description :  This is a multiple job wrapper for pcrs_execute().
 779  *                Apply the regular substitutions defined by the jobs in
 780  *                the joblist to the subject.
 781  *                The subject itself is left untouched, memory for the result
 782  *                is malloc()ed and it is the caller's responsibility to free
 783  *                the result when it's no longer needed.
 784  *
 785  *                Note: For convenient string handling, a null byte is
 786  *                      appended to the result. It does not count towards the
 787  *                      result_length, though.
 788  *
 789  *
 790  * Parameters  :
 791  *          1  :  joblist = the chained list of pcrs_jobs to be executed
 792  *          2  :  subject = the subject string
 793  *          3  :  subject_length = the subject's length
 794  *          4  :  result = char** for returning  the result
 795  *          5  :  result_length = size_t* for returning the result's length
 796  *
 797  * Returns     :  On success, the number of substitutions that were made.
 798  *                 May be > 1 if job->flags contained PCRS_GLOBAL
 799  *                On failure, the (negative) pcre error code describing the
 800  *                 failure, which may be translated to text using pcrs_strerror().
 801  *
 802  *********************************************************************/
 803 int pcrs_execute_list(pcrs_job *joblist, char *subject, size_t subject_length, char **result, size_t *result_length)
 804 {
 805    pcrs_job *job;
 806    char *old, *new = NULL;
 807    int hits, total_hits;
 808
 809    old = subject;
 810    *result_length = subject_length;
 811    hits = total_hits = 0;
 812
 813    for (job = joblist; job != NULL; job = job->next)
 814    {
 815       hits = pcrs_execute(job, old, *result_length, &new, result_length);
 816
 817       if (old != subject) free(old);
 818
 819       if (hits < 0)
 820       {
 821          return(hits);
 822       }
 823       else
 824       {
 825          total_hits += hits;
 826          old = new;
 827       }
 828    }
 829
 830    *result = new;
 831    return(total_hits);
 832
 833 }
 834
 835
 836 /*********************************************************************
 837  *
 838  * Function    :  pcrs_execute
 839  *
 840  * Description :  Apply the regular substitution defined by the job to the
 841  *                subject.
 842  *                The subject itself is left untouched, memory for the result
 843  *                is malloc()ed and it is the caller's responsibility to free
 844  *                the result when it's no longer needed.
 845  *
 846  *                Note: For convenient string handling, a null byte is
 847  *                      appended to the result. It does not count towards the
 848  *                      result_length, though.
 849  *
 850  * Parameters  :
 851  *          1  :  job = the pcrs_job to be executed
 852  *          2  :  subject = the subject (== original) string
 853  *          3  :  subject_length = the subject's length
 854  *          4  :  result = char** for returning  the result
 855  *          5  :  result_length = size_t* for returning the result's length
 856  *
 857  * Returns     :  On success, the number of substitutions that were made.
 858  *                 May be > 1 if job->flags contained PCRS_GLOBAL
 859  *                On failure, the (negative) pcre error code describing the
 860  *                 failure, which may be translated to text using pcrs_strerror().
 861  *
 862  *********************************************************************/
 863 int pcrs_execute(pcrs_job *job, const char *subject, size_t subject_length, char **result, size_t *result_length)
 864 {
 865    int offsets[3 * PCRS_MAX_SUBMATCHES],
 866        offset,
 867        i, k,
 868        matches_found,
 869        submatches,
 870        max_matches = PCRS_MAX_MATCH_INIT;
 871    size_t newsize;
 872    pcrs_match *matches, *dummy;
 873    char *result_offset;
 874
 875    offset = i = k = 0;
 876
 877    /*
 878     * Sanity check & memory allocation
 879     */
 880    if (job == NULL || job->pattern == NULL || job->substitute == NULL || NULL == subject)
 881    {
 882       *result = NULL;
 883       return(PCRS_ERR_BADJOB);
 884    }
 885
 886    if (NULL == (matches = (pcrs_match *)malloc((size_t)max_matches * sizeof(pcrs_match))))
 887    {
 888       *result = NULL;
 889       return(PCRS_ERR_NOMEM);
 890    }
 891    memset(matches, '\0', (size_t)max_matches * sizeof(pcrs_match));
 892
 893
 894    /*
 895     * Find the pattern and calculate the space
 896     * requirements for the result
 897     */
 898    newsize = subject_length;
 899
 900    while ((submatches = pcre_exec(job->pattern, job->hints, subject, (int)subject_length, offset, 0, offsets, 3 * PCRS_MAX_SUBMATCHES)) > 0)
 901    {
 902       job->flags |= PCRS_SUCCESS;
 903       matches[i].submatches = submatches;
 904
 905       for (k = 0; k < submatches; k++)
 906       {
 907          matches[i].submatch_offset[k] = offsets[2 * k];
 908
 909          /* Note: Non-found optional submatches have length -1-(-1)==0 */
 910          matches[i].submatch_length[k] = (size_t)(offsets[2 * k + 1] - offsets[2 * k]);
 911
 912          /* reserve mem for each submatch as often as it is ref'd */
 913          newsize += matches[i].submatch_length[k] * (size_t)job->substitute->backref_count[k];
 914       }
 915       /* plus replacement text size minus match text size */
 916       newsize += job->substitute->length - matches[i].submatch_length[0];
 917
 918       /* chunk before match */
 919       matches[i].submatch_offset[PCRS_MAX_SUBMATCHES] = 0;
 920       matches[i].submatch_length[PCRS_MAX_SUBMATCHES] = (size_t)offsets[0];
 921       newsize += (size_t)offsets[0] * (size_t)job->substitute->backref_count[PCRS_MAX_SUBMATCHES];
 922
 923       /* chunk after match */
 924       matches[i].submatch_offset[PCRS_MAX_SUBMATCHES + 1] = offsets[1];
 925       matches[i].submatch_length[PCRS_MAX_SUBMATCHES + 1] = subject_length - (size_t)offsets[1] - 1;
 926       newsize += (subject_length - (size_t)offsets[1]) * (size_t)job->substitute->backref_count[PCRS_MAX_SUBMATCHES + 1];
 927
 928       /* Storage for matches exhausted? -> Extend! */
 929       if (++i >= max_matches)
 930       {
 931          max_matches = (int)(max_matches * PCRS_MAX_MATCH_GROW);
 932          if (NULL == (dummy = (pcrs_match *)realloc(matches, (size_t)max_matches * sizeof(pcrs_match))))
 933          {
 934             free(matches);
 935             *result = NULL;
 936             return(PCRS_ERR_NOMEM);
 937          }
 938          matches = dummy;
 939       }
 940
 941       /* Non-global search or limit reached? */
 942       if (!(job->flags & PCRS_GLOBAL)) break;
 943
 944       /* Don't loop on empty matches */
 945       if (offsets[1] == offset)
 946          if ((size_t)offset < subject_length)
 947             offset++;
 948          else
 949             break;
 950       /* Go find the next one */
 951       else
 952          offset = offsets[1];
 953    }
 954    /* Pass pcre error through if (bad) failiure */
 955    if (submatches < PCRE_ERROR_NOMATCH)
 956    {
 957       free(matches);
 958       return submatches;
 959    }
 960    matches_found = i;
 961
 962
 963    /*
 964     * Get memory for the result (must be freed by caller!)
 965     * and append terminating null byte.
 966     */
 967    if ((*result = (char *)malloc(newsize + 1)) == NULL)
 968    {
 969       free(matches);
 970       return PCRS_ERR_NOMEM;
 971    }
 972    else
 973    {
 974       (*result)[newsize] = '\0';
 975    }
 976
 977
 978    /*
 979     * Replace
 980     */
 981    offset = 0;
 982    result_offset = *result;
 983
 984    for (i = 0; i < matches_found; i++)
 985    {
 986       /* copy the chunk preceding the match */
 987       memcpy(result_offset, subject + offset, (size_t)(matches[i].submatch_offset[0] - offset));
 988       result_offset += matches[i].submatch_offset[0] - offset;
 989
 990       /* For every segment of the substitute.. */
 991       for (k = 0; k <= job->substitute->backrefs; k++)
 992       {
 993          /* ...copy its text.. */
 994          memcpy(result_offset, job->substitute->text + job->substitute->block_offset[k], job->substitute->block_length[k]);
 995          result_offset += job->substitute->block_length[k];
 996
 997          /* ..plus, if it's not the last chunk, i.e.: There *is* a backref.. */
 998          if (k != job->substitute->backrefs
 999              /* ..in legal range.. */
1000              && job->substitute->backref[k] < PCRS_MAX_SUBMATCHES + 2
1001              /* ..and referencing a real submatch.. */
1002              && job->substitute->backref[k] < matches[i].submatches
1003              /* ..that is nonempty.. */
1004              && matches[i].submatch_length[job->substitute->backref[k]] > 0)
1005          {
1006             /* ..copy the submatch that is ref'd. */
1007             memcpy(
1008                result_offset,
1009                subject + matches[i].submatch_offset[job->substitute->backref[k]],
1010                matches[i].submatch_length[job->substitute->backref[k]]
1011             );
1012             result_offset += matches[i].submatch_length[job->substitute->backref[k]];
1013          }
1014       }
1015       offset =  matches[i].submatch_offset[0] + (int)matches[i].submatch_length[0];
1016    }
1017
1018    /* Copy the rest. */
1019    memcpy(result_offset, subject + offset, subject_length - (size_t)offset);
1020
1021    *result_length = newsize;
1022    free(matches);
1023    return matches_found;
1024
1025 }
1026
1027
1028 #define is_hex_digit(x) ((x) && strchr("0123456789ABCDEF", toupper(x)))
1029
1030 /*********************************************************************
1031  *
1032  * Function    :  is_hex_sequence
1033  *
1034  * Description :  Checks the first four characters of a string
1035  *                and decides if they are a valid hex sequence
1036  *                (like '\x40').
1037  *
1038  * Parameters  :
1039  *          1  :  sequence = The string to check
1040  *
1041  * Returns     :  Non-zero if it's valid sequence, or
1042  *                Zero if it isn't.
1043  *
1044  *********************************************************************/
1045 static int is_hex_sequence(const char *sequence)
1046 {
1047    return (sequence[0] == '\\' &&
1048            sequence[1] == 'x'  &&
1049            is_hex_digit(sequence[2]) &&
1050            is_hex_digit(sequence[3]));
1051 }
1052
1053
1054 /*********************************************************************
1055  *
1056  * Function    :  hex_to_byte
1057  *
1058  * Description :  Converts two bytes in hex into a single byte
1059  *                with that value. For example '40' is converted
1060  *                into '@'.
1061  *
1062  *                Based on Werner Koch's _gpgme_hextobyte()
1063  *                in gpgme's conversion.c.
1064  *
1065  * Parameters  :
1066  *          1  :  hex_sequence = Pointer to the two bytes to convert.
1067  *
1068  * Returns     :  The byte value.
1069  *
1070  *********************************************************************/
1071 static char hex_to_byte(const char *hex_sequence)
1072 {
1073    const char *current_position = hex_sequence;
1074    int value = 0;
1075
1076    do
1077    {
1078       const char current_digit = (char)toupper(*current_position);
1079
1080       if ((current_digit >= '0') && (current_digit <= '9'))
1081       {
1082          value += current_digit - '0';
1083       }
1084       else if ((current_digit >= 'A') && (current_digit <= 'F'))
1085       {
1086          value += current_digit - 'A' + 10; /* + 10 for the hex offset */
1087       }
1088
1089       if (current_position == hex_sequence)
1090       {
1091          /*
1092           * As 0xNM is N * 16**1 + M * 16**0, the value
1093           * of the first byte has to be multiplied.
1094           */
1095          value *= 16;
1096       }
1097
1098    } while (current_position++ < hex_sequence + 1);
1099
1100    return (char)value;
1101
1102 }
1103
1104
1105 /*
1106  * Functions below this line are only part of the pcrs version
1107  * included in Privoxy. If you use any of them you should not
1108  * try to dynamically link against external pcrs versions.
1109  */
1110
1111 /*********************************************************************
1112  *
1113  * Function    :  pcrs_job_is_dynamic
1114  *
1115  * Description :  Checks if a job has the "D" (dynamic) option set.
1116  *
1117  * Parameters  :
1118  *          1  :  job = The job to check
1119  *
1120  * Returns     :  TRUE if the job is indeed dynamic, otherwise
1121  *                FALSE
1122  *
1123  *********************************************************************/
1124 int pcrs_job_is_dynamic (char *job)
1125 {
1126    const char delimiter = job[1];
1127    const size_t length = strlen(job);
1128    char *option;
1129
1130    if (length < 5)
1131    {
1132       /*
1133        * The shortest valid (but useless)
1134        * dynamic pattern is "s@@@D"
1135        */
1136       return FALSE;
1137    }
1138
1139    /*
1140     * Everything between the last character
1141     * and the last delimiter is an option ...
1142     */
1143    for (option = job + length; *option != delimiter; option--)
1144    {
1145       if (*option == 'D')
1146       {
1147          /*
1148           * ... and if said option is 'D' the job is dynamic.
1149           */
1150          return TRUE;
1151       }
1152    }
1153    return FALSE;
1154
1155 }
1156
1157
1158 /*********************************************************************
1159  *
1160  * Function    :  pcrs_get_delimiter
1161  *
1162  * Description :  Tries to find a character that is safe to
1163  *                be used as a pcrs delimiter for a certain string.
1164  *
1165  * Parameters  :
1166  *          1  :  string = The string to search in
1167  *
1168  * Returns     :  A safe delimiter if one was found, otherwise '\0'.
1169  *
1170  *********************************************************************/
1171 char pcrs_get_delimiter(const char *string)
1172 {
1173    /*
1174     * Some characters that are unlikely to
1175     * be part of pcrs replacement strings.
1176     */
1177    char delimiters[] = "><§#+*~%^°-:;µ!@";
1178    char *d = delimiters;
1179
1180    /* Take the first delimiter that isn't part of the string */
1181    while (*d && NULL != strchr(string, *d))
1182    {
1183       d++;
1184    }
1185    return *d;
1186
1187 }
1188
1189
1190 /*********************************************************************
1191  *
1192  * Function    :  pcrs_execute_single_command
1193  *
1194  * Description :  Apply single pcrs command to the subject.
1195  *                The subject itself is left untouched, memory for the result
1196  *                is malloc()ed and it is the caller's responsibility to free
1197  *                the result when it's no longer needed.
1198  *
1199  * Parameters  :
1200  *          1  :  subject = the subject (== original) string
1201  *          2  :  pcrs_command = the pcrs command as string (s@foo@bar@)
1202  *          3  :  hits = int* for returning  the number of modifications
1203  *
1204  * Returns     :  NULL in case of errors, otherwise the
1205  *                result of the pcrs command.
1206  *
1207  *********************************************************************/
1208 char *pcrs_execute_single_command(const char *subject, const char *pcrs_command, int *hits)
1209 {
1210    size_t size;
1211    char *result = NULL;
1212    pcrs_job *job;
1213
1214    assert(subject);
1215    assert(pcrs_command);
1216
1217    *hits = 0;
1218    size = strlen(subject);
1219
1220    job = pcrs_compile_command(pcrs_command, hits);
1221    if (NULL != job)
1222    {
1223       *hits = pcrs_execute(job, subject, size, &result, &size);
1224       if (*hits < 0)
1225       {
1226          freez(result);
1227       }
1228       pcrs_free_job(job);
1229    }
1230    return result;
1231
1232 }
1233
1234
1235 const static char warning[] = "... [too long, truncated]";
1236 /*********************************************************************
1237  *
1238  * Function    :  pcrs_compile_dynamic_command
1239  *
1240  * Description :  Takes a dynamic pcrs command, fills in the
1241  *                values of the variables and compiles it.
1242  *
1243  * Parameters  :
1244  *          1  :  csp = Current client state (buffers, headers, etc...)
1245  *          2  :  pcrs_command = The dynamic pcrs command to compile
1246  *          3  :  v = NULL terminated array of variables and their values.
1247  *          4  :  error = pcrs error code
1248  *
1249  * Returns     :  NULL in case of hard errors, otherwise the
1250  *                compiled pcrs job.
1251  *
1252  *********************************************************************/
1253 pcrs_job *pcrs_compile_dynamic_command(char *pcrs_command, const struct pcrs_variable v[], int *error)
1254 {
1255    char buf[PCRS_BUFFER_SIZE];
1256    const char *original_pcrs_command = pcrs_command;
1257    char *pcrs_command_tmp = NULL;
1258    pcrs_job *job = NULL;
1259    int truncation = 0;
1260    char d;
1261    int ret;
1262
1263    while ((NULL != v->name) && (NULL != pcrs_command))
1264    {
1265       assert(NULL != v->value);
1266
1267       if (NULL == strstr(pcrs_command, v->name))
1268       {
1269          /*
1270           * Skip the substitution if the variable
1271           * name isn't part of the pattern.
1272           */
1273          v++;
1274          continue;
1275       }
1276
1277       /* Use pcrs to replace the variable with its value. */
1278       d = pcrs_get_delimiter(v->value);
1279       if ('\0' == d)
1280       {
1281          /* No proper delimiter found */
1282          *error = PCRS_ERR_CMDSYNTAX;
1283          return NULL;
1284       }
1285
1286       /*
1287        * Variable names are supposed to contain alpha
1288        * numerical characters plus '_' only.
1289        */
1290       assert(NULL == strchr(v->name, d));
1291
1292       ret = snprintf(buf, sizeof(buf), "s%c\\$%s%c%s%cgT", d, v->name, d, v->value, d);
1293       assert(ret >= 0);
1294       if (ret >= sizeof(buf))
1295       {
1296          /*
1297           * Value didn't completely fit into buffer,
1298           * overwrite the end of the substitution text
1299           * with a truncation message and close the pattern
1300           * properly.
1301           */
1302          const size_t trailer_size = sizeof(warning) + 3; /* 3 for d + "gT" */
1303          char *trailer_start = buf + sizeof(buf) - trailer_size;
1304
1305          ret = snprintf(trailer_start, trailer_size, "%s%cgT", warning, d);
1306          assert(ret == trailer_size - 1);
1307          assert(sizeof(buf) == strlen(buf) + 1);
1308          truncation = 1;
1309       }
1310
1311       pcrs_command_tmp = pcrs_execute_single_command(pcrs_command, buf, error);
1312       if (NULL == pcrs_command_tmp)
1313       {
1314          return NULL;
1315       }
1316
1317       if (pcrs_command != original_pcrs_command)
1318       {
1319          freez(pcrs_command);
1320       }
1321       pcrs_command = pcrs_command_tmp;
1322
1323       v++;
1324    }
1325
1326    job = pcrs_compile_command(pcrs_command, error);
1327    if (pcrs_command != original_pcrs_command)
1328    {
1329       freez(pcrs_command);
1330    }
1331
1332    if (truncation)
1333    {
1334       *error = PCRS_WARN_TRUNCATION;
1335    }
1336
1337    return job;
1338
1339 }
1340
1341
1342 /*
1343   Local Variables:
1344   tab-width: 3
1345   end:
1346 */