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