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