X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=actions.c;h=d9282cb4f125949dfa9581c37654141ae13085e0;hp=4b31f7fe7c6948f5ebf6beb068618084fa923215;hb=0b740fcf77b1f86134de4475cef3a74c880ba161;hpb=d3b49edb39bfc457d4c9047b01e1dbcdd3cf209e diff --git a/actions.c b/actions.c index 4b31f7fe..d9282cb4 100644 --- a/actions.c +++ b/actions.c @@ -1,4 +1,4 @@ -const char actions_rcs[] = "$Id: actions.c,v 1.31 2002/05/06 07:56:50 oes Exp $"; +const char actions_rcs[] = "$Id: actions.c,v 1.51 2008/04/27 16:20:19 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/actions.c,v $ @@ -6,7 +6,7 @@ const char actions_rcs[] = "$Id: actions.c,v 1.31 2002/05/06 07:56:50 oes Exp $" * Purpose : Declares functions to work with actions files * Functions declared include: FIXME * - * Copyright : Written by and Copyright (C) 2001 the SourceForge + * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -33,6 +33,100 @@ const char actions_rcs[] = "$Id: actions.c,v 1.31 2002/05/06 07:56:50 oes Exp $" * * Revisions : * $Log: actions.c,v $ + * Revision 1.51 2008/04/27 16:20:19 fabiankeil + * Complain about every block action without reason found. + * + * Revision 1.50 2008/03/30 14:52:00 fabiankeil + * Rename load_actions_file() and load_re_filterfile() + * as they load multiple files "now". + * + * Revision 1.49 2008/03/29 12:13:45 fabiankeil + * Remove send-wafer and send-vanilla-wafer actions. + * + * Revision 1.48 2008/03/28 18:17:14 fabiankeil + * In action_used_to_be_valid(), loop through an array of formerly + * valid actions instead of using an OR-chain of strcmpic() calls. + * + * Revision 1.47 2008/03/28 15:13:37 fabiankeil + * Remove inspect-jpegs action. + * + * Revision 1.46 2008/03/27 18:27:20 fabiankeil + * Remove kill-popups action. + * + * Revision 1.45 2008/03/24 11:21:02 fabiankeil + * Share the action settings for multiple patterns in the same + * section so we waste less memory for gigantic block lists + * (and load them slightly faster). Reported by Franz Schwartau. + * + * Revision 1.44 2008/03/04 18:30:34 fabiankeil + * Remove the treat-forbidden-connects-like-blocks action. We now + * use the "blocked" page for forbidden CONNECT requests by default. + * + * Revision 1.43 2008/03/01 14:00:43 fabiankeil + * Let the block action take the reason for the block + * as argument and show it on the "blocked" page. + * + * Revision 1.42 2008/02/09 15:15:38 fabiankeil + * List active and inactive actions in the show-url-info's + * "Final results" section separately. Patch submitted by Lee + * in #1830056, modified to list active actions first. + * + * Revision 1.41 2008/01/28 20:17:40 fabiankeil + * - Mark some parameters as immutable. + * - Hide update_action_bits_for_all_tags() while it's unused. + * + * Revision 1.40 2007/05/21 10:26:50 fabiankeil + * - Use strlcpy() instead of strcpy(). + * - Provide a reason why loading the actions + * file might have failed. + * + * Revision 1.39 2007/04/17 18:21:45 fabiankeil + * Split update_action_bits() into + * update_action_bits_for_all_tags() + * and update_action_bits_for_tag(). + * + * Revision 1.38 2007/04/15 16:39:20 fabiankeil + * Introduce tags as alternative way to specify which + * actions apply to a request. At the moment tags can be + * created based on client and server headers. + * + * Revision 1.37 2007/03/11 15:56:12 fabiankeil + * Add kludge to log unknown aliases and actions before exiting. + * + * Revision 1.36 2006/12/28 17:15:42 fabiankeil + * Fix gcc43 conversion warning. + * + * Revision 1.35 2006/07/18 14:48:45 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.32.2.6 2006/01/29 23:10:56 david__schmidt + * Multiple filter file support + * + * Revision 1.32.2.5 2005/06/09 01:18:41 david__schmidt + * Tweaks to conditionally include pthread.h if FEATURE_PTHREAD is enabled - + * this becomes important when jcc.h gets included later down the line. + * + * Revision 1.32.2.4 2003/12/03 10:33:11 oes + * - Implemented Privoxy version requirement through + * for-privoxy-version= statement in {{settings}} + * block + * - Fix for unchecked out-of-memory condition + * + * Revision 1.32.2.3 2003/02/28 12:52:10 oes + * Fixed memory leak reported by Dan Price in Bug #694713 + * + * Revision 1.32.2.2 2002/11/20 14:36:55 oes + * Extended unload_current_actions_file() to multiple AFs. + * Thanks to Oliver Stoeneberg for the hint. + * + * Revision 1.32.2.1 2002/05/26 12:13:16 roro + * Change unsigned to unsigned long in actions_name struct. This closes + * SourceForge Bug #539284. + * + * Revision 1.32 2002/05/12 21:36:29 jongfoster + * Correcting function comments + * * Revision 1.31 2002/05/06 07:56:50 oes * Made actions_to_html independent of FEATURE_CGI_EDIT_ACTIONS * @@ -181,6 +275,10 @@ const char actions_rcs[] = "$Id: actions.c,v 1.31 2002/05/06 07:56:50 oes Exp $" #include #include +#ifdef FEATURE_PTHREAD +#include +#endif + #include "project.h" #include "jcc.h" #include "list.h" @@ -191,6 +289,7 @@ const char actions_rcs[] = "$Id: actions.c,v 1.31 2002/05/06 07:56:50 oes Exp $" #include "encode.h" #include "urlmatch.h" #include "cgi.h" +#include "ssplit.h" const char actions_h_rcs[] = ACTIONS_H_VERSION; @@ -218,10 +317,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 */ + int takes_value; /* an AV_... constant */ + int index; /* index into strings[] or multi[] */ }; /* @@ -392,6 +491,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); +} + /********************************************************************* * @@ -536,6 +653,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 *formerly_valid_actions[] = { + "inspect-jpegs", + "kill-popups", + "send-vanilla-wafer", + "send-wafer", + "treat-forbidden-connects-like-blocks", + "vanilla-wafer", + "wafer" + }; + int i; + + for (i = 0; i < SZ(formerly_valid_actions); i++) + { + if (0 == strcmpic(action, formerly_valid_actions[i])) + { + return TRUE; + } + } + + return FALSE; +} /********************************************************************* * @@ -603,7 +756,21 @@ 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; + } } /* FIXME: should validate option string here */ freez (cur_action->string[action->index]); @@ -697,9 +864,24 @@ jb_err get_actions(char *line, /* Found it */ merge_actions(cur_action, alias->action); } + else if ((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 { /* 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; } } @@ -818,6 +1000,99 @@ jb_err merge_current_action (struct current_action_spec *dest, return err; } +#if 0 +/********************************************************************* + * + * Function : update_action_bits_for_all_tags + * + * Description : Updates the action bits based on all matching tags. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * + * Returns : 0 if no tag matched, or + * 1 otherwise + * + *********************************************************************/ +int update_action_bits_for_all_tags(struct client_state *csp) +{ + struct list_entry *tag; + int updated = 0; + + for (tag = csp->tags->first; tag != NULL; tag = tag->next) + { + if (update_action_bits_for_tag(csp, tag->str)) + { + updated = 1; + } + } + + return updated; +} +#endif + +/********************************************************************* + * + * 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 the URL patterns, */ + if (NULL == b->url->tag_regex) + { + continue; + } + + /* and check if one of the tag patterns matches the tag, */ + if (0 == regexec(b->url->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 memorey while changing action bits"); + } + /* and signal the change. */ + updated = 1; + } + } + } + + return updated; +} + /********************************************************************* * @@ -850,7 +1125,7 @@ void free_current_action (struct current_action_spec *src) } -static struct file_list *current_actions_file[MAX_ACTION_FILES] = { +static struct file_list *current_actions_file[MAX_AF_FILES] = { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL }; @@ -871,10 +1146,15 @@ static struct file_list *current_actions_file[MAX_ACTION_FILES] = { *********************************************************************/ void unload_current_actions_file(void) { - if (current_actions_file) + int i; + + for (i = 0; i < MAX_AF_FILES; i++) { - current_actions_file->unloader = unload_actions_file; - current_actions_file = NULL; + if (current_actions_file[i]) + { + current_actions_file[i]->unloader = unload_actions_file; + current_actions_file[i] = NULL; + } } } #endif /* FEATURE_GRACEFUL_TERMINATION */ @@ -901,11 +1181,19 @@ void unload_actions_file(void *file_data) { next = cur->next; free_url_spec(cur->url); - free_action(cur->action); + 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; } - } @@ -937,7 +1225,7 @@ 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. @@ -948,12 +1236,12 @@ void free_alias_list(struct action_alias *alias_list) * Returns : 0 => Ok, everything else is an error. * *********************************************************************/ -int load_actions_file(struct client_state *csp) +int load_action_files(struct client_state *csp) { int i; int result; - for (i = 0; i < MAX_ACTION_FILES; i++) + for (i = 0; i < MAX_AF_FILES; i++) { if (csp->config->actions_file[i]) { @@ -1021,8 +1309,9 @@ static int load_one_actions_file(struct client_state *csp, int fileid) } if (!fs) { - log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error finding file: %E", - csp->config->actions_file[fileid]); + 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 */ } @@ -1049,7 +1338,7 @@ static int load_one_actions_file(struct client_state *csp, int fileid) 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-- != '}')) @@ -1169,8 +1458,7 @@ static int load_one_actions_file(struct client_state *csp, int fileid) { if (!cur_action_used) { - free_action(cur_action); - free(cur_action); + free_action_spec(cur_action); } cur_action = NULL; } @@ -1187,7 +1475,7 @@ static int load_one_actions_file(struct client_state *csp, int fileid) init_action(cur_action); /* trim { */ - strcpy(actions_buf, buf + 1); + strlcpy(actions_buf, buf + 1, sizeof(actions_buf)); /* check we have a trailing } and then trim it */ end = actions_buf + strlen(actions_buf) - 1; @@ -1220,9 +1508,44 @@ static int load_one_actions_file(struct client_state *csp, int fileid) { /* * 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; + + if ((version_string = strdup(buf + 20)) == NULL) + { + fclose(fp); + log_error(LOG_LEVEL_FATAL, + "can't load actions file '%s': out of memory!", + csp->config->actions_file[fileid]); + return 1; /* never get here */ + } + + num_fields = ssplit(version_string, ".", fields, 3, TRUE, FALSE); + + 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) { @@ -1285,9 +1608,16 @@ static int load_one_actions_file(struct client_state *csp, int fileid) return 1; /* never get here */ } - new_alias->name = strdup(buf); + if ((new_alias->name = strdup(buf)) == NULL) + { + fclose(fp); + log_error(LOG_LEVEL_FATAL, + "can't load actions file '%s': out of memory!", + csp->config->actions_file[fileid]); + return 1; /* never get here */ + } - strcpy(actions_buf, start); + strlcpy(actions_buf, start, sizeof(actions_buf)); if (get_actions(actions_buf, alias_list, new_alias->action)) { @@ -1317,8 +1647,8 @@ static int load_one_actions_file(struct client_state *csp, int fileid) return 1; /* never get here */ } - /* 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)) @@ -1356,8 +1686,10 @@ static int load_one_actions_file(struct client_state *csp, int fileid) 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 */ @@ -1382,7 +1714,7 @@ static int load_one_actions_file(struct client_state *csp, int fileid) * Function : actions_to_text * * Description : Converts a actionsfile entry from the internal - * structurt into a text line. The output is split + * structure into a text line. The output is split * into one line for each action with line continuation. * * Parameters : @@ -1392,7 +1724,7 @@ static int load_one_actions_file(struct client_state *csp, int fileid) * 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; @@ -1480,8 +1812,8 @@ char * actions_to_text(struct action_spec *action) * NULL on out-of-memory error. * *********************************************************************/ -char * actions_to_html(struct client_state *csp, - 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; @@ -1586,56 +1918,58 @@ char * actions_to_html(struct client_state *csp, * NULL on out-of-memory error. * *********************************************************************/ -char *current_action_to_html(struct client_state *csp, - 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(""); + char *active = strdup(""); + char *inactive = strdup(""); #define DEFINE_ACTION_BOOL(__name, __bit) \ if (flags & __bit) \ { \ - string_append(&result, "\n
+"); \ - string_join(&result, add_help_link(__name, csp->config)); \ + string_append(&active, "\n
+"); \ + string_join(&active, add_help_link(__name, csp->config)); \ } \ else \ { \ - string_append(&result, "\n
-"); \ - string_join(&result, add_help_link(__name, csp->config)); \ + 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, "\n
+"); \ - string_join(&result, add_help_link(__name, csp->config)); \ - string_append(&result, "{"); \ - string_join(&result, html_encode(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, "\n
-"); \ - string_join(&result, add_help_link(__name, csp->config)); \ + 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, "\n
-"); \ - string_join(&result, add_help_link(__name, csp->config)); \ + string_append(&inactive, "\n
-"); \ + string_join(&inactive, add_help_link(__name, csp->config)); \ } \ else \ { \ 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, "}"); \ + 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; \ } \ } @@ -1649,5 +1983,16 @@ char *current_action_to_html(struct client_state *csp, #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; }