X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=actions.c;h=cbd48727423f7a2f03976c5ea3f1d3c176adeca1;hp=875e1d9ee4b43a23cb1e842c6959e35c574a8c2a;hb=fffab6e6ee7719edef26f9cced06f3797be11312;hpb=b3ee70e4ee07171ad5cc5050748d53db7228f232 diff --git a/actions.c b/actions.c index 875e1d9e..cbd48727 100644 --- a/actions.c +++ b/actions.c @@ -1,4 +1,4 @@ -const char actions_rcs[] = "$Id: actions.c,v 1.24 2002/03/16 23:54:06 jongfoster Exp $"; +const char actions_rcs[] = "$Id: actions.c,v 1.38 2007/04/15 16:39:20 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/actions.c,v $ @@ -6,8 +6,8 @@ const char actions_rcs[] = "$Id: actions.c,v 1.24 2002/03/16 23:54:06 jongfoster * Purpose : Declares functions to work with actions files * Functions declared include: FIXME * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * Privoxy team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -33,6 +33,83 @@ const char actions_rcs[] = "$Id: actions.c,v 1.24 2002/03/16 23:54:06 jongfoster * * Revisions : * $Log: actions.c,v $ + * 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 + * + * Revision 1.30 2002/04/30 11:14:52 oes + * Made csp the first parameter in *action_to_html + * + * 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 @@ -146,6 +223,10 @@ const char actions_rcs[] = "$Id: actions.c,v 1.24 2002/03/16 23:54:06 jongfoster #include #include +#ifdef FEATURE_PTHREAD +#include +#endif + #include "project.h" #include "jcc.h" #include "list.h" @@ -153,10 +234,10 @@ const char actions_rcs[] = "$Id: actions.c,v 1.24 2002/03/16 23:54:06 jongfoster #include "miscutil.h" #include "errlog.h" #include "loaders.h" -#ifdef FEATURE_CGI_EDIT_ACTIONS #include "encode.h" -#endif /* def FEATURE_CGI_EDIT_ACTIONS */ #include "urlmatch.h" +#include "cgi.h" +#include "ssplit.h" const char actions_h_rcs[] = ACTIONS_H_VERSION; @@ -184,10 +265,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[] */ }; /* @@ -223,16 +304,19 @@ static const struct action_name action_names[] = }; +static int load_one_actions_file(struct client_state *csp, int fileid); + + /********************************************************************* * * Function : merge_actions * * Description : Merge two actions together. - * Similar to "cur_action += new_action". + * Similar to "dest += src". * * Parameters : - * 1 : cur_action = Current actions, to modify. - * 2 : new_action = Action to add. + * 1 : dest = Actions to modify. + * 2 : src = Action to add. * * Returns : JB_ERR_OK or JB_ERR_MEMORY * @@ -303,9 +387,7 @@ jb_err merge_actions (struct action_spec *dest, * Function : copy_action * * Description : Copy an action_specs. - * Similar to "cur_action = new_action". - * Note that dest better not contain valid data - * - it's overwritten, not freed. + * Similar to "dest = src". * * Parameters : * 1 : dest = Destination of copy. @@ -320,6 +402,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; @@ -510,7 +593,7 @@ jb_err get_action_token(char **line, char **name, char **value) * Parameters : * 1 : line = The string containing the actions. * Will be written to by this function. - * 2 : aliases = Custom alias list, or NULL for none. + * 2 : alias_list = Custom alias list, or NULL for none. * 3 : cur_action = Where to store the action. Caller * allocates memory. * @@ -664,6 +747,16 @@ jb_err get_actions(char *line, 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; } } @@ -783,6 +876,99 @@ jb_err merge_current_action (struct current_action_spec *dest, } +/********************************************************************* + * + * 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; +} + + +/********************************************************************* + * + * 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; +} + + /********************************************************************* * * Function : free_current_action @@ -814,7 +1000,10 @@ void free_current_action (struct current_action_spec *src) } -static struct file_list *current_actions_file = NULL; +static struct file_list *current_actions_file[MAX_AF_FILES] = { + NULL, NULL, NULL, NULL, NULL, + NULL, NULL, NULL, NULL, NULL +}; #ifdef FEATURE_GRACEFUL_TERMINATION @@ -832,10 +1021,15 @@ static struct file_list *current_actions_file = NULL; *********************************************************************/ 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 */ @@ -900,7 +1094,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 : @@ -910,6 +1104,45 @@ void free_alias_list(struct action_alias *alias_list) * *********************************************************************/ int load_actions_file(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 : 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) { /* @@ -935,19 +1168,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 */ } @@ -955,14 +1185,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 */ } @@ -974,7 +1204,7 @@ 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-- != '}')) @@ -983,7 +1213,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 */ } @@ -997,7 +1227,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 */ } @@ -1029,7 +1259,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; } @@ -1043,7 +1273,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; } @@ -1065,7 +1295,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; } @@ -1075,7 +1305,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 */ } } @@ -1106,7 +1336,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); @@ -1122,7 +1352,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'; @@ -1136,7 +1366,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 */ } } @@ -1145,9 +1375,44 @@ int load_actions_file(struct client_state *csp) { /* * 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) { @@ -1171,7 +1436,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 */ } @@ -1180,7 +1445,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 */ } @@ -1206,11 +1471,18 @@ int load_actions_file(struct client_state *csp) { log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': invalid alias line (%lu): %s", - csp->config->actions_file, linenum, buf); + csp->config->actions_file[fileid], linenum, buf); return 1; /* never get here */ } - new_alias->name = strdup(buf); + 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); @@ -1220,7 +1492,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 */ } @@ -1238,7 +1510,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 */ } @@ -1251,7 +1523,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 */ } @@ -1265,7 +1537,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 @@ -1274,7 +1546,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 */ } } @@ -1282,23 +1554,21 @@ int load_actions_file(struct client_state *csp) fclose(fp); free_action(cur_action); + freez(cur_action); free_alias_list(alias_list); /* the old one is now obsolete */ - if (current_actions_file) + if (current_actions_file[fileid]) { - current_actions_file->unloader = unload_actions_file; + current_actions_file[fileid]->unloader = unload_actions_file; } fs->next = files->next; files->next = fs; - current_actions_file = fs; + current_actions_file[fileid] = fs; - if (csp) - { - csp->actions_list = fs; - } + csp->actions_list[fileid] = fs; return(0); @@ -1309,12 +1579,12 @@ int load_actions_file(struct client_state *csp) * * Function : actions_to_text * - * Description : Converts a actionsfile entry from numeric form - * ("mask" and "add") to text. + * Description : Converts a actionsfile entry from the internal + * structure into a text line. The output is split + * into one line for each action with line continuation. * * Parameters : - * 1 : mask = As from struct url_actions - * 2 : add = As from struct url_actions + * 1 : action = The action to format. * * Returns : A string. Caller must free it. * NULL on out-of-memory error. @@ -1331,32 +1601,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 \ { \ @@ -1365,7 +1635,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; \ } \ } \ @@ -1374,7 +1644,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; \ } @@ -1391,28 +1661,29 @@ char * actions_to_text(struct action_spec *action) } -#ifdef FEATURE_CGI_EDIT_ACTIONS /********************************************************************* * * Function : actions_to_html * * Description : Converts a actionsfile entry from numeric form - * ("mask" and "add") to a
-seperated HTML string. + * ("mask" and "add") to a
-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" */ @@ -1422,59 +1693,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; \ } \ @@ -1482,19 +1739,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; \ } @@ -1518,23 +1766,26 @@ char * actions_to_html(struct action_spec *action) return result; } -#endif /* def FEATURE_CGI_EDIT_ACTIONS */ /********************************************************************* * - * Function : current_actions_to_text + * Function : current_actions_to_html * - * Description : Converts a actionsfile entry to text. + * Description : Converts a 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(""); @@ -1543,37 +1794,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; \ } \