X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=actions.c;h=6249de9e6085b3cf1d5ee672d3ac0c48986c4290;hp=9388449859fb5b26c75d79944a5d940f41cf9ed6;hb=60c5d95c4584689ec650b97a5adb706a55d7950d;hpb=d07371e61491a6efa4e119dbb4a805e72348604a diff --git a/actions.c b/actions.c index 93884498..6249de9e 100644 --- a/actions.c +++ b/actions.c @@ -1,19 +1,17 @@ -const char actions_rcs[] = "$Id: actions.c,v 1.1 2001/05/31 21:16:46 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. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General * Public License as published by the Free Software * Foundation; either version 2 of the License, or (at @@ -31,19 +29,19 @@ const char actions_rcs[] = "$Id: actions.c,v 1.1 2001/05/31 21:16:46 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.1 2001/05/31 21:16:46 jongfoster - * Moved functions to process the action list into this new file. - * - * *********************************************************************/ - + #include "config.h" #include #include +#include +#include + +#ifdef FEATURE_PTHREAD +#include +#endif #include "project.h" #include "jcc.h" @@ -52,24 +50,11 @@ const char actions_rcs[] = "$Id: actions.c,v 1.1 2001/05/31 21:16:46 jongfoster #include "miscutil.h" #include "errlog.h" #include "loaders.h" - -const char actions_h_rcs[] = ACTIONS_H_VERSION; - -/* This structure is used to hold user-defined aliases */ -struct action_alias -{ - const char * name; - struct action_spec action[1]; - struct action_alias * next; -}; - - -/* - * Must declare this in this file for the above structure. - * FIXME: Make this static or put structure in header. - */ -extern int get_actions (char *line, struct action_alias * alias_list, - struct action_spec *cur_action); +#include "encode.h" +#include "urlmatch.h" +#include "cgi.h" +#include "ssplit.h" +#include "filters.h" /* * We need the main list of options. @@ -81,23 +66,25 @@ extern int get_actions (char *line, struct action_alias * alias_list, * 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, + * We need a structure to hold the name, flag changes, * type, and string index. */ 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[] */ }; /* @@ -133,24 +120,31 @@ 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 : N/A + * Returns : JB_ERR_OK or JB_ERR_MEMORY * *********************************************************************/ -void merge_actions (struct action_spec *dest, - const struct action_spec *src) +jb_err merge_actions (struct action_spec *dest, + const struct action_spec *src) { int i; + jb_err err; dest->mask &= src->mask; dest->add &= src->mask; @@ -162,7 +156,7 @@ void merge_actions (struct action_spec *dest, if (str) { freez(dest->string[i]); - dest->string[i] = strdup(str); + dest->string[i] = strdup_or_die(str); } } @@ -171,10 +165,10 @@ void merge_actions (struct action_spec *dest, if (src->multi_remove_all[i]) { /* Remove everything from dest */ - destroy_list(dest->multi_remove[i]); - destroy_list(dest->multi_add[i]); + list_remove_all(dest->multi_remove[i]); dest->multi_remove_all[i] = 1; - list_duplicate(dest->multi_add[i], src->multi_add[i]); + + err = list_duplicate(dest->multi_add[i], src->multi_add[i]); } else if (dest->multi_remove_all[i]) { @@ -183,16 +177,23 @@ void merge_actions (struct action_spec *dest, * about what we add. */ list_remove_list(dest->multi_add[i], src->multi_remove[i]); - list_append_list_unique(dest->multi_add[i], src->multi_add[i]); + err = list_append_list_unique(dest->multi_add[i], src->multi_add[i]); } else { /* No "remove all"s to worry about. */ list_remove_list(dest->multi_add[i], src->multi_remove[i]); - list_append_list_unique(dest->multi_remove[i], src->multi_remove[i]); - list_append_list_unique(dest->multi_add[i], src->multi_add[i]); + err = list_append_list_unique(dest->multi_remove[i], src->multi_remove[i]); + if (!err) err = list_append_list_unique(dest->multi_add[i], src->multi_add[i]); + } + + if (err) + { + return err; } } + + return JB_ERR_OK; } @@ -201,19 +202,23 @@ void merge_actions (struct action_spec *dest, * Function : copy_action * * Description : Copy an action_specs. - * Similar to "cur_action = new_action". + * 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 * *********************************************************************/ -void copy_action (struct action_spec *dest, - const struct action_spec *src) +jb_err copy_action (struct action_spec *dest, + const struct action_spec *src) { int i; + jb_err err = JB_ERR_OK; + + free_action(dest); + memset(dest, '\0', sizeof(*dest)); dest->mask = src->mask; dest->add = src->add; @@ -221,15 +226,46 @@ void copy_action (struct action_spec *dest, for (i = 0; i < ACTION_STRING_COUNT; i++) { char * str = src->string[i]; - dest->string[i] = (str ? strdup(str) : NULL); + if (str) + { + str = strdup_or_die(str); + dest->string[i] = str; + } } for (i = 0; i < ACTION_MULTI_COUNT; i++) { dest->multi_remove_all[i] = src->multi_remove_all[i]; - list_duplicate(dest->multi_remove[i], src->multi_remove[i]); - list_duplicate(dest->multi_add[i], src->multi_add[i]); + err = list_duplicate(dest->multi_remove[i], src->multi_remove[i]); + if (err) + { + return err; + } + err = list_duplicate(dest->multi_add[i], src->multi_add[i]); + if (err) + { + return err; + } } + 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); } @@ -237,7 +273,9 @@ void copy_action (struct action_spec *dest, * * Function : free_action * - * Description : Free an action_specs. + * Description : Destroy an action_spec. Frees memory used by it, + * except for the memory used by the struct action_spec + * itself. * * Parameters : * 1 : src = Source to free. @@ -249,6 +287,11 @@ void free_action (struct action_spec *src) { int i; + if (src == NULL) + { + return; + } + for (i = 0; i < ACTION_STRING_COUNT; i++) { freez(src->string[i]); @@ -269,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: @@ -284,14 +327,14 @@ void free_action (struct action_spec *src) * we found an action. * 2 : name = [out] Start of action name, null * terminated. NULL on EOL - * 3 : value = [out] Start of action value, null + * 3 : value = [out] Start of action value, null * terminated. NULL if none or EOL. * - * Returns : 0 => Ok - * nonzero => Mismatched {} (line was trashed anyway) + * Returns : JB_ERR_OK => Ok + * JB_ERR_PARSE => Mismatched {} (line was trashed anyway) * *********************************************************************/ -int get_action_token(char **line, char **name, char **value) +jb_err get_action_token(char **line, char **name, char **value) { char * str = *line; char ch; @@ -315,19 +358,19 @@ int get_action_token(char **line, char **name, char **value) if (*str == '{') { /* null name, just value is prohibited */ - return 1; + return JB_ERR_PARSE; } *name = str; /* parse option */ - while (((ch = *str) != '\0') && + while (((ch = *str) != '\0') && (ch != ' ') && (ch != '\t') && (ch != '{')) { if (ch == '}') { - /* error */ - return 1; + /* error, '}' without '{' */ + return JB_ERR_PARSE; } str++; } @@ -346,18 +389,28 @@ int get_action_token(char **line, char **name, char **value) /* More to parse next time. */ *line = str + 1; } - return 0; + return JB_ERR_OK; } 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 */ *value = NULL; - return 1; + return JB_ERR_PARSE; } /* got value */ @@ -366,9 +419,45 @@ int get_action_token(char **line, char **name, char **value) chomp(*value); - return 0; + 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; +} /********************************************************************* * @@ -379,18 +468,21 @@ int 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. * - * Returns : 0 => Ok - * nonzero => Error (line was trashed anyway) + * Returns : JB_ERR_OK => Ok + * JB_ERR_PARSE => Parse error (line was trashed anyway) + * nonzero => Out of memory (line was trashed anyway) * *********************************************************************/ -int get_actions(char *line, struct action_alias * alias_list, - struct action_spec *cur_action) +jb_err get_actions(char *line, + struct action_alias * alias_list, + struct action_spec *cur_action) { - memset(cur_action, '\0', sizeof(*cur_action)); + jb_err err; + init_action(cur_action); cur_action->mask = ACTION_MASK_ALL; while (line) @@ -398,19 +490,20 @@ int get_actions(char *line, struct action_alias * alias_list, char * option = NULL; char * value = NULL; - if (get_action_token(&line, &option, &value)) + err = get_action_token(&line, &option, &value); + if (err) { - return 1; + return err; } if (option) { /* handle option in 'option' */ - + /* 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++; } @@ -421,10 +514,16 @@ int get_actions(char *line, struct action_alias * alias_list, 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: { @@ -432,11 +531,29 @@ int get_actions(char *line, struct action_alias * alias_list, if ((value == NULL) || (*value == '\0')) { - return 1; + 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; + } } /* FIXME: should validate option string here */ freez (cur_action->string[action->index]); cur_action->string[action->index] = strdup(value); + if (NULL == cur_action->string[action->index]) + { + return JB_ERR_MEMORY; + } break; } case AV_REM_STRING: @@ -450,61 +567,70 @@ int get_actions(char *line, struct action_alias * alias_list, { /* 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 1; + return JB_ERR_PARSE; } - list_remove_item(remove, value); - enlist_unique(add, value); + list_remove_item(remove_p, value); + err = enlist_unique(add_p, value, 0); + if (err) + { + return err; + } break; } case AV_REM_MULTI: { /* 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*. */ - destroy_list(remove); - destroy_list(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 */ - enlist_unique(remove, value); + err = enlist_unique(remove_p, value, 0); + if (err) + { + return err; + } } - list_remove_item(add, value); + list_remove_item(add_p, value); } break; } default: /* Shouldn't get here unless there's memory corruption. */ - return 1; + assert(0); + return JB_ERR_PARSE; } } else { /* 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; } @@ -513,190 +639,75 @@ int get_actions(char *line, struct action_alias * alias_list, /* 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 */ - return 1; + /* + * 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; } } } } - return 0; -} - - -/********************************************************************* - * - * Function : actions_to_text - * - * Description : Converts a actionsfile entry from numeric form - * ("mask" and "add") to text. - * - * Parameters : - * 1 : mask = As from struct url_actions - * 2 : add = As from struct url_actions - * - * Returns : A string. Caller must free it. - * - *********************************************************************/ -char * actions_to_text(struct action_spec *action) -{ - unsigned mask = action->mask; - unsigned add = action->add; - char * result = strdup(""); - struct list * lst; - - /* sanity - prevents "-feature +feature" */ - mask |= add; - - -#define DEFINE_ACTION_BOOL(__name, __bit) \ - if (!(mask & __bit)) \ - { \ - result = strsav(result, " -" __name); \ - } \ - else if (add & __bit) \ - { \ - result = strsav(result, " +" __name); \ - } - -#define DEFINE_ACTION_STRING(__name, __bit, __index) \ - if (!(mask & __bit)) \ - { \ - result = strsav(result, " -" __name); \ - } \ - else if (add & __bit) \ - { \ - result = strsav(result, " +" __name "{"); \ - result = strsav(result, action->string[__index]); \ - result = strsav(result, "}"); \ - } - -#define DEFINE_ACTION_MULTI(__name, __index) \ - if (action->multi_remove_all[__index]) \ - { \ - result = strsav(result, " -" __name "{*}"); \ - } \ - else \ - { \ - lst = action->multi_remove[__index]->next; \ - while (lst) \ - { \ - result = strsav(result, " -" __name "{"); \ - result = strsav(result, lst->str); \ - result = strsav(result, "}"); \ - lst = lst->next; \ - } \ - } \ - lst = action->multi_add[__index]->next; \ - while (lst) \ - { \ - result = strsav(result, " +" __name "{"); \ - result = strsav(result, lst->str); \ - result = strsav(result, "}"); \ - 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 - - return result; + return JB_ERR_OK; } /********************************************************************* * - * Function : current_actions_to_text + * Function : init_current_action * - * Description : Converts a actionsfile entry to text. + * Description : Zero out an action. * * Parameters : - * 1 : action = Action + * 1 : dest = An uninitialized current_action_spec. * - * Returns : A string. Caller must free it. + * Returns : N/A * *********************************************************************/ -char * current_action_to_text(struct current_action_spec *action) +void init_current_action (struct current_action_spec *dest) { - unsigned flags = action->flags; - char * result = strdup(""); - struct list_share * lst; - -#define DEFINE_ACTION_BOOL(__name, __bit) \ - if (flags & __bit) \ - { \ - result = strsav(result, " +" __name); \ - } \ - else \ - { \ - result = strsav(result, " -" __name); \ - } - -#define DEFINE_ACTION_STRING(__name, __bit, __index) \ - if (flags & __bit) \ - { \ - result = strsav(result, " +" __name "{"); \ - result = strsav(result, action->string[__index]); \ - result = strsav(result, "}"); \ - } \ - else \ - { \ - result = strsav(result, " -" __name); \ - } - -#define DEFINE_ACTION_MULTI(__name, __index) \ - lst = action->multi[__index]->next; \ - if (lst == NULL) \ - { \ - result = strsav(result, " -" __name); \ - } \ - else \ - { \ - while (lst) \ - { \ - result = strsav(result, " +" __name "{"); \ - result = strsav(result, lst->str); \ - result = strsav(result, "}"); \ - 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 + memset(dest, '\0', sizeof(*dest)); - return result; + dest->flags = ACTION_MOST_COMPATIBLE; } /********************************************************************* * - * Function : init_current_action + * Function : init_action * * Description : Zero out an action. * * Parameters : - * 1 : dest = An uninitialized current_action_spec. + * 1 : dest = An uninitialized action_spec. * * Returns : N/A * *********************************************************************/ -void init_current_action (struct current_action_spec *dest) +void init_action (struct action_spec *dest) { memset(dest, '\0', sizeof(*dest)); - dest->flags = ACTION_MOST_COMPATIBLE; } @@ -710,7 +721,7 @@ void init_current_action (struct current_action_spec *dest) * is that this one doesn't allocate memory for * strings (so "src" better be in memory for at least * as long as "dest" is, and you'd better free - * "dest" using "current_free_action"). + * "dest" using "free_current_action"). * Also, there is no mask or remove lists in dest. * (If we're applying it to a URL, we don't need them) * @@ -718,13 +729,15 @@ void init_current_action (struct current_action_spec *dest) * 1 : dest = Current actions, to modify. * 2 : src = Action to add. * - * Returns : N/A + * Returns 0 : no error + * !=0 : error, probably JB_ERR_MEMORY. * *********************************************************************/ -void merge_current_action (struct current_action_spec *dest, - const struct action_spec *src) +jb_err merge_current_action (struct current_action_spec *dest, + const struct action_spec *src) { int i; + jb_err err = JB_ERR_OK; dest->flags &= src->mask; dest->flags |= src->add; @@ -734,6 +747,8 @@ void merge_current_action (struct current_action_spec *dest, char * str = src->string[i]; if (str) { + str = strdup_or_die(str); + freez(dest->string[i]); dest->string[i] = str; } } @@ -742,136 +757,514 @@ void merge_current_action (struct current_action_spec *dest, { if (src->multi_remove_all[i]) { - /* Remove everything from dest */ - destroy_list_share(dest->multi[i]); - list_duplicate_share(dest->multi[i], src->multi_add[i]); + /* Remove everything from dest, then add src->multi_add */ + err = list_duplicate(dest->multi[i], src->multi_add[i]); + if (err) + { + return err; + } } else { - list_remove_list_share(dest->multi[i], src->multi_remove[i]); - list_append_list_unique_share(dest->multi[i], src->multi_add[i]); + list_remove_list(dest->multi[i], src->multi_remove[i]); + err = list_append_list_unique(dest->multi[i], src->multi_add[i]); + if (err) + { + return err; + } } } + return err; } /********************************************************************* * - * Function : free_current_action + * Function : update_action_bits_for_tag * - * Description : Free a current_action_spec. + * Description : Updates the action bits based on the action sections + * whose tag patterns match a provided tag. * * Parameters : - * 1 : src = Source to free. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : tag = The tag on which the update should be based on * - * Returns : N/A + * Returns : 0 if no tag matched, or + * 1 otherwise * *********************************************************************/ -void free_current_action (struct current_action_spec *src) +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; - for (i = 0; i < ACTION_MULTI_COUNT; i++) + assert(tag); + assert(list_contains_item(csp->tags, tag)); + + /* Run through all action files, */ + for (i = 0; i < MAX_AF_FILES; i++) { - destroy_list_share(src->multi[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; + } + } } - memset(src, '\0', sizeof(*src)); + return updated; } /********************************************************************* * - * Function : unload_actions_file + * Function : check_negative_tag_patterns * - * Description : Unloads an actions module. + * Description : Updates the action bits based on NO-*-TAG patterns. * * Parameters : - * 1 : file_data = the data structure associated with the - * actions file. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : flag = The tag pattern type * - * Returns : N/A + * Returns : JB_ERR_OK in case off success, or + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -void unload_actions_file(void *file_data) +jb_err check_negative_tag_patterns(struct client_state *csp, unsigned int flag) { - struct url_actions * next; - struct url_actions * cur = (struct url_actions *)file_data; - while (cur != NULL) + struct list_entry *tag; + struct file_list *fl; + struct url_actions *b = NULL; + int i; + + for (i = 0; i < MAX_AF_FILES; i++) { - next = cur->next; - free_url(cur->url); - freez(cur); - cur = next; + 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 : load_actions_file + * Function : free_current_action * - * Description : Read and parse a action file and add to files - * list. + * Description : Free memory used by a current_action_spec. + * Does not free the current_action_spec itself. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) + * 1 : src = Source to free. * - * Returns : 0 => Ok, everything else is an error. + * Returns : N/A * *********************************************************************/ -int load_actions_file(struct client_state *csp) +void free_current_action(struct current_action_spec *src) { - static struct file_list *current_actions_file = NULL; - - FILE *fp; - - struct url_actions *last_perm; - struct url_actions *perm; - char buf[BUFSIZ]; - struct file_list *fs; -#define MODE_START_OF_FILE 1 -#define MODE_ACTIONS 2 -#define MODE_ALIAS 3 - int mode = MODE_START_OF_FILE; - struct action_spec cur_action[1]; - struct action_alias * alias_list = NULL; - - memset(cur_action, '\0', sizeof(*cur_action)); + int i; - if (!check_file_changed(current_actions_file, csp->config->actions_file, &fs)) + for (i = 0; i < ACTION_STRING_COUNT; i++) { - /* No need to load */ - if (csp) + freez(src->string[i]); + } + + for (i = 0; i < ACTION_MULTI_COUNT; i++) + { + destroy_list(src->multi[i]); + } + + memset(src, '\0', sizeof(*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]) { - csp->actions_list = current_actions_file; + current_actions_file[i]->unloader = unload_actions_file; + current_actions_file[i] = NULL; } - return 0; } - if (!fs) +} +#endif /* FEATURE_GRACEFUL_TERMINATION */ + + +/********************************************************************* + * + * Function : unload_actions_file + * + * Description : Unloads an actions module. + * + * Parameters : + * 1 : file_data = the data structure associated with the + * actions file. + * + * Returns : N/A + * + *********************************************************************/ +void unload_actions_file(void *file_data) +{ + struct url_actions * next; + struct url_actions * cur = (struct url_actions *)file_data; + while (cur != NULL) { - log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error finding file: %E", - csp->config->actions_file); - return 1; /* never get here */ + next = cur->next; + 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; } +} + - fs->f = last_perm = (struct url_actions *)zalloc(sizeof(*last_perm)); - if (last_perm == NULL) +/********************************************************************* + * + * Function : free_alias_list + * + * Description : Free memory used by a list of aliases. + * + * Parameters : + * 1 : alias_list = Linked list to free. + * + * Returns : N/A + * + *********************************************************************/ +void free_alias_list(struct action_alias *alias_list) +{ + while (alias_list != NULL) { - log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': out of memory!", - csp->config->actions_file); + struct action_alias * next = alias_list->next; + alias_list->next = NULL; + freez(alias_list->name); + free_action(alias_list->action); + free(alias_list); + alias_list = next; + } +} + + +/********************************************************************* + * + * 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_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} + }; + 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. + * + *********************************************************************/ +#ifndef FUZZ +static +#endif +int load_one_actions_file(struct client_state *csp, int fileid) +{ + + /* + * Parser mode. + * Note: Keep these in the order they occur in the file, they are + * sometimes tested with <= + */ + 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; + 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[fileid], csp->config->actions_file[fileid], &fs)) + { + /* No need to load */ + csp->actions_list[fileid] = current_actions_file[fileid]; + return 0; + } + if (!fs) + { + 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 */ } - if ((fp = fopen(csp->config->actions_file, "r")) == NULL) + fs->f = last_perm = zalloc_or_die(sizeof(*last_perm)); + + 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, fs) != 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 == '{') { @@ -879,16 +1272,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: %s", - csp->config->actions_file, buf); + log_error(LOG_LEVEL_FATAL, + "can't load actions file '%s': invalid line (%lu): %s", + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } @@ -900,25 +1293,87 @@ int load_actions_file(struct client_state *csp) { /* too short */ fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid line: {{ }}", - csp->config->actions_file); + log_error(LOG_LEVEL_FATAL, + "can't load actions file '%s': invalid line (%lu): {{ }}", + csp->config->actions_file[fileid], linenum); return 1; /* never get here */ } - if (0 == strcmpic(start, "alias")) + /* + * An actionsfile can optionally contain the following blocks. + * They *MUST* be in this order, to simplify processing: + * + * {{settings}} + * name=value... + * + * {{description}} + * ...free text, format TBD, but no line may start with a '{'... + * + * {{alias}} + * name=actions... + * + * The actual actions must be *after* these special blocks. + * None of these special blocks may be repeated. + * + */ + if (0 == strcmpic(start, "settings")) + { + /* it's a {{settings}} block */ + if (mode >= MODE_SETTINGS) + { + /* {{settings}} must be first thing in file and must only + * appear once. + */ + 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[fileid], linenum); + } + mode = MODE_SETTINGS; + } + else if (0 == strcmpic(start, "description")) + { + /* it's a {{description}} block */ + if (mode >= MODE_DESCRIPTION) + { + /* {{description}} is a singleton and only {{settings}} may proceed it + */ + 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[fileid], linenum); + } + mode = MODE_DESCRIPTION; + } + else if (0 == strcmpic(start, "alias")) { /* it's an {{alias}} block */ - + if (mode >= MODE_ALIAS) + { + /* {{alias}} must be first thing in file, possibly after + * {{settings}} and {{description}} + * + * {{alias}} must only appear once. + * + * Note that these are new restrictions introduced in + * v2.9.10 in order to make actionsfile editing simpler. + * (Otherwise, reordering actionsfile entries without + * completely rewriting the file becomes non-trivial) + */ + 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[fileid], linenum); + } mode = MODE_ALIAS; } else { /* invalid {{something}} block */ fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid line: {{%s}}", - csp->config->actions_file, start); + log_error(LOG_LEVEL_FATAL, + "can't load actions file '%s': invalid line (%lu): {{%s}}", + csp->config->actions_file[fileid], linenum, start); return 1; /* never get here */ } } @@ -926,27 +1381,48 @@ int load_actions_file(struct client_state *csp) { /* It's an actions block */ - char actions_buf[BUFSIZ]; + char *actions_buf; char * end; /* set mode */ - mode = MODE_ACTIONS; + mode = MODE_ACTIONS; /* free old action */ - free_action(cur_action); + if (cur_action) + { + if (!cur_action_used) + { + free_action_spec(cur_action); + } + cur_action = NULL; + } + cur_action_used = 0; + 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 != '}') { - /* too short */ + /* No closing } */ fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid line: %s", - csp->config->actions_file, 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'; @@ -954,54 +1430,91 @@ int load_actions_file(struct client_state *csp) /* trim any whitespace immediately inside {} */ chomp(actions_buf); - if (*actions_buf == '\0') + if (get_actions(actions_buf, alias_list, cur_action)) { - /* too short */ + /* error */ fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid line: %s", - csp->config->actions_file, 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 (get_actions(actions_buf, alias_list, cur_action)) + 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. + * 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))) { - /* error */ fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid line: %s", - csp->config->actions_file, buf); + 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) + { + /* + * Part of the {{description}} block. + * Ignore for now. + */ + } else if (mode == MODE_ALIAS) { - /* define an alias */ - char actions_buf[BUFSIZ]; + /* + * define an alias + */ + char actions_buf[BUFFER_SIZE]; struct action_alias * new_alias; - int more = 1; char * start = strchr(buf, '='); char * end = start; if ((start == NULL) || (start == buf)) { - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid alias line: %s", - csp->config->actions_file, 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); + "can't load actions file '%s': invalid alias line (%lu): %s", + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } + new_alias = zalloc_or_die(sizeof(*new_alias)); + /* Eat any the whitespace before the '=' */ end--; while ((*end == ' ') || (*end == '\t')) @@ -1022,54 +1535,47 @@ int load_actions_file(struct client_state *csp) } if (*start == '\0') { - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid alias line: %s", - csp->config->actions_file, buf); + log_error(LOG_LEVEL_FATAL, + "can't load actions file '%s': invalid alias line (%lu): %s", + 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)) { /* error */ fclose(fp); - log_error(LOG_LEVEL_FATAL, - "can't load actions file '%s': invalid alias line: %s = %s", - csp->config->actions_file, buf, start); + log_error(LOG_LEVEL_FATAL, + "can't load actions file '%s': invalid alias line (%lu): %s = %s", + csp->config->actions_file[fileid], linenum, buf, start); return 1; /* never get here */ } - + /* add to list */ new_alias->next = alias_list; alias_list = new_alias; } 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': cannot create URL pattern from: %s", - csp->config->actions_file, buf); + log_error(LOG_LEVEL_FATAL, + "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 */ } @@ -1081,57 +1587,398 @@ 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 line is invalid: %s", - csp->config->actions_file, buf); + log_error(LOG_LEVEL_FATAL, + "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 { /* How did we get here? This is impossible! */ fclose(fp); - log_error(LOG_LEVEL_FATAL, + 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); - while (alias_list != NULL) + if (!cur_action_used) { - struct action_alias * next = alias_list->next; - freez((char *)alias_list->name); - free_action(alias_list->action); - free(alias_list); - alias_list = next; + free_action_spec(cur_action); } - -#ifndef SPLIT_PROXY_ARGS - if (!suppress_blocklists) - { - fs->proxy_args = strsav(fs->proxy_args, ""); - } -#endif /* ndef SPLIT_PROXY_ARGS */ + 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; + + csp->actions_list[fileid] = fs; - if (csp) + return(0); + +} + + +/********************************************************************* + * + * Function : actions_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 : action = The action to format. + * + * Returns : A string. Caller must free it. + * NULL on out-of-memory error. + * + *********************************************************************/ +char * actions_to_text(const struct action_spec *action) +{ + 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 " \\\n"); \ + } \ + else if (add & __bit) \ + { \ + string_append(&result, " +" __name " \\\n"); \ + } + +#define DEFINE_ACTION_STRING(__name, __bit, __index) \ + if (!(mask & __bit)) \ + { \ + string_append(&result, " -" __name " \\\n"); \ + } \ + else if (add & __bit) \ + { \ + string_append(&result, " +" __name "{"); \ + string_append(&result, action->string[__index]); \ + string_append(&result, "} \\\n"); \ + } + +#define DEFINE_ACTION_MULTI(__name, __index) \ + if (action->multi_remove_all[__index]) \ + { \ + string_append(&result, " -" __name " \\\n"); \ + } \ + else \ + { \ + lst = action->multi_remove[__index]->first; \ + while (lst) \ + { \ + string_append(&result, " -" __name "{"); \ + string_append(&result, lst->str); \ + string_append(&result, "} \\\n"); \ + lst = lst->next; \ + } \ + } \ + lst = action->multi_add[__index]->first; \ + while (lst) \ + { \ + string_append(&result, " +" __name "{"); \ + string_append(&result, lst->str); \ + string_append(&result, "} \\\n"); \ + 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 + + return result; +} + + +/********************************************************************* + * + * Function : actions_to_html + * + * Description : Converts a actionsfile entry from numeric form + * ("mask" and "add") to a
-separated HTML string + * in which each action is linked to its chapter in + * the user manual. + * + * Parameters : + * 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(const struct client_state *csp, + const struct action_spec *action) +{ + 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, "\n
-"); \ + string_join(&result, add_help_link(__name, csp->config)); \ + } \ + else if (add & __bit) \ + { \ + 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
-"); \ + string_join(&result, add_help_link(__name, csp->config)); \ + } \ + else if (add & __bit) \ + { \ + 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
-"); \ + string_join(&result, add_help_link(__name, csp->config)); \ + } \ + else \ + { \ + lst = action->multi_remove[__index]->first; \ + while (lst) \ + { \ + 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; \ + } \ + } \ + lst = action->multi_add[__index]->first; \ + while (lst) \ + { \ + 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; \ + } + +#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 + + /* trim leading
*/ + if (result && *result) { - csp->actions_list = fs; + char * s = result; + result = strdup(result + 5); + free(s); } - return(0); + return result; +} + + +/********************************************************************* + * + * Function : current_actions_to_html + * + * Description : Converts a curren action spec to a
separated HTML + * text in which each action is linked to its chapter in + * the user manual. + * + * Parameters : + * 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_html(const struct client_state *csp, + const struct current_action_spec *action) +{ + unsigned long flags = action->flags; + 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(&active, "\n
+"); \ + string_join(&active, add_help_link(__name, csp->config)); \ + } \ + else \ + { \ + 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(&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(&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(&inactive, "\n
-"); \ + string_join(&inactive, add_help_link(__name, csp->config)); \ + } \ + else \ + { \ + while (lst) \ + { \ + 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; \ + } \ + } + +#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) + { + 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; }