X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=actions.c;h=6a30577caeb4355c387bfaeb922fb1cfeea24e71;hp=113024edd078c8cb2481caddd53949de17122c95;hb=41bcde325feaf65a42fe2c4ab21cee5771ac60ad;hpb=c31dff24961d15a9cf13b81ec3d19ad68074107a diff --git a/actions.c b/actions.c index 113024ed..6a30577c 100644 --- a/actions.c +++ b/actions.c @@ -1,13 +1,11 @@ -const char actions_rcs[] = "$Id: actions.c,v 1.21 2002/01/17 20:54:44 jongfoster Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/actions.c,v $ * * Purpose : Declares functions to work with actions files - * Functions declared include: FIXME * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001-2016 the + * Privoxy team. https://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -31,97 +29,8 @@ const char actions_rcs[] = "$Id: actions.c,v 1.21 2002/01/17 20:54:44 jongfoster * or write to the Free Software Foundation, Inc., 59 * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - * Revisions : - * $Log: actions.c,v $ - * Revision 1.21 2002/01/17 20:54:44 jongfoster - * Renaming free_url to free_url_spec, since it frees a struct url_spec. - * - * Revision 1.20 2001/11/22 21:56:49 jongfoster - * Making action_spec->flags into an unsigned long rather than just an - * unsigned int. - * Fixing a bug in the display of -add-header and -wafer - * - * Revision 1.19 2001/11/13 00:14:07 jongfoster - * Fixing stupid bug now I've figured out what || means. - * (It always returns 0 or 1, not one of it's paramaters.) - * - * Revision 1.18 2001/11/07 00:06:06 steudten - * Add line number in error output for lineparsing for - * actionsfile. - * - * Revision 1.17 2001/10/25 03:40:47 david__schmidt - * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple - * threads to call select() simultaneously. So, it's time to do a real, live, - * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__ - * (native). Both versions will work, but using __OS2__ offers multi-threading. - * - * Revision 1.16 2001/10/23 21:30:30 jongfoster - * Adding error-checking to selected functions. - * - * Revision 1.15 2001/10/14 21:58:22 jongfoster - * Adding support for the CGI-based editor: - * - Exported get_actions() - * - Added new function free_alias_list() - * - Added support for {{settings}} and {{description}} blocks - * in the actions file. They are currently ignored. - * - Added restriction to only one {{alias}} block which must appear - * first in the file, to simplify the editor's rewriting rules. - * - Note that load_actions_file() is no longer used by the CGI-based - * editor, but some of the other routines in this file are. - * - * Revision 1.14 2001/09/22 16:36:59 jongfoster - * Removing unused parameter fs from read_config_line() - * - * Revision 1.13 2001/09/16 15:47:37 jongfoster - * First version of CGI-based edit interface. This is very much a - * work-in-progress, and you can't actually use it to edit anything - * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes - * to have any effect. - * - * Revision 1.12 2001/09/16 13:21:27 jongfoster - * Changes to use new list functions. - * - * Revision 1.11 2001/09/14 00:17:32 jongfoster - * Tidying up memory allocation. New function init_action(). - * - * Revision 1.10 2001/09/10 10:14:34 oes - * Removing unused variable - * - * Revision 1.9 2001/07/30 22:08:36 jongfoster - * Tidying up #defines: - * - All feature #defines are now of the form FEATURE_xxx - * - Permanently turned off WIN_GUI_EDIT - * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS - * - * Revision 1.8 2001/06/29 13:19:52 oes - * Removed logentry from cancelled commit - * - * Revision 1.7 2001/06/09 10:55:28 jongfoster - * Changing BUFSIZ ==> BUFFER_SIZE - * - * Revision 1.6 2001/06/07 23:04:34 jongfoster - * Made get_actions() static. - * - * Revision 1.5 2001/06/03 19:11:48 oes - * adapted to new enlist_unique arg format - * - * Revision 1.4 2001/06/01 20:03:42 jongfoster - * Better memory management - current_action->strings[] now - * contains copies of the strings, not the original. - * - * Revision 1.3 2001/06/01 18:49:17 jongfoster - * Replaced "list_share" with "list" - the tiny memory gain was not - * worth the extra complexity. - * - * Revision 1.2 2001/05/31 21:40:00 jongfoster - * Removing some commented out, obsolete blocks of code. - * - * Revision 1.1 2001/05/31 21:16:46 jongfoster - * Moved functions to process the action list into this new file. - * - * *********************************************************************/ - + #include "config.h" @@ -130,6 +39,10 @@ const char actions_rcs[] = "$Id: actions.c,v 1.21 2002/01/17 20:54:44 jongfoster #include #include +#ifdef FEATURE_PTHREAD +#include +#endif + #include "project.h" #include "jcc.h" #include "list.h" @@ -137,13 +50,11 @@ const char actions_rcs[] = "$Id: actions.c,v 1.21 2002/01/17 20:54:44 jongfoster #include "miscutil.h" #include "errlog.h" #include "loaders.h" -#ifdef FEATURE_CGI_EDIT_ACTIONS #include "encode.h" -#endif /* def FEATURE_CGI_EDIT_ACTIONS */ #include "urlmatch.h" - -const char actions_h_rcs[] = ACTIONS_H_VERSION; - +#include "cgi.h" +#include "ssplit.h" +#include "filters.h" /* * We need the main list of options. @@ -155,11 +66,13 @@ const char actions_h_rcs[] = ACTIONS_H_VERSION; * an enumerated type (well, the preprocessor equivalent). Here are * the values: */ -#define AV_NONE 0 /* +opt -opt */ -#define AV_ADD_STRING 1 /* +stropt{string} */ -#define AV_REM_STRING 2 /* -stropt */ -#define AV_ADD_MULTI 3 /* +multiopt{string} +multiopt{string2} */ -#define AV_REM_MULTI 4 /* -multiopt{string} -multiopt */ +enum action_value_type { + AV_NONE = 0, /* +opt -opt */ + AV_ADD_STRING = 1, /* +stropt{string} */ + AV_REM_STRING = 2, /* -stropt */ + AV_ADD_MULTI = 3, /* +multiopt{string} +multiopt{string2} */ + AV_REM_MULTI = 4 /* -multiopt{string} -multiopt */ +}; /* * We need a structure to hold the name, flag changes, @@ -168,10 +81,10 @@ const char actions_h_rcs[] = ACTIONS_H_VERSION; struct action_name { const char * name; - unsigned mask; /* a bit set to "0" = remove action */ - unsigned add; /* a bit set to "1" = add action */ - int takes_value; /* an AV_... constant */ - int index; /* index into strings[] or multi[] */ + unsigned long mask; /* a bit set to "0" = remove action */ + unsigned long add; /* a bit set to "1" = add action */ + enum action_value_type value_type; /* an AV_... constant */ + int index; /* index into strings[] or multi[] */ }; /* @@ -207,16 +120,22 @@ static const struct action_name action_names[] = }; +#ifndef FUZZ +static +#endif +int load_one_actions_file(struct client_state *csp, int fileid); + + /********************************************************************* * * Function : merge_actions * * Description : Merge two actions together. - * Similar to "cur_action += new_action". + * Similar to "dest += src". * * Parameters : - * 1 : cur_action = Current actions, to modify. - * 2 : new_action = Action to add. + * 1 : dest = Actions to modify. + * 2 : src = Action to add. * * Returns : JB_ERR_OK or JB_ERR_MEMORY * @@ -237,11 +156,7 @@ jb_err merge_actions (struct action_spec *dest, if (str) { freez(dest->string[i]); - dest->string[i] = strdup(str); - if (NULL == dest->string[i]) - { - return JB_ERR_MEMORY; - } + dest->string[i] = strdup_or_die(str); } } @@ -287,15 +202,13 @@ jb_err merge_actions (struct action_spec *dest, * Function : copy_action * * Description : Copy an action_specs. - * Similar to "cur_action = new_action". - * Note that dest better not contain valid data - * - it's overwritten, not freed. + * Similar to "dest = src". * * Parameters : * 1 : dest = Destination of copy. * 2 : src = Source for copy. * - * Returns : N/A + * Returns : JB_ERR_OK or JB_ERR_MEMORY * *********************************************************************/ jb_err copy_action (struct action_spec *dest, @@ -304,6 +217,7 @@ jb_err copy_action (struct action_spec *dest, int i; jb_err err = JB_ERR_OK; + free_action(dest); memset(dest, '\0', sizeof(*dest)); dest->mask = src->mask; @@ -314,11 +228,7 @@ jb_err copy_action (struct action_spec *dest, char * str = src->string[i]; if (str) { - str = strdup(str); - if (!str) - { - return JB_ERR_MEMORY; - } + str = strdup_or_die(str); dest->string[i] = str; } } @@ -340,6 +250,24 @@ jb_err copy_action (struct action_spec *dest, return err; } +/********************************************************************* + * + * Function : free_action_spec + * + * Description : Frees an action_spec and the memory used by it. + * + * Parameters : + * 1 : src = Source to free. + * + * Returns : N/A + * + *********************************************************************/ +void free_action_spec(struct action_spec *src) +{ + free_action(src); + freez(src); +} + /********************************************************************* * @@ -384,7 +312,7 @@ void free_action (struct action_spec *src) * Function : get_action_token * * Description : Parses a line for the first action. - * Modifies it's input array, doesn't allocate memory. + * Modifies its input array, doesn't allocate memory. * e.g. given: * *line=" +abc{def} -ghi " * Returns: @@ -467,7 +395,17 @@ jb_err get_action_token(char **line, char **name, char **value) str++; *value = str; - str = strchr(str, '}'); + /* The value ends with the first non-escaped closing curly brace */ + while ((str = strchr(str, '}')) != NULL) + { + if (str[-1] == '\\') + { + /* Overwrite the '\' so the action doesn't see it. */ + string_move(str-1, str); + continue; + } + break; + } if (str == NULL) { /* error */ @@ -484,6 +422,42 @@ jb_err get_action_token(char **line, char **name, char **value) return JB_ERR_OK; } +/********************************************************************* + * + * Function : action_used_to_be_valid + * + * Description : Checks if unrecognized actions were valid in earlier + * releases. + * + * Parameters : + * 1 : action = The string containing the action to check. + * + * Returns : True if yes, otherwise false. + * + *********************************************************************/ +static int action_used_to_be_valid(const char *action) +{ + static const char * const formerly_valid_actions[] = { + "inspect-jpegs", + "kill-popups", + "send-vanilla-wafer", + "send-wafer", + "treat-forbidden-connects-like-blocks", + "vanilla-wafer", + "wafer" + }; + unsigned int i; + + for (i = 0; i < SZ(formerly_valid_actions); i++) + { + if (0 == strcmpic(action, formerly_valid_actions[i])) + { + return TRUE; + } + } + + return FALSE; +} /********************************************************************* * @@ -494,7 +468,7 @@ jb_err get_action_token(char **line, char **name, char **value) * Parameters : * 1 : line = The string containing the actions. * Will be written to by this function. - * 2 : aliases = Custom alias list, or NULL for none. + * 2 : alias_list = Custom alias list, or NULL for none. * 3 : cur_action = Where to store the action. Caller * allocates memory. * @@ -529,7 +503,7 @@ jb_err get_actions(char *line, /* Check for standard action name */ const struct action_name * action = action_names; - while ( (action->name != NULL) && (0 != strcmpic(action->name, option)) ) + while ((action->name != NULL) && (0 != strcmpic(action->name, option))) { action++; } @@ -540,10 +514,16 @@ jb_err get_actions(char *line, cur_action->add &= action->mask; cur_action->add |= action->add; - switch (action->takes_value) + switch (action->value_type) { case AV_NONE: - /* ignore any option. */ + if (value != NULL) + { + log_error(LOG_LEVEL_ERROR, + "Action %s does not take parameters but %s was given.", + action->name, value); + return JB_ERR_PARSE; + } break; case AV_ADD_STRING: { @@ -551,8 +531,28 @@ jb_err get_actions(char *line, if ((value == NULL) || (*value == '\0')) { - return JB_ERR_PARSE; + if (0 == strcmpic(action->name, "+block")) + { + /* + * XXX: Temporary backwards compatibility hack. + * XXX: should include line number. + */ + value = "No reason specified."; + log_error(LOG_LEVEL_ERROR, + "block action without reason found. This may " + "become a fatal error in future versions."); + } + else + { + return JB_ERR_PARSE; + } + } +#ifdef FEATURE_EXTENDED_STATISTICS + if (0 == strcmpic(action->name, "+block")) + { + register_block_reason_for_statistics(value); } +#endif /* FIXME: should validate option string here */ freez (cur_action->string[action->index]); cur_action->string[action->index] = strdup(value); @@ -573,16 +573,16 @@ jb_err get_actions(char *line, { /* append multi string. */ - struct list * remove = cur_action->multi_remove[action->index]; - struct list * add = cur_action->multi_add[action->index]; + struct list * remove_p = cur_action->multi_remove[action->index]; + struct list * add_p = cur_action->multi_add[action->index]; if ((value == NULL) || (*value == '\0')) { return JB_ERR_PARSE; } - list_remove_item(remove, value); - err = enlist_unique(add, value, 0); + list_remove_item(remove_p, value); + err = enlist_unique(add_p, value, 0); if (err) { return err; @@ -593,35 +593,35 @@ jb_err get_actions(char *line, { /* remove multi string. */ - struct list * remove = cur_action->multi_remove[action->index]; - struct list * add = cur_action->multi_add[action->index]; + struct list * remove_p = cur_action->multi_remove[action->index]; + struct list * add_p = cur_action->multi_add[action->index]; - if ( (value == NULL) || (*value == '\0') - || ((*value == '*') && (value[1] == '\0')) ) + if ((value == NULL) || (*value == '\0') + || ((*value == '*') && (value[1] == '\0'))) { /* * no option, or option == "*". * * Remove *ALL*. */ - list_remove_all(remove); - list_remove_all(add); + list_remove_all(remove_p); + list_remove_all(add_p); cur_action->multi_remove_all[action->index] = 1; } else { /* Valid option - remove only 1 option */ - if ( !cur_action->multi_remove_all[action->index] ) + if (!cur_action->multi_remove_all[action->index]) { /* there isn't a catch-all in the remove list already */ - err = enlist_unique(remove, value, 0); + err = enlist_unique(remove_p, value, 0); if (err) { return err; } } - list_remove_item(add, value); + list_remove_item(add_p, value); } break; } @@ -636,7 +636,7 @@ jb_err get_actions(char *line, /* try user aliases. */ const struct action_alias * alias = alias_list; - while ( (alias != NULL) && (0 != strcmpic(alias->name, option)) ) + while ((alias != NULL) && (0 != strcmpic(alias->name, option))) { alias = alias->next; } @@ -645,9 +645,30 @@ jb_err get_actions(char *line, /* Found it */ merge_actions(cur_action, alias->action); } + else if (((size_t)2 < strlen(option)) && action_used_to_be_valid(option+1)) + { + log_error(LOG_LEVEL_ERROR, "Action '%s' is no longer valid " + "in this Privoxy release. Ignored.", option+1); + } + else if (((size_t)2 < strlen(option)) && 0 == strcmpic(option+1, "hide-forwarded-for-headers")) + { + log_error(LOG_LEVEL_FATAL, "The action 'hide-forwarded-for-headers' " + "is no longer valid in this Privoxy release. " + "Use 'change-x-forwarded-for' instead."); + } else { /* Bad action name */ + /* + * XXX: This is a fatal error and Privoxy will later on exit + * in load_one_actions_file() because of an "invalid line". + * + * It would be preferable to name the offending option in that + * error message, but currently there is no way to do that and + * we have to live with two error messages for basically the + * same reason. + */ + log_error(LOG_LEVEL_ERROR, "Unknown action or alias: %s", option); return JB_ERR_PARSE; } } @@ -732,11 +753,7 @@ jb_err merge_current_action (struct current_action_spec *dest, char * str = src->string[i]; if (str) { - str = strdup(str); - if (!str) - { - return JB_ERR_MEMORY; - } + str = strdup_or_die(str); freez(dest->string[i]); dest->string[i] = str; } @@ -767,6 +784,139 @@ jb_err merge_current_action (struct current_action_spec *dest, } +/********************************************************************* + * + * Function : update_action_bits_for_tag + * + * Description : Updates the action bits based on the action sections + * whose tag patterns match a provided tag. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : tag = The tag on which the update should be based on + * + * Returns : 0 if no tag matched, or + * 1 otherwise + * + *********************************************************************/ +int update_action_bits_for_tag(struct client_state *csp, const char *tag) +{ + struct file_list *fl; + struct url_actions *b; + + int updated = 0; + int i; + + assert(tag); + assert(list_contains_item(csp->tags, tag)); + + /* Run through all action files, */ + for (i = 0; i < MAX_AF_FILES; i++) + { + if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL)) + { + /* Skip empty files */ + continue; + } + + /* and through all the action patterns, */ + for (b = b->next; NULL != b; b = b->next) + { + /* skip everything but TAG patterns, */ + if (!(b->url->flags & PATTERN_SPEC_TAG_PATTERN)) + { + continue; + } + + /* and check if one of the tag patterns matches the tag, */ + if (0 == regexec(b->url->pattern.tag_regex, tag, 0, NULL, 0)) + { + /* if it does, update the action bit map, */ + if (merge_current_action(csp->action, b->action)) + { + log_error(LOG_LEVEL_ERROR, + "Out of memory while changing action bits"); + } + /* and signal the change. */ + updated = 1; + } + } + } + + return updated; +} + + +/********************************************************************* + * + * Function : check_negative_tag_patterns + * + * Description : Updates the action bits based on NO-*-TAG patterns. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : flag = The tag pattern type + * + * Returns : JB_ERR_OK in case off success, or + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err check_negative_tag_patterns(struct client_state *csp, unsigned int flag) +{ + struct list_entry *tag; + struct file_list *fl; + struct url_actions *b = NULL; + int i; + + for (i = 0; i < MAX_AF_FILES; i++) + { + fl = csp->actions_list[i]; + if ((fl == NULL) || ((b = fl->f) == NULL)) + { + continue; + } + for (b = b->next; NULL != b; b = b->next) + { + int tag_found = 0; + if (0 == (b->url->flags & flag)) + { + continue; + } + for (tag = csp->tags->first; NULL != tag; tag = tag->next) + { + if (0 == regexec(b->url->pattern.tag_regex, tag->str, 0, NULL, 0)) + { + /* + * The pattern matches at least one tag, thus the action + * section doesn't apply and we don't need to look at the + * other tags. + */ + tag_found = 1; + break; + } + } + if (!tag_found) + { + /* + * The pattern doesn't match any tags, + * thus the action section applies. + */ + if (merge_current_action(csp->action, b->action)) + { + log_error(LOG_LEVEL_ERROR, + "Out of memory while changing action bits"); + return JB_ERR_MEMORY; + } + log_error(LOG_LEVEL_HEADER, "Updated action bits based on: %s", + b->url->spec); + } + } + } + + return JB_ERR_OK; +} + + /********************************************************************* * * Function : free_current_action @@ -780,7 +930,7 @@ jb_err merge_current_action (struct current_action_spec *dest, * Returns : N/A * *********************************************************************/ -void free_current_action (struct current_action_spec *src) +void free_current_action(struct current_action_spec *src) { int i; @@ -798,6 +948,41 @@ void free_current_action (struct current_action_spec *src) } +static struct file_list *current_actions_file[MAX_AF_FILES] = { + NULL, NULL, NULL, NULL, NULL, + NULL, NULL, NULL, NULL, NULL +}; + + +#ifdef FEATURE_GRACEFUL_TERMINATION +/********************************************************************* + * + * Function : unload_current_actions_file + * + * Description : Unloads current actions file - reset to state at + * beginning of program. + * + * Parameters : None + * + * Returns : N/A + * + *********************************************************************/ +void unload_current_actions_file(void) +{ + int i; + + for (i = 0; i < MAX_AF_FILES; i++) + { + if (current_actions_file[i]) + { + current_actions_file[i]->unloader = unload_actions_file; + current_actions_file[i] = NULL; + } + } +} +#endif /* FEATURE_GRACEFUL_TERMINATION */ + + /********************************************************************* * * Function : unload_actions_file @@ -818,12 +1003,20 @@ void unload_actions_file(void *file_data) while (cur != NULL) { next = cur->next; - free_url_spec(cur->url); - free_action(cur->action); + free_pattern_spec(cur->url); + if ((next == NULL) || (next->action != cur->action)) + { + /* + * As the action settings might be shared, + * we can only free them if the current + * url pattern is the last one, or if the + * next one is using different settings. + */ + free_action_spec(cur->action); + } freez(cur); cur = next; } - } @@ -855,76 +1048,234 @@ void free_alias_list(struct action_alias *alias_list) /********************************************************************* * - * Function : load_actions_file + * Function : load_action_files + * + * Description : Read and parse all the action files and add to files + * list. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * + * Returns : 0 => Ok, everything else is an error. + * + *********************************************************************/ +int load_action_files(struct client_state *csp) +{ + int i; + int result; + + for (i = 0; i < MAX_AF_FILES; i++) + { + if (csp->config->actions_file[i]) + { + result = load_one_actions_file(csp, i); + if (result) + { + return result; + } + } + else if (current_actions_file[i]) + { + current_actions_file[i]->unloader = unload_actions_file; + current_actions_file[i] = NULL; + } + } + + return 0; +} + + +/********************************************************************* + * + * Function : filter_type_to_string + * + * Description : Converts a filter type enum into a string. + * + * Parameters : + * 1 : filter_type = filter_type as enum + * + * Returns : Pointer to static string. + * + *********************************************************************/ +static const char *filter_type_to_string(enum filter_type filter_type) +{ + switch (filter_type) + { + case FT_CONTENT_FILTER: + return "content filter"; + case FT_CLIENT_HEADER_FILTER: + return "client-header filter"; + case FT_SERVER_HEADER_FILTER: + return "server-header filter"; + case FT_CLIENT_HEADER_TAGGER: + return "client-header tagger"; + case FT_SERVER_HEADER_TAGGER: + return "server-header tagger"; +#ifdef FEATURE_EXTERNAL_FILTERS + case FT_EXTERNAL_CONTENT_FILTER: + return "external content filter"; +#endif + case FT_SUPPRESS_TAG: + return "suppress tag filter"; + case FT_CLIENT_BODY_FILTER: + return "client body filter"; + case FT_INVALID_FILTER: + return "invalid filter type"; + } + + return "unknown filter type"; + +} + +/********************************************************************* + * + * Function : referenced_filters_are_missing + * + * Description : Checks if any filters of a certain type referenced + * in an action spec are missing. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : cur_action = The action spec to check. + * 3 : multi_index = The index where to look for the filter. + * 4 : filter_type = The filter type the caller is interested in. + * + * Returns : 0 => All referenced filters exist, everything else is an error. + * + *********************************************************************/ +static int referenced_filters_are_missing(const struct client_state *csp, + const struct action_spec *cur_action, int multi_index, enum filter_type filter_type) +{ + struct list_entry *filtername; + + for (filtername = cur_action->multi_add[multi_index]->first; + filtername; filtername = filtername->next) + { + if (NULL == get_filter(csp, filtername->str, filter_type)) + { + log_error(LOG_LEVEL_ERROR, "Missing %s '%s'", + filter_type_to_string(filter_type), filtername->str); + return 1; + } + } + + return 0; + +} + + +/********************************************************************* + * + * Function : action_spec_is_valid + * + * Description : Should eventually figure out if an action spec + * is valid, but currently only checks that the + * referenced filters are accounted for. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : cur_action = The action spec to check. + * + * Returns : 0 => No problems detected, everything else is an error. + * + *********************************************************************/ +static int action_spec_is_valid(struct client_state *csp, const struct action_spec *cur_action) +{ + struct { + int multi_index; + enum filter_type filter_type; + } filter_map[] = { + {ACTION_MULTI_FILTER, FT_CONTENT_FILTER}, + {ACTION_MULTI_CLIENT_HEADER_FILTER, FT_CLIENT_HEADER_FILTER}, + {ACTION_MULTI_SERVER_HEADER_FILTER, FT_SERVER_HEADER_FILTER}, + {ACTION_MULTI_CLIENT_HEADER_TAGGER, FT_CLIENT_HEADER_TAGGER}, + {ACTION_MULTI_SERVER_HEADER_TAGGER, FT_SERVER_HEADER_TAGGER}, + {ACTION_MULTI_CLIENT_BODY_FILTER, FT_CLIENT_BODY_FILTER} + }; + int errors = 0; + int i; + + for (i = 0; i < SZ(filter_map); i++) + { + errors += referenced_filters_are_missing(csp, cur_action, + filter_map[i].multi_index, filter_map[i].filter_type); + } + + return errors; + +} + + +/********************************************************************* + * + * Function : load_one_actions_file * * Description : Read and parse a action file and add to files * list. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : fileid = File index to load. * * Returns : 0 => Ok, everything else is an error. * *********************************************************************/ -int load_actions_file(struct client_state *csp) +#ifndef FUZZ +static +#endif +int load_one_actions_file(struct client_state *csp, int fileid) { - static struct file_list *current_actions_file = NULL; /* * Parser mode. * Note: Keep these in the order they occur in the file, they are * sometimes tested with <= */ -#define MODE_START_OF_FILE 1 -#define MODE_SETTINGS 2 -#define MODE_DESCRIPTION 3 -#define MODE_ALIAS 4 -#define MODE_ACTIONS 5 - - int mode = MODE_START_OF_FILE; + enum { + MODE_START_OF_FILE = 1, + MODE_SETTINGS = 2, + MODE_DESCRIPTION = 3, + MODE_ALIAS = 4, + MODE_ACTIONS = 5 + } mode; FILE *fp; struct url_actions *last_perm; struct url_actions *perm; - char buf[BUFFER_SIZE]; + char *buf; struct file_list *fs; struct action_spec * cur_action = NULL; int cur_action_used = 0; struct action_alias * alias_list = NULL; unsigned long linenum = 0; + mode = MODE_START_OF_FILE; - if (!check_file_changed(current_actions_file, csp->config->actions_file, &fs)) + if (!check_file_changed(current_actions_file[fileid], csp->config->actions_file[fileid], &fs)) { /* No need to load */ - if (csp) - { - csp->actions_list = current_actions_file; - } + csp->actions_list[fileid] = current_actions_file[fileid]; return 0; } if (!fs) { - log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error finding file: %E", - csp->config->actions_file); + log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': %E. " + "Note that beginning with Privoxy 3.0.7, actions files have to be specified " + "with their complete file names.", csp->config->actions_file[fileid]); return 1; /* never get here */ } - fs->f = last_perm = (struct url_actions *)zalloc(sizeof(*last_perm)); - if (last_perm == NULL) - { - log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': out of memory!", - csp->config->actions_file); - return 1; /* never get here */ - } + fs->f = last_perm = zalloc_or_die(sizeof(*last_perm)); - if ((fp = fopen(csp->config->actions_file, "r")) == NULL) + if ((fp = fopen(csp->config->actions_file[fileid], "r")) == NULL) { log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error opening file: %E", - csp->config->actions_file); + csp->config->actions_file[fileid]); return 1; /* never get here */ } - while (read_config_line(buf, sizeof(buf), fp, &linenum) != NULL) + log_error(LOG_LEVEL_INFO, "Loading actions file: %s", csp->config->actions_file[fileid]); + + while (read_config_line(fp, &linenum, &buf) != NULL) { if (*buf == '{') { @@ -932,16 +1283,16 @@ int load_actions_file(struct client_state *csp) if (buf[1] == '{') { /* It's {{settings}} or {{alias}} */ - int len = strlen(buf); + size_t len = strlen(buf); char * start = buf + 2; char * end = buf + len - 1; - if ((len < 5) || (*end-- != '}') || (*end-- != '}')) + if ((len < (size_t)5) || (*end-- != '}') || (*end-- != '}')) { /* too short */ fclose(fp); log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid line (%lu): %s", - csp->config->actions_file, linenum, buf); + "can't load actions file '%s': invalid line (%lu): %s", + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } @@ -955,7 +1306,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': invalid line (%lu): {{ }}", - csp->config->actions_file, linenum); + csp->config->actions_file[fileid], linenum); return 1; /* never get here */ } @@ -987,7 +1338,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': line %lu: {{settings}} must only appear once, and it must be before anything else.", - csp->config->actions_file, linenum); + csp->config->actions_file[fileid], linenum); } mode = MODE_SETTINGS; } @@ -1001,7 +1352,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': line %lu: {{description}} must only appear once, and only a {{settings}} block may be above it.", - csp->config->actions_file, linenum); + csp->config->actions_file[fileid], linenum); } mode = MODE_DESCRIPTION; } @@ -1023,7 +1374,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': line %lu: {{alias}} must only appear once, and it must be before all actions.", - csp->config->actions_file, linenum); + csp->config->actions_file[fileid], linenum); } mode = MODE_ALIAS; } @@ -1033,7 +1384,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': invalid line (%lu): {{%s}}", - csp->config->actions_file, linenum, start); + csp->config->actions_file[fileid], linenum, start); return 1; /* never get here */ } } @@ -1041,46 +1392,48 @@ int load_actions_file(struct client_state *csp) { /* It's an actions block */ - char actions_buf[BUFFER_SIZE]; + char *actions_buf; char * end; /* set mode */ - mode = MODE_ACTIONS; + mode = MODE_ACTIONS; /* free old action */ if (cur_action) { if (!cur_action_used) { - free_action(cur_action); - free(cur_action); + free_action_spec(cur_action); } cur_action = NULL; } cur_action_used = 0; - cur_action = (struct action_spec *)zalloc(sizeof(*cur_action)); - if (cur_action == NULL) - { - fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': out of memory", - csp->config->actions_file); - return 1; /* never get here */ - } + cur_action = zalloc_or_die(sizeof(*cur_action)); init_action(cur_action); - /* trim { */ - strcpy(actions_buf, buf + 1); + /* + * Copy the buffer before messing with it as we may need the + * unmodified version in for the fatal error messages. Given + * that this is not a common event, we could instead simply + * read the line again. + * + * buf + 1 to skip the leading '{' + */ + actions_buf = end = strdup_or_die(buf + 1); /* check we have a trailing } and then trim it */ - end = actions_buf + strlen(actions_buf) - 1; + if (strlen(actions_buf)) + { + end += strlen(actions_buf) - 1; + } if (*end != '}') { /* No closing } */ fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid line (%lu): %s", - csp->config->actions_file, linenum, buf); + freez(actions_buf); + log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': " + "Missing trailing '}' in action section starting at line (%lu): %s", + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } *end = '\0'; @@ -1092,20 +1445,58 @@ int load_actions_file(struct client_state *csp) { /* error */ fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid line (%lu): %s", - csp->config->actions_file, linenum, buf); + freez(actions_buf); + log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': " + "can't completely parse the action section starting at line (%lu): %s", + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } + + if (action_spec_is_valid(csp, cur_action)) + { + log_error(LOG_LEVEL_ERROR, "Invalid action section in file '%s', " + "starting at line %lu: %s", + csp->config->actions_file[fileid], linenum, buf); + } + + freez(actions_buf); } } else if (mode == MODE_SETTINGS) { /* * Part of the {{settings}} block. - * Ignore for now, but we may want to read & check permissions - * when we go multi-user. + * For now only serves to check if the file's minimum Privoxy + * version requirement is met, but we may want to read & check + * permissions when we go multi-user. */ + if (!strncmp(buf, "for-privoxy-version=", 20)) + { + char *version_string, *fields[3]; + int num_fields; + + version_string = strdup_or_die(buf + 20); + + num_fields = ssplit(version_string, ".", fields, SZ(fields)); + + if (num_fields < 1 || atoi(fields[0]) == 0) + { + log_error(LOG_LEVEL_ERROR, + "While loading actions file '%s': invalid line (%lu): %s", + csp->config->actions_file[fileid], linenum, buf); + } + else if ( (atoi(fields[0]) > VERSION_MAJOR) + || ((num_fields > 1) && (atoi(fields[1]) > VERSION_MINOR)) + || ((num_fields > 2) && (atoi(fields[2]) > VERSION_POINT))) + { + fclose(fp); + log_error(LOG_LEVEL_FATAL, + "Actions file '%s', line %lu requires newer Privoxy version: %s", + csp->config->actions_file[fileid], linenum, buf); + return 1; /* never get here */ + } + free(version_string); + } } else if (mode == MODE_DESCRIPTION) { @@ -1129,18 +1520,11 @@ int load_actions_file(struct client_state *csp) { log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': invalid alias line (%lu): %s", - csp->config->actions_file, linenum, buf); + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } - if ((new_alias = zalloc(sizeof(*new_alias))) == NULL) - { - fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': out of memory!", - csp->config->actions_file); - return 1; /* never get here */ - } + new_alias = zalloc_or_die(sizeof(*new_alias)); /* Eat any the whitespace before the '=' */ end--; @@ -1164,13 +1548,13 @@ int load_actions_file(struct client_state *csp) { log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': invalid alias line (%lu): %s", - csp->config->actions_file, linenum, buf); + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } - new_alias->name = strdup(buf); + new_alias->name = strdup_or_die(buf); - strcpy(actions_buf, start); + strlcpy(actions_buf, start, sizeof(actions_buf)); if (get_actions(actions_buf, alias_list, new_alias->action)) { @@ -1178,7 +1562,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': invalid alias line (%lu): %s = %s", - csp->config->actions_file, linenum, buf, start); + csp->config->actions_file[fileid], linenum, buf, start); return 1; /* never get here */ } @@ -1188,28 +1572,21 @@ int load_actions_file(struct client_state *csp) } else if (mode == MODE_ACTIONS) { - /* it's a URL pattern */ + /* it's an URL pattern */ /* allocate a new node */ - if ((perm = zalloc(sizeof(*perm))) == NULL) - { - fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': out of memory!", - csp->config->actions_file); - return 1; /* never get here */ - } + perm = zalloc_or_die(sizeof(*perm)); - /* Save flags */ - copy_action (perm->action, cur_action); + perm->action = cur_action; + cur_action_used = 1; /* Save the URL pattern */ - if (create_url_spec(perm->url, buf)) + if (create_pattern_spec(perm->url, buf)) { fclose(fp); log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': line %lu: cannot create URL pattern from: %s", - csp->config->actions_file, linenum, buf); + "can't load actions file '%s': line %lu: cannot create URL or TAG pattern from: %s", + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } @@ -1222,8 +1599,8 @@ int load_actions_file(struct client_state *csp) /* oops - please have a {} line as 1st line in file. */ fclose(fp); log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': first needed line (%lu) is invalid: %s", - csp->config->actions_file, linenum, buf); + "can't load actions file '%s': line %lu should begin with a '{': %s", + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } else @@ -1232,31 +1609,31 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': INTERNAL ERROR - mode = %d", - csp->config->actions_file, mode); + csp->config->actions_file[fileid], mode); return 1; /* never get here */ } + freez(buf); } fclose(fp); - free_action(cur_action); - + if (!cur_action_used) + { + free_action_spec(cur_action); + } free_alias_list(alias_list); /* the old one is now obsolete */ - if (current_actions_file) + if (current_actions_file[fileid]) { - current_actions_file->unloader = unload_actions_file; + current_actions_file[fileid]->unloader = unload_actions_file; } fs->next = files->next; files->next = fs; - current_actions_file = fs; + current_actions_file[fileid] = fs; - if (csp) - { - csp->actions_list = fs; - } + csp->actions_list[fileid] = fs; return(0); @@ -1267,54 +1644,54 @@ int load_actions_file(struct client_state *csp) * * Function : actions_to_text * - * Description : Converts a actionsfile entry from numeric form - * ("mask" and "add") to text. + * Description : Converts a actionsfile entry from the internal + * structure into a text line. The output is split + * into one line for each action with line continuation. * * Parameters : - * 1 : mask = As from struct url_actions - * 2 : add = As from struct url_actions + * 1 : action = The action to format. * * Returns : A string. Caller must free it. * NULL on out-of-memory error. * *********************************************************************/ -char * actions_to_text(struct action_spec *action) +char * actions_to_text(const struct action_spec *action) { - unsigned mask = action->mask; - unsigned add = action->add; - char * result = strdup(""); + unsigned long mask = action->mask; + unsigned long add = action->add; + char *result = strdup_or_die(""); struct list_entry * lst; /* sanity - prevents "-feature +feature" */ mask |= add; -#define DEFINE_ACTION_BOOL(__name, __bit) \ - if (!(mask & __bit)) \ - { \ - string_append(&result, " -" __name); \ - } \ - else if (add & __bit) \ - { \ - string_append(&result, " +" __name); \ +#define DEFINE_ACTION_BOOL(__name, __bit) \ + if (!(mask & __bit)) \ + { \ + string_append(&result, " -" __name " \\\n"); \ + } \ + else if (add & __bit) \ + { \ + string_append(&result, " +" __name " \\\n"); \ } #define DEFINE_ACTION_STRING(__name, __bit, __index) \ if (!(mask & __bit)) \ { \ - string_append(&result, " -" __name); \ + string_append(&result, " -" __name " \\\n"); \ } \ else if (add & __bit) \ { \ string_append(&result, " +" __name "{"); \ string_append(&result, action->string[__index]); \ - string_append(&result, "}"); \ + string_append(&result, "} \\\n"); \ } #define DEFINE_ACTION_MULTI(__name, __index) \ if (action->multi_remove_all[__index]) \ { \ - string_append(&result, " -" __name); \ + string_append(&result, " -" __name " \\\n"); \ } \ else \ { \ @@ -1323,7 +1700,7 @@ char * actions_to_text(struct action_spec *action) { \ string_append(&result, " -" __name "{"); \ string_append(&result, lst->str); \ - string_append(&result, "}"); \ + string_append(&result, "} \\\n"); \ lst = lst->next; \ } \ } \ @@ -1332,7 +1709,7 @@ char * actions_to_text(struct action_spec *action) { \ string_append(&result, " +" __name "{"); \ string_append(&result, lst->str); \ - string_append(&result, "}"); \ + string_append(&result, "} \\\n"); \ lst = lst->next; \ } @@ -1349,28 +1726,29 @@ char * actions_to_text(struct action_spec *action) } -#ifdef FEATURE_CGI_EDIT_ACTIONS /********************************************************************* * * Function : actions_to_html * * Description : Converts a actionsfile entry from numeric form - * ("mask" and "add") to a
-seperated HTML string. + * ("mask" and "add") to a
-separated HTML string + * in which each action is linked to its chapter in + * the user manual. * * Parameters : - * 1 : mask = As from struct url_actions - * 2 : add = As from struct url_actions + * 1 : csp = Client state (for config) + * 2 : action = Action spec to be converted * * Returns : A string. Caller must free it. * NULL on out-of-memory error. * *********************************************************************/ -char * actions_to_html(struct action_spec *action) +char * actions_to_html(const struct client_state *csp, + const struct action_spec *action) { - unsigned mask = action->mask; - unsigned add = action->add; - char * result = strdup(""); - char * enc_str; + unsigned long mask = action->mask; + unsigned long add = action->add; + char *result = strdup_or_die(""); struct list_entry * lst; /* sanity - prevents "-feature +feature" */ @@ -1380,59 +1758,45 @@ char * actions_to_html(struct action_spec *action) #define DEFINE_ACTION_BOOL(__name, __bit) \ if (!(mask & __bit)) \ { \ - string_append(&result, "\n
-" __name); \ + string_append(&result, "\n
-"); \ + string_join(&result, add_help_link(__name, csp->config)); \ } \ else if (add & __bit) \ { \ - string_append(&result, "\n
+" __name); \ + string_append(&result, "\n
+"); \ + string_join(&result, add_help_link(__name, csp->config)); \ } #define DEFINE_ACTION_STRING(__name, __bit, __index) \ if (!(mask & __bit)) \ { \ - string_append(&result, "\n
-" __name); \ + string_append(&result, "\n
-"); \ + string_join(&result, add_help_link(__name, csp->config)); \ } \ else if (add & __bit) \ { \ - string_append(&result, "\n
+" __name "{"); \ - if (NULL == result) \ - { \ - return NULL; \ - } \ - enc_str = html_encode(action->string[__index]);\ - if (NULL == enc_str) \ - { \ - free(result); \ - return NULL; \ - } \ - string_append(&result, enc_str); \ - free(enc_str); \ + string_append(&result, "\n
+"); \ + string_join(&result, add_help_link(__name, csp->config)); \ + string_append(&result, "{"); \ + string_join(&result, html_encode(action->string[__index])); \ string_append(&result, "}"); \ } #define DEFINE_ACTION_MULTI(__name, __index) \ if (action->multi_remove_all[__index]) \ { \ - string_append(&result, "\n
-" __name); \ + string_append(&result, "\n
-"); \ + string_join(&result, add_help_link(__name, csp->config)); \ } \ else \ { \ lst = action->multi_remove[__index]->first; \ while (lst) \ { \ - string_append(&result, "\n
-" __name "{");\ - if (NULL == result) \ - { \ - return NULL; \ - } \ - enc_str = html_encode(lst->str); \ - if (NULL == enc_str) \ - { \ - free(result); \ - return NULL; \ - } \ - string_append(&result, enc_str); \ - free(enc_str); \ + string_append(&result, "\n
-"); \ + string_join(&result, add_help_link(__name, csp->config)); \ + string_append(&result, "{"); \ + string_join(&result, html_encode(lst->str)); \ string_append(&result, "}"); \ lst = lst->next; \ } \ @@ -1440,19 +1804,10 @@ char * actions_to_html(struct action_spec *action) lst = action->multi_add[__index]->first; \ while (lst) \ { \ - string_append(&result, "\n
+" __name "{"); \ - if (NULL == result) \ - { \ - return NULL; \ - } \ - enc_str = html_encode(lst->str); \ - if (NULL == enc_str) \ - { \ - free(result); \ - return NULL; \ - } \ - string_append(&result, enc_str); \ - free(enc_str); \ + string_append(&result, "\n
+"); \ + string_join(&result, add_help_link(__name, csp->config)); \ + string_append(&result, "{"); \ + string_join(&result, html_encode(lst->str)); \ string_append(&result, "}"); \ lst = lst->next; \ } @@ -1476,63 +1831,76 @@ char * actions_to_html(struct action_spec *action) return result; } -#endif /* def FEATURE_CGI_EDIT_ACTIONS */ /********************************************************************* * - * Function : current_actions_to_text + * Function : current_actions_to_html * - * Description : Converts a actionsfile entry to text. + * Description : Converts a current action spec to a
separated HTML + * text in which each action is linked to its chapter in + * the user manual. * * Parameters : - * 1 : action = Action + * 1 : csp = Client state (for config) + * 2 : action = Current action spec to be converted * * Returns : A string. Caller must free it. * NULL on out-of-memory error. * *********************************************************************/ -char * current_action_to_text(struct current_action_spec *action) +char *current_action_to_html(const struct client_state *csp, + const struct current_action_spec *action) { unsigned long flags = action->flags; - char * result = strdup(""); struct list_entry * lst; + char *result = strdup_or_die(""); + char *active = strdup_or_die(""); + char *inactive = strdup_or_die(""); #define DEFINE_ACTION_BOOL(__name, __bit) \ if (flags & __bit) \ { \ - string_append(&result, " +" __name); \ + string_append(&active, "\n
+"); \ + string_join(&active, add_help_link(__name, csp->config)); \ } \ else \ { \ - string_append(&result, " -" __name); \ + string_append(&inactive, "\n
-"); \ + string_join(&inactive, add_help_link(__name, csp->config)); \ } #define DEFINE_ACTION_STRING(__name, __bit, __index) \ if (flags & __bit) \ { \ - string_append(&result, " +" __name "{"); \ - string_append(&result, action->string[__index]); \ - string_append(&result, "}"); \ + string_append(&active, "\n
+"); \ + string_join(&active, add_help_link(__name, csp->config)); \ + string_append(&active, "{"); \ + string_join(&active, html_encode(action->string[__index])); \ + string_append(&active, "}"); \ } \ else \ { \ - string_append(&result, " -" __name); \ + string_append(&inactive, "\n
-"); \ + string_join(&inactive, add_help_link(__name, csp->config)); \ } #define DEFINE_ACTION_MULTI(__name, __index) \ lst = action->multi[__index]->first; \ if (lst == NULL) \ { \ - string_append(&result, " -" __name); \ + string_append(&inactive, "\n
-"); \ + string_join(&inactive, add_help_link(__name, csp->config)); \ } \ else \ { \ while (lst) \ { \ - string_append(&result, " +" __name "{"); \ - string_append(&result, lst->str); \ - string_append(&result, "}"); \ + string_append(&active, "\n
+"); \ + string_join(&active, add_help_link(__name, csp->config)); \ + string_append(&active, "{"); \ + string_join(&active, html_encode(lst->str)); \ + string_append(&active, "}"); \ lst = lst->next; \ } \ } @@ -1546,5 +1914,82 @@ char * current_action_to_text(struct current_action_spec *action) #undef DEFINE_ACTION_BOOL #undef DEFINE_ACTION_ALIAS + if (active != NULL) + { + string_append(&result, active); + freez(active); + } + string_append(&result, "\n
"); + if (inactive != NULL) + { + string_append(&result, inactive); + freez(inactive); + } return result; } + + +/********************************************************************* + * + * Function : action_to_line_of_text + * + * Description : Converts a action spec to a single text line + * listing the enabled actions. + * + * Parameters : + * 1 : action = Current action spec to be converted + * + * Returns : A string. Caller must free it. + * Out-of-memory errors are fatal. + * + *********************************************************************/ +char *actions_to_line_of_text(const struct current_action_spec *action) +{ + char buffer[200]; + struct list_entry *lst; + char *active; + const unsigned long flags = action->flags; + + active = strdup_or_die(""); + +#define DEFINE_ACTION_BOOL(__name, __bit) \ + if (flags & __bit) \ + { \ + snprintf(buffer, sizeof(buffer), "+%s ", __name); \ + string_append(&active, buffer); \ + } \ + +#define DEFINE_ACTION_STRING(__name, __bit, __index) \ + if (flags & __bit) \ + { \ + snprintf(buffer, sizeof(buffer), "+%s{%s} ", \ + __name, action->string[__index]); \ + string_append(&active, buffer); \ + } \ + +#define DEFINE_ACTION_MULTI(__name, __index) \ + lst = action->multi[__index]->first; \ + while (lst != NULL) \ + { \ + snprintf(buffer, sizeof(buffer), "+%s{%s} ", \ + __name, lst->str); \ + string_append(&active, buffer); \ + lst = lst->next; \ + } \ + +#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */ + +#include "actionlist.h" + +#undef DEFINE_ACTION_MULTI +#undef DEFINE_ACTION_STRING +#undef DEFINE_ACTION_BOOL +#undef DEFINE_ACTION_ALIAS + + if (active == NULL) + { + log_error(LOG_LEVEL_FATAL, "Out of memory in action_to_line_of_text()"); + } + + return active; +}