1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/pcrs.c,v $
5 * Purpose : pcrs is a supplement to the pcre library by Philip Hazel
6 * <ph10@cam.ac.uk> and adds Perl-style substitution. That
7 * is, it mimics Perl's 's' operator. See pcrs(3) for details.
9 * WARNING: This file contains additional functions and bug
10 * fixes that aren't part of the latest official pcrs package
11 * (which apparently is no longer maintained).
13 * Copyright : Written and Copyright (C) 2000, 2001 by Andreas S. Oesterhelt
14 * <andreas@oesterhelt.org>
16 * Copyright (C) 2006, 2007 Fabian Keil <fk@fabiankeil.de>
18 * This program is free software; you can redistribute it
19 * and/or modify it under the terms of the GNU General
20 * Public License as published by the Free Software
21 * Foundation; either version 2 of the License, or (at
22 * your option) any later version.
24 * This program is distributed in the hope that it will
25 * be useful, but WITHOUT ANY WARRANTY; without even the
26 * implied warranty of MERCHANTABILITY or FITNESS FOR A
27 * PARTICULAR PURPOSE. See the GNU General Public
28 * License for more details.
30 * The GNU General Public License should be included with
31 * this file. If not, you can view it at
32 * http://www.gnu.org/copyleft/gpl.html
33 * or write to the Free Software Foundation, Inc., 59
34 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
36 *********************************************************************/
44 * Include project.h just so that the right pcre.h gets
49 /* For snprintf only */
60 static int pcrs_parse_perl_options(const char *optstring, int *flags);
61 static pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag,
62 int capturecount, int *errptr);
63 static int is_hex_sequence(const char *sequence);
65 /*********************************************************************
67 * Function : pcrs_strerror
69 * Description : Return a string describing a given error code.
72 * 1 : error = the error code
74 * Returns : char * to the descriptive string
76 *********************************************************************/
77 const char *pcrs_strerror(const int error)
85 /* Passed-through PCRE error: */
86 case PCRE_ERROR_NOMEMORY: return "(pcre:) No memory";
88 /* Shouldn't happen unless PCRE or PCRS bug, or user messed with compiled job: */
89 case PCRE_ERROR_NULL: return "(pcre:) NULL code or subject or ovector";
90 case PCRE_ERROR_BADOPTION: return "(pcre:) Unrecognized option bit";
91 case PCRE_ERROR_BADMAGIC: return "(pcre:) Bad magic number in code";
92 case PCRE_ERROR_UNKNOWN_NODE: return "(pcre:) Bad node in pattern";
94 /* Can't happen / not passed: */
95 case PCRE_ERROR_NOSUBSTRING: return "(pcre:) Fire in power supply";
96 case PCRE_ERROR_NOMATCH: return "(pcre:) Water in power supply";
98 #ifdef PCRE_ERROR_MATCHLIMIT
100 * Only reported by PCRE versions newer than our own.
102 case PCRE_ERROR_MATCHLIMIT: return "(pcre:) Match limit reached";
103 #endif /* def PCRE_ERROR_MATCHLIMIT */
106 case PCRS_ERR_NOMEM: return "(pcrs:) No memory";
107 case PCRS_ERR_CMDSYNTAX: return "(pcrs:) Syntax error while parsing command";
108 case PCRS_ERR_STUDY: return "(pcrs:) PCRE error while studying the pattern";
109 case PCRS_ERR_BADJOB: return "(pcrs:) Bad job - NULL job, pattern or substitute";
110 case PCRS_WARN_BADREF: return "(pcrs:) Backreference out of range";
111 case PCRS_WARN_TRUNCATION:
112 return "(pcrs:) At least one variable was too big and has been truncated before compilation";
115 * XXX: With the exception of PCRE_ERROR_MATCHLIMIT we
116 * only catch PCRE errors that can happen with our internal
117 * version. If Privoxy is linked against a newer
118 * PCRE version all bets are off ...
121 snprintf(buf, sizeof(buf),
122 "Error code %d. For details, check the pcre documentation.",
127 /* error >= 0: No error */
128 return "(pcrs:) Everything's just fine. Thanks for asking.";
133 /*********************************************************************
135 * Function : pcrs_parse_perl_options
137 * Description : This function parses a string containing the options to
138 * Perl's s/// operator. It returns an integer that is the
139 * pcre equivalent of the symbolic optstring.
140 * Since pcre doesn't know about Perl's 'g' (global) or pcrs',
141 * 'T' (trivial) options but pcrs needs them, the corresponding
142 * flags are set if 'g'or 'T' is encountered.
143 * Note: The 'T' and 'U' options do not conform to Perl.
146 * 1 : optstring = string with options in perl syntax
147 * 2 : flags = see description
149 * Returns : option integer suitable for pcre
151 *********************************************************************/
152 static int pcrs_parse_perl_options(const char *optstring, int *flags)
158 if (NULL == optstring) return 0;
160 for (i = 0; i < strlen(optstring); i++)
164 case 'e': break; /* ToDo ;-) */
165 case 'g': *flags |= PCRS_GLOBAL; break;
166 case 'i': rc |= PCRE_CASELESS; break;
167 case 'm': rc |= PCRE_MULTILINE; break;
169 case 's': rc |= PCRE_DOTALL; break;
170 case 'x': rc |= PCRE_EXTENDED; break;
171 case 'U': rc |= PCRE_UNGREEDY; break;
172 case 'T': *flags |= PCRS_TRIVIAL; break;
182 /*********************************************************************
184 * Function : pcrs_compile_fuzzed_replacement
186 * Description : Wrapper around pcrs_compile_replacement() for
190 * 1 : replacement = replacement part of s/// operator
192 * 2 : errptr = pointer to an integer in which error
193 * conditions can be returned.
195 * Returns : pcrs_substitute data structure, or NULL if an
196 * error is encountered. In that case, *errptr has
199 *********************************************************************/
200 extern pcrs_substitute *pcrs_compile_fuzzed_replacement(const char *replacement, int *errptr)
202 int capturecount = PCRS_MAX_SUBMATCHES; /* XXX: fuzzworthy? */
203 int trivial_flag = 0; /* We don't want to fuzz strncpy() */
205 *errptr = 0; /* XXX: Should pcrs_compile_replacement() do this? */
207 return pcrs_compile_replacement(replacement, trivial_flag, capturecount, errptr);
213 /*********************************************************************
215 * Function : pcrs_compile_replacement
217 * Description : This function takes a Perl-style replacement (2nd argument
218 * to the s/// operator and returns a compiled pcrs_substitute,
219 * or NULL if memory allocation for the substitute structure
223 * 1 : replacement = replacement part of s/// operator
225 * 2 : trivialflag = Flag that causes backreferences to be
227 * 3 : capturecount = Number of capturing subpatterns in
228 * the pattern. Needed for $+ handling.
229 * 4 : errptr = pointer to an integer in which error
230 * conditions can be returned.
232 * Returns : pcrs_substitute data structure, or NULL if an
233 * error is encountered. In that case, *errptr has
236 *********************************************************************/
237 static pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag, int capturecount, int *errptr)
245 static size_t length;
247 i = k = l = quoted = 0;
252 if (NULL == replacement)
260 if (NULL == (r = (pcrs_substitute *)malloc(sizeof(pcrs_substitute))))
262 *errptr = PCRS_ERR_NOMEM;
265 memset(r, '\0', sizeof(pcrs_substitute));
267 length = strlen(replacement);
269 if (NULL == (text = (char *)malloc(length + 1)))
272 *errptr = PCRS_ERR_NOMEM;
275 memset(text, '\0', length + 1);
279 * In trivial mode, just copy the substitute text
283 text = strncpy(text, replacement, length + 1);
288 * Else, parse, cut out and record all backreferences
292 while (i < (int)length)
295 if (replacement[i] == '\\')
299 text[k++] = replacement[i++];
304 if (replacement[i+1] && strchr("tnrfae0", replacement[i+1]))
306 switch (replacement[++i])
332 else if (is_hex_sequence(&replacement[i]))
335 * Replace a hex sequence with a single
336 * character with the sequence's ascii value.
337 * e.g.: '\x7e' => '~'
339 const int ascii_value = xtoi(&replacement[i+2]);
341 assert(ascii_value >= 0);
342 assert(ascii_value < 256);
343 text[k++] = (char)ascii_value;
356 if (replacement[i] == '$' && !quoted && i < (int)(length - 1))
358 char *symbol, symbols[] = "'`+&";
359 if (l >= PCRS_MAX_SUBMATCHES)
363 *errptr = PCRS_WARN_BADREF;
366 r->block_length[l] = (size_t)(k - r->block_offset[l]);
368 /* Numerical backreferences */
369 if (isdigit((int)replacement[i + 1]))
371 while (i < (int)length && isdigit((int)replacement[++i]))
373 r->backref[l] = r->backref[l] * 10 + replacement[i] - 48;
375 if (r->backref[l] > capturecount)
379 *errptr = PCRS_WARN_BADREF;
384 /* Symbolic backreferences: */
385 else if (NULL != (symbol = strchr(symbols, replacement[i + 1])))
388 if (symbol - symbols == 2) /* $+ */
390 r->backref[l] = capturecount;
392 else if (symbol - symbols == 3) /* $& */
398 r->backref[l] = (int)(PCRS_MAX_SUBMATCHES + 1 - (symbol - symbols));
403 /* Invalid backref -> plain '$' */
409 assert(r->backref[l] < PCRS_MAX_SUBMATCHES + 2);
410 /* Valid and in range? -> record */
411 if ((0 <= r->backref[l]) &&
412 (r->backref[l] < PCRS_MAX_SUBMATCHES + 2) &&
413 (l < PCRS_MAX_SUBMATCHES - 1))
415 r->backref_count[r->backref[l]] += 1;
416 r->block_offset[++l] = k;
422 *errptr = PCRS_WARN_BADREF;
429 /* Plain chars are copied */
430 text[k++] = replacement[i++];
433 } /* -END- if (!trivialflag) */
440 r->length = (size_t)k;
441 r->block_length[l] = (size_t)(k - r->block_offset[l]);
448 /*********************************************************************
450 * Function : pcrs_free_job
452 * Description : Frees the memory used by a pcrs_job struct and its
453 * dependent structures.
456 * 1 : job = pointer to the pcrs_job structure to be freed
458 * Returns : a pointer to the next job, if there was any, or
461 *********************************************************************/
462 pcrs_job *pcrs_free_job(pcrs_job *job)
473 if (job->pattern != NULL) free(job->pattern);
474 if (job->hints != NULL) free(job->hints);
475 if (job->substitute != NULL)
477 if (job->substitute->text != NULL) free(job->substitute->text);
478 free(job->substitute);
487 /*********************************************************************
489 * Function : pcrs_free_joblist
491 * Description : Iterates through a chained list of pcrs_job's and
492 * frees them using pcrs_free_job.
495 * 1 : joblist = pointer to the first pcrs_job structure to
500 *********************************************************************/
501 void pcrs_free_joblist(pcrs_job *joblist)
503 while (NULL != (joblist = pcrs_free_job(joblist))) {};
510 /*********************************************************************
512 * Function : pcrs_compile_command
514 * Description : Parses a string with a Perl-style s/// command,
515 * calls pcrs_compile, and returns a corresponding
516 * pcrs_job, or NULL if parsing or compiling the job
520 * 1 : command = string with perl-style s/// command
521 * 2 : errptr = pointer to an integer in which error
522 * conditions can be returned.
524 * Returns : a corresponding pcrs_job data structure, or NULL
525 * if an error was encountered. In that case, *errptr
528 *********************************************************************/
529 pcrs_job *pcrs_compile_command(const char *command, int *errptr)
531 int i, k, l, quoted = FALSE;
540 * Tokenize the perl command
542 limit = strlen(command);
545 *errptr = PCRS_ERR_CMDSYNTAX;
550 delimiter = command[1];
553 tokens[l] = (char *) malloc(limit + 1);
555 for (i = 0; i <= (int)limit; i++)
558 if (command[i] == delimiter && !quoted)
565 tokens[0][k++] = '\0';
566 tokens[++l] = tokens[0] + k;
570 else if (command[i] == '\\' && !quoted)
573 if (command[i+1] == delimiter) continue;
579 tokens[0][k++] = command[i];
587 *errptr = PCRS_ERR_CMDSYNTAX;
592 newjob = pcrs_compile(tokens[1], tokens[2], tokens[3], errptr);
599 /*********************************************************************
601 * Function : pcrs_compile
603 * Description : Takes the three arguments to a perl s/// command
604 * and compiles a pcrs_job structure from them.
607 * 1 : pattern = string with perl-style pattern
608 * 2 : substitute = string with perl-style substitute
609 * 3 : options = string with perl-style options
610 * 4 : errptr = pointer to an integer in which error
611 * conditions can be returned.
613 * Returns : a corresponding pcrs_job data structure, or NULL
614 * if an error was encountered. In that case, *errptr
617 *********************************************************************/
618 pcrs_job *pcrs_compile(const char *pattern, const char *substitute, const char *options, int *errptr)
628 * Handle NULL arguments
630 if (pattern == NULL) pattern = "";
631 if (substitute == NULL) substitute = "";
635 * Get and init memory
637 if (NULL == (newjob = (pcrs_job *)malloc(sizeof(pcrs_job))))
639 *errptr = PCRS_ERR_NOMEM;
642 memset(newjob, '\0', sizeof(pcrs_job));
646 * Evaluate the options
648 newjob->options = pcrs_parse_perl_options(options, &flags);
649 newjob->flags = flags;
653 * Compile the pattern
655 newjob->pattern = pcre_compile(pattern, newjob->options, &error, errptr, NULL);
656 if (newjob->pattern == NULL)
658 pcrs_free_job(newjob);
664 * Generate hints. This has little overhead, since the
665 * hints will be NULL for a boring pattern anyway.
667 newjob->hints = pcre_study(newjob->pattern, 0, &error);
670 *errptr = PCRS_ERR_STUDY;
671 pcrs_free_job(newjob);
677 * Determine the number of capturing subpatterns.
678 * This is needed for handling $+ in the substitute.
680 if (0 > (*errptr = pcre_fullinfo(newjob->pattern, newjob->hints, PCRE_INFO_CAPTURECOUNT, &capturecount)))
682 pcrs_free_job(newjob);
688 * Compile the substitute
690 if (NULL == (newjob->substitute = pcrs_compile_replacement(substitute, newjob->flags & PCRS_TRIVIAL, capturecount, errptr)))
692 pcrs_free_job(newjob);
701 /*********************************************************************
703 * Function : pcrs_execute_list
705 * Description : This is a multiple job wrapper for pcrs_execute().
706 * Apply the regular substitutions defined by the jobs in
707 * the joblist to the subject.
708 * The subject itself is left untouched, memory for the result
709 * is malloc()ed and it is the caller's responsibility to free
710 * the result when it's no longer needed.
712 * Note: For convenient string handling, a null byte is
713 * appended to the result. It does not count towards the
714 * result_length, though.
718 * 1 : joblist = the chained list of pcrs_jobs to be executed
719 * 2 : subject = the subject string
720 * 3 : subject_length = the subject's length
721 * 4 : result = char** for returning the result
722 * 5 : result_length = size_t* for returning the result's length
724 * Returns : On success, the number of substitutions that were made.
725 * May be > 1 if job->flags contained PCRS_GLOBAL
726 * On failure, the (negative) pcre error code describing the
727 * failure, which may be translated to text using pcrs_strerror().
729 *********************************************************************/
730 int pcrs_execute_list(pcrs_job *joblist, char *subject, size_t subject_length, char **result, size_t *result_length)
733 char *old, *new = NULL;
734 int hits, total_hits;
737 *result_length = subject_length;
740 for (job = joblist; job != NULL; job = job->next)
742 hits = pcrs_execute(job, old, *result_length, &new, result_length);
744 if (old != subject) free(old);
763 /*********************************************************************
765 * Function : pcrs_execute
767 * Description : Apply the regular substitution defined by the job to the
769 * The subject itself is left untouched, memory for the result
770 * is malloc()ed and it is the caller's responsibility to free
771 * the result when it's no longer needed.
773 * Note: For convenient string handling, a null byte is
774 * appended to the result. It does not count towards the
775 * result_length, though.
778 * 1 : job = the pcrs_job to be executed
779 * 2 : subject = the subject (== original) string
780 * 3 : subject_length = the subject's length
781 * 4 : result = char** for returning the result (NULL on error)
782 * 5 : result_length = size_t* for returning the result's length
784 * Returns : On success, the number of substitutions that were made.
785 * May be > 1 if job->flags contained PCRS_GLOBAL
786 * On failure, the (negative) pcre error code describing the
787 * failure, which may be translated to text using pcrs_strerror().
789 *********************************************************************/
790 int pcrs_execute(pcrs_job *job, const char *subject, size_t subject_length, char **result, size_t *result_length)
792 int offsets[3 * PCRS_MAX_SUBMATCHES],
797 max_matches = PCRS_MAX_MATCH_INIT;
799 pcrs_match *matches, *dummy;
806 * Sanity check & memory allocation
808 if (job == NULL || job->pattern == NULL || job->substitute == NULL || NULL == subject)
810 return(PCRS_ERR_BADJOB);
813 if (NULL == (matches = (pcrs_match *)malloc((size_t)max_matches * sizeof(pcrs_match))))
815 return(PCRS_ERR_NOMEM);
817 memset(matches, '\0', (size_t)max_matches * sizeof(pcrs_match));
821 * Find the pattern and calculate the space
822 * requirements for the result
824 newsize = subject_length;
826 while ((submatches = pcre_exec(job->pattern, job->hints, subject, (int)subject_length, offset, 0, offsets, 3 * PCRS_MAX_SUBMATCHES)) > 0)
828 job->flags |= PCRS_SUCCESS;
829 matches[i].submatches = submatches;
831 for (k = 0; k < submatches; k++)
833 matches[i].submatch_offset[k] = offsets[2 * k];
835 /* Note: Non-found optional submatches have length -1-(-1)==0 */
836 matches[i].submatch_length[k] = (size_t)(offsets[2 * k + 1] - offsets[2 * k]);
838 /* reserve mem for each submatch as often as it is ref'd */
839 newsize += matches[i].submatch_length[k] * (size_t)job->substitute->backref_count[k];
841 /* plus replacement text size minus match text size */
842 newsize += job->substitute->length - matches[i].submatch_length[0];
844 /* chunk before match */
845 matches[i].submatch_offset[PCRS_MAX_SUBMATCHES] = 0;
846 matches[i].submatch_length[PCRS_MAX_SUBMATCHES] = (size_t)offsets[0];
847 newsize += (size_t)offsets[0] * (size_t)job->substitute->backref_count[PCRS_MAX_SUBMATCHES];
849 /* chunk after match */
850 matches[i].submatch_offset[PCRS_MAX_SUBMATCHES + 1] = offsets[1];
851 matches[i].submatch_length[PCRS_MAX_SUBMATCHES + 1] = subject_length - (size_t)offsets[1] - 1;
852 newsize += (subject_length - (size_t)offsets[1]) * (size_t)job->substitute->backref_count[PCRS_MAX_SUBMATCHES + 1];
854 /* Storage for matches exhausted? -> Extend! */
855 if (++i >= max_matches)
857 max_matches = (int)(max_matches * PCRS_MAX_MATCH_GROW);
858 if (NULL == (dummy = (pcrs_match *)realloc(matches, (size_t)max_matches * sizeof(pcrs_match))))
861 return(PCRS_ERR_NOMEM);
866 /* Non-global search or limit reached? */
867 if (!(job->flags & PCRS_GLOBAL)) break;
869 /* Don't loop on empty matches */
870 if (offsets[1] == offset)
871 if ((size_t)offset < subject_length)
875 /* Go find the next one */
879 /* Pass pcre error through if (bad) failure */
880 if (submatches < PCRE_ERROR_NOMATCH)
889 * Get memory for the result (must be freed by caller!)
890 * and append terminating null byte.
892 if ((*result = (char *)malloc(newsize + 1)) == NULL)
895 return PCRS_ERR_NOMEM;
899 (*result)[newsize] = '\0';
907 result_offset = *result;
909 for (i = 0; i < matches_found; i++)
911 /* copy the chunk preceding the match */
912 memcpy(result_offset, subject + offset, (size_t)(matches[i].submatch_offset[0] - offset));
913 result_offset += matches[i].submatch_offset[0] - offset;
915 /* For every segment of the substitute.. */
916 for (k = 0; k <= job->substitute->backrefs; k++)
918 /* ...copy its text.. */
919 memcpy(result_offset, job->substitute->text + job->substitute->block_offset[k], job->substitute->block_length[k]);
920 result_offset += job->substitute->block_length[k];
922 /* ..plus, if it's not the last chunk, i.e.: There *is* a backref.. */
923 if (k != job->substitute->backrefs
924 /* ..in legal range.. */
925 && job->substitute->backref[k] < PCRS_MAX_SUBMATCHES + 2
926 /* ..and referencing a real submatch.. */
927 && job->substitute->backref[k] < matches[i].submatches
928 /* ..that is nonempty.. */
929 && matches[i].submatch_length[job->substitute->backref[k]] > 0)
931 /* ..copy the submatch that is ref'd. */
934 subject + matches[i].submatch_offset[job->substitute->backref[k]],
935 matches[i].submatch_length[job->substitute->backref[k]]
937 result_offset += matches[i].submatch_length[job->substitute->backref[k]];
940 offset = matches[i].submatch_offset[0] + (int)matches[i].submatch_length[0];
944 memcpy(result_offset, subject + offset, subject_length - (size_t)offset);
946 *result_length = newsize;
948 return matches_found;
953 #define is_hex_digit(x) ((x) && strchr("0123456789ABCDEF", toupper(x)))
955 /*********************************************************************
957 * Function : is_hex_sequence
959 * Description : Checks the first four characters of a string
960 * and decides if they are a valid hex sequence
964 * 1 : sequence = The string to check
966 * Returns : Non-zero if it's valid sequence, or
969 *********************************************************************/
970 static int is_hex_sequence(const char *sequence)
972 return (sequence[0] == '\\' &&
973 sequence[1] == 'x' &&
974 is_hex_digit(sequence[2]) &&
975 is_hex_digit(sequence[3]));
980 * Functions below this line are only part of the pcrs version
981 * included in Privoxy. If you use any of them you should not
982 * try to dynamically link against external pcrs versions.
985 /*********************************************************************
987 * Function : pcrs_job_is_dynamic
989 * Description : Checks if a job has the "D" (dynamic) option set.
992 * 1 : job = The job to check
994 * Returns : TRUE if the job is indeed dynamic, otherwise
997 *********************************************************************/
998 int pcrs_job_is_dynamic (char *job)
1000 const char delimiter = job[1];
1001 const size_t length = strlen(job);
1007 * The shortest valid (but useless)
1008 * dynamic pattern is "s@@@D"
1014 * Everything between the last character
1015 * and the last delimiter is an option ...
1017 for (option = job + length; *option != delimiter; option--)
1022 * ... and if said option is 'D' the job is dynamic.
1032 /*********************************************************************
1034 * Function : pcrs_get_delimiter
1036 * Description : Tries to find a character that is safe to
1037 * be used as a pcrs delimiter for a certain string.
1040 * 1 : string = The string to search in
1042 * Returns : A safe delimiter if one was found, otherwise '\0'.
1044 *********************************************************************/
1045 char pcrs_get_delimiter(const char *string)
1048 * Some characters that are unlikely to
1049 * be part of pcrs replacement strings.
1051 static const char delimiters[] = "><#+*~%^-:;!@";
1052 const char *d = delimiters;
1054 /* Take the first delimiter that isn't part of the string */
1055 while (*d && NULL != strchr(string, *d))
1064 /*********************************************************************
1066 * Function : pcrs_execute_single_command
1068 * Description : Apply single pcrs command to the subject.
1069 * The subject itself is left untouched, memory for the result
1070 * is malloc()ed and it is the caller's responsibility to free
1071 * the result when it's no longer needed.
1074 * 1 : subject = the subject (== original) string
1075 * 2 : pcrs_command = the pcrs command as string (s@foo@bar@)
1076 * 3 : hits = int* for returning the number of modifications
1078 * Returns : NULL in case of errors, otherwise the
1079 * result of the pcrs command.
1081 *********************************************************************/
1082 char *pcrs_execute_single_command(const char *subject, const char *pcrs_command, int *hits)
1085 char *result = NULL;
1089 assert(pcrs_command);
1092 size = strlen(subject);
1094 job = pcrs_compile_command(pcrs_command, hits);
1097 *hits = pcrs_execute(job, subject, size, &result, &size);
1109 static const char warning[] = "... [too long, truncated]";
1110 /*********************************************************************
1112 * Function : pcrs_compile_dynamic_command
1114 * Description : Takes a dynamic pcrs command, fills in the
1115 * values of the variables and compiles it.
1118 * 1 : pcrs_command = The dynamic pcrs command to compile
1119 * 2 : v = NULL terminated array of variables and their values.
1120 * 3 : error = pcrs error code
1122 * Returns : NULL in case of hard errors, otherwise the
1123 * compiled pcrs job.
1125 *********************************************************************/
1126 pcrs_job *pcrs_compile_dynamic_command(char *pcrs_command, const struct pcrs_variable v[], int *error)
1128 char buf[PCRS_BUFFER_SIZE];
1129 const char *original_pcrs_command = pcrs_command;
1130 char *pcrs_command_tmp = NULL;
1131 pcrs_job *job = NULL;
1136 while ((NULL != v->name) && (NULL != pcrs_command))
1138 assert(NULL != v->value);
1140 if (NULL == strstr(pcrs_command, v->name))
1143 * Skip the substitution if the variable
1144 * name isn't part of the pattern.
1150 /* Use pcrs to replace the variable with its value. */
1151 d = pcrs_get_delimiter(v->value);
1154 /* No proper delimiter found */
1155 *error = PCRS_ERR_CMDSYNTAX;
1156 freez(pcrs_command_tmp);
1161 * Variable names are supposed to contain alpha
1162 * numerical characters plus '_' only.
1164 assert(NULL == strchr(v->name, d));
1166 ret = snprintf(buf, sizeof(buf), "s%c\\$%s%c%s%cgT", d, v->name, d, v->value, d);
1168 if (ret >= sizeof(buf))
1171 * Value didn't completely fit into buffer,
1172 * overwrite the end of the substitution text
1173 * with a truncation message and close the pattern
1176 const size_t trailer_size = sizeof(warning) + 3; /* 3 for d + "gT" */
1177 char *trailer_start = buf + sizeof(buf) - trailer_size;
1179 ret = snprintf(trailer_start, trailer_size, "%s%cgT", warning, d);
1180 assert(ret == trailer_size - 1);
1181 assert(sizeof(buf) == strlen(buf) + 1);
1185 pcrs_command_tmp = pcrs_execute_single_command(pcrs_command, buf, error);
1186 if (NULL == pcrs_command_tmp)
1191 if (pcrs_command != original_pcrs_command)
1193 freez(pcrs_command);
1195 pcrs_command = pcrs_command_tmp;
1200 job = pcrs_compile_command(pcrs_command, error);
1201 if (pcrs_command != original_pcrs_command)
1203 freez(pcrs_command);
1208 *error = PCRS_WARN_TRUNCATION;