X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=actions.c;h=e5d320b4197caa186fa30d6329cc07e917e2726f;hp=113024edd078c8cb2481caddd53949de17122c95;hb=870102d4d177eed65eb7940727408bf7efbad248;hpb=c31dff24961d15a9cf13b81ec3d19ad68074107a diff --git a/actions.c b/actions.c index 113024ed..e5d320b4 100644 --- a/actions.c +++ b/actions.c @@ -1,4 +1,4 @@ -const char actions_rcs[] = "$Id: actions.c,v 1.21 2002/01/17 20:54:44 jongfoster Exp $"; +const char actions_rcs[] = "$Id: actions.c,v 1.29 2002/04/26 19:30:54 jongfoster Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/actions.c,v $ @@ -7,7 +7,7 @@ const char actions_rcs[] = "$Id: actions.c,v 1.21 2002/01/17 20:54:44 jongfoster * Functions declared include: FIXME * * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -33,6 +33,51 @@ const char actions_rcs[] = "$Id: actions.c,v 1.21 2002/01/17 20:54:44 jongfoster * * Revisions : * $Log: actions.c,v $ + * Revision 1.29 2002/04/26 19:30:54 jongfoster + * - current_action_to_html(): Adding help link for the "-" form of + * one-string actions. + * - Some actions had "
-", some "
-" (note the space). + * Standardizing on no space. + * - Greatly simplifying some of the code by using string_join() + * where appropriate. + * + * Revision 1.28 2002/04/26 12:53:15 oes + * - CGI AF editor now writes action lines split into + * single lines with line continuation + * - actions_to_html now embeds each action name in + * link to chapter + * - current_action_to_text is now called current_action_to_html + * and acts like actions_to_html + * + * Revision 1.27 2002/04/24 02:10:31 oes + * - Jon's patch for multiple AFs: + * - split load_actions_file, add load_one_actions_file + * - make csp->actions_list files an array + * - remember file id with each action + * - Copy_action now frees dest action before copying + * + * Revision 1.26 2002/03/26 22:29:54 swa + * we have a new homepage! + * + * Revision 1.25 2002/03/24 13:25:43 swa + * name change related issues + * + * Revision 1.24 2002/03/16 23:54:06 jongfoster + * Adding graceful termination feature, to help look for memory leaks. + * If you enable this (which, by design, has to be done by hand + * editing config.h) and then go to http://i.j.b/die, then the program + * will exit cleanly after the *next* request. It should free all the + * memory that was used. + * + * Revision 1.23 2002/03/07 03:46:16 oes + * Fixed compiler warnings + * + * Revision 1.22 2002/01/21 00:27:02 jongfoster + * Allowing free_action(NULL). + * Moving the functions that #include actionlist.h to the end of the file, + * because the Visual C++ 97 debugger gets extremely confused if you try + * to debug any code that comes after them in the file. + * * Revision 1.21 2002/01/17 20:54:44 jongfoster * Renaming free_url to free_url_spec, since it frees a struct url_spec. * @@ -141,6 +186,7 @@ const char actions_rcs[] = "$Id: actions.c,v 1.21 2002/01/17 20:54:44 jongfoster #include "encode.h" #endif /* def FEATURE_CGI_EDIT_ACTIONS */ #include "urlmatch.h" +#include "cgi.h" const char actions_h_rcs[] = ACTIONS_H_VERSION; @@ -207,6 +253,9 @@ static const struct action_name action_names[] = }; +static int load_one_actions_file(struct client_state *csp, int fileid); + + /********************************************************************* * * Function : merge_actions @@ -288,8 +337,6 @@ jb_err merge_actions (struct action_spec *dest, * * Description : Copy an action_specs. * Similar to "cur_action = new_action". - * Note that dest better not contain valid data - * - it's overwritten, not freed. * * Parameters : * 1 : dest = Destination of copy. @@ -304,6 +351,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; @@ -573,16 +621,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,8 +641,8 @@ 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')) ) @@ -604,8 +652,8 @@ jb_err get_actions(char *line, * * 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 @@ -615,13 +663,13 @@ jb_err get_actions(char *line, 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; } @@ -798,6 +846,36 @@ void free_current_action (struct current_action_spec *src) } +static struct file_list *current_actions_file[MAX_ACTION_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) +{ + if (current_actions_file) + { + current_actions_file->unloader = unload_actions_file; + current_actions_file = NULL; + } +} +#endif /* FEATURE_GRACEFUL_TERMINATION */ + + /********************************************************************* * * Function : unload_actions_file @@ -857,7 +935,7 @@ void free_alias_list(struct action_alias *alias_list) * * Function : load_actions_file * - * Description : Read and parse a action file and add to files + * Description : Read and parse all the action files and add to files * list. * * Parameters : @@ -868,7 +946,45 @@ void free_alias_list(struct action_alias *alias_list) *********************************************************************/ int load_actions_file(struct client_state *csp) { - static struct file_list *current_actions_file = NULL; + int i; + int result; + + for (i = 0; i < MAX_ACTION_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 : 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. + * + *********************************************************************/ +static int load_one_actions_file(struct client_state *csp, int fileid) +{ /* * Parser mode. @@ -893,19 +1009,16 @@ int load_actions_file(struct client_state *csp) struct action_alias * alias_list = NULL; unsigned long linenum = 0; - 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); + csp->config->actions_file[fileid]); return 1; /* never get here */ } @@ -913,14 +1026,14 @@ int load_actions_file(struct client_state *csp) if (last_perm == NULL) { log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': out of memory!", - csp->config->actions_file); + csp->config->actions_file[fileid]); return 1; /* never get here */ } - 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 */ } @@ -941,7 +1054,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, buf); + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } @@ -955,7 +1068,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 +1100,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 +1114,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 +1136,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 +1146,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 */ } } @@ -1064,7 +1177,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': out of memory", - csp->config->actions_file); + csp->config->actions_file[fileid]); return 1; /* never get here */ } init_action(cur_action); @@ -1080,7 +1193,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, buf); + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } *end = '\0'; @@ -1094,7 +1207,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, buf); + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } } @@ -1129,7 +1242,7 @@ 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 */ } @@ -1138,7 +1251,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': out of memory!", - csp->config->actions_file); + csp->config->actions_file[fileid]); return 1; /* never get here */ } @@ -1164,7 +1277,7 @@ 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 */ } @@ -1178,7 +1291,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 */ } @@ -1196,7 +1309,7 @@ int load_actions_file(struct client_state *csp) fclose(fp); log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': out of memory!", - csp->config->actions_file); + csp->config->actions_file[fileid]); return 1; /* never get here */ } @@ -1209,7 +1322,7 @@ int load_actions_file(struct client_state *csp) 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); + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } @@ -1223,7 +1336,7 @@ int load_actions_file(struct client_state *csp) 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); + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } else @@ -1232,7 +1345,7 @@ 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 */ } } @@ -1244,19 +1357,16 @@ int load_actions_file(struct client_state *csp) 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); @@ -1268,7 +1378,8 @@ 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. + * ("mask" and "add") to a text line which is split + * into one line for each action with line continuation. * * Parameters : * 1 : mask = As from struct url_actions @@ -1289,32 +1400,32 @@ char * actions_to_text(struct action_spec *action) 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 +1434,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 +1443,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; \ } @@ -1355,22 +1466,24 @@ char * actions_to_text(struct action_spec *action) * 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
-seperated 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(struct client_state *csp, + struct action_spec *action) { unsigned mask = action->mask; unsigned add = action->add; char * result = strdup(""); - char * enc_str; struct list_entry * lst; /* sanity - prevents "-feature +feature" */ @@ -1380,59 +1493,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 +1539,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; \ } @@ -1481,18 +1571,22 @@ char * actions_to_html(struct action_spec *action) /********************************************************************* * - * Function : current_actions_to_text + * Function : current_actions_to_html * - * Description : Converts a actionsfile entry to text. + * Description : Converts a curren action spec to a
seperated 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(struct client_state *csp, + struct current_action_spec *action) { unsigned long flags = action->flags; char * result = strdup(""); @@ -1501,37 +1595,45 @@ char * current_action_to_text(struct current_action_spec *action) #define DEFINE_ACTION_BOOL(__name, __bit) \ if (flags & __bit) \ { \ - string_append(&result, " +" __name); \ + string_append(&result, "\n
+"); \ + string_join(&result, add_help_link(__name, csp->config)); \ } \ else \ { \ - string_append(&result, " -" __name); \ + string_append(&result, "\n
-"); \ + string_join(&result, 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, "\n
+"); \ + string_join(&result, add_help_link(__name, csp->config)); \ + string_append(&result, "{"); \ + string_join(&result, html_encode(action->string[__index])); \ string_append(&result, "}"); \ } \ else \ { \ - string_append(&result, " -" __name); \ + string_append(&result, "\n
-"); \ + string_join(&result, 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(&result, "\n
-"); \ + string_join(&result, add_help_link(__name, csp->config)); \ } \ else \ { \ while (lst) \ { \ - string_append(&result, " +" __name "{"); \ - string_append(&result, lst->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; \ } \