pcrs.c

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