X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=pcrs.c;h=a6c521af7e2a5173442b4c36540ade9bf2d3c2bc;hp=c2a4945e06844dcafbd7763a2f81b467f0e5ef5d;hb=5b366a65be8550ee01cc3e7cf2495a2f4f2bd870;hpb=d2871ac82955cf0b901a6916da1f8ff66cd8fd72 diff --git a/pcrs.c b/pcrs.c index c2a4945e..a6c521af 100644 --- a/pcrs.c +++ b/pcrs.c @@ -1,5 +1,4 @@ -const char pcrs_rcs[] = "$Id: pcrs.c,v 1.13 2001/09/06 14:05:59 oes Exp $"; - +const char pcrs_rcs[] = "$Id: pcrs.c,v 1.28 2007/08/18 14:37:27 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/pcrs.c,v $ @@ -8,10 +7,15 @@ const char pcrs_rcs[] = "$Id: pcrs.c,v 1.13 2001/09/06 14:05:59 oes Exp $"; * and adds Perl-style substitution. That * is, it mimics Perl's 's' operator. See pcrs(3) for details. * + * WARNING: This file contains additional functions and bug + * fixes that aren't part of the latest official pcrs package + * (which apparently is no longer maintained). * * Copyright : Written and Copyright (C) 2000, 2001 by Andreas S. Oesterhelt * * + * Copyright (C) 2006, 2007 Fabian Keil + * * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU Lesser * General Public License (LGPL), version 2.1, which should @@ -33,6 +37,76 @@ const char pcrs_rcs[] = "$Id: pcrs.c,v 1.13 2001/09/06 14:05:59 oes Exp $"; * * Revisions : * $Log: pcrs.c,v $ + * Revision 1.28 2007/08/18 14:37:27 fabiankeil + * Ditch hex_to_byte() in favour of xtoi(). + * + * Revision 1.27 2007/08/05 13:47:04 fabiankeil + * #1763173 from Stefan Huehner: s@const static@static const@. + * + * Revision 1.26 2007/07/01 13:29:54 fabiankeil + * Add limited hex notation support for the PCRS + * substitution text ('\x7e' = '~'). Closes #1627140. + * + * Revision 1.25 2007/04/30 15:02:18 fabiankeil + * Introduce dynamic pcrs jobs that can resolve variables. + * + * Revision 1.24 2007/01/05 15:46:12 fabiankeil + * Don't use strlen() to calculate the length of + * the pcrs substitutes. They don't have to be valid C + * strings and getting their length wrong can result in + * user-controlled memory corruption. + * + * Thanks to Felix Gröbert for reporting the problem + * and providing the fix [#1627140]. + * + * Revision 1.23 2006/12/29 17:53:05 fabiankeil + * Fixed gcc43 conversion warnings. + * + * Revision 1.22 2006/12/24 17:34:20 fabiankeil + * Add pcrs_strerror() message for PCRE_ERROR_MATCHLIMIT + * and give a hint why an error code might be unknown. + * + * Catch NULL subjects early in pcrs_execute(). + * + * Revision 1.21 2006/07/18 14:48:47 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.19.2.4 2005/05/07 21:50:55 david__schmidt + * A few memory leaks plugged (mostly on error paths) + * + * Revision 1.19.2.3 2003/12/04 12:32:45 oes + * Append a trailing nullbyte to result to facilitate string processing + * + * Revision 1.19.2.2 2002/10/08 16:22:28 oes + * Bugfix: Need to check validity of backreferences explicitly, + * because when max_matches are reached and matches is expanded, + * realloc() does not zero the memory. Fixes Bug # 606227 + * + * Revision 1.19.2.1 2002/08/10 11:23:40 oes + * Include prce.h via project.h, where the appropriate + * source will have been selected + * + * Revision 1.19 2002/03/08 14:47:48 oes + * Cosmetics + * + * Revision 1.18 2002/03/08 14:17:14 oes + * Fixing -Wconversion warnings + * + * Revision 1.17 2002/03/08 13:45:48 oes + * Hiding internal functions + * + * Revision 1.16 2001/11/30 21:32:14 jongfoster + * Fixing signed/unsigned comparison (Andreas please check this!) + * One tab->space + * + * Revision 1.15 2001/09/20 16:11:06 steudten + * + * Add casting for some string functions. + * + * Revision 1.14 2001/09/09 21:41:57 oes + * Fixing yet another silly bug + * * Revision 1.13 2001/09/06 14:05:59 oes * Fixed silly bug * @@ -109,14 +183,34 @@ const char pcrs_rcs[] = "$Id: pcrs.c,v 1.13 2001/09/06 14:05:59 oes Exp $"; *********************************************************************/ -#include #include #include +#include + +/* + * Include project.h just so that the right pcre.h gets + * included from there + */ +#include "project.h" + +/* For snprintf only */ +#include "miscutil.h" +/* For xtoi */ +#include "encode.h" #include "pcrs.h" const char pcrs_h_rcs[] = PCRS_H_VERSION; +/* + * Internal prototypes + */ + +static int pcrs_parse_perl_options(const char *optstring, int *flags); +static pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag, + int capturecount, int *errptr); +static int is_hex_sequence(const char *sequence); + /********************************************************************* * * Function : pcrs_strerror @@ -148,15 +242,29 @@ const char *pcrs_strerror(const int error) case PCRE_ERROR_NOSUBSTRING: return "(pcre:) Fire in power supply"; case PCRE_ERROR_NOMATCH: return "(pcre:) Water in power supply"; +#ifdef PCRE_ERROR_MATCHLIMIT + /* + * Only reported by PCRE versions newer than our own. + */ + case PCRE_ERROR_MATCHLIMIT: return "(pcre:) Match limit reached"; +#endif /* def PCRE_ERROR_MATCHLIMIT */ + /* PCRS errors: */ case PCRS_ERR_NOMEM: return "(pcrs:) No memory"; case PCRS_ERR_CMDSYNTAX: return "(pcrs:) Syntax error while parsing command"; case PCRS_ERR_STUDY: return "(pcrs:) PCRE error while studying the pattern"; case PCRS_ERR_BADJOB: return "(pcrs:) Bad job - NULL job, pattern or substitute"; case PCRS_WARN_BADREF: return "(pcrs:) Backreference out of range"; - - /* What's that? */ - default: return "Unknown error"; + case PCRS_WARN_TRUNCATION: + return "(pcrs:) At least one variable was too big and has been truncated before compilation"; + + /* + * XXX: With the exception of PCRE_ERROR_MATCHLIMIT we + * only catch PCRE errors that can happen with our internal + * version. If Privoxy is linked against a newer + * PCRE version all bets are off ... + */ + default: return "Unknown error. Privoxy out of sync with PCRE?"; } } /* error >= 0: No error */ @@ -184,7 +292,7 @@ const char *pcrs_strerror(const int error) * Returns : option integer suitable for pcre * *********************************************************************/ -int pcrs_parse_perl_options(const char *optstring, int *flags) +static int pcrs_parse_perl_options(const char *optstring, int *flags) { size_t i; int rc = 0; @@ -192,7 +300,7 @@ int pcrs_parse_perl_options(const char *optstring, int *flags) if (NULL == optstring) return 0; - for (i=0; i < strlen(optstring); i++) + for (i = 0; i < strlen(optstring); i++) { switch(optstring[i]) { @@ -204,7 +312,7 @@ int pcrs_parse_perl_options(const char *optstring, int *flags) case 's': rc |= PCRE_DOTALL; break; case 'x': rc |= PCRE_EXTENDED; break; case 'U': rc |= PCRE_UNGREEDY; break; - case 'T': *flags |= PCRS_TRIVIAL; break; + case 'T': *flags |= PCRS_TRIVIAL; break; default: break; } } @@ -237,9 +345,10 @@ int pcrs_parse_perl_options(const char *optstring, int *flags) * the reason. * *********************************************************************/ -pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag, int capturecount, int *errptr) +static pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag, int capturecount, int *errptr) { - int length, i, k, l, quoted; + int i, k, l, quoted; + size_t length; char *text; pcrs_substitute *r; @@ -280,7 +389,7 @@ pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialfl if (trivialflag) { text = strncpy(text, replacement, length + 1); - k = length; + k = (int)length; } /* @@ -288,7 +397,7 @@ pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialfl */ else { - while(i < length) + while (i < (int)length) { /* Quoting */ if (replacement[i] == '\\') @@ -302,7 +411,7 @@ pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialfl { if (replacement[i+1] && strchr("tnrfae0", replacement[i+1])) { - switch(replacement[++i]) + switch (replacement[++i]) { case 't': text[k++] = '\t'; @@ -317,7 +426,7 @@ pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialfl text[k++] = '\f'; break; case 'a': - text[k++] = '\a'; + text[k++] = 7; break; case 'e': text[k++] = 27; @@ -328,6 +437,20 @@ pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialfl } i++; } + else if (is_hex_sequence(&replacement[i])) + { + /* + * Replace a hex sequence with a single + * character with the sequence's ascii value. + * e.g.: '\x7e' => '~' + */ + const int ascii_value = xtoi(&replacement[i+2]); + + assert(ascii_value > 0); + assert(ascii_value < 256); + text[k++] = (char)ascii_value; + i += 4; + } else { quoted = 1; @@ -338,15 +461,15 @@ pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialfl } /* Backreferences */ - if (replacement[i] == '$' && !quoted && i < length - 1) + if (replacement[i] == '$' && !quoted && i < (int)(length - 1)) { char *symbol, symbols[] = "'`+&"; - r->block_length[l] = k - r->block_offset[l]; + r->block_length[l] = (size_t)(k - r->block_offset[l]); /* Numerical backreferences */ - if (isdigit(replacement[i + 1])) + if (isdigit((int)replacement[i + 1])) { - while (i < length && isdigit(replacement[++i])) + while (i < (int)length && isdigit((int)replacement[++i])) { r->backref[l] = r->backref[l] * 10 + replacement[i] - 48; } @@ -406,7 +529,8 @@ plainchar: */ r->text = text; r->backrefs = l; - r->block_length[l] = k - r->block_offset[l]; + r->length = (size_t)k; + r->block_length[l] = (size_t)(k - r->block_offset[l]); return r; @@ -496,7 +620,8 @@ void pcrs_free_joblist(pcrs_job *joblist) *********************************************************************/ pcrs_job *pcrs_compile_command(const char *command, int *errptr) { - int i, k, l, limit, quoted = FALSE; + int i, k, l, quoted = FALSE; + size_t limit; char delimiter; char *tokens[4]; pcrs_job *newjob; @@ -519,7 +644,7 @@ pcrs_job *pcrs_compile_command(const char *command, int *errptr) tokens[l] = (char *) malloc(limit + 1); - for (i=0; i <= limit; i++) + for (i = 0; i <= (int)limit; i++) { if (command[i] == delimiter && !quoted) @@ -674,26 +799,30 @@ pcrs_job *pcrs_compile(const char *pattern, const char *substitute, const char * * the joblist to the subject. * The subject itself is left untouched, memory for the result * is malloc()ed and it is the caller's responsibility to free - * the result when it's no longer needed. + * the result when it's no longer needed. + * + * Note: For convenient string handling, a null byte is + * appended to the result. It does not count towards the + * result_length, though. + * * * Parameters : * 1 : joblist = the chained list of pcrs_jobs to be executed * 2 : subject = the subject string * 3 : subject_length = the subject's length - * INCLUDING the terminating zero, if string! * 4 : result = char** for returning the result * 5 : result_length = size_t* for returning the result's length * * Returns : On success, the number of substitutions that were made. * May be > 1 if job->flags contained PCRS_GLOBAL - * On failiure, the (negative) pcre error code describing the - * failiure, which may be translated to text using pcrs_strerror(). + * On failure, the (negative) pcre error code describing the + * failure, which may be translated to text using pcrs_strerror(). * *********************************************************************/ int pcrs_execute_list(pcrs_job *joblist, char *subject, size_t subject_length, char **result, size_t *result_length) { pcrs_job *job; - char *old, *new; + char *old, *new = NULL; int hits, total_hits; old = subject; @@ -733,28 +862,32 @@ int pcrs_execute_list(pcrs_job *joblist, char *subject, size_t subject_length, c * is malloc()ed and it is the caller's responsibility to free * the result when it's no longer needed. * + * Note: For convenient string handling, a null byte is + * appended to the result. It does not count towards the + * result_length, though. + * * Parameters : * 1 : job = the pcrs_job to be executed * 2 : subject = the subject (== original) string * 3 : subject_length = the subject's length - * INCLUDING the terminating zero, if string! * 4 : result = char** for returning the result * 5 : result_length = size_t* for returning the result's length * * Returns : On success, the number of substitutions that were made. * May be > 1 if job->flags contained PCRS_GLOBAL - * On failiure, the (negative) pcre error code describing the - * failiure, which may be translated to text using pcrs_strerror(). + * On failure, the (negative) pcre error code describing the + * failure, which may be translated to text using pcrs_strerror(). * *********************************************************************/ -int pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **result, size_t *result_length) +int pcrs_execute(pcrs_job *job, const char *subject, size_t subject_length, char **result, size_t *result_length) { int offsets[3 * PCRS_MAX_SUBMATCHES], - offset, i, k, + offset, + i, k, matches_found, - newsize, submatches, max_matches = PCRS_MAX_MATCH_INIT; + size_t newsize; pcrs_match *matches, *dummy; char *result_offset; @@ -763,59 +896,59 @@ int pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **res /* * Sanity check & memory allocation */ - if (job == NULL || job->pattern == NULL || job->substitute == NULL) + if (job == NULL || job->pattern == NULL || job->substitute == NULL || NULL == subject) { *result = NULL; return(PCRS_ERR_BADJOB); } - if (NULL == (matches = (pcrs_match *)malloc(max_matches * sizeof(pcrs_match)))) + if (NULL == (matches = (pcrs_match *)malloc((size_t)max_matches * sizeof(pcrs_match)))) { *result = NULL; return(PCRS_ERR_NOMEM); } - memset(matches, '\0', max_matches * sizeof(pcrs_match)); + memset(matches, '\0', (size_t)max_matches * sizeof(pcrs_match)); /* * Find the pattern and calculate the space * requirements for the result */ - newsize=subject_length; + newsize = subject_length; - while ((submatches = pcre_exec(job->pattern, job->hints, subject, subject_length, offset, 0, offsets, 3 * PCRS_MAX_SUBMATCHES)) > 0) + while ((submatches = pcre_exec(job->pattern, job->hints, subject, (int)subject_length, offset, 0, offsets, 3 * PCRS_MAX_SUBMATCHES)) > 0) { job->flags |= PCRS_SUCCESS; matches[i].submatches = submatches; - for (k=0; k < submatches; k++) + for (k = 0; k < submatches; k++) { matches[i].submatch_offset[k] = offsets[2 * k]; /* Note: Non-found optional submatches have length -1-(-1)==0 */ - matches[i].submatch_length[k] = offsets[2 * k + 1] - offsets[2 * k]; + matches[i].submatch_length[k] = (size_t)(offsets[2 * k + 1] - offsets[2 * k]); /* reserve mem for each submatch as often as it is ref'd */ - newsize += matches[i].submatch_length[k] * job->substitute->backref_count[k]; + newsize += matches[i].submatch_length[k] * (size_t)job->substitute->backref_count[k]; } /* plus replacement text size minus match text size */ - newsize += strlen(job->substitute->text) - matches[i].submatch_length[0]; + newsize += job->substitute->length - matches[i].submatch_length[0]; /* chunk before match */ matches[i].submatch_offset[PCRS_MAX_SUBMATCHES] = 0; - matches[i].submatch_length[PCRS_MAX_SUBMATCHES] = offsets[0]; - newsize += offsets[0] * job->substitute->backref_count[PCRS_MAX_SUBMATCHES]; + matches[i].submatch_length[PCRS_MAX_SUBMATCHES] = (size_t)offsets[0]; + newsize += (size_t)offsets[0] * (size_t)job->substitute->backref_count[PCRS_MAX_SUBMATCHES]; /* chunk after match */ matches[i].submatch_offset[PCRS_MAX_SUBMATCHES + 1] = offsets[1]; - matches[i].submatch_length[PCRS_MAX_SUBMATCHES + 1] = subject_length - offsets[1] - 1; - newsize += (subject_length - offsets[1]) * job->substitute->backref_count[PCRS_MAX_SUBMATCHES + 1]; + matches[i].submatch_length[PCRS_MAX_SUBMATCHES + 1] = subject_length - (size_t)offsets[1] - 1; + newsize += (subject_length - (size_t)offsets[1]) * (size_t)job->substitute->backref_count[PCRS_MAX_SUBMATCHES + 1]; /* Storage for matches exhausted? -> Extend! */ if (++i >= max_matches) { - max_matches *= PCRS_MAX_MATCH_GROW; - if (NULL == (dummy = (pcrs_match *)realloc(matches, max_matches * sizeof(pcrs_match)))) + max_matches = (int)(max_matches * PCRS_MAX_MATCH_GROW); + if (NULL == (dummy = (pcrs_match *)realloc(matches, (size_t)max_matches * sizeof(pcrs_match)))) { free(matches); *result = NULL; @@ -829,7 +962,7 @@ int pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **res /* Don't loop on empty matches */ if (offsets[1] == offset) - if (offset < subject_length) + if ((size_t)offset < subject_length) offset++; else break; @@ -847,13 +980,18 @@ int pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **res /* - * Get memory for the result + * Get memory for the result (must be freed by caller!) + * and append terminating null byte. */ - if ((*result = (char *)malloc(newsize)) == NULL) /* must be free()d by caller */ + if ((*result = (char *)malloc(newsize + 1)) == NULL) { free(matches); return PCRS_ERR_NOMEM; } + else + { + (*result)[newsize] = '\0'; + } /* @@ -862,14 +1000,14 @@ int pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **res offset = 0; result_offset = *result; - for (i=0; i < matches_found; i++) + for (i = 0; i < matches_found; i++) { /* copy the chunk preceding the match */ - memcpy(result_offset, subject + offset, matches[i].submatch_offset[0] - offset); + memcpy(result_offset, subject + offset, (size_t)(matches[i].submatch_offset[0] - offset)); result_offset += matches[i].submatch_offset[0] - offset; /* For every segment of the substitute.. */ - for (k=0; k <= job->substitute->backrefs; k++) + for (k = 0; k <= job->substitute->backrefs; k++) { /* ...copy its text.. */ memcpy(result_offset, job->substitute->text + job->substitute->block_offset[k], job->substitute->block_length[k]); @@ -879,7 +1017,9 @@ int pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **res if (k != job->substitute->backrefs /* ..in legal range.. */ && job->substitute->backref[k] < PCRS_MAX_SUBMATCHES + 2 - /* ..and referencing a nonempty match.. */ + /* ..and referencing a real submatch.. */ + && job->substitute->backref[k] < matches[i].submatches + /* ..that is nonempty.. */ && matches[i].submatch_length[job->substitute->backref[k]] > 0) { /* ..copy the submatch that is ref'd. */ @@ -891,11 +1031,11 @@ int pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **res result_offset += matches[i].submatch_length[job->substitute->backref[k]]; } } - offset = matches[i].submatch_offset[0] + matches[i].submatch_length[0]; + offset = matches[i].submatch_offset[0] + (int)matches[i].submatch_length[0]; } /* Copy the rest. */ - memcpy(result_offset, subject + offset, subject_length - offset); + memcpy(result_offset, subject + offset, subject_length - (size_t)offset); *result_length = newsize; free(matches); @@ -904,6 +1044,269 @@ int pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **res } +#define is_hex_digit(x) ((x) && strchr("0123456789ABCDEF", toupper(x))) + +/********************************************************************* + * + * Function : is_hex_sequence + * + * Description : Checks the first four characters of a string + * and decides if they are a valid hex sequence + * (like '\x40'). + * + * Parameters : + * 1 : sequence = The string to check + * + * Returns : Non-zero if it's valid sequence, or + * Zero if it isn't. + * + *********************************************************************/ +static int is_hex_sequence(const char *sequence) +{ + return (sequence[0] == '\\' && + sequence[1] == 'x' && + is_hex_digit(sequence[2]) && + is_hex_digit(sequence[3])); +} + + +/* + * Functions below this line are only part of the pcrs version + * included in Privoxy. If you use any of them you should not + * try to dynamically link against external pcrs versions. + */ + +/********************************************************************* + * + * Function : pcrs_job_is_dynamic + * + * Description : Checks if a job has the "D" (dynamic) option set. + * + * Parameters : + * 1 : job = The job to check + * + * Returns : TRUE if the job is indeed dynamic, otherwise + * FALSE + * + *********************************************************************/ +int pcrs_job_is_dynamic (char *job) +{ + const char delimiter = job[1]; + const size_t length = strlen(job); + char *option; + + if (length < 5) + { + /* + * The shortest valid (but useless) + * dynamic pattern is "s@@@D" + */ + return FALSE; + } + + /* + * Everything between the last character + * and the last delimiter is an option ... + */ + for (option = job + length; *option != delimiter; option--) + { + if (*option == 'D') + { + /* + * ... and if said option is 'D' the job is dynamic. + */ + return TRUE; + } + } + return FALSE; + +} + + +/********************************************************************* + * + * Function : pcrs_get_delimiter + * + * Description : Tries to find a character that is safe to + * be used as a pcrs delimiter for a certain string. + * + * Parameters : + * 1 : string = The string to search in + * + * Returns : A safe delimiter if one was found, otherwise '\0'. + * + *********************************************************************/ +char pcrs_get_delimiter(const char *string) +{ + /* + * Some characters that are unlikely to + * be part of pcrs replacement strings. + */ + char delimiters[] = "><§#+*~%^°-:;µ!@"; + char *d = delimiters; + + /* Take the first delimiter that isn't part of the string */ + while (*d && NULL != strchr(string, *d)) + { + d++; + } + return *d; + +} + + +/********************************************************************* + * + * Function : pcrs_execute_single_command + * + * Description : Apply single pcrs command to the subject. + * The subject itself is left untouched, memory for the result + * is malloc()ed and it is the caller's responsibility to free + * the result when it's no longer needed. + * + * Parameters : + * 1 : subject = the subject (== original) string + * 2 : pcrs_command = the pcrs command as string (s@foo@bar@) + * 3 : hits = int* for returning the number of modifications + * + * Returns : NULL in case of errors, otherwise the + * result of the pcrs command. + * + *********************************************************************/ +char *pcrs_execute_single_command(const char *subject, const char *pcrs_command, int *hits) +{ + size_t size; + char *result = NULL; + pcrs_job *job; + + assert(subject); + assert(pcrs_command); + + *hits = 0; + size = strlen(subject); + + job = pcrs_compile_command(pcrs_command, hits); + if (NULL != job) + { + *hits = pcrs_execute(job, subject, size, &result, &size); + if (*hits < 0) + { + freez(result); + } + pcrs_free_job(job); + } + return result; + +} + + +static const char warning[] = "... [too long, truncated]"; +/********************************************************************* + * + * Function : pcrs_compile_dynamic_command + * + * Description : Takes a dynamic pcrs command, fills in the + * values of the variables and compiles it. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : pcrs_command = The dynamic pcrs command to compile + * 3 : v = NULL terminated array of variables and their values. + * 4 : error = pcrs error code + * + * Returns : NULL in case of hard errors, otherwise the + * compiled pcrs job. + * + *********************************************************************/ +pcrs_job *pcrs_compile_dynamic_command(char *pcrs_command, const struct pcrs_variable v[], int *error) +{ + char buf[PCRS_BUFFER_SIZE]; + const char *original_pcrs_command = pcrs_command; + char *pcrs_command_tmp = NULL; + pcrs_job *job = NULL; + int truncation = 0; + char d; + int ret; + + while ((NULL != v->name) && (NULL != pcrs_command)) + { + assert(NULL != v->value); + + if (NULL == strstr(pcrs_command, v->name)) + { + /* + * Skip the substitution if the variable + * name isn't part of the pattern. + */ + v++; + continue; + } + + /* Use pcrs to replace the variable with its value. */ + d = pcrs_get_delimiter(v->value); + if ('\0' == d) + { + /* No proper delimiter found */ + *error = PCRS_ERR_CMDSYNTAX; + return NULL; + } + + /* + * Variable names are supposed to contain alpha + * numerical characters plus '_' only. + */ + assert(NULL == strchr(v->name, d)); + + ret = snprintf(buf, sizeof(buf), "s%c\\$%s%c%s%cgT", d, v->name, d, v->value, d); + assert(ret >= 0); + if (ret >= sizeof(buf)) + { + /* + * Value didn't completely fit into buffer, + * overwrite the end of the substitution text + * with a truncation message and close the pattern + * properly. + */ + const size_t trailer_size = sizeof(warning) + 3; /* 3 for d + "gT" */ + char *trailer_start = buf + sizeof(buf) - trailer_size; + + ret = snprintf(trailer_start, trailer_size, "%s%cgT", warning, d); + assert(ret == trailer_size - 1); + assert(sizeof(buf) == strlen(buf) + 1); + truncation = 1; + } + + pcrs_command_tmp = pcrs_execute_single_command(pcrs_command, buf, error); + if (NULL == pcrs_command_tmp) + { + return NULL; + } + + if (pcrs_command != original_pcrs_command) + { + freez(pcrs_command); + } + pcrs_command = pcrs_command_tmp; + + v++; + } + + job = pcrs_compile_command(pcrs_command, error); + if (pcrs_command != original_pcrs_command) + { + freez(pcrs_command); + } + + if (truncation) + { + *error = PCRS_WARN_TRUNCATION; + } + + return job; + +} + + /* Local Variables: tab-width: 3