Correctly document the action type for a bunch of "multi-value" actions
[privoxy.git] / pcrs.c
1 const char pcrs_rcs[] = "$Id: pcrs.c,v 1.47 2015/01/24 16:40:59 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] && r->backref[l] < PCRS_MAX_SUBMATCHES + 2)
380             {
381                r->backref_count[r->backref[l]] += 1;
382                r->block_offset[++l] = k;
383             }
384             else
385             {
386                freez(text);
387                freez(r);
388                *errptr = PCRS_WARN_BADREF;
389                return NULL;
390             }
391             continue;
392          }
393
394 plainchar:
395          /* Plain chars are copied */
396          text[k++] = replacement[i++];
397          quoted = 0;
398       }
399    } /* -END- if (!trivialflag) */
400
401    /*
402     * Finish & return
403     */
404    r->text = text;
405    r->backrefs = l;
406    r->length = (size_t)k;
407    r->block_length[l] = (size_t)(k - r->block_offset[l]);
408
409    return r;
410
411 }
412
413
414 /*********************************************************************
415  *
416  * Function    :  pcrs_free_job
417  *
418  * Description :  Frees the memory used by a pcrs_job struct and its
419  *                dependent structures.
420  *
421  * Parameters  :
422  *          1  :  job = pointer to the pcrs_job structure to be freed
423  *
424  * Returns     :  a pointer to the next job, if there was any, or
425  *                NULL otherwise.
426  *
427  *********************************************************************/
428 pcrs_job *pcrs_free_job(pcrs_job *job)
429 {
430    pcrs_job *next;
431
432    if (job == NULL)
433    {
434       return NULL;
435    }
436    else
437    {
438       next = job->next;
439       if (job->pattern != NULL) free(job->pattern);
440       if (job->hints != NULL) free(job->hints);
441       if (job->substitute != NULL)
442       {
443          if (job->substitute->text != NULL) free(job->substitute->text);
444          free(job->substitute);
445       }
446       free(job);
447    }
448    return next;
449
450 }
451
452
453 /*********************************************************************
454  *
455  * Function    :  pcrs_free_joblist
456  *
457  * Description :  Iterates through a chained list of pcrs_job's and
458  *                frees them using pcrs_free_job.
459  *
460  * Parameters  :
461  *          1  :  joblist = pointer to the first pcrs_job structure to
462  *                be freed
463  *
464  * Returns     :  N/A
465  *
466  *********************************************************************/
467 void pcrs_free_joblist(pcrs_job *joblist)
468 {
469    while (NULL != (joblist = pcrs_free_job(joblist))) {};
470
471    return;
472
473 }
474
475
476 /*********************************************************************
477  *
478  * Function    :  pcrs_compile_command
479  *
480  * Description :  Parses a string with a Perl-style s/// command,
481  *                calls pcrs_compile, and returns a corresponding
482  *                pcrs_job, or NULL if parsing or compiling the job
483  *                fails.
484  *
485  * Parameters  :
486  *          1  :  command = string with perl-style s/// command
487  *          2  :  errptr = pointer to an integer in which error
488  *                         conditions can be returned.
489  *
490  * Returns     :  a corresponding pcrs_job data structure, or NULL
491  *                if an error was encountered. In that case, *errptr
492  *                has the reason.
493  *
494  *********************************************************************/
495 pcrs_job *pcrs_compile_command(const char *command, int *errptr)
496 {
497    int i, k, l, quoted = FALSE;
498    size_t limit;
499    char delimiter;
500    char *tokens[4];
501    pcrs_job *newjob;
502
503    k = l = 0;
504
505    /*
506     * Tokenize the perl command
507     */
508    limit = strlen(command);
509    if (limit < 4)
510    {
511       *errptr = PCRS_ERR_CMDSYNTAX;
512       return NULL;
513    }
514    else
515    {
516       delimiter = command[1];
517    }
518
519    tokens[l] = (char *) malloc(limit + 1);
520
521    for (i = 0; i <= (int)limit; i++)
522    {
523
524       if (command[i] == delimiter && !quoted)
525       {
526          if (l == 3)
527          {
528             l = -1;
529             break;
530          }
531          tokens[0][k++] = '\0';
532          tokens[++l] = tokens[0] + k;
533          continue;
534       }
535
536       else if (command[i] == '\\' && !quoted)
537       {
538          quoted = TRUE;
539          if (command[i+1] == delimiter) continue;
540       }
541       else
542       {
543          quoted = FALSE;
544       }
545       tokens[0][k++] = command[i];
546    }
547
548    /*
549     * Syntax error ?
550     */
551    if (l != 3)
552    {
553       *errptr = PCRS_ERR_CMDSYNTAX;
554       free(tokens[0]);
555       return NULL;
556    }
557
558    newjob = pcrs_compile(tokens[1], tokens[2], tokens[3], errptr);
559    free(tokens[0]);
560    return newjob;
561
562 }
563
564
565 /*********************************************************************
566  *
567  * Function    :  pcrs_compile
568  *
569  * Description :  Takes the three arguments to a perl s/// command
570  *                and compiles a pcrs_job structure from them.
571  *
572  * Parameters  :
573  *          1  :  pattern = string with perl-style pattern
574  *          2  :  substitute = string with perl-style substitute
575  *          3  :  options = string with perl-style options
576  *          4  :  errptr = pointer to an integer in which error
577  *                         conditions can be returned.
578  *
579  * Returns     :  a corresponding pcrs_job data structure, or NULL
580  *                if an error was encountered. In that case, *errptr
581  *                has the reason.
582  *
583  *********************************************************************/
584 pcrs_job *pcrs_compile(const char *pattern, const char *substitute, const char *options, int *errptr)
585 {
586    pcrs_job *newjob;
587    int flags;
588    int capturecount;
589    const char *error;
590
591    *errptr = 0;
592
593    /*
594     * Handle NULL arguments
595     */
596    if (pattern == NULL) pattern = "";
597    if (substitute == NULL) substitute = "";
598
599
600    /*
601     * Get and init memory
602     */
603    if (NULL == (newjob = (pcrs_job *)malloc(sizeof(pcrs_job))))
604    {
605       *errptr = PCRS_ERR_NOMEM;
606       return NULL;
607    }
608    memset(newjob, '\0', sizeof(pcrs_job));
609
610
611    /*
612     * Evaluate the options
613     */
614    newjob->options = pcrs_parse_perl_options(options, &flags);
615    newjob->flags = flags;
616
617
618    /*
619     * Compile the pattern
620     */
621    newjob->pattern = pcre_compile(pattern, newjob->options, &error, errptr, NULL);
622    if (newjob->pattern == NULL)
623    {
624       pcrs_free_job(newjob);
625       return NULL;
626    }
627
628
629    /*
630     * Generate hints. This has little overhead, since the
631     * hints will be NULL for a boring pattern anyway.
632     */
633    newjob->hints = pcre_study(newjob->pattern, 0, &error);
634    if (error != NULL)
635    {
636       *errptr = PCRS_ERR_STUDY;
637       pcrs_free_job(newjob);
638       return NULL;
639    }
640
641
642    /*
643     * Determine the number of capturing subpatterns.
644     * This is needed for handling $+ in the substitute.
645     */
646    if (0 > (*errptr = pcre_fullinfo(newjob->pattern, newjob->hints, PCRE_INFO_CAPTURECOUNT, &capturecount)))
647    {
648       pcrs_free_job(newjob);
649       return NULL;
650    }
651
652
653    /*
654     * Compile the substitute
655     */
656    if (NULL == (newjob->substitute = pcrs_compile_replacement(substitute, newjob->flags & PCRS_TRIVIAL, capturecount, errptr)))
657    {
658       pcrs_free_job(newjob);
659       return NULL;
660    }
661
662    return newjob;
663
664 }
665
666
667 /*********************************************************************
668  *
669  * Function    :  pcrs_execute_list
670  *
671  * Description :  This is a multiple job wrapper for pcrs_execute().
672  *                Apply the regular substitutions defined by the jobs in
673  *                the joblist to the subject.
674  *                The subject itself is left untouched, memory for the result
675  *                is malloc()ed and it is the caller's responsibility to free
676  *                the result when it's no longer needed.
677  *
678  *                Note: For convenient string handling, a null byte is
679  *                      appended to the result. It does not count towards the
680  *                      result_length, though.
681  *
682  *
683  * Parameters  :
684  *          1  :  joblist = the chained list of pcrs_jobs to be executed
685  *          2  :  subject = the subject string
686  *          3  :  subject_length = the subject's length
687  *          4  :  result = char** for returning  the result
688  *          5  :  result_length = size_t* for returning the result's length
689  *
690  * Returns     :  On success, the number of substitutions that were made.
691  *                 May be > 1 if job->flags contained PCRS_GLOBAL
692  *                On failure, the (negative) pcre error code describing the
693  *                 failure, which may be translated to text using pcrs_strerror().
694  *
695  *********************************************************************/
696 int pcrs_execute_list(pcrs_job *joblist, char *subject, size_t subject_length, char **result, size_t *result_length)
697 {
698    pcrs_job *job;
699    char *old, *new = NULL;
700    int hits, total_hits;
701
702    old = subject;
703    *result_length = subject_length;
704    total_hits = 0;
705
706    for (job = joblist; job != NULL; job = job->next)
707    {
708       hits = pcrs_execute(job, old, *result_length, &new, result_length);
709
710       if (old != subject) free(old);
711
712       if (hits < 0)
713       {
714          return(hits);
715       }
716       else
717       {
718          total_hits += hits;
719          old = new;
720       }
721    }
722
723    *result = new;
724    return(total_hits);
725
726 }
727
728
729 /*********************************************************************
730  *
731  * Function    :  pcrs_execute
732  *
733  * Description :  Apply the regular substitution defined by the job to the
734  *                subject.
735  *                The subject itself is left untouched, memory for the result
736  *                is malloc()ed and it is the caller's responsibility to free
737  *                the result when it's no longer needed.
738  *
739  *                Note: For convenient string handling, a null byte is
740  *                      appended to the result. It does not count towards the
741  *                      result_length, though.
742  *
743  * Parameters  :
744  *          1  :  job = the pcrs_job to be executed
745  *          2  :  subject = the subject (== original) string
746  *          3  :  subject_length = the subject's length
747  *          4  :  result = char** for returning the result (NULL on error)
748  *          5  :  result_length = size_t* for returning the result's length
749  *
750  * Returns     :  On success, the number of substitutions that were made.
751  *                 May be > 1 if job->flags contained PCRS_GLOBAL
752  *                On failure, the (negative) pcre error code describing the
753  *                 failure, which may be translated to text using pcrs_strerror().
754  *
755  *********************************************************************/
756 int pcrs_execute(pcrs_job *job, const char *subject, size_t subject_length, char **result, size_t *result_length)
757 {
758    int offsets[3 * PCRS_MAX_SUBMATCHES],
759        offset,
760        i, k,
761        matches_found,
762        submatches,
763        max_matches = PCRS_MAX_MATCH_INIT;
764    size_t newsize;
765    pcrs_match *matches, *dummy;
766    char *result_offset;
767
768    offset = i = 0;
769    *result = NULL;
770
771    /*
772     * Sanity check & memory allocation
773     */
774    if (job == NULL || job->pattern == NULL || job->substitute == NULL || NULL == subject)
775    {
776       return(PCRS_ERR_BADJOB);
777    }
778
779    if (NULL == (matches = (pcrs_match *)malloc((size_t)max_matches * sizeof(pcrs_match))))
780    {
781       return(PCRS_ERR_NOMEM);
782    }
783    memset(matches, '\0', (size_t)max_matches * sizeof(pcrs_match));
784
785
786    /*
787     * Find the pattern and calculate the space
788     * requirements for the result
789     */
790    newsize = subject_length;
791
792    while ((submatches = pcre_exec(job->pattern, job->hints, subject, (int)subject_length, offset, 0, offsets, 3 * PCRS_MAX_SUBMATCHES)) > 0)
793    {
794       job->flags |= PCRS_SUCCESS;
795       matches[i].submatches = submatches;
796
797       for (k = 0; k < submatches; k++)
798       {
799          matches[i].submatch_offset[k] = offsets[2 * k];
800
801          /* Note: Non-found optional submatches have length -1-(-1)==0 */
802          matches[i].submatch_length[k] = (size_t)(offsets[2 * k + 1] - offsets[2 * k]);
803
804          /* reserve mem for each submatch as often as it is ref'd */
805          newsize += matches[i].submatch_length[k] * (size_t)job->substitute->backref_count[k];
806       }
807       /* plus replacement text size minus match text size */
808       newsize += job->substitute->length - matches[i].submatch_length[0];
809
810       /* chunk before match */
811       matches[i].submatch_offset[PCRS_MAX_SUBMATCHES] = 0;
812       matches[i].submatch_length[PCRS_MAX_SUBMATCHES] = (size_t)offsets[0];
813       newsize += (size_t)offsets[0] * (size_t)job->substitute->backref_count[PCRS_MAX_SUBMATCHES];
814
815       /* chunk after match */
816       matches[i].submatch_offset[PCRS_MAX_SUBMATCHES + 1] = offsets[1];
817       matches[i].submatch_length[PCRS_MAX_SUBMATCHES + 1] = subject_length - (size_t)offsets[1] - 1;
818       newsize += (subject_length - (size_t)offsets[1]) * (size_t)job->substitute->backref_count[PCRS_MAX_SUBMATCHES + 1];
819
820       /* Storage for matches exhausted? -> Extend! */
821       if (++i >= max_matches)
822       {
823          max_matches = (int)(max_matches * PCRS_MAX_MATCH_GROW);
824          if (NULL == (dummy = (pcrs_match *)realloc(matches, (size_t)max_matches * sizeof(pcrs_match))))
825          {
826             free(matches);
827             return(PCRS_ERR_NOMEM);
828          }
829          matches = dummy;
830       }
831
832       /* Non-global search or limit reached? */
833       if (!(job->flags & PCRS_GLOBAL)) break;
834
835       /* Don't loop on empty matches */
836       if (offsets[1] == offset)
837          if ((size_t)offset < subject_length)
838             offset++;
839          else
840             break;
841       /* Go find the next one */
842       else
843          offset = offsets[1];
844    }
845    /* Pass pcre error through if (bad) failure */
846    if (submatches < PCRE_ERROR_NOMATCH)
847    {
848       free(matches);
849       return submatches;
850    }
851    matches_found = i;
852
853
854    /*
855     * Get memory for the result (must be freed by caller!)
856     * and append terminating null byte.
857     */
858    if ((*result = (char *)malloc(newsize + 1)) == NULL)
859    {
860       free(matches);
861       return PCRS_ERR_NOMEM;
862    }
863    else
864    {
865       (*result)[newsize] = '\0';
866    }
867
868
869    /*
870     * Replace
871     */
872    offset = 0;
873    result_offset = *result;
874
875    for (i = 0; i < matches_found; i++)
876    {
877       /* copy the chunk preceding the match */
878       memcpy(result_offset, subject + offset, (size_t)(matches[i].submatch_offset[0] - offset));
879       result_offset += matches[i].submatch_offset[0] - offset;
880
881       /* For every segment of the substitute.. */
882       for (k = 0; k <= job->substitute->backrefs; k++)
883       {
884          /* ...copy its text.. */
885          memcpy(result_offset, job->substitute->text + job->substitute->block_offset[k], job->substitute->block_length[k]);
886          result_offset += job->substitute->block_length[k];
887
888          /* ..plus, if it's not the last chunk, i.e.: There *is* a backref.. */
889          if (k != job->substitute->backrefs
890              /* ..in legal range.. */
891              && job->substitute->backref[k] < PCRS_MAX_SUBMATCHES + 2
892              /* ..and referencing a real submatch.. */
893              && job->substitute->backref[k] < matches[i].submatches
894              /* ..that is nonempty.. */
895              && matches[i].submatch_length[job->substitute->backref[k]] > 0)
896          {
897             /* ..copy the submatch that is ref'd. */
898             memcpy(
899                result_offset,
900                subject + matches[i].submatch_offset[job->substitute->backref[k]],
901                matches[i].submatch_length[job->substitute->backref[k]]
902             );
903             result_offset += matches[i].submatch_length[job->substitute->backref[k]];
904          }
905       }
906       offset =  matches[i].submatch_offset[0] + (int)matches[i].submatch_length[0];
907    }
908
909    /* Copy the rest. */
910    memcpy(result_offset, subject + offset, subject_length - (size_t)offset);
911
912    *result_length = newsize;
913    free(matches);
914    return matches_found;
915
916 }
917
918
919 #define is_hex_digit(x) ((x) && strchr("0123456789ABCDEF", toupper(x)))
920
921 /*********************************************************************
922  *
923  * Function    :  is_hex_sequence
924  *
925  * Description :  Checks the first four characters of a string
926  *                and decides if they are a valid hex sequence
927  *                (like '\x40').
928  *
929  * Parameters  :
930  *          1  :  sequence = The string to check
931  *
932  * Returns     :  Non-zero if it's valid sequence, or
933  *                Zero if it isn't.
934  *
935  *********************************************************************/
936 static int is_hex_sequence(const char *sequence)
937 {
938    return (sequence[0] == '\\' &&
939            sequence[1] == 'x'  &&
940            is_hex_digit(sequence[2]) &&
941            is_hex_digit(sequence[3]));
942 }
943
944
945 /*
946  * Functions below this line are only part of the pcrs version
947  * included in Privoxy. If you use any of them you should not
948  * try to dynamically link against external pcrs versions.
949  */
950
951 /*********************************************************************
952  *
953  * Function    :  pcrs_job_is_dynamic
954  *
955  * Description :  Checks if a job has the "D" (dynamic) option set.
956  *
957  * Parameters  :
958  *          1  :  job = The job to check
959  *
960  * Returns     :  TRUE if the job is indeed dynamic, otherwise
961  *                FALSE
962  *
963  *********************************************************************/
964 int pcrs_job_is_dynamic (char *job)
965 {
966    const char delimiter = job[1];
967    const size_t length = strlen(job);
968    char *option;
969
970    if (length < 5)
971    {
972       /*
973        * The shortest valid (but useless)
974        * dynamic pattern is "s@@@D"
975        */
976       return FALSE;
977    }
978
979    /*
980     * Everything between the last character
981     * and the last delimiter is an option ...
982     */
983    for (option = job + length; *option != delimiter; option--)
984    {
985       if (*option == 'D')
986       {
987          /*
988           * ... and if said option is 'D' the job is dynamic.
989           */
990          return TRUE;
991       }
992    }
993    return FALSE;
994
995 }
996
997
998 /*********************************************************************
999  *
1000  * Function    :  pcrs_get_delimiter
1001  *
1002  * Description :  Tries to find a character that is safe to
1003  *                be used as a pcrs delimiter for a certain string.
1004  *
1005  * Parameters  :
1006  *          1  :  string = The string to search in
1007  *
1008  * Returns     :  A safe delimiter if one was found, otherwise '\0'.
1009  *
1010  *********************************************************************/
1011 char pcrs_get_delimiter(const char *string)
1012 {
1013    /*
1014     * Some characters that are unlikely to
1015     * be part of pcrs replacement strings.
1016     */
1017    static const char delimiters[] = "><#+*~%^-:;!@";
1018    const char *d = delimiters;
1019
1020    /* Take the first delimiter that isn't part of the string */
1021    while (*d && NULL != strchr(string, *d))
1022    {
1023       d++;
1024    }
1025    return *d;
1026
1027 }
1028
1029
1030 /*********************************************************************
1031  *
1032  * Function    :  pcrs_execute_single_command
1033  *
1034  * Description :  Apply single pcrs command to the subject.
1035  *                The subject itself is left untouched, memory for the result
1036  *                is malloc()ed and it is the caller's responsibility to free
1037  *                the result when it's no longer needed.
1038  *
1039  * Parameters  :
1040  *          1  :  subject = the subject (== original) string
1041  *          2  :  pcrs_command = the pcrs command as string (s@foo@bar@)
1042  *          3  :  hits = int* for returning  the number of modifications
1043  *
1044  * Returns     :  NULL in case of errors, otherwise the
1045  *                result of the pcrs command.
1046  *
1047  *********************************************************************/
1048 char *pcrs_execute_single_command(const char *subject, const char *pcrs_command, int *hits)
1049 {
1050    size_t size;
1051    char *result = NULL;
1052    pcrs_job *job;
1053
1054    assert(subject);
1055    assert(pcrs_command);
1056
1057    *hits = 0;
1058    size = strlen(subject);
1059
1060    job = pcrs_compile_command(pcrs_command, hits);
1061    if (NULL != job)
1062    {
1063       *hits = pcrs_execute(job, subject, size, &result, &size);
1064       if (*hits < 0)
1065       {
1066          freez(result);
1067       }
1068       pcrs_free_job(job);
1069    }
1070    return result;
1071
1072 }
1073
1074
1075 static const char warning[] = "... [too long, truncated]";
1076 /*********************************************************************
1077  *
1078  * Function    :  pcrs_compile_dynamic_command
1079  *
1080  * Description :  Takes a dynamic pcrs command, fills in the
1081  *                values of the variables and compiles it.
1082  *
1083  * Parameters  :
1084  *          1  :  pcrs_command = The dynamic pcrs command to compile
1085  *          2  :  v = NULL terminated array of variables and their values.
1086  *          3  :  error = pcrs error code
1087  *
1088  * Returns     :  NULL in case of hard errors, otherwise the
1089  *                compiled pcrs job.
1090  *
1091  *********************************************************************/
1092 pcrs_job *pcrs_compile_dynamic_command(char *pcrs_command, const struct pcrs_variable v[], int *error)
1093 {
1094    char buf[PCRS_BUFFER_SIZE];
1095    const char *original_pcrs_command = pcrs_command;
1096    char *pcrs_command_tmp = NULL;
1097    pcrs_job *job = NULL;
1098    int truncation = 0;
1099    char d;
1100    int ret;
1101
1102    while ((NULL != v->name) && (NULL != pcrs_command))
1103    {
1104       assert(NULL != v->value);
1105
1106       if (NULL == strstr(pcrs_command, v->name))
1107       {
1108          /*
1109           * Skip the substitution if the variable
1110           * name isn't part of the pattern.
1111           */
1112          v++;
1113          continue;
1114       }
1115
1116       /* Use pcrs to replace the variable with its value. */
1117       d = pcrs_get_delimiter(v->value);
1118       if ('\0' == d)
1119       {
1120          /* No proper delimiter found */
1121          *error = PCRS_ERR_CMDSYNTAX;
1122          freez(pcrs_command_tmp);
1123          return NULL;
1124       }
1125
1126       /*
1127        * Variable names are supposed to contain alpha
1128        * numerical characters plus '_' only.
1129        */
1130       assert(NULL == strchr(v->name, d));
1131
1132       ret = snprintf(buf, sizeof(buf), "s%c\\$%s%c%s%cgT", d, v->name, d, v->value, d);
1133       assert(ret >= 0);
1134       if (ret >= sizeof(buf))
1135       {
1136          /*
1137           * Value didn't completely fit into buffer,
1138           * overwrite the end of the substitution text
1139           * with a truncation message and close the pattern
1140           * properly.
1141           */
1142          const size_t trailer_size = sizeof(warning) + 3; /* 3 for d + "gT" */
1143          char *trailer_start = buf + sizeof(buf) - trailer_size;
1144
1145          ret = snprintf(trailer_start, trailer_size, "%s%cgT", warning, d);
1146          assert(ret == trailer_size - 1);
1147          assert(sizeof(buf) == strlen(buf) + 1);
1148          truncation = 1;
1149       }
1150
1151       pcrs_command_tmp = pcrs_execute_single_command(pcrs_command, buf, error);
1152       if (NULL == pcrs_command_tmp)
1153       {
1154          return NULL;
1155       }
1156
1157       if (pcrs_command != original_pcrs_command)
1158       {
1159          freez(pcrs_command);
1160       }
1161       pcrs_command = pcrs_command_tmp;
1162
1163       v++;
1164    }
1165
1166    job = pcrs_compile_command(pcrs_command, error);
1167    if (pcrs_command != original_pcrs_command)
1168    {
1169       freez(pcrs_command);
1170    }
1171
1172    if (truncation)
1173    {
1174       *error = PCRS_WARN_TRUNCATION;
1175    }
1176
1177    return job;
1178
1179 }
1180
1181
1182 /*
1183   Local Variables:
1184   tab-width: 3
1185   end:
1186 */