pcrs.c

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