X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgiedit.c;h=7e04f46d51293d2fca6c27e4abb6dc97b96e88d7;hp=1b0ca29ea2f9f3b5b767107419325c4565c17269;hb=60c5d95c4584689ec650b97a5adb706a55d7950d;hpb=4f72d7e5449fbbb7e7b4d3a9354ea55647ed3f1e diff --git a/cgiedit.c b/cgiedit.c index 1b0ca29e..7e04f46d 100644 --- a/cgiedit.c +++ b/cgiedit.c @@ -1,15 +1,19 @@ -const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.6 2001/10/29 03:48:09 david__schmidt Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $ * * Purpose : CGI-based actionsfile editor. * - * Functions declared include: + * NOTE: The CGIs in this file use parameter names + * such as "f" and "s" which are really *BAD* choices. + * However, I'm trying to save bytes in the + * edit-actions-list HTML page - the standard actions + * file generated a 550kbyte page, which is ridiculous. * + * Stick to the short names in this file for consistency. * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001-2014 the + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -33,53 +37,8 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.6 2001/10/29 03:48:09 david__schm * or write to the Free Software Foundation, Inc., 59 * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - * Revisions : - * $Log: cgiedit.c,v $ - * Revision 1.6 2001/10/29 03:48:09 david__schmidt - * OS/2 native needed a snprintf() routine. Added one to miscutil, brackedted - * by and __OS2__ ifdef. - * - * Revision 1.5 2001/10/25 03:40:48 david__schmidt - * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple - * threads to call select() simultaneously. So, it's time to do a real, live, - * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__ - * (native). Both versions will work, but using __OS2__ offers multi-threading. - * - * Revision 1.4 2001/10/23 21:48:19 jongfoster - * Cleaning up error handling in CGI functions - they now send back - * a HTML error page and should never cause a FATAL error. (Fixes one - * potential source of "denial of service" attacks). - * - * CGI actions file editor that works and is actually useful. - * - * Ability to toggle JunkBuster remotely using a CGI call. - * - * You can turn off both the above features in the main configuration - * file, e.g. if you are running a multi-user proxy. - * - * Revision 1.3 2001/10/14 22:12:49 jongfoster - * New version of CGI-based actionsfile editor. - * Major changes, including: - * - Completely new file parser and file output routines - * - edit-actions CGI renamed edit-actions-for-url - * - All CGIs now need a filename parameter, except for... - * - New CGI edit-actions which doesn't need a filename, - * to allow you to start the editor up. - * - edit-actions-submit now works, and now automatically - * redirects you back to the main edit-actions-list handler. - * - * Revision 1.2 2001/09/16 17:05:14 jongfoster - * Removing unused #include showarg.h - * - * Revision 1.1 2001/09/16 15:47:37 jongfoster - * First version of CGI-based edit interface. This is very much a - * work-in-progress, and you can't actually use it to edit anything - * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes - * to have any effect. - * - * **********************************************************************/ - + #include "config.h" @@ -93,13 +52,8 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.6 2001/10/29 03:48:09 david__schm #include #include #include -#include #include -#ifdef _WIN32 -#define snprintf _snprintf -#endif /* def _WIN32 */ - #include "project.h" #include "cgi.h" #include "cgiedit.h" @@ -109,77 +63,191 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.6 2001/10/29 03:48:09 david__schm #include "actions.h" #include "miscutil.h" #include "errlog.h" +#include "loaders.h" +#ifdef FEATURE_TOGGLE +/* loadcfg.h is for global_toggle_state only */ #include "loadcfg.h" -/* loadcfg.h is for g_bToggleIJB only */ - -const char cgiedit_h_rcs[] = CGIEDIT_H_VERSION; +#endif /* def FEATURE_TOGGLE */ +#include "urlmatch.h" #ifdef FEATURE_CGI_EDIT_ACTIONS +/** + * A line in an editable_file. + */ struct file_line { + /** Next entry in the linked list */ struct file_line * next; + + /** The raw data, to write out if this line is unmodified. */ char * raw; + + /** Comments and/or whitespace to put before this line if it's modified + and then written out. */ char * prefix; + + /** The actual data, as a string. Line continuation and comment removal + are performed on the data read from file before it's stored here, so + it will be a single line of data. */ char * unprocessed; + + /** The type of data on this line. One of the FILE_LINE_xxx constants. */ int type; + /** The actual data, processed into some sensible data type. */ union { + + /** An action specification. */ struct action_spec action[1]; + /** A name=value pair. */ struct { - char * name; - char * svalue; - int ivalue; - } setting; - - /* Add more data types here... e.g. + /** The name in the name=value pair. */ + char * name; - struct url_spec url[1]; + /** The value in the name=value pair, as a string. */ + char * svalue; - struct - { - struct action_spec action[1]; - const char * name; - } alias; + /** The value in the name=value pair, as an integer. */ + int ivalue; - */ + } setting; } data; + }; +/** This file_line has not been processed yet. */ #define FILE_LINE_UNPROCESSED 1 + +/** This file_line is blank. Can only appear at the end of a file, due to + the way the parser works. */ #define FILE_LINE_BLANK 2 + +/** This file_line says {{alias}}. */ #define FILE_LINE_ALIAS_HEADER 3 + +/** This file_line defines an alias. */ #define FILE_LINE_ALIAS_ENTRY 4 + +/** This file_line defines an {action}. */ #define FILE_LINE_ACTION 5 + +/** This file_line specifies a URL pattern. */ #define FILE_LINE_URL 6 + +/** This file_line says {{settings}}. */ #define FILE_LINE_SETTINGS_HEADER 7 + +/** This file_line is in a {{settings}} block. */ #define FILE_LINE_SETTINGS_ENTRY 8 + +/** This file_line says {{description}}. */ #define FILE_LINE_DESCRIPTION_HEADER 9 + +/** This file_line is in a {{description}} block. */ #define FILE_LINE_DESCRIPTION_ENTRY 10 +/* + * Number of file modification time mismatches + * before the CGI editor gets turned off. + */ +#define ACCEPTABLE_TIMESTAMP_MISMATCHES 3 +/** + * A configuration file, in a format that can be edited and written back to + * disk. + */ struct editable_file { - struct file_line * lines; - const char * filename; /* Full pathname - e.g. "/etc/junkbuster/wibble.action" */ - const char * identifier; /* Filename stub - e.g. "wibble". Use for CGI param. */ - const char * version_str; /* Last modification time, as a string. For CGI param */ - unsigned version; /* Last modification time - prevents chaos with - * the browser's "back" button. Note that this is a - * time_t cast to an unsigned. When comparing, always - * cast the time_t to an unsigned, and *NOT* vice-versa. - * This may lose the top few bits, but they're not - * significant anyway. - */ - struct file_line * parse_error; /* On parse error, this is the offending line. */ - const char * parse_error_text; /* On parse error, this is the problem. - * (Statically allocated) */ + struct file_line * lines; /**< The contents of the file. A linked list of lines. */ + const char * filename; /**< Full pathname - e.g. "/etc/privoxy/wibble.action". */ + unsigned identifier; /**< The file name's position in csp->config->actions_file[]. */ + const char * version_str; /**< Last modification time, as a string. For CGI param. */ + /**< Can be used in URL without using url_param(). */ + unsigned version; /**< Last modification time - prevents chaos with + the browser's "back" button. Note that this is a + time_t cast to an unsigned. When comparing, always + cast the time_t to an unsigned, and *NOT* vice-versa. + This may lose the top few bits, but they're not + significant anyway. */ + int newline; /**< Newline convention - one of the NEWLINE_xxx constants. + Note that changing this after the file has been + read in will cause a mess. */ + struct file_line * parse_error; /**< On parse error, this is the offending line. */ + const char * parse_error_text; /**< On parse error, this is the problem. + (Statically allocated) */ +}; + +/** + * Information about the filter types. + * Used for macro replacement in cgi_edit_actions_for_url. + */ +struct filter_type_info +{ + const int multi_action_index; /**< The multi action index as defined in project.h */ + const char *macro_name; /**< Name of the macro that has to be replaced + with the prepared templates. + For example "content-filter-params" */ + const char *type; /**< Name of the filter type, + for example "server-header-filter". */ + /* XXX: check if these two can be combined. */ + const char *disable_all_option; /**< Name of the catch-all radio option that has + to be checked or unchecked for this filter type. */ + const char *disable_all_param; /**< Name of the parameter that causes all filters of + this type to be disabled. */ + const char *abbr_type; /**< Abbreviation of the filter type, usually the + first or second character capitalized */ + const char *anchor; /**< Anchor for the User Manual link, + for example "SERVER-HEADER-FILTER" */ +}; + +/* Accessed by index, keep the order in the way the FT_ macros are defined. */ +static const struct filter_type_info filter_type_info[] = +{ + { + ACTION_MULTI_FILTER, + "content-filter-params", "filter", + "filter-all", "filter_all", + "F", "FILTER" + }, + { + ACTION_MULTI_CLIENT_HEADER_FILTER, + "client-header-filter-params", "client-header-filter", + "client-header-filter-all", "client_header_filter_all", + "C", "CLIENT-HEADER-FILTER" + }, + { + ACTION_MULTI_SERVER_HEADER_FILTER, + "server-header-filter-params", "server-header-filter", + "server-header-filter-all", "server_header_filter_all", + "S", "SERVER-HEADER-FILTER" + }, + { + ACTION_MULTI_CLIENT_HEADER_TAGGER, + "client-header-tagger-params", "client-header-tagger", + "client-header-tagger-all", "client_header_tagger_all", + "L", "CLIENT-HEADER-TAGGER" + }, + { + ACTION_MULTI_SERVER_HEADER_TAGGER, + "server-header-tagger-params", "server-header-tagger", + "server-header-tagger-all", "server_header_tagger_all", + "E", "SERVER-HEADER-TAGGER" + }, +#ifdef FEATURE_EXTERNAL_FILTERS + { + ACTION_MULTI_EXTERNAL_FILTER, + "external-content-filter-params", "external-filter", + "external-content-filter-all", "external_content_filter_all", + "E", "EXTERNAL-CONTENT-FILTER" + }, +#endif }; /* FIXME: Following non-static functions should be prototyped in .h or made static */ @@ -188,7 +256,6 @@ struct editable_file jb_err edit_read_file(struct client_state *csp, const struct map *parameters, int require_version, - const char *suffix, struct editable_file **pfile); jb_err edit_write_file(struct editable_file * file); void edit_free_file(struct editable_file * file); @@ -211,36 +278,30 @@ jb_err cgi_error_parse(struct client_state *csp, jb_err cgi_error_file(struct client_state *csp, struct http_response *rsp, const char *filename); -jb_err cgi_error_disabled(struct client_state *csp, - struct http_response *rsp); +jb_err cgi_error_file_read_only(struct client_state *csp, + struct http_response *rsp, + const char *filename); /* Internal arbitrary config file support functions */ -static jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile); +static jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile, int *newline); static void edit_free_file_lines(struct file_line * first_line); -static jb_err simple_read_line(char **dest, FILE *fp); -static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out); /* Internal actions file support functions */ static int match_actions_file_header_line(const char * line, const char * name); static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue); /* Internal parameter parsing functions */ -static jb_err get_file_name_param(struct client_state *csp, - const struct map *parameters, - const char *param_name, - const char *suffix, - char **pfilename, - const char **pparam); -static jb_err get_number_param(struct client_state *csp, - const struct map *parameters, - char *name, - unsigned *pvalue); +static jb_err get_url_spec_param(struct client_state *csp, + const struct map *parameters, + const char *name, + char **pvalue); + /* Internal actionsfile <==> HTML conversion functions */ static jb_err map_radio(struct map * exports, const char * optionname, const char * values, - char value); + int value); static jb_err actions_to_radio(struct map * exports, const struct action_spec *action); static jb_err actions_from_radio(const struct map * parameters, @@ -250,56 +311,62 @@ static jb_err actions_from_radio(const struct map * parameters, static jb_err map_copy_parameter_html(struct map *out, const struct map *in, const char *name); -static jb_err map_copy_parameter_url(struct map *out, - const struct map *in, - const char *name); +static jb_err get_file_name_param(struct client_state *csp, + const struct map *parameters, + const char *param_name, + const char **pfilename); + +/* Internal convenience functions */ +static char *section_target(const unsigned sectionid); /********************************************************************* * - * Function : map_copy_parameter_html + * Function : section_target * - * Description : Copy a CGI parameter from one map to another, HTML - * encoding it. + * Description : Given an unsigned (section id) n, produce a dynamically + * allocated string of the form #l, for use in link + * targets. + * + * XXX: The hash should be moved into the templates + * to make this function more generic and render + * stringify() obsolete. * * Parameters : - * 1 : out = target map - * 2 : in = source map - * 3 : name = name of cgi parameter to copy + * 1 : sectionid = start line number of section * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory - * JB_ERR_CGI_PARAMS if the parameter doesn't exist - * in the source map + * Returns : String with link target, or NULL if out of + * memory * *********************************************************************/ -static jb_err map_copy_parameter_html(struct map *out, - const struct map *in, - const char *name) +static char *section_target(const unsigned sectionid) { - const char * value; - jb_err err; + char buf[30]; - assert(out); - assert(in); - assert(name); + snprintf(buf, sizeof(buf), "#l%u", sectionid); + return(strdup(buf)); - value = lookup(in, name); - err = map(out, name, 1, html_encode(value), 0); +} - if (err) - { - /* Out of memory */ - return err; - } - else if (*value == '\0') - { - return JB_ERR_CGI_PARAMS; - } - else - { - return JB_ERR_OK; - } + +/********************************************************************* + * + * Function : stringify + * + * Description : Convert a number into a dynamically allocated string. + * + * Parameters : + * 1 : number = The number to convert. + * + * Returns : String with link target, or NULL if out of memory + * + *********************************************************************/ +static char *stringify(const unsigned number) +{ + char buf[6]; + + snprintf(buf, sizeof(buf), "%u", number); + return strdup(buf); } @@ -307,13 +374,13 @@ static jb_err map_copy_parameter_html(struct map *out, * * Function : map_copy_parameter_html * - * Description : Copy a CGI parameter from one map to another, URL + * Description : Copy a CGI parameter from one map to another, HTML * encoding it. * * Parameters : - * 1 : out = target map - * 2 : in = source map - * 3 : name = name of cgi parameter to copy + * 1 : out = target map + * 2 : in = source map + * 3 : name = name of cgi parameter to copy * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -321,9 +388,9 @@ static jb_err map_copy_parameter_html(struct map *out, * in the source map * *********************************************************************/ -static jb_err map_copy_parameter_url(struct map *out, - const struct map *in, - const char *name) +static jb_err map_copy_parameter_html(struct map *out, + const struct map *in, + const char *name) { const char * value; jb_err err; @@ -333,7 +400,7 @@ static jb_err map_copy_parameter_url(struct map *out, assert(name); value = lookup(in, name); - err = map(out, name, 1, url_encode(value), 0); + err = map(out, name, 1, html_encode(value), 0); if (err) { @@ -359,16 +426,14 @@ static jb_err map_copy_parameter_url(struct map *out, * edit-actions-url * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters - * filename : Identifies the file to edit - * ver : File's last-modified time - * section : Line number of section to edit - * pattern : Line number of pattern to edit - * oldval : Current value for pattern + * i : (action index) Identifies the file to edit + * v : (version) File's last-modified time + * p : (pattern) Line number of pattern to edit * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -380,7 +445,12 @@ jb_err cgi_edit_actions_url_form(struct client_state *csp, struct http_response *rsp, const struct map *parameters) { - struct map *exports; + struct map * exports; + unsigned patternid; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; + unsigned section_start_line_number = 0; jb_err err; assert(csp); @@ -392,16 +462,53 @@ jb_err cgi_edit_actions_url_form(struct client_state *csp, return cgi_error_disabled(csp, rsp); } + err = get_number_param(csp, parameters, "p", &patternid); + if (err) + { + return err; + } + + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) + { + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } + + cur_line = file->lines; + + for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++) + { + if (cur_line->type == FILE_LINE_ACTION) + { + section_start_line_number = line_number; + } + cur_line = cur_line->next; + } + + if ( (cur_line == NULL) + || (line_number != patternid) + || (patternid < 1U) + || (cur_line->type != FILE_LINE_URL)) + { + /* Invalid "patternid" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + if (NULL == (exports = default_exports(csp, NULL))) { + edit_free_file(file); return JB_ERR_MEMORY; } - err = map_copy_parameter_html(exports, parameters, "section"); - if (!err) err = map_copy_parameter_html(exports, parameters, "pattern"); - if (!err) err = map_copy_parameter_html(exports, parameters, "ver"); - if (!err) err = map_copy_parameter_html(exports, parameters, "filename"); - if (!err) err = map_copy_parameter_html(exports, parameters, "oldval"); + err = map(exports, "f", 1, stringify(file->identifier), 0); + if (!err) err = map(exports, "v", 1, file->version_str, 1); + if (!err) err = map(exports, "p", 1, url_encode(lookup(parameters, "p")), 0); + if (!err) err = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0); + if (!err) err = map(exports, "jumptarget", 1, section_target(section_start_line_number), 0); + + edit_free_file(file); if (err) { @@ -421,14 +528,14 @@ jb_err cgi_edit_actions_url_form(struct client_state *csp, * edit-actions-url * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters : - * filename : Identifies the file to edit - * ver : File's last-modified time - * section : Line number of section to edit + * f : (filename) Identifies the file to edit + * v : (version) File's last-modified time + * s : (section) Line number of section to edit * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -457,9 +564,9 @@ jb_err cgi_edit_actions_add_url_form(struct client_state *csp, return JB_ERR_MEMORY; } - err = map_copy_parameter_html(exports, parameters, "section"); - if (!err) err = map_copy_parameter_html(exports, parameters, "ver"); - if (!err) err = map_copy_parameter_html(exports, parameters, "filename"); + err = map_copy_parameter_html(exports, parameters, "f"); + if (!err) err = map_copy_parameter_html(exports, parameters, "v"); + if (!err) err = map_copy_parameter_html(exports, parameters, "s"); if (err) { @@ -479,16 +586,14 @@ jb_err cgi_edit_actions_add_url_form(struct client_state *csp, * edit-actions-url * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters : - * filename : Identifies the file to edit - * ver : File's last-modified time - * section : Line number of section to edit - * pattern : Line number of pattern to edit - * oldval : Current value for pattern + * f : (number) The action file identifier. + * v : (version) File's last-modified time + * p : (pattern) Line number of pattern to edit * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -500,7 +605,12 @@ jb_err cgi_edit_actions_remove_url_form(struct client_state *csp, struct http_response *rsp, const struct map *parameters) { - struct map *exports; + struct map * exports; + unsigned patternid; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; + unsigned section_start_line_number = 0; jb_err err; assert(csp); @@ -512,16 +622,54 @@ jb_err cgi_edit_actions_remove_url_form(struct client_state *csp, return cgi_error_disabled(csp, rsp); } + err = get_number_param(csp, parameters, "p", &patternid); + if (err) + { + return err; + } + + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) + { + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } + + cur_line = file->lines; + + for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++) + { + if (cur_line->type == FILE_LINE_ACTION) + { + section_start_line_number = line_number; + } + cur_line = cur_line->next; + } + + if ( (cur_line == NULL) + || (line_number != patternid) + || (patternid < 1U) + || (cur_line->type != FILE_LINE_URL)) + { + /* Invalid "patternid" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + if (NULL == (exports = default_exports(csp, NULL))) { + edit_free_file(file); return JB_ERR_MEMORY; } - err = map_copy_parameter_url(exports, parameters, "section"); - if (!err) err = map_copy_parameter_url(exports, parameters, "pattern"); - if (!err) err = map_copy_parameter_url(exports, parameters, "ver"); - if (!err) err = map_copy_parameter_url(exports, parameters, "filename"); - if (!err) err = map_copy_parameter_html(exports, parameters, "oldval"); + err = map(exports, "f", 1, stringify(file->identifier), 0); + if (!err) err = map(exports, "v", 1, file->version_str, 1); + if (!err) err = map(exports, "p", 1, url_encode(lookup(parameters, "p")), 0); + if (!err) err = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0); + if (!err) err = map(exports, "jumptarget", 1, section_target(section_start_line_number), 0); + if (!err) err = map(exports, "actions-file", 1, html_encode(file->filename), 0); + + edit_free_file(file); if (err) { @@ -535,383 +683,132 @@ jb_err cgi_edit_actions_remove_url_form(struct client_state *csp, /********************************************************************* * - * Function : simple_read_line - * - * Description : Read a single line from a file and return it. - * This is basically a version of fgets() that malloc()s - * it's own line buffer. Note that the buffer will - * always be a multiple of BUFFER_SIZE bytes long. - * Therefore if you are going to keep the string for - * an extended period of time, you should probably - * strdup() it and free() the original, to save memory. + * Function : edit_write_file * + * Description : Write a complete file to disk. * * Parameters : - * 1 : dest = destination for newly malloc'd pointer to - * line data. Will be set to NULL on error. - * 2 : fp = File to read from + * 1 : file = File to write. * * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory - * JB_ERR_FILE on EOF. + * JB_ERR_FILE on error writing to file. + * JB_ERR_MEMORY on out of memory * *********************************************************************/ -static jb_err simple_read_line(char **dest, FILE *fp) +jb_err edit_write_file(struct editable_file * file) { - int len; - char * buf; - char * newbuf; - - assert(fp); - assert(dest); + FILE * fp; + struct file_line * cur_line; + struct stat statbuf[1]; + char version_buf[22]; /* 22 = ceil(log10(2^64)) + 2 = max number of + digits in time_t, assuming this is a 64-bit + machine, plus null terminator, plus one + for paranoia */ - *dest = NULL; + assert(file); + assert(file->filename); - if (NULL == (buf = malloc(BUFFER_SIZE))) + if (NULL == (fp = fopen(file->filename, "wb"))) { - return JB_ERR_MEMORY; + return JB_ERR_FILE; } - *buf = '\0'; - len = 0; - - while (FOREVER) + cur_line = file->lines; + while (cur_line != NULL) { - newbuf = buf + len; - if ((!fgets(newbuf, BUFFER_SIZE, fp)) || (*newbuf == '\0')) + if (cur_line->raw) { - /* (*newbuf == '\0') should never happen unless fgets fails */ - if (*buf == '\0') + if (fputs(cur_line->raw, fp) < 0) { - free(buf); + fclose(fp); return JB_ERR_FILE; } - else - { - *dest = buf; - return JB_ERR_OK; - } } - len = strlen(buf); - if ((buf[len - 1] == '\n') || (buf[len - 1] == '\r')) + else { - *dest = buf; - return JB_ERR_OK; - } + if (cur_line->prefix) + { + if (fputs(cur_line->prefix, fp) < 0) + { + fclose(fp); + return JB_ERR_FILE; + } + } + if (cur_line->unprocessed) + { - if (NULL == (newbuf = realloc(buf, len + BUFFER_SIZE))) - { - free(buf); - return JB_ERR_MEMORY; - } - buf = newbuf; - } -} + if (NULL != strchr(cur_line->unprocessed, '#')) + { + /* Must quote '#' characters */ + int numhash = 0; + size_t len; + char * src; + char * dest; + char * str; + + /* Count number of # characters, so we know length of output string */ + src = cur_line->unprocessed; + while (NULL != (src = strchr(src, '#'))) + { + numhash++; + src++; + } + assert(numhash > 0); + /* Allocate new memory for string */ + len = strlen(cur_line->unprocessed) + (size_t)numhash; + str = malloc_or_die(len + 1); -/********************************************************************* - * - * Function : edit_read_line - * - * Description : Read a single non-empty line from a file and return - * it. Trims comments, leading and trailing whitespace - * and respects escaping of newline and comment char. - * Provides the line in 2 alternative forms: raw and - * preprocessed. - * - raw is the raw data read from the file. If the - * line is not modified, then this should be written - * to the new file. - * - prefix is any comments and blank lines that were - * read from the file. If the line is modified, then - * this should be written out to the file followed - * by the modified data. (If this string is non-empty - * then it will have a newline at the end). - * - data is the actual data that will be parsed - * further by appropriate routines. - * On EOF, the 3 strings will all be set to NULL and - * 0 will be returned. - * - * Parameters : - * 1 : fp = File to read from - * 2 : raw_out = destination for newly malloc'd pointer to - * raw line data. May be NULL if you don't want it. - * 3 : prefix_out = destination for newly malloc'd pointer to - * comments. May be NULL if you don't want it. - * 4 : data_out = destination for newly malloc'd pointer to - * line data with comments and leading/trailing spaces - * removed, and line continuation performed. May be - * NULL if you don't want it. - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory - * JB_ERR_FILE on EOF. - * - *********************************************************************/ -static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out) -{ - char *p; /* Temporary pointer */ - char *linebuf; /* Line read from file */ - char *linestart; /* Start of linebuf, usually first non-whitespace char */ - char newline[3]; /* Used to store the newline - "\n", "\r", or "\r\n" */ - int contflag = 0; /* Nonzero for line continuation - i.e. line ends '\' */ - char *raw; /* String to be stored in raw_out */ - char *prefix; /* String to be stored in prefix_out */ - char *data; /* String to be stored in data_out */ - jb_err rval = JB_ERR_OK; + /* Copy string but quote hashes */ + src = cur_line->unprocessed; + dest = str; + while (*src) + { + if (*src == '#') + { + *dest++ = '\\'; + numhash--; + assert(numhash >= 0); + } + *dest++ = *src++; + } + *dest = '\0'; - assert(fp); - - /* Set output parameters to NULL */ - if (raw_out) - { - *raw_out = NULL; - } - if (prefix_out) - { - *prefix_out = NULL; - } - if (data_out) - { - *data_out = NULL; - } - - /* Set string variables to new, empty strings. */ - - raw = malloc(1); - prefix = malloc(1); - data = malloc(1); - - if ((raw == NULL) || (prefix == NULL) || (data == NULL)) - { - freez(raw); - freez(prefix); - freez(data); - return JB_ERR_MEMORY; - } - - *raw = '\0'; - *prefix = '\0'; - *data = '\0'; - - /* Main loop. Loop while we need more data & it's not EOF. */ - - while ( (contflag || (*data == '\0')) - && (JB_ERR_OK == (rval = simple_read_line(&linebuf, fp)))) - { - if (string_append(&raw,linebuf)) - { - free(prefix); - free(data); - free(linebuf); - return JB_ERR_MEMORY; - } - - /* Trim off newline */ - p = linebuf + strlen(linebuf); - if ((p != linebuf) && ((p[-1] == '\r') || (p[-1] == '\n'))) - { - p--; - if ((p != linebuf) && ((p[-1] == '\r') || (p[-1] == '\n'))) - { - p--; - } - } - strcpy(newline, p); - *p = '\0'; - - /* Line continuation? Trim escape and set flag. */ - contflag = ((p != linebuf) && (*--p == '\\')); - if (contflag) - { - *p = '\0'; - } - - /* Trim leading spaces if we're at the start of the line */ - linestart = linebuf; - if (*data == '\0') - { - /* Trim leading spaces */ - while (*linestart && isspace((int)(unsigned char)*linestart)) - { - linestart++; - } - } - - /* Handle comment characters. */ - p = linestart; - while ((p = strchr(p, '#')) != NULL) - { - /* Found a comment char.. */ - if ((p != linebuf) && (*(p-1) == '\\')) - { - /* ..and it's escaped, left-shift the line over the escape. */ - char *q = p - 1; - while ((*q = *(q + 1)) != '\0') - { - q++; - } - /* Now scan from just after the "#". */ - } - else - { - /* Real comment. Save it... */ - if (p == linestart) - { - /* Special case: Line only contains a comment, so all the - * previous whitespace is considered part of the comment. - * Undo the whitespace skipping, if any. - */ - linestart = linebuf; - p = linestart; - } - string_append(&prefix,p); - if (string_append(&prefix,newline)) - { - free(raw); - free(data); - free(linebuf); - return JB_ERR_MEMORY; - } - *newline = '\0'; - - /* ... and chop off the rest of the line */ - *p = '\0'; - } - } /* END while (there's a # character) */ - - /* Write to the buffer */ - if (*linestart) - { - if (string_append(&data, linestart)) - { - free(raw); - free(prefix); - free(linebuf); - return JB_ERR_MEMORY; - } - } - - free(linebuf); - } /* END while(we need more data) */ - - /* Handle simple_read_line() errors - ignore EOF */ - if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE)) - { - free(raw); - free(prefix); - free(data); - return rval; - } - - - if (*raw) - { - /* Got at least some data */ - - /* Remove trailing whitespace */ - chomp(data); - - if (raw_out) - { - *raw_out = raw; - } - else - { - free(raw); - } - if (prefix_out) - { - *prefix_out = prefix; - } - else - { - free(prefix); - } - if (data_out) - { - *data_out = data; - } - else - { - free(data); - } - return JB_ERR_OK; - } - else - { - /* EOF and no data there. */ - - free(raw); - free(prefix); - free(data); - - return JB_ERR_FILE; - } -} - - -/********************************************************************* - * - * Function : edit_write_file - * - * Description : Write a complete file to disk. - * - * Parameters : - * 1 : filename = File to write to. - * 2 : file = Data structure to write. - * - * Returns : JB_ERR_OK on success - * JB_ERR_FILE on error writing to file. - * JB_ERR_MEMORY on out of memory - * - *********************************************************************/ -jb_err edit_write_file(struct editable_file * file) -{ - FILE * fp; - struct file_line * cur_line; - struct stat statbuf[1]; - char version_buf[22]; /* 22 = ceil(log10(2^64)) + 2 = max number of - digits in time_t, assuming this is a 64-bit - machine, plus null terminator, plus one - for paranoia */ + assert(numhash == 0); + assert(strlen(str) == len); + assert(str == dest - len); + assert(src - len <= cur_line->unprocessed); - assert(file); - assert(file->filename); + if ((strlen(str) != len) || (numhash != 0)) + { + /* + * Escaping didn't work as expected, go spread the news. + * Only reached in non-debugging builds. + */ + log_error(LOG_LEVEL_ERROR, + "Looks like hash escaping failed. %s might be corrupted now.", + file->filename); + } - if (NULL == (fp = fopen(file->filename, "wt"))) - { - return JB_ERR_FILE; - } + if (fputs(str, fp) < 0) + { + free(str); + fclose(fp); + return JB_ERR_FILE; + } - cur_line = file->lines; - while (cur_line != NULL) - { - if (cur_line->raw) - { - if (fputs(cur_line->raw, fp) < 0) - { - fclose(fp); - return JB_ERR_FILE; - } - } - else - { - if (cur_line->prefix) - { - if (fputs(cur_line->prefix, fp) < 0) - { - fclose(fp); - return JB_ERR_FILE; + free(str); } - } - if (cur_line->unprocessed) - { - if (fputs(cur_line->unprocessed, fp) < 0) + else { - fclose(fp); - return JB_ERR_FILE; + /* Can write without quoting '#' characters. */ + if (fputs(cur_line->unprocessed, fp) < 0) + { + fclose(fp); + return JB_ERR_FILE; + } } - if (fputs("\n", fp) < 0) + if (fputs(NEWLINE(file->newline), fp) < 0) { fclose(fp); return JB_ERR_FILE; @@ -941,13 +838,9 @@ jb_err edit_write_file(struct editable_file * file) /* Correct file->version_str */ freez(file->version_str); - snprintf(version_buf, 22, "%u", file->version); - version_buf[21] = '\0'; - file->version_str = strdup(version_buf); - if (version_buf == NULL) - { - return JB_ERR_MEMORY; - } + snprintf(version_buf, sizeof(version_buf), "%u", file->version); + version_buf[sizeof(version_buf)-1] = '\0'; + file->version_str = strdup_or_die(version_buf); return JB_ERR_OK; } @@ -974,8 +867,6 @@ void edit_free_file(struct editable_file * file) } edit_free_file_lines(file->lines); - freez(file->filename); - freez(file->identifier); freez(file->version_str); file->version = 0; file->parse_error_text = NULL; /* Statically allocated */ @@ -987,7 +878,7 @@ void edit_free_file(struct editable_file * file) /********************************************************************* * - * Function : edit_free_file + * Function : edit_free_file_lines * * Description : Free an entire linked list of file lines. * @@ -1049,15 +940,15 @@ static void edit_free_file_lines(struct file_line * first_line) * Description : Match an actions file {{header}} line * * Parameters : - * 1 : line - String from file - * 2 : name - Header to match against + * 1 : line = String from file + * 2 : name = Header to match against * * Returns : 0 iff they match. * *********************************************************************/ static int match_actions_file_header_line(const char * line, const char * name) { - int len; + size_t len; assert(line); assert(name); @@ -1070,7 +961,7 @@ static int match_actions_file_header_line(const char * line, const char * name) line += 2; /* Look for optional whitespace */ - while ( (*line == ' ') || (*line == '\t') ) + while ((*line == ' ') || (*line == '\t')) { line++; } @@ -1084,7 +975,7 @@ static int match_actions_file_header_line(const char * line, const char * name) line += len; /* Look for optional whitespace */ - while ( (*line == ' ') || (*line == '\t') ) + while ((*line == ' ') || (*line == '\t')) { line++; } @@ -1107,10 +998,10 @@ static int match_actions_file_header_line(const char * line, const char * name) * Description : Match an actions file {{header}} line * * Parameters : - * 1 : line - String from file. Must not start with + * 1 : line = String from file. Must not start with * whitespace (else infinite loop!) - * 2 : name - Destination for name - * 2 : name - Destination for value + * 2 : pname = Destination for name + * 2 : pvalue = Destination for value * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -1123,7 +1014,7 @@ static jb_err split_line_on_equals(const char * line, char ** pname, char ** pva { const char * name_end; const char * value_start; - int name_len; + size_t name_len; assert(line); assert(pname); @@ -1152,11 +1043,8 @@ static jb_err split_line_on_equals(const char * line, char ** pname, char ** pva name_end--; } - name_len = name_end - line + 1; /* Length excluding \0 */ - if (NULL == (*pname = (char *) malloc(name_len + 1))) - { - return JB_ERR_MEMORY; - } + name_len = (size_t)(name_end - line) + 1; /* Length excluding \0 */ + *pname = malloc_or_die(name_len + 1); strncpy(*pname, line, name_len); (*pname)[name_len] = '\0'; @@ -1203,7 +1091,7 @@ static jb_err split_line_on_equals(const char * line, char ** pname, char ** pva jb_err edit_parse_actions_file(struct editable_file * file) { struct file_line * cur_line; - int len; + size_t len; const char * text; /* Text from a line */ char * name; /* For lines of the form name=value */ char * value; /* For lines of the form name=value */ @@ -1226,16 +1114,16 @@ jb_err edit_parse_actions_file(struct editable_file * file) /* Skip leading blanks. Should only happen if file is * empty (which is valid, but pointless). */ - while ( (cur_line != NULL) - && (cur_line->unprocessed[0] == '\0') ) + while ((cur_line != NULL) + && (cur_line->unprocessed[0] == '\0')) { /* Blank line */ cur_line->type = FILE_LINE_BLANK; cur_line = cur_line->next; } - if ( (cur_line != NULL) - && (cur_line->unprocessed[0] != '{') ) + if ((cur_line != NULL) + && (cur_line->unprocessed[0] != '{')) { /* File doesn't start with a header */ file->parse_error = cur_line; @@ -1243,8 +1131,8 @@ jb_err edit_parse_actions_file(struct editable_file * file) return JB_ERR_PARSE; } - if ( (cur_line != NULL) && (0 == - match_actions_file_header_line(cur_line->unprocessed, "settings") ) ) + if ((cur_line != NULL) && (0 == + match_actions_file_header_line(cur_line->unprocessed, "settings"))) { cur_line->type = FILE_LINE_SETTINGS_HEADER; @@ -1278,8 +1166,8 @@ jb_err edit_parse_actions_file(struct editable_file * file) } } - if ( (cur_line != NULL) && (0 == - match_actions_file_header_line(cur_line->unprocessed, "description") ) ) + if ((cur_line != NULL) && (0 == + match_actions_file_header_line(cur_line->unprocessed, "description"))) { cur_line->type = FILE_LINE_DESCRIPTION_HEADER; @@ -1298,8 +1186,8 @@ jb_err edit_parse_actions_file(struct editable_file * file) } } - if ( (cur_line != NULL) && (0 == - match_actions_file_header_line(cur_line->unprocessed, "alias") ) ) + if ((cur_line != NULL) && (0 == + match_actions_file_header_line(cur_line->unprocessed, "alias"))) { cur_line->type = FILE_LINE_ALIAS_HEADER; @@ -1316,6 +1204,7 @@ jb_err edit_parse_actions_file(struct editable_file * file) err = split_line_on_equals(cur_line->unprocessed, &name, &value); if (err == JB_ERR_MEMORY) { + free_alias_list(alias_list); return err; } else if (err != JB_ERR_OK) @@ -1323,17 +1212,11 @@ jb_err edit_parse_actions_file(struct editable_file * file) /* Line does not contain a name=value pair */ file->parse_error = cur_line; file->parse_error_text = "Expected a name=value pair on this {{alias}} line, but couldn't find one."; + free_alias_list(alias_list); return JB_ERR_PARSE; } - if ((new_alias = zalloc(sizeof(*new_alias))) == NULL) - { - /* Out of memory */ - free(name); - free(value); - free_alias_list(alias_list); - return JB_ERR_MEMORY; - } + new_alias = zalloc_or_die(sizeof(*new_alias)); err = get_actions(value, alias_list, new_alias->action); if (err) @@ -1403,14 +1286,14 @@ jb_err edit_parse_actions_file(struct editable_file * file) return JB_ERR_PARSE; } - while ( (*text == ' ') || (*text == '\t') ) + while ((*text == ' ') || (*text == '\t')) { text++; len--; } - while ( (len > 0) - && ( (text[len - 1] == ' ') - || (text[len - 1] == '\t') ) ) + while ((len > (size_t)0) + && ((text[len - 1] == ' ') + || (text[len - 1] == '\t'))) { len--; } @@ -1418,12 +1301,7 @@ jb_err edit_parse_actions_file(struct editable_file * file) cur_line->type = FILE_LINE_ACTION; /* Remove {} and make copy */ - if (NULL == (value = (char *) malloc(len + 1))) - { - /* Out of memory */ - free_alias_list(alias_list); - return JB_ERR_MEMORY; - } + value = malloc_or_die(len + 1); strncpy(value, text, len); value[len] = '\0'; @@ -1488,12 +1366,13 @@ jb_err edit_parse_actions_file(struct editable_file * file) * at EOF but it will not have been closed. * 2 : pfile = Destination for a linked list of file_lines. * Will be set to NULL on error. + * 3 : newline = How to handle newlines. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * *********************************************************************/ -jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) +jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile, int *newline) { struct file_line * first_line; /* Keep for return value or to free */ struct file_line * cur_line; /* Current line */ @@ -1505,19 +1384,15 @@ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) *pfile = NULL; - cur_line = first_line = zalloc(sizeof(struct file_line)); - if (cur_line == NULL) - { - return JB_ERR_MEMORY; - } + cur_line = first_line = zalloc_or_die(sizeof(struct file_line)); cur_line->type = FILE_LINE_UNPROCESSED; - rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); + rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed, newline, NULL); if (rval) { /* Out of memory or empty file. */ - /* Note that empty file is not an error we propogate up */ + /* Note that empty file is not an error we propagate up */ free(cur_line); return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval); } @@ -1525,17 +1400,11 @@ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) do { prev_line = cur_line; - cur_line = prev_line->next = zalloc(sizeof(struct file_line)); - if (cur_line == NULL) - { - /* Out of memory */ - edit_free_file_lines(first_line); - return JB_ERR_MEMORY; - } + cur_line = prev_line->next = zalloc_or_die(sizeof(struct file_line)); cur_line->type = FILE_LINE_UNPROCESSED; - rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); + rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed, newline, NULL); if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE)) { /* Out of memory */ @@ -1569,13 +1438,11 @@ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) * 1 : csp = Current client state (buffers, headers, etc...) * 2 : parameters = map of cgi parameters. * 3 : require_version = true to check "ver" parameter. - * 4 : suffix = File extension, e.g. ".action". - * 5 : pfile = Destination for the file. Will be set + * 4 : pfile = Destination for the file. Will be set * to NULL on error. * * CGI Parameters : - * filename : The name of the file to read, without the - * path or ".action" extension. + * f : The action file identifier. * ver : (Only if require_version is nonzero) * Timestamp of the actions file. If wrong, this * function fails with JB_ERR_MODIFIED. @@ -1594,18 +1461,18 @@ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) jb_err edit_read_file(struct client_state *csp, const struct map *parameters, int require_version, - const char *suffix, struct editable_file **pfile) { struct file_line * lines; FILE * fp; jb_err err; - char * filename; - const char * identifier; + const char *filename = NULL; struct editable_file * file; unsigned version = 0; struct stat statbuf[1]; char version_buf[22]; + int newline = NEWLINE_UNKNOWN; + unsigned i; assert(csp); assert(parameters); @@ -1613,17 +1480,23 @@ jb_err edit_read_file(struct client_state *csp, *pfile = NULL; - err = get_file_name_param(csp, parameters, "filename", suffix, - &filename, &identifier); - if (err) + err = get_number_param(csp, parameters, "f", &i); + if ((JB_ERR_OK == err) && (i < MAX_AF_FILES) && (NULL != csp->config->actions_file[i])) { - return err; + filename = csp->config->actions_file[i]; + } + else if (JB_ERR_CGI_PARAMS == err) + { + /* + * Probably an old-school URL like + * http://config.privoxy.org/edit-actions-list?f=default + */ + get_file_name_param(csp, parameters, "f", &filename); } - if (stat(filename, statbuf) < 0) + if (NULL == filename || stat(filename, statbuf) < 0) { /* Error, probably file not found. */ - free(filename); return JB_ERR_FILE; } version = (unsigned) statbuf->st_mtime; @@ -1631,10 +1504,9 @@ jb_err edit_read_file(struct client_state *csp, if (require_version) { unsigned specified_version; - err = get_number_param(csp, parameters, "ver", &specified_version); + err = get_number_param(csp, parameters, "v", &specified_version); if (err) { - free(filename); return err; } @@ -1644,51 +1516,33 @@ jb_err edit_read_file(struct client_state *csp, } } - if (NULL == (fp = fopen(filename,"rt"))) + if (NULL == (fp = fopen(filename,"rb"))) { - free(filename); return JB_ERR_FILE; } - err = edit_read_file_lines(fp, &lines); + err = edit_read_file_lines(fp, &lines, &newline); fclose(fp); if (err) { - free(filename); return err; } - file = (struct editable_file *) zalloc(sizeof(*file)); - if (err) - { - free(filename); - edit_free_file_lines(lines); - return err; - } + file = zalloc_or_die(sizeof(*file)); file->lines = lines; + file->newline = newline; file->filename = filename; file->version = version; - file->identifier = strdup(identifier); - - if (file->identifier == NULL) - { - edit_free_file(file); - return JB_ERR_MEMORY; - } + file->identifier = i; /* Correct file->version_str */ freez(file->version_str); - snprintf(version_buf, 22, "%u", file->version); - version_buf[21] = '\0'; - file->version_str = strdup(version_buf); - if (version_buf == NULL) - { - edit_free_file(file); - return JB_ERR_MEMORY; - } + snprintf(version_buf, sizeof(version_buf), "%u", file->version); + version_buf[sizeof(version_buf)-1] = '\0'; + file->version_str = strdup_or_die(version_buf); *pfile = file; return JB_ERR_OK; @@ -1717,8 +1571,7 @@ jb_err edit_read_file(struct client_state *csp, * to NULL on error. * * CGI Parameters : - * filename : The name of the actions file to read, without the - * path or ".action" extension. + * f : The actions file identifier. * ver : (Only if require_version is nonzero) * Timestamp of the actions file. If wrong, this * function fails with JB_ERR_MODIFIED. @@ -1741,6 +1594,7 @@ jb_err edit_read_actions_file(struct client_state *csp, { jb_err err; struct editable_file *file; + static int acceptable_failures = ACCEPTABLE_TIMESTAMP_MISMATCHES - 1; assert(csp); assert(parameters); @@ -1748,17 +1602,34 @@ jb_err edit_read_actions_file(struct client_state *csp, *pfile = NULL; - err = edit_read_file(csp, parameters, require_version, ".action", &file); + err = edit_read_file(csp, parameters, require_version, &file); if (err) { /* Try to handle if possible */ if (err == JB_ERR_FILE) { - err = cgi_error_file(csp, rsp, lookup(parameters, "filename")); + err = cgi_error_file(csp, rsp, lookup(parameters, "f")); } else if (err == JB_ERR_MODIFIED) { - err = cgi_error_modified(csp, rsp, lookup(parameters, "filename")); + assert(require_version); + err = cgi_error_modified(csp, rsp, lookup(parameters, "f")); + log_error(LOG_LEVEL_ERROR, + "Blocking CGI edit request due to modification time mismatch."); + if (acceptable_failures > 0) + { + log_error(LOG_LEVEL_INFO, + "The CGI editor will be turned off after another %d mismatche(s).", + acceptable_failures); + acceptable_failures--; + } + else + { + log_error(LOG_LEVEL_INFO, + "Timestamp mismatch limit reached, turning CGI editor off. " + "Reload the configuration file to re-enable it."); + csp->config->feature_flags &= ~RUNTIME_FEATURE_CGI_EDIT_ACTIONS; + } } if (err == JB_ERR_OK) { @@ -1800,31 +1671,16 @@ jb_err edit_read_actions_file(struct client_state *csp, * Function : get_file_name_param * * Description : Get the name of the file to edit from the parameters - * passed to a CGI function. This function handles - * security checks such as blocking urls containing - * "/" or ".", prepending the config file directory, - * and adding the specified suffix. - * - * (This is an essential security check, otherwise - * users may be able to pass "../../../etc/passwd" - * and overwrite the password file [linux], "prn:" - * and print random data [Windows], etc...) - * - * This function only allows filenames contining the - * characters '-', '_', 'A'-'Z', 'a'-'z', and '0'-'9'. - * That's probably too restrictive but at least it's - * secure. + * passed to a CGI function using the old syntax. + * This function handles security checks and only + * accepts files that Privoxy already knows. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : parameters = map of cgi parameters - * 3 : suffix = File extension, e.g. ".actions" - * 4 : pfilename = destination for full filename. Caller - * free()s. Set to NULL on error. - * 5 : pparam = destination for partial filename, - * suitable for use in another URL. Allocated as part - * of the map "parameters", so don't free it. - * Set to NULL if not specified. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : parameters = map of cgi parameters + * 3 : param_name = The name of the parameter to read + * 4 : pfilename = pointer to the filename in + * csp->config->actions_file[] if found. Set to NULL on error. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -1835,25 +1691,23 @@ jb_err edit_read_actions_file(struct client_state *csp, static jb_err get_file_name_param(struct client_state *csp, const struct map *parameters, const char *param_name, - const char *suffix, - char **pfilename, - const char **pparam) + const char **pfilename) { const char *param; + const char suffix[] = ".action"; const char *s; char *name; char *fullpath; char ch; - int len; + size_t len; + size_t name_size; + int i; assert(csp); assert(parameters); - assert(suffix); assert(pfilename); - assert(pparam); *pfilename = NULL; - *pparam = NULL; param = lookup(parameters, param_name); if (!*param) @@ -1861,8 +1715,6 @@ static jb_err get_file_name_param(struct client_state *csp, return JB_ERR_CGI_PARAMS; } - *pparam = param; - len = strlen(param); if (len >= FILENAME_MAX) { @@ -1870,7 +1722,10 @@ static jb_err get_file_name_param(struct client_state *csp, return JB_ERR_CGI_PARAMS; } - /* Check every character to see if it's legal */ + /* + * Check every character to see if it's legal. + * Totally unnecessary but we do it anyway. + */ s = param; while ((ch = *s++) != '\0') { @@ -1878,7 +1733,7 @@ static jb_err get_file_name_param(struct client_state *csp, && ((ch < 'a') || (ch > 'z')) && ((ch < '0') || (ch > '9')) && (ch != '-') - && (ch != '_') ) + && (ch != '_')) { /* Probable hack attempt. */ return JB_ERR_CGI_PARAMS; @@ -1886,42 +1741,53 @@ static jb_err get_file_name_param(struct client_state *csp, } /* Append extension */ - name = malloc(len + strlen(suffix) + 1); - if (name == NULL) - { - return JB_ERR_MEMORY; - } - strcpy(name, param); - strcpy(name + len, suffix); + name_size = len + strlen(suffix) + 1; + name = malloc_or_die(name_size); + strlcpy(name, param, name_size); + strlcat(name, suffix, name_size); /* Prepend path */ fullpath = make_path(csp->config->confdir, name); free(name); + if (fullpath == NULL) { return JB_ERR_MEMORY; } - /* Success */ - *pfilename = fullpath; + /* Check if the file is known */ + for (i = 0; i < MAX_AF_FILES; i++) + { + if (NULL != csp->config->actions_file[i] && + !strcmp(fullpath, csp->config->actions_file[i])) + { + /* Success */ + *pfilename = csp->config->actions_file[i]; + freez(fullpath); - return JB_ERR_OK; + return JB_ERR_OK; + } + } + freez(fullpath); + + return JB_ERR_CGI_PARAMS; } /********************************************************************* * - * Function : get_number_param + * Function : get_url_spec_param * - * Description : Get a non-negative integer from the parameters - * passed to a CGI function. + * Description : Get a URL pattern from the parameters + * passed to a CGI function. Removes leading/trailing + * spaces and validates it. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : parameters = map of cgi parameters - * 3 : name = Name of CGI parameter to read - * 4 : pvalue = destination for value. - * Set to -1 on error. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : parameters = map of cgi parameters + * 3 : name = Name of CGI parameter to read + * 4 : pvalue = destination for value. Will be malloc()'d. + * Set to NULL on error. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -1929,62 +1795,112 @@ static jb_err get_file_name_param(struct client_state *csp, * or is not valid. * *********************************************************************/ -static jb_err get_number_param(struct client_state *csp, - const struct map *parameters, - char *name, - unsigned *pvalue) +static jb_err get_url_spec_param(struct client_state *csp, + const struct map *parameters, + const char *name, + char **pvalue) { - const char *param; - char ch; - unsigned value; + const char *orig_param; + char *param; + char *s; + struct pattern_spec compiled[1]; + jb_err err; assert(csp); assert(parameters); assert(name); assert(pvalue); - *pvalue = -1; + *pvalue = NULL; - param = lookup(parameters, name); - if (!*param) + orig_param = lookup(parameters, name); + if (!*orig_param) { return JB_ERR_CGI_PARAMS; } - /* We don't use atoi because I want to check this carefully... */ + /* Copy and trim whitespace */ + param = strdup(orig_param); + if (param == NULL) + { + return JB_ERR_MEMORY; + } + chomp(param); + + /* Must be non-empty, and can't allow 1st character to be '{' */ + if (param[0] == '\0' || param[0] == '{') + { + free(param); + return JB_ERR_CGI_PARAMS; + } - value = 0; - while ((ch = *param++) != '\0') + /* Check for embedded newlines */ + for (s = param; *s != '\0'; s++) { - if ((ch < '0') || (ch > '9')) + if ((*s == '\r') || (*s == '\n')) { + free(param); return JB_ERR_CGI_PARAMS; } + } - ch -= '0'; + /* Check that regex is valid */ + s = strdup(param); + if (s == NULL) + { + free(param); + return JB_ERR_MEMORY; + } + err = create_pattern_spec(compiled, s); + free(s); + if (err) + { + free(param); + return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS; + } + free_pattern_spec(compiled); - /* Note: - * - * defines UINT_MAX - * - * (UINT_MAX - ch) / 10 is the largest number that - * can be safely multiplied by 10 then have ch added. + if (param[strlen(param) - 1] == '\\') + { + /* + * Must protect trailing '\\' from becoming line continuation character. + * Two methods: 1) If it's a domain only, add a trailing '/'. + * 2) For path, add the do-nothing PCRE expression (?:) to the end */ - if (value > ((UINT_MAX - (unsigned)ch) / 10U)) + if (strchr(param, '/') == NULL) { - return JB_ERR_CGI_PARAMS; + err = string_append(¶m, "/"); + } + else + { + err = string_append(¶m, "(?:)"); + } + if (err) + { + return err; } - value = value * 10 + ch; + /* Check that the modified regex is valid */ + s = strdup(param); + if (s == NULL) + { + free(param); + return JB_ERR_MEMORY; + } + err = create_pattern_spec(compiled, s); + free(s); + if (err) + { + free(param); + return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS; + } + free_pattern_spec(compiled); } - /* Success */ - *pvalue = value; - + *pvalue = param; return JB_ERR_OK; } - /********************************************************************* * * Function : map_radio @@ -2000,10 +1916,10 @@ static jb_err get_number_param(struct client_state *csp, * Where 'sel' is 'a', 'b', or 'c'. * * Parameters : - * 1 : exports = Exports map to modify. - * 2 : optionname = name for map - * 3 : values = null-terminated list of values; - * 4 : value = Selected value. + * 1 : exports = Exports map to modify. + * 2 : optionname = name for map + * 3 : values = null-terminated list of values; + * 4 : value = Selected value. * * CGI Parameters : None * @@ -2014,25 +1930,23 @@ static jb_err get_number_param(struct client_state *csp, static jb_err map_radio(struct map * exports, const char * optionname, const char * values, - char value) + int value) { - int len; char * buf; char * p; char c; + const size_t len = strlen(optionname); + const size_t buf_size = len + 3; assert(exports); assert(optionname); assert(values); - len = strlen(optionname); - buf = malloc(len + 3); - if (buf == NULL) - { - return JB_ERR_MEMORY; - } + buf = malloc_or_die(buf_size); - strcpy(buf, optionname); + strlcpy(buf, optionname, buf_size); + + /* XXX: this looks ... interesting */ p = buf + len; *p++ = '-'; p[1] = '\0'; @@ -2044,894 +1958,1268 @@ static jb_err map_radio(struct map * exports, *p = c; if (map(exports, buf, 1, "", 1)) { - free(buf); return JB_ERR_MEMORY; } } } - *p = value; - if (map(exports, buf, 0, "checked", 1)) - { - free(buf); - return JB_ERR_MEMORY; - } - - return JB_ERR_OK; + *p = (char)value; + return map(exports, buf, 0, "checked", 1); } /********************************************************************* * - * Function : actions_to_radio + * Function : cgi_error_modified * - * Description : Converts a actionsfile entry into settings for - * radio buttons and edit boxes on a HTML form. + * Description : CGI function that is called when a file is modified + * outside the CGI editor. * * Parameters : - * 1 : exports = List of substitutions to add to. - * 2 : action = Action to read + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : filename = The file that was modified. * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory + * CGI Parameters : none + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -static jb_err actions_to_radio(struct map * exports, - const struct action_spec *action) +jb_err cgi_error_modified(struct client_state *csp, + struct http_response *rsp, + const char *filename) { - unsigned mask = action->mask; - unsigned add = action->add; - int mapped_param; - int checked; - char current_mode; - - assert(exports); - assert(action); - - mask = action->mask; - add = action->add; + struct map *exports; + jb_err err; - /* sanity - prevents "-feature +feature" */ - mask |= add; + assert(csp); + assert(rsp); + assert(filename); + if (NULL == (exports = default_exports(csp, NULL))) + { + return JB_ERR_MEMORY; + } -#define DEFINE_ACTION_BOOL(name, bit) \ - if (!(mask & bit)) \ - { \ - current_mode = 'n'; \ - } \ - else if (add & bit) \ - { \ - current_mode = 'y'; \ - } \ - else \ - { \ - current_mode = 'x'; \ - } \ - if (map_radio(exports, name, "ynx", current_mode)) \ - { \ - return JB_ERR_MEMORY; \ + err = map(exports, "f", 1, html_encode(filename), 0); + if (err) + { + free_map(exports); + return err; } -#define DEFINE_ACTION_STRING(name, bit, index) \ - DEFINE_ACTION_BOOL(name, bit); \ - mapped_param = 0; + return template_fill_for_cgi(csp, "cgi-error-modified", exports, rsp); +} -#define DEFINE_CGI_PARAM_RADIO(name, bit, index, value, is_default) \ - if (add & bit) \ - { \ - checked = !strcmp(action->string[index], value); \ - } \ - else \ - { \ - checked = is_default; \ - } \ - mapped_param |= checked; \ - if (map(exports, name "-param-" value, 1, (checked ? "checked" : ""), 1)) \ - { \ - return JB_ERR_MEMORY; \ - } -#define DEFINE_CGI_PARAM_CUSTOM(name, bit, index, default_val) \ - if (map(exports, name "-param-custom", 1, \ - ((!mapped_param) ? "checked" : ""), 1)) \ - { \ - return JB_ERR_MEMORY; \ - } \ - if (map(exports, name "-param", 1, \ - (((add & bit) && !mapped_param) ? \ - action->string[index] : default_val), 1)) \ - { \ - return JB_ERR_MEMORY; \ - } +/********************************************************************* + * + * Function : cgi_error_parse + * + * Description : CGI function that is called when a file cannot + * be parsed by the CGI editor. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : file = The file that was modified. + * + * CGI Parameters : none + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_error_parse(struct client_state *csp, + struct http_response *rsp, + struct editable_file *file) +{ + struct map *exports; + jb_err err; + struct file_line *cur_line; -#define DEFINE_CGI_PARAM_NO_RADIO(name, bit, index, default_val) \ - if (map(exports, name "-param", 1, \ - ((add & bit) ? action->string[index] : default_val), 1)) \ - { \ - return JB_ERR_MEMORY; \ - } + assert(csp); + assert(rsp); + assert(file); -#define DEFINE_ACTION_MULTI(name, index) \ - if (action->multi_add[index]->first) \ - { \ - current_mode = 'y'; \ - } \ - else if (action->multi_remove_all[index]) \ - { \ - current_mode = 'n'; \ - } \ - else if (action->multi_remove[index]->first) \ - { \ - current_mode = 'y'; \ - } \ - else \ - { \ - current_mode = 'x'; \ - } \ - if (map_radio(exports, name, "ynx", current_mode)) \ - { \ - return JB_ERR_MEMORY; \ + if (NULL == (exports = default_exports(csp, NULL))) + { + return JB_ERR_MEMORY; } -#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */ + err = map(exports, "f", 1, stringify(file->identifier), 0); + if (!err) err = map(exports, "parse-error", 1, html_encode(file->parse_error_text), 0); -#include "actionlist.h" + cur_line = file->parse_error; + assert(cur_line); -#undef DEFINE_ACTION_MULTI -#undef DEFINE_ACTION_STRING -#undef DEFINE_ACTION_BOOL -#undef DEFINE_ACTION_ALIAS -#undef DEFINE_CGI_PARAM_CUSTOM -#undef DEFINE_CGI_PARAM_RADIO -#undef DEFINE_CGI_PARAM_NO_RADIO + if (!err) err = map(exports, "line-raw", 1, html_encode(cur_line->raw), 0); + if (!err) err = map(exports, "line-data", 1, html_encode(cur_line->unprocessed), 0); - return JB_ERR_OK; + if (err) + { + free_map(exports); + return err; + } + + return template_fill_for_cgi(csp, "cgi-error-parse", exports, rsp); } /********************************************************************* * - * Function : javascriptify - * - * Description : Converts a string into a form JavaScript will like. - * - * Netscape 4's JavaScript sucks - it doesn't use - * "id" parameters, so you have to set the "name" - * used to submit a form element to something JavaScript - * will like. (Or access the elements by index in an - * array. That array contains >60 elements and will - * be changed whenever we add a new action to the - * editor, so I'm NOT going to use indexes that have - * to be figured out by hand.) - * - * Currently the only thing we have to worry about - * is "-" ==> "_" conversion. + * Function : cgi_error_file * - * This is a length-preserving operation so it is - * carried out in-place, no memory is allocated - * or freed. + * Description : CGI function that is called when a file cannot be + * opened by the CGI editor. * * Parameters : - * 1 : identifier = String to make JavaScript-friendly. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : filename = The file that was modified. * - * Returns : N/A + * CGI Parameters : none + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -static void javascriptify(char * identifier) +jb_err cgi_error_file(struct client_state *csp, + struct http_response *rsp, + const char *filename) { - char * p = identifier; - while (NULL != (p = strchr(p, '-'))) + struct map *exports; + jb_err err; + + assert(csp); + assert(rsp); + assert(filename); + + if (NULL == (exports = default_exports(csp, NULL))) { - *p++ = '_'; + return JB_ERR_MEMORY; } + + err = map(exports, "f", 1, html_encode(filename), 0); + if (err) + { + free_map(exports); + return err; + } + + return template_fill_for_cgi(csp, "cgi-error-file", exports, rsp); } /********************************************************************* * - * Function : actions_from_radio + * Function : cgi_error_file_read_only * - * Description : Converts a map of parameters passed to a CGI function - * into an actionsfile entry. + * Description : CGI function that is called when a file cannot be + * opened for writing by the CGI editor. * * Parameters : - * 1 : parameters = parameters to the CGI call - * 2 : action = Action to change. Must be valid before - * the call, actions not specified will be - * left unchanged. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : filename = The file that we can't write to * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory + * CGI Parameters : none + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -static jb_err actions_from_radio(const struct map * parameters, - struct action_spec *action) +jb_err cgi_error_file_read_only(struct client_state *csp, + struct http_response *rsp, + const char *filename) { - static int first_time = 1; - const char * param; - char * param_dup; - char ch; - const char * js_name; + struct map *exports; + jb_err err; - assert(parameters); - assert(action); - - /* Statics are generally a potential race condition, - * but in this case we're safe and don't need semaphores. - * Be careful if you modify this function. - * - Jon - */ - -#define JAVASCRIPTIFY(dest_var, string) \ - { \ - static char js_name_arr[] = string; \ - if (first_time) \ - { \ - javascriptify(js_name_arr); \ - } \ - dest_var = js_name_arr; \ - } \ - -#define DEFINE_ACTION_BOOL(name, bit) \ - JAVASCRIPTIFY(js_name, name); \ - param = lookup(parameters, js_name); \ - ch = ijb_toupper(param[0]); \ - if (ch == 'Y') \ - { \ - action->add |= bit; \ - action->mask |= bit; \ - } \ - else if (ch == 'N') \ - { \ - action->add &= ~bit; \ - action->mask &= ~bit; \ - } \ - else if (ch == 'X') \ - { \ - action->add &= ~bit; \ - action->mask |= bit; \ - } \ - -#define DEFINE_ACTION_STRING(name, bit, index) \ - JAVASCRIPTIFY(js_name, name); \ - param = lookup(parameters, js_name); \ - ch = ijb_toupper(param[0]); \ - if (ch == 'Y') \ - { \ - JAVASCRIPTIFY(js_name, name "-mode"); \ - param = lookup(parameters, js_name); \ - if ((*param == '\0') || (0 == strcmp(param, "CUSTOM"))) \ - { \ - JAVASCRIPTIFY(js_name, name "-param"); \ - param = lookup(parameters, js_name); \ - } \ - if (*param != '\0') \ - { \ - if (NULL == (param_dup = strdup(param))) \ - { \ - return JB_ERR_MEMORY; \ - } \ - freez(action->string[index]); \ - action->add |= bit; \ - action->mask |= bit; \ - action->string[index] = param_dup; \ - } \ - } \ - else if (ch == 'N') \ - { \ - if (action->add & bit) \ - { \ - freez(action->string[index]); \ - } \ - action->add &= ~bit; \ - action->mask &= ~bit; \ - } \ - else if (ch == 'X') \ - { \ - if (action->add & bit) \ - { \ - freez(action->string[index]); \ - } \ - action->add &= ~bit; \ - action->mask |= bit; \ - } \ - -#define DEFINE_ACTION_MULTI(name, index) \ - JAVASCRIPTIFY(js_name, name); \ - param = lookup(parameters, js_name); \ - ch = ijb_toupper((int)param[0]); \ - if (ch == 'Y') \ - { \ - /* FIXME */ \ - } \ - else if (ch == 'N') \ - { \ - list_remove_all(action->multi_add[index]); \ - list_remove_all(action->multi_remove[index]); \ - action->multi_remove_all[index] = 1; \ - } \ - else if (ch == 'X') \ - { \ - list_remove_all(action->multi_add[index]); \ - list_remove_all(action->multi_remove[index]); \ - action->multi_remove_all[index] = 0; \ - } \ - -#define DEFINE_ACTION_ALIAS 0 /* No aliases for URL parsing */ - -#include "actionlist.h" - -#undef DEFINE_ACTION_MULTI -#undef DEFINE_ACTION_STRING -#undef DEFINE_ACTION_BOOL -#undef DEFINE_ACTION_ALIAS -#undef JAVASCRIPTIFY - - first_time = 0; - - return JB_ERR_OK; -} - - -/********************************************************************* - * - * Function : cgi_error_modified - * - * Description : CGI function that is called when a file is modified - * outside the CGI editor. - * - * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : filename = The file that was modified. - * - * CGI Parameters : none - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error. - * - *********************************************************************/ -jb_err cgi_error_modified(struct client_state *csp, - struct http_response *rsp, - const char *filename) -{ - struct map *exports; - jb_err err; - - assert(csp); - assert(rsp); - assert(filename); + assert(csp); + assert(rsp); + assert(filename); if (NULL == (exports = default_exports(csp, NULL))) { return JB_ERR_MEMORY; } - err = map(exports, "filename", 1, filename, 1); + err = map(exports, "f", 1, html_encode(filename), 0); if (err) { free_map(exports); return err; } - return template_fill_for_cgi(csp, "cgi-error-modified", exports, rsp); + return template_fill_for_cgi(csp, "cgi-error-file-read-only", exports, rsp); } /********************************************************************* * - * Function : cgi_error_parse + * Function : cgi_edit_actions * - * Description : CGI function that is called when a file cannot - * be parsed by the CGI editor. + * Description : CGI function that allows the user to choose which + * actions file to edit. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : file = The file that was modified. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * - * CGI Parameters : none + * CGI Parameters : None * * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error. + * JB_ERR_MEMORY on out-of-memory error * *********************************************************************/ -jb_err cgi_error_parse(struct client_state *csp, - struct http_response *rsp, - struct editable_file *file) +jb_err cgi_edit_actions(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - struct map *exports; - jb_err err; - struct file_line *cur_line; - - assert(csp); - assert(rsp); - assert(file); + (void)parameters; - if (NULL == (exports = default_exports(csp, NULL))) + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) { - return JB_ERR_MEMORY; + return cgi_error_disabled(csp, rsp); } - err = map(exports, "filename", 1, file->identifier, 1); - if (!err) err = map(exports, "parse-error", 1, file->parse_error_text, 1); - - cur_line = file->parse_error; - assert(cur_line); - - if (!err) err = map(exports, "line-raw", 1, html_encode(cur_line->raw), 0); - if (!err) err = map(exports, "line-data", 1, html_encode(cur_line->unprocessed), 0); + /* FIXME: Incomplete */ - if (err) - { - free_map(exports); - return err; - } + return cgi_redirect(rsp, CGI_PREFIX "edit-actions-list?f=default"); - return template_fill_for_cgi(csp, "cgi-error-parse", exports, rsp); } /********************************************************************* * - * Function : cgi_error_file - * - * Description : CGI function that is called when a file cannot be - * opened by the CGI editor. + * Function : cgi_edit_actions_list * + * Description : CGI function that edits the actions list. + * FIXME: This function shouldn't FATAL ever. + * FIXME: This function doesn't check the retval of map() * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : filename = The file that was modified. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * - * CGI Parameters : none + * CGI Parameters : filename * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error. + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_FILE if the file cannot be opened or + * contains no data + * JB_ERR_CGI_PARAMS if "filename" was not specified + * or is not valid. * *********************************************************************/ -jb_err cgi_error_file(struct client_state *csp, - struct http_response *rsp, - const char *filename) +jb_err cgi_edit_actions_list(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - struct map *exports; + char * section_template; + char * url_template; + char * sections; + char * urls; + char buf[150]; + char * s; + struct map * exports; + struct map * section_exports; + struct map * url_exports; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number = 0; + unsigned prev_section_line_number = ((unsigned) (-1)); + int i, url_1_2; + struct file_list * fl; + struct url_actions * b; + char * buttons = NULL; jb_err err; - assert(csp); - assert(rsp); - assert(filename); + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } if (NULL == (exports = default_exports(csp, NULL))) { return JB_ERR_MEMORY; } - err = map(exports, "filename", 1, filename, 1); + /* Load actions file */ + err = edit_read_actions_file(csp, rsp, parameters, 0, &file); if (err) { + /* No filename specified, can't read file, or out of memory. */ free_map(exports); - return err; + return (err == JB_ERR_FILE ? JB_ERR_OK : err); } - return template_fill_for_cgi(csp, "cgi-error-file", exports, rsp); -} - - -/********************************************************************* - * - * Function : cgi_error_bad_param - * - * Description : CGI function that is called if the parameters - * (query string) for a CGI were wrong. - * - * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * - * CGI Parameters : none - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error. - * - *********************************************************************/ -jb_err cgi_error_disabled(struct client_state *csp, - struct http_response *rsp) -{ - struct map *exports; - - assert(csp); - assert(rsp); - - if (NULL == (exports = default_exports(csp, NULL))) + /* Find start of actions in file */ + cur_line = file->lines; + line_number = 1; + while ((cur_line != NULL) && (cur_line->type != FILE_LINE_ACTION)) { - return JB_ERR_MEMORY; + cur_line = cur_line->next; + line_number++; } - return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp); -} - + /* + * Conventional actions files should have a match all block + * at the start: + * cur_line = {...global actions...} + * cur_line->next = / + * cur_line->next->next = {...actions...} or EOF + */ + if ( (cur_line != NULL) + && (cur_line->type == FILE_LINE_ACTION) + && (cur_line->next != NULL) + && (cur_line->next->type == FILE_LINE_URL) + && (0 == strcmp(cur_line->next->unprocessed, "/")) + && ( (cur_line->next->next == NULL) + || (cur_line->next->next->type != FILE_LINE_URL) + ) ) + { + /* + * Generate string with buttons to set actions for "/" to + * any predefined set of actions (named standard.*, probably + * residing in standard.action). + */ -/********************************************************************* - * - * Function : cgi_edit_actions + err = template_load(csp, §ion_template, "edit-actions-list-button", 0); + if (err) + { + edit_free_file(file); + free_map(exports); + if (err == JB_ERR_FILE) + { + return cgi_error_no_template(csp, rsp, "edit-actions-list-button"); + } + return err; + } + + err = template_fill(§ion_template, exports); + if (err) + { + edit_free_file(file); + free_map(exports); + return err; + } + + buttons = strdup(""); + for (i = 0; i < MAX_AF_FILES; i++) + { + if (((fl = csp->actions_list[i]) != NULL) && ((b = fl->f) != NULL)) + { + for (b = b->next; NULL != b; b = b->next) + { + if (!strncmp(b->url->spec, "standard.", 9) && *(b->url->spec + 9) != '\0') + { + if (err) + { + freez(buttons); + free(section_template); + edit_free_file(file); + free_map(exports); + return JB_ERR_MEMORY; + } + + section_exports = new_map(); + err = map(section_exports, "button-name", 1, b->url->spec + 9, 1); + + if (err || (NULL == (s = strdup(section_template)))) + { + free_map(section_exports); + freez(buttons); + free(section_template); + edit_free_file(file); + free_map(exports); + return JB_ERR_MEMORY; + } + + if (!err) err = template_fill(&s, section_exports); + free_map(section_exports); + if (!err) err = string_join(&buttons, s); + } + } + } + } + freez(section_template); + if (!err) err = map(exports, "all-urls-buttons", 1, buttons, 0); + + /* + * Conventional actions file, supply extra editing help. + * (e.g. don't allow them to make it an unconventional one). + */ + if (!err) err = map_conditional(exports, "all-urls-present", 1); + + snprintf(buf, sizeof(buf), "%u", line_number); + if (!err) err = map(exports, "all-urls-s", 1, buf, 1); + snprintf(buf, sizeof(buf), "%u", line_number + 2); + if (!err) err = map(exports, "all-urls-s-next", 1, buf, 1); + if (!err) err = map(exports, "all-urls-actions", 1, + actions_to_html(csp, cur_line->data.action), 0); + + /* Skip the 2 lines */ + cur_line = cur_line->next->next; + line_number += 2; + + /* + * Note that prev_section_line_number is NOT set here. + * This is deliberate and not a bug. It stops a "Move up" + * option appearing on the next section. Clicking "Move + * up" would make the actions file unconventional, which + * we don't want, so we hide this option. + */ + } + else + { + /* + * Non-standard actions file - does not begin with + * the "All URLs" section. + */ + if (!err) err = map_conditional(exports, "all-urls-present", 0); + } + + /* Set up global exports */ + + if (!err) err = map(exports, "actions-file", 1, html_encode(file->filename), 0); + if (!err) err = map(exports, "f", 1, stringify(file->identifier), 0); + if (!err) err = map(exports, "v", 1, file->version_str, 1); + + /* Discourage private additions to default.action */ + + if (!err) err = map_conditional(exports, "default-action", + (strstr("default.action", file->filename) != NULL)); + if (err) + { + edit_free_file(file); + free_map(exports); + return err; + } + + /* Should do all global exports above this point */ + + /* Load templates */ + + err = template_load(csp, §ion_template, "edit-actions-list-section", 0); + if (err) + { + edit_free_file(file); + free_map(exports); + if (err == JB_ERR_FILE) + { + return cgi_error_no_template(csp, rsp, "edit-actions-list-section"); + } + return err; + } + + err = template_load(csp, &url_template, "edit-actions-list-url", 0); + if (err) + { + free(section_template); + edit_free_file(file); + free_map(exports); + if (err == JB_ERR_FILE) + { + return cgi_error_no_template(csp, rsp, "edit-actions-list-url"); + } + return err; + } + + err = template_fill(§ion_template, exports); + if (err) + { + free(url_template); + edit_free_file(file); + free_map(exports); + return err; + } + + err = template_fill(&url_template, exports); + if (err) + { + free(section_template); + edit_free_file(file); + free_map(exports); + return err; + } + + if (NULL == (sections = strdup(""))) + { + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + return JB_ERR_MEMORY; + } + + while ((cur_line != NULL) && (cur_line->type == FILE_LINE_ACTION)) + { + section_exports = new_map(); + + snprintf(buf, sizeof(buf), "%u", line_number); + err = map(section_exports, "s", 1, buf, 1); + if (!err) err = map(section_exports, "actions", 1, + actions_to_html(csp, cur_line->data.action), 0); + + if ((!err) + && (cur_line->next != NULL) + && (cur_line->next->type == FILE_LINE_URL)) + { + /* This section contains at least one URL, don't allow delete */ + err = map_block_killer(section_exports, "empty-section"); + } + else + { + if (!err) err = map_block_keep(section_exports, "empty-section"); + } + + if (prev_section_line_number != ((unsigned)(-1))) + { + /* Not last section */ + snprintf(buf, sizeof(buf), "%u", prev_section_line_number); + if (!err) err = map(section_exports, "s-prev", 1, buf, 1); + if (!err) err = map_block_keep(section_exports, "s-prev-exists"); + } + else + { + /* Last section */ + if (!err) err = map_block_killer(section_exports, "s-prev-exists"); + } + prev_section_line_number = line_number; + + if (err) + { + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return err; + } + + /* Should do all section-specific exports above this point */ + + if (NULL == (urls = strdup(""))) + { + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return JB_ERR_MEMORY; + } + + url_1_2 = 2; + + cur_line = cur_line->next; + line_number++; + + while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL)) + { + url_exports = new_map(); + + snprintf(buf, sizeof(buf), "%u", line_number); + err = map(url_exports, "p", 1, buf, 1); + + snprintf(buf, sizeof(buf), "%d", url_1_2); + if (!err) err = map(url_exports, "url-1-2", 1, buf, 1); + + if (!err) err = map(url_exports, "url-html", 1, + html_encode(cur_line->unprocessed), 0); + if (!err) err = map(url_exports, "url", 1, + url_encode(cur_line->unprocessed), 0); + + if (err) + { + free(urls); + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + free_map(url_exports); + return err; + } + + if (NULL == (s = strdup(url_template))) + { + free(urls); + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + free_map(url_exports); + return JB_ERR_MEMORY; + } + + err = template_fill(&s, section_exports); + if (!err) err = template_fill(&s, url_exports); + if (!err) err = string_append(&urls, s); + + free_map(url_exports); + freez(s); + + if (err) + { + freez(urls); + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return err; + } + + url_1_2 = 3 - url_1_2; + + cur_line = cur_line->next; + line_number++; + } + + err = map(section_exports, "urls", 1, urls, 0); + + /* Could also do section-specific exports here, but it wouldn't be as fast */ + + snprintf(buf, sizeof(buf), "%u", line_number); + if (!err) err = map(section_exports, "s-next", 1, buf, 1); + + if ((cur_line != NULL) + && (cur_line->type == FILE_LINE_ACTION)) + { + /* Not last section */ + if (!err) err = map_block_keep(section_exports, "s-next-exists"); + } + else + { + /* Last section */ + if (!err) err = map_block_killer(section_exports, "s-next-exists"); + } + + if (err) + { + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return err; + } + + if (NULL == (s = strdup(section_template))) + { + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return JB_ERR_MEMORY; + } + + err = template_fill(&s, section_exports); + if (!err) err = string_append(§ions, s); + + freez(s); + free_map(section_exports); + + if (err) + { + freez(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + return err; + } + } + + edit_free_file(file); + free(section_template); + free(url_template); + + err = map(exports, "sections", 1, sections, 0); + if (err) + { + free_map(exports); + return err; + } + + /* Could also do global exports here, but it wouldn't be as fast */ + + return template_fill_for_cgi(csp, "edit-actions-list", exports, rsp); +} + + +/********************************************************************* * - * Description : CGI function that allows the user to choose which - * actions file to edit. + * Function : cgi_edit_actions_for_url + * + * Description : CGI function that edits the Actions list. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters : None * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the CGI parameters are not + * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_edit_actions_for_url(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { + struct map * exports; + unsigned sectionid; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; + jb_err err; + struct re_filterfile_spec *filter_group; + int i, have_filters = 0; + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } + + err = get_number_param(csp, parameters, "s", §ionid); + if (err) + { + return err; + } + + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) + { + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } + + cur_line = file->lines; + + for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++) + { + cur_line = cur_line->next; + } + + if ( (cur_line == NULL) + || (line_number != sectionid) + || (sectionid < 1) + || (cur_line->type != FILE_LINE_ACTION)) + { + /* Invalid "sectionid" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + + if (NULL == (exports = default_exports(csp, NULL))) + { + edit_free_file(file); + return JB_ERR_MEMORY; + } + + err = map(exports, "f", 1, stringify(file->identifier), 0); + if (!err) err = map(exports, "v", 1, file->version_str, 1); + if (!err) err = map(exports, "s", 1, url_encode(lookup(parameters, "s")), 0); + + if (!err) err = actions_to_radio(exports, cur_line->data.action); + + /* + * XXX: Some browsers (at least IE6 and IE7) have an artificial URL + * length limitation and ignore clicks on the Submit buttons if + * the resulting GET URL would be longer than their limit. + * + * In Privoxy 3.0.5 beta the standard edit-actions-for-url template + * reached this limit and action editing stopped working in these + * browsers (BR #1570678). + * + * The config option split-large-forms works around this browser + * bug (HTTP has no URL length limitation) by deviding the action + * list form into multiple smaller ones. It means the URLs are shorter + * and work in broken browsers as well, but the user can no longer change + * all actions with one submit. + * + * A better solution would be to switch to POST requests, + * but this will do for now. + */ + if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_SPLIT_LARGE_FORMS)) + { + /* Generate multiple smaller form by killing the big one. */ + err = map_block_killer(exports, "one-form-only"); + } + else + { + /* Default: Generate one large form by killing the smaller ones. */ + err = map_block_killer(exports, "multiple-forms"); + } + + for (i = 0; i < MAX_AF_FILES; i++) + { + if ((csp->rlist[i] != NULL) && (csp->rlist[i]->f != NULL)) + { + if (!err) err = map_conditional(exports, "any-filters-defined", 1); + have_filters = 1; + break; + } + } + +#ifndef FEATURE_EXTERNAL_FILTERS + if (!err) err = map_block_killer(exports, "external-content-filters"); +#endif + + if (err) + { + edit_free_file(file); + free_map(exports); + return err; + } + + if (0 == have_filters) + { + err = map(exports, "filter-params", 1, "", 1); + } + else + { + /* + * List available filters and their settings. + */ + char *filter_template; + int filter_identifier = 0; + char *prepared_templates[MAX_FILTER_TYPES]; + + for (i = 0; i < MAX_FILTER_TYPES; i++) + { + prepared_templates[i] = strdup(""); + } + + err = template_load(csp, &filter_template, "edit-actions-for-url-filter", 0); + if (err) + { + edit_free_file(file); + free_map(exports); + if (err == JB_ERR_FILE) + { + return cgi_error_no_template(csp, rsp, "edit-actions-for-url-filter"); + } + return err; + } + + err = template_fill(&filter_template, exports); + + for (i = 0; i < MAX_AF_FILES; i++) + { + if ((csp->rlist[i] != NULL) && (csp->rlist[i]->f != NULL)) + { + filter_group = csp->rlist[i]->f; + for (;(!err) && (filter_group != NULL); filter_group = filter_group->next) + { + char current_mode = 'x'; + char number[20]; + struct list_entry *filter_name; + struct map *line_exports; + const enum filter_type type = filter_group->type; + const int multi_action_index = filter_type_info[type].multi_action_index; + + assert(type < MAX_FILTER_TYPES); + + filter_name = cur_line->data.action->multi_add[multi_action_index]->first; + while ((filter_name != NULL) + && (0 != strcmp(filter_group->name, filter_name->str))) + { + filter_name = filter_name->next; + } + + if (filter_name != NULL) + { + current_mode = 'y'; + } + else + { + filter_name = cur_line->data.action->multi_remove[multi_action_index]->first; + while ((filter_name != NULL) + && (0 != strcmp(filter_group->name, filter_name->str))) + { + filter_name = filter_name->next; + } + if (filter_name != NULL) + { + current_mode = 'n'; + } + } + + /* Generate a unique serial number */ + snprintf(number, sizeof(number), "%x", filter_identifier++); + number[sizeof(number) - 1] = '\0'; + + line_exports = new_map(); + if (line_exports == NULL) + { + err = JB_ERR_MEMORY; + } + else + { + char *filter_line; + + if (!err) err = map(line_exports, "index", 1, number, 1); + if (!err) err = map(line_exports, "name", 1, filter_group->name, 1); + if (!err) err = map(line_exports, "description", 1, filter_group->description, 1); + if (!err) err = map_radio(line_exports, "this-filter", "ynx", current_mode); + if (!err) err = map(line_exports, "filter-type", 1, filter_type_info[type].type, 1); + if (!err) err = map(line_exports, "abbr-filter-type", 1, filter_type_info[type].abbr_type, 1); + if (!err) err = map(line_exports, "anchor", 1, filter_type_info[type].anchor, 1); + + if (!err) + { + filter_line = strdup(filter_template); + if (filter_line == NULL) err = JB_ERR_MEMORY; + } + if (!err) err = template_fill(&filter_line, line_exports); + string_join(&prepared_templates[type], filter_line); + + free_map(line_exports); + } + } + } + } + freez(filter_template); - if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) - { - return cgi_error_disabled(csp, rsp); + /* Replace all filter macros with the aggregated templates */ + for (i = 0; i < MAX_FILTER_TYPES; i++) + { + if (err) break; + err = map(exports, filter_type_info[i].macro_name, 1, prepared_templates[i], 0); + } + + if (err) + { + /* Free aggregated templates */ + for (i = 0; i < MAX_FILTER_TYPES; i++) + { + freez(prepared_templates[i]); + } + } } - /* FIXME: Incomplete */ - rsp->status = strdup("302 Local Redirect from Junkbuster"); - if (rsp->status == NULL) + /* Check or uncheck the "disable all of this type" radio buttons. */ + for (i = 0; i < MAX_FILTER_TYPES; i++) { - return JB_ERR_MEMORY; + const int a = filter_type_info[i].multi_action_index; + const int disable_all = cur_line->data.action->multi_remove_all[a]; + if (err) break; + err = map_radio(exports, filter_type_info[i].disable_all_option, "nx", (disable_all ? 'n' : 'x')); } - if (enlist_unique_header(rsp->headers, "Location", "http://ijbswa.sourceforge.net/config/edit-actions-list?filename=edit")) + + edit_free_file(file); + + if (err) { - free(rsp->status); - rsp->status = NULL; - return JB_ERR_MEMORY; + free_map(exports); + return err; } - return JB_ERR_OK; + return template_fill_for_cgi(csp, "edit-actions-for-url", exports, rsp); } /********************************************************************* * - * Function : cgi_edit_actions_list + * Function : cgi_edit_actions_submit + * + * Description : CGI function that actually edits the Actions list. * - * Description : CGI function that edits the actions list. - * FIXME: This function shouldn't FATAL ever. - * FIXME: This function doesn't check the retval of map() * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * - * CGI Parameters : filename + * CGI Parameters : None * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory - * JB_ERR_FILE if the file cannot be opened or - * contains no data - * JB_ERR_CGI_PARAMS if "filename" was not specified - * or is not valid. + * JB_ERR_CGI_PARAMS if the CGI parameters are not + * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions_list(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_edit_actions_submit(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - char * section_template; - char * url_template; - char * sections; - char * urls; - char buf[50]; - char * s; - struct map * exports; - struct map * section_exports; - struct map * url_exports; + unsigned sectionid; + char * actiontext; + char * newtext; + size_t newtext_size; + size_t len; struct editable_file * file; struct file_line * cur_line; - unsigned line_number = 0; - int url_1_2; + unsigned line_number; + char target[1024]; jb_err err; + int filter_identifier; + int i; + const char * action_set_name; + struct file_list * fl; + struct url_actions * b; if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) { return cgi_error_disabled(csp, rsp); } - err = edit_read_actions_file(csp, rsp, parameters, 0, &file); + err = get_number_param(csp, parameters, "s", §ionid); if (err) { - /* No filename specified, can't read file, or out of memory. */ - return (err == JB_ERR_FILE ? JB_ERR_OK : err); + return err; } - if (NULL == (exports = default_exports(csp, NULL))) + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) { - edit_free_file(file); - return JB_ERR_MEMORY; + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); } - err = map(exports, "filename", 1, file->identifier, 1); - if (!err) err = map(exports, "ver", 1, file->version_str, 1); + cur_line = file->lines; - if (err) + for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++) { - edit_free_file(file); - free_map(exports); - return err; + cur_line = cur_line->next; } - /* Should do all global exports above this point */ - - err = template_load(csp, §ion_template, "edit-actions-list-section"); - if (err) + if ( (cur_line == NULL) + || (line_number != sectionid) + || (sectionid < 1) + || (cur_line->type != FILE_LINE_ACTION)) { + /* Invalid "sectionid" parameter */ edit_free_file(file); - free_map(exports); - if (err == JB_ERR_FILE) - { - return cgi_error_no_template(csp, rsp, "edit-actions-list-section"); - } - return err; + return JB_ERR_CGI_PARAMS; } - err = template_load(csp, &url_template, "edit-actions-list-url"); - if (err) + get_string_param(parameters, "p", &action_set_name); + if (action_set_name != NULL) { - free(section_template); - edit_free_file(file); - free_map(exports); - if (err == JB_ERR_FILE) + for (filter_identifier = 0; filter_identifier < MAX_AF_FILES; filter_identifier++) { - return cgi_error_no_template(csp, rsp, "edit-actions-list-url"); + if (((fl = csp->actions_list[filter_identifier]) != NULL) && ((b = fl->f) != NULL)) + { + for (b = b->next; NULL != b; b = b->next) + { + if (!strncmp(b->url->spec, "standard.", 9) && !strcmp(b->url->spec + 9, action_set_name)) + { + copy_action(cur_line->data.action, b->action); + goto found; + } + } + } } - return err; - } - - err = template_fill(§ion_template, exports); - if (err) - { - free(url_template); edit_free_file(file); - free_map(exports); - free(url_template); - return err; - } + return JB_ERR_CGI_PARAMS; - err = template_fill(&url_template, exports); - if (err) - { - free(section_template); - edit_free_file(file); - free_map(exports); - return err; + found: ; } - - /* Find start of actions in file */ - cur_line = file->lines; - line_number = 1; - while ((cur_line != NULL) && (cur_line->type != FILE_LINE_ACTION)) + else { - cur_line = cur_line->next; - line_number++; + err = actions_from_radio(parameters, cur_line->data.action); } - if (NULL == (sections = strdup(""))) + if (err) { - free(section_template); - free(url_template); + /* Out of memory */ edit_free_file(file); - free_map(exports); - return JB_ERR_MEMORY; + return err; } - while ((cur_line != NULL) && (cur_line->type == FILE_LINE_ACTION)) + /* Check the "disable all of this type" parameters. */ + for (i = 0; i < MAX_FILTER_TYPES; i++) { - if (NULL == (section_exports = new_map())) - { - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - return JB_ERR_MEMORY; - } - - snprintf(buf, 50, "%d", line_number); - err = map(section_exports, "sectionid", 1, buf, 1); - if (!err) err = map(section_exports, "actions", 1, - actions_to_html(cur_line->data.action), 0); + const int multi_action_index = filter_type_info[i].multi_action_index; + const char ch = get_char_param(parameters, filter_type_info[i].disable_all_param); - if ( (!err) - && (cur_line->next != NULL) - && (cur_line->next->type == FILE_LINE_URL)) + if (ch == 'N') { - /* This section contains at least one URL, don't allow delete */ - err = map_block_killer(section_exports, "empty-section"); + list_remove_all(cur_line->data.action->multi_add[multi_action_index]); + list_remove_all(cur_line->data.action->multi_remove[multi_action_index]); + cur_line->data.action->multi_remove_all[multi_action_index] = 1; } - - if (err) + else if (ch == 'X') { - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - free_map(section_exports); - return err; + cur_line->data.action->multi_remove_all[multi_action_index] = 0; } + } - /* Should do all section-specific exports above this point */ - - if (NULL == (urls = strdup(""))) + for (filter_identifier = 0; !err; filter_identifier++) + { + char key_value[30]; + char key_name[30]; + char key_type[30]; + const char *name; + char value; /* + * Filter state. Valid states are: 'Y' (active), + * 'N' (inactive) and 'X' (no change). + * XXX: bad name. + */ + char type; /* + * Abbreviated filter type. Valid types are: 'F' (content filter), + * 'S' (server-header filter) and 'C' (client-header filter). + */ + int multi_action_index = 0; + + /* Generate the keys */ + snprintf(key_value, sizeof(key_value), "filter_r%x", filter_identifier); + key_value[sizeof(key_value) - 1] = '\0'; /* XXX: Why? */ + snprintf(key_name, sizeof(key_name), "filter_n%x", filter_identifier); + key_name[sizeof(key_name) - 1] = '\0'; /* XXX: Why? */ + snprintf(key_type, sizeof(key_type), "filter_t%x", filter_identifier); + + err = get_string_param(parameters, key_name, &name); + if (err) break; + + if (name == NULL) { - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - free_map(section_exports); - return JB_ERR_MEMORY; + /* End of list */ + break; } - url_1_2 = 2; - - cur_line = cur_line->next; - line_number++; - - while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL)) + type = get_char_param(parameters, key_type); + switch (type) { - if (NULL == (url_exports = new_map())) - { - free(urls); - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - free_map(section_exports); - return JB_ERR_MEMORY; - } - - snprintf(buf, 50, "%d", line_number); - err = map(url_exports, "urlid", 1, buf, 1); - - snprintf(buf, 50, "%d", url_1_2); - if (!err) err = map(url_exports, "url-1-2", 1, buf, 1); - - if (!err) err = map(url_exports, "url-html", 1, - html_encode(cur_line->unprocessed), 0); - if (!err) err = map(url_exports, "url", 1, - url_encode(cur_line->unprocessed), 0); - - if (err) - { - free(urls); - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - free_map(section_exports); - free_map(url_exports); - return err; - } - - if (NULL == (s = strdup(url_template))) - { - free(urls); - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - free_map(section_exports); - free_map(url_exports); - return JB_ERR_MEMORY; - } - - err = template_fill(&s, section_exports); - if (!err) err = template_fill(&s, url_exports); - if (!err) err = string_append(&urls, s); - - free_map(url_exports); - freez(s); - - if (err) - { - freez(urls); - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - free_map(section_exports); - return err; - } - - url_1_2 = 3 - url_1_2; - - cur_line = cur_line->next; - line_number++; + case 'F': + multi_action_index = ACTION_MULTI_FILTER; + break; + case 'S': + multi_action_index = ACTION_MULTI_SERVER_HEADER_FILTER; + break; + case 'C': + multi_action_index = ACTION_MULTI_CLIENT_HEADER_FILTER; + break; + case 'L': + multi_action_index = ACTION_MULTI_CLIENT_HEADER_TAGGER; + break; + case 'E': + multi_action_index = ACTION_MULTI_SERVER_HEADER_TAGGER; + break; + default: + log_error(LOG_LEVEL_ERROR, + "Unknown filter type: %c for filter %s. Filter ignored.", type, name); + continue; } + assert(multi_action_index); - err = map(section_exports, "urls", 1, urls, 0); - - if (err) + value = get_char_param(parameters, key_value); + if (value == 'Y') { - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - free_map(section_exports); - return err; + list_remove_item(cur_line->data.action->multi_add[multi_action_index], name); + if (!err) err = enlist(cur_line->data.action->multi_add[multi_action_index], name); + list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name); } - - /* Could also do section-specific exports here, but it wouldn't be as fast */ - - if (NULL == (s = strdup(section_template))) + else if (value == 'N') { - free(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - free_map(section_exports); - return JB_ERR_MEMORY; + list_remove_item(cur_line->data.action->multi_add[multi_action_index], name); + if (!cur_line->data.action->multi_remove_all[multi_action_index]) + { + list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name); + if (!err) err = enlist(cur_line->data.action->multi_remove[multi_action_index], name); + } + } + else if (value == 'X') + { + list_remove_item(cur_line->data.action->multi_add[multi_action_index], name); + list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name); } + } - err = template_fill(&s, section_exports); - if (!err) err = string_append(§ions, s); + if (err) + { + /* Out of memory */ + edit_free_file(file); + return err; + } - freez(s); - free_map(section_exports); + if (NULL == (actiontext = actions_to_text(cur_line->data.action))) + { + /* Out of memory */ + edit_free_file(file); + return JB_ERR_MEMORY; + } - if (err) - { - freez(sections); - free(section_template); - free(url_template); - edit_free_file(file); - free_map(exports); - return err; - } + len = strlen(actiontext); + if (len == 0) + { + /* + * Empty action - must special-case this. + * Simply setting len to 1 is sufficient... + */ + len = 1; } - edit_free_file(file); - free(section_template); - free(url_template); + newtext_size = len + 2; + newtext = malloc_or_die(newtext_size); + strlcpy(newtext, actiontext, newtext_size); + free(actiontext); + newtext[0] = '{'; + newtext[len] = '}'; + newtext[len + 1] = '\0'; - err = map(exports, "sections", 1, sections, 0); + freez(cur_line->raw); + freez(cur_line->unprocessed); + cur_line->unprocessed = newtext; + + err = edit_write_file(file); if (err) { - free_map(exports); + /* Error writing file */ + if (err == JB_ERR_FILE) + { + /* Read-only file. */ + err = cgi_error_file_read_only(csp, rsp, file->filename); + } + edit_free_file(file); return err; } - /* Could also do global exports here, but it wouldn't be as fast */ + snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u", + (long) time(NULL), file->identifier, sectionid); - return template_fill_for_cgi(csp, "edit-actions-list", exports, rsp); + edit_free_file(file); + + return cgi_redirect(rsp, target); } /********************************************************************* * - * Function : cgi_edit_actions + * Function : cgi_edit_actions_url * - * Description : CGI function that edits the Actions list. + * Description : CGI function that actually edits a URL pattern in + * an actions file. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * - * CGI Parameters : None + * CGI Parameters : + * filename : Identifies the file to edit + * ver : File's last-modified time + * section : Line number of section to edit + * pattern : Line number of pattern to edit + * newval : New value for pattern * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -2939,23 +3227,39 @@ jb_err cgi_edit_actions_list(struct client_state *csp, * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions_for_url(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_edit_actions_url(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - struct map * exports; - unsigned sectionid; + unsigned patternid; + char * new_pattern; struct editable_file * file; struct file_line * cur_line; unsigned line_number; + unsigned section_start_line_number = 0; + char target[1024]; jb_err err; + assert(csp); + assert(rsp); + assert(parameters); + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) { return cgi_error_disabled(csp, rsp); } - err = get_number_param(csp, parameters, "section", §ionid); + err = get_number_param(csp, parameters, "p", &patternid); + if (err) + { + return err; + } + if (patternid < 1U) + { + return JB_ERR_CGI_PARAMS; + } + + err = get_url_spec_param(csp, parameters, "u", &new_pattern); if (err) { return err; @@ -2965,62 +3269,77 @@ jb_err cgi_edit_actions_for_url(struct client_state *csp, if (err) { /* No filename specified, can't read file, modified, or out of memory. */ + free(new_pattern); return (err == JB_ERR_FILE ? JB_ERR_OK : err); } + line_number = 1; cur_line = file->lines; - for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++) + while ((cur_line != NULL) && (line_number < patternid)) { + if (cur_line->type == FILE_LINE_ACTION) + { + section_start_line_number = line_number; + } cur_line = cur_line->next; + line_number++; } - if ( (cur_line == NULL) - || (line_number != sectionid) - || (sectionid < 1) - || (cur_line->type != FILE_LINE_ACTION)) + if ((cur_line == NULL) + || (cur_line->type != FILE_LINE_URL)) { - /* Invalid "sectionid" parameter */ + /* Invalid "patternid" parameter */ + free(new_pattern); edit_free_file(file); return JB_ERR_CGI_PARAMS; } - if (NULL == (exports = default_exports(csp, NULL))) - { - edit_free_file(file); - return JB_ERR_MEMORY; - } - - err = map(exports, "filename", 1, file->identifier, 1); - if (!err) err = map(exports, "ver", 1, file->version_str, 1); - if (!err) err = map(exports, "section", 1, lookup(parameters, "section"), 1); - - if (!err) err = actions_to_radio(exports, cur_line->data.action); + /* At this point, the line to edit is in cur_line */ - edit_free_file(file); + freez(cur_line->raw); + freez(cur_line->unprocessed); + cur_line->unprocessed = new_pattern; + err = edit_write_file(file); if (err) { - free_map(exports); + /* Error writing file */ + if (err == JB_ERR_FILE) + { + /* Read-only file. */ + err = cgi_error_file_read_only(csp, rsp, file->filename); + } + edit_free_file(file); return err; } - return template_fill_for_cgi(csp, "edit-actions-for-url", exports, rsp); + snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u", + (long) time(NULL), file->identifier, section_start_line_number); + + edit_free_file(file); + + return cgi_redirect(rsp, target); } /********************************************************************* * - * Function : cgi_edit_actions_submit + * Function : cgi_edit_actions_add_url * - * Description : CGI function that actually edits the Actions list. + * Description : CGI function that actually adds a URL pattern to + * an actions file. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * - * CGI Parameters : None + * CGI Parameters : + * filename : Identifies the file to edit + * ver : File's last-modified time + * section : Line number of section to edit + * newval : New pattern * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -3028,18 +3347,17 @@ jb_err cgi_edit_actions_for_url(struct client_state *csp, * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions_submit(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_edit_actions_add_url(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { unsigned sectionid; - char * actiontext; - char * newtext; - int len; + char * new_pattern; + struct file_line * new_line; struct editable_file * file; struct file_line * cur_line; unsigned line_number; - char * target; + char target[1024]; jb_err err; if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) @@ -3047,7 +3365,17 @@ jb_err cgi_edit_actions_submit(struct client_state *csp, return cgi_error_disabled(csp, rsp); } - err = get_number_param(csp, parameters, "section", §ionid); + err = get_number_param(csp, parameters, "s", §ionid); + if (err) + { + return err; + } + if (sectionid < 1U) + { + return JB_ERR_CGI_PARAMS; + } + + err = get_url_spec_param(csp, parameters, "u", &new_pattern); if (err) { return err; @@ -3057,118 +3385,83 @@ jb_err cgi_edit_actions_submit(struct client_state *csp, if (err) { /* No filename specified, can't read file, modified, or out of memory. */ + free(new_pattern); return (err == JB_ERR_FILE ? JB_ERR_OK : err); } + line_number = 1; cur_line = file->lines; - for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++) + while ((cur_line != NULL) && (line_number < sectionid)) { cur_line = cur_line->next; + line_number++; } - if ( (cur_line == NULL) - || (line_number != sectionid) - || (sectionid < 1) - || (cur_line->type != FILE_LINE_ACTION)) + if ((cur_line == NULL) + || (cur_line->type != FILE_LINE_ACTION)) { /* Invalid "sectionid" parameter */ + free(new_pattern); edit_free_file(file); return JB_ERR_CGI_PARAMS; } - err = actions_from_radio(parameters, cur_line->data.action); - if(err) - { - /* Out of memory */ - edit_free_file(file); - return err; - } + /* At this point, the section header is in cur_line - add after this. */ - if (NULL == (actiontext = actions_to_text(cur_line->data.action))) - { - /* Out of memory */ - edit_free_file(file); - return JB_ERR_MEMORY; - } + /* Allocate the new line */ + new_line = zalloc_or_die(sizeof(*new_line)); - len = strlen(actiontext); - if (len == 0) - { - /* - * Empty action - must special-case this. - * Simply setting len to 1 is sufficient... - */ - len = 1; - } + /* Fill in the data members of the new line */ + new_line->raw = NULL; + new_line->prefix = NULL; + new_line->unprocessed = new_pattern; + new_line->type = FILE_LINE_URL; - if (NULL == (newtext = malloc(len + 2))) - { - /* Out of memory */ - free(actiontext); - edit_free_file(file); - return JB_ERR_MEMORY; - } - strcpy(newtext, actiontext); - free(actiontext); - newtext[0] = '{'; - newtext[len] = '}'; - newtext[len + 1] = '\0'; + /* Link new_line into the list, after cur_line */ + new_line->next = cur_line->next; + cur_line->next = new_line; - freez(cur_line->raw); - freez(cur_line->unprocessed); - cur_line->unprocessed = newtext; + /* Done making changes, now commit */ err = edit_write_file(file); if (err) { /* Error writing file */ + if (err == JB_ERR_FILE) + { + /* Read-only file. */ + err = cgi_error_file_read_only(csp, rsp, file->filename); + } edit_free_file(file); return err; } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); - string_append(&target, file->identifier); + snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u", + (long) time(NULL), file->identifier, sectionid); edit_free_file(file); - if (target == NULL) - { - /* Out of memory */ - return JB_ERR_MEMORY; - } - - rsp->status = strdup("302 Local Redirect from Junkbuster"); - if (rsp->status == NULL) - { - free(target); - return JB_ERR_MEMORY; - } - err = enlist_unique_header(rsp->headers, "Location", target); - free(target); - - return err; + return cgi_redirect(rsp, target); } /********************************************************************* * - * Function : cgi_edit_actions_url + * Function : cgi_edit_actions_remove_url * - * Description : CGI function that actually edits a URL pattern in - * an actions file. + * Description : CGI function that actually removes a URL pattern from + * the actions file. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters : - * filename : Identifies the file to edit - * ver : File's last-modified time - * section : Line number of section to edit - * pattern : Line number of pattern to edit - * newval : New value for pattern + * f : (filename) Identifies the file to edit + * v : (version) File's last-modified time + * p : (pattern) Line number of pattern to remove * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -3176,18 +3469,17 @@ jb_err cgi_edit_actions_submit(struct client_state *csp, * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions_url(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_edit_actions_remove_url(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - unsigned sectionid; unsigned patternid; - const char * newval; - char * new_pattern; struct editable_file * file; struct file_line * cur_line; + struct file_line * prev_line; unsigned line_number; - char * target; + unsigned section_start_line_number = 0; + char target[1024]; jb_err err; if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) @@ -3195,25 +3487,12 @@ jb_err cgi_edit_actions_url(struct client_state *csp, return cgi_error_disabled(csp, rsp); } - err = get_number_param(csp, parameters, "section", §ionid); + err = get_number_param(csp, parameters, "p", &patternid); if (err) { return err; } - err = get_number_param(csp, parameters, "pattern", &patternid); - if (err) - { - return err; - } - - newval = lookup(parameters, "newval"); - - if ((*newval == '\0') || (sectionid < 1U) || (patternid < 1U)) - { - return JB_ERR_CGI_PARAMS; - } - err = edit_read_actions_file(csp, rsp, parameters, 1, &file); if (err) { @@ -3222,106 +3501,79 @@ jb_err cgi_edit_actions_url(struct client_state *csp, } line_number = 1; + prev_line = NULL; cur_line = file->lines; - while ((cur_line != NULL) && (line_number < sectionid)) + while ((cur_line != NULL) && (line_number < patternid)) { + if (cur_line->type == FILE_LINE_ACTION) + { + section_start_line_number = line_number; + } + prev_line = cur_line; cur_line = cur_line->next; line_number++; } if ( (cur_line == NULL) - || (cur_line->type != FILE_LINE_ACTION)) - { - /* Invalid "sectionid" parameter */ - edit_free_file(file); - return JB_ERR_CGI_PARAMS; - } - - while (line_number < patternid) - { - cur_line = cur_line->next; - line_number++; - - if ( (cur_line == NULL) - || ( (cur_line->type != FILE_LINE_URL) - && (cur_line->type != FILE_LINE_BLANK) ) ) - { - /* Invalid "patternid" parameter */ - edit_free_file(file); - return JB_ERR_CGI_PARAMS; - } - } - - if (cur_line->type != FILE_LINE_URL) + || (prev_line == NULL) + || (cur_line->type != FILE_LINE_URL)) { /* Invalid "patternid" parameter */ edit_free_file(file); return JB_ERR_CGI_PARAMS; } - /* At this point, the line to edit is in cur_line */ + /* At this point, the line to remove is in cur_line, and the previous + * one is in prev_line + */ - new_pattern = strdup(newval); - if (NULL == new_pattern) - { - edit_free_file(file); - return JB_ERR_MEMORY; - } + /* Unlink cur_line */ + prev_line->next = cur_line->next; + cur_line->next = NULL; - freez(cur_line->raw); - freez(cur_line->unprocessed); - cur_line->unprocessed = new_pattern; + /* Free cur_line */ + edit_free_file_lines(cur_line); err = edit_write_file(file); if (err) { /* Error writing file */ + if (err == JB_ERR_FILE) + { + /* Read-only file. */ + err = cgi_error_file_read_only(csp, rsp, file->filename); + } edit_free_file(file); return err; } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); - string_append(&target, file->identifier); + snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u#l%u", + (long) time(NULL), file->identifier, section_start_line_number); edit_free_file(file); - if (target == NULL) - { - /* Out of memory */ - return JB_ERR_MEMORY; - } - - rsp->status = strdup("302 Local Redirect from Junkbuster"); - if (rsp->status == NULL) - { - free(target); - return JB_ERR_MEMORY; - } - err = enlist_unique_header(rsp->headers, "Location", target); - free(target); - - return err; + return cgi_redirect(rsp, target); } /********************************************************************* * - * Function : cgi_edit_actions_add_url + * Function : cgi_edit_actions_section_remove * - * Description : CGI function that actually adds a URL pattern to - * an actions file. + * Description : CGI function that actually removes a whole section from + * the actions file. The section must be empty first + * (else JB_ERR_CGI_PARAMS). * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters : - * filename : Identifies the file to edit - * ver : File's last-modified time - * section : Line number of section to edit - * newval : New pattern + * f : (filename) Identifies the file to edit + * v : (version) File's last-modified time + * s : (section) Line number of section to edit * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -3329,18 +3581,16 @@ jb_err cgi_edit_actions_url(struct client_state *csp, * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions_add_url(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_edit_actions_section_remove(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { unsigned sectionid; - const char * newval; - char * new_pattern; - struct file_line * new_line; struct editable_file * file; struct file_line * cur_line; + struct file_line * prev_line; unsigned line_number; - char * target; + char target[1024]; jb_err err; if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) @@ -3348,19 +3598,12 @@ jb_err cgi_edit_actions_add_url(struct client_state *csp, return cgi_error_disabled(csp, rsp); } - err = get_number_param(csp, parameters, "section", §ionid); + err = get_number_param(csp, parameters, "s", §ionid); if (err) { return err; } - newval = lookup(parameters, "newval"); - - if ((*newval == '\0') || (sectionid < 1U)) - { - return JB_ERR_CGI_PARAMS; - } - err = edit_read_actions_file(csp, rsp, parameters, 1, &file); if (err) { @@ -3371,99 +3614,88 @@ jb_err cgi_edit_actions_add_url(struct client_state *csp, line_number = 1; cur_line = file->lines; + prev_line = NULL; while ((cur_line != NULL) && (line_number < sectionid)) { + prev_line = cur_line; cur_line = cur_line->next; line_number++; } - if ( (cur_line == NULL) - || (cur_line->type != FILE_LINE_ACTION)) + if ((cur_line == NULL) + || (cur_line->type != FILE_LINE_ACTION)) { /* Invalid "sectionid" parameter */ edit_free_file(file); return JB_ERR_CGI_PARAMS; } - /* At this point, the section header is in cur_line - add after this. */ - - new_pattern = strdup(newval); - if (NULL == new_pattern) + if ((cur_line->next != NULL) + && (cur_line->next->type == FILE_LINE_URL)) { + /* Section not empty. */ edit_free_file(file); - return JB_ERR_MEMORY; + return JB_ERR_CGI_PARAMS; } - /* Allocate the new line */ - new_line = (struct file_line *)zalloc(sizeof(*new_line)); - if (new_line == NULL) + /* At this point, the line to remove is in cur_line, and the previous + * one is in prev_line + */ + + /* Unlink cur_line */ + if (prev_line == NULL) { - free(new_pattern); - edit_free_file(file); - return JB_ERR_MEMORY; + /* Removing the first line from the file */ + file->lines = cur_line->next; } + else + { + prev_line->next = cur_line->next; + } + cur_line->next = NULL; - /* Fill in the data members of the new line */ - new_line->raw = NULL; - new_line->prefix = NULL; - new_line->unprocessed = new_pattern; - new_line->type = FILE_LINE_URL; - - /* Link new_line into the list, after cur_line */ - new_line->next = cur_line->next; - cur_line->next = new_line; - - /* Done making changes, now commit */ + /* Free cur_line */ + edit_free_file_lines(cur_line); err = edit_write_file(file); if (err) { /* Error writing file */ + if (err == JB_ERR_FILE) + { + /* Read-only file. */ + err = cgi_error_file_read_only(csp, rsp, file->filename); + } edit_free_file(file); return err; } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); - string_append(&target, file->identifier); + snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u", + (long) time(NULL), file->identifier); edit_free_file(file); - if (target == NULL) - { - /* Out of memory */ - return JB_ERR_MEMORY; - } - - rsp->status = strdup("302 Local Redirect from Junkbuster"); - if (rsp->status == NULL) - { - free(target); - return JB_ERR_MEMORY; - } - err = enlist_unique_header(rsp->headers, "Location", target); - free(target); - - return err; + return cgi_redirect(rsp, target); } /********************************************************************* * - * Function : cgi_edit_actions_remove_url + * Function : cgi_edit_actions_section_add * - * Description : CGI function that actually removes a URL pattern from - * the actions file. + * Description : CGI function that adds a new empty section to + * an actions file. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters : - * filename : Identifies the file to edit - * ver : File's last-modified time - * section : Line number of section to edit - * pattern : Line number of pattern to edit + * f : (filename) Identifies the file to edit + * v : (version) File's last-modified time + * s : (section) Line number of section to add after, 0 for + * start of file. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -3471,17 +3703,17 @@ jb_err cgi_edit_actions_add_url(struct client_state *csp, * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions_remove_url(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_edit_actions_section_add(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { unsigned sectionid; - unsigned patternid; + struct file_line * new_line; + char * new_text; struct editable_file * file; struct file_line * cur_line; - struct file_line * prev_line; unsigned line_number; - char * target; + char target[1024]; jb_err err; if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) @@ -3489,19 +3721,12 @@ jb_err cgi_edit_actions_remove_url(struct client_state *csp, return cgi_error_disabled(csp, rsp); } - err = get_number_param(csp, parameters, "section", §ionid); + err = get_number_param(csp, parameters, "s", §ionid); if (err) { return err; } - err = get_number_param(csp, parameters, "pattern", &patternid); - if (err) - { - return err; - } - - err = edit_read_actions_file(csp, rsp, parameters, 1, &file); if (err) { @@ -3512,107 +3737,131 @@ jb_err cgi_edit_actions_remove_url(struct client_state *csp, line_number = 1; cur_line = file->lines; - while ((cur_line != NULL) && (line_number < sectionid)) - { - cur_line = cur_line->next; - line_number++; - } - - if ( (cur_line == NULL) - || (cur_line->type != FILE_LINE_ACTION)) + if (sectionid <= 1U) { - /* Invalid "sectionid" parameter */ - edit_free_file(file); - return JB_ERR_CGI_PARAMS; + /* Add to start of file */ + if (cur_line != NULL && cur_line->type != FILE_LINE_ACTION) + { + /* There's something in the file, find the line before the first + * action. + */ + while ((cur_line->next != NULL) + && (cur_line->next->type != FILE_LINE_ACTION)) + { + cur_line = cur_line->next; + line_number++; + } + } + else + { + /* File starts with action line, so insert at top */ + cur_line = NULL; + } } - - prev_line = NULL; - while (line_number < patternid) + else { - prev_line = cur_line; - cur_line = cur_line->next; - line_number++; + /* Add after stated section. */ + while ((cur_line != NULL) && (line_number < sectionid)) + { + cur_line = cur_line->next; + line_number++; + } - if ( (cur_line == NULL) - || ( (cur_line->type != FILE_LINE_URL) - && (cur_line->type != FILE_LINE_BLANK) ) ) + if ((cur_line == NULL) + || (cur_line->type != FILE_LINE_ACTION)) { - /* Invalid "patternid" parameter */ + /* Invalid "sectionid" parameter */ edit_free_file(file); return JB_ERR_CGI_PARAMS; } + + /* Skip through the section to find the last line in it. */ + while ((cur_line->next != NULL) + && (cur_line->next->type != FILE_LINE_ACTION)) + { + cur_line = cur_line->next; + line_number++; + } } - if (cur_line->type != FILE_LINE_URL) + /* At this point, the last line in the previous section is in cur_line + * - add after this. (Or if we need to add as the first line, cur_line + * will be NULL). + */ + + new_text = strdup("{}"); + if (NULL == new_text) { - /* Invalid "patternid" parameter */ edit_free_file(file); - return JB_ERR_CGI_PARAMS; + return JB_ERR_MEMORY; } - assert(prev_line); + /* Allocate the new line */ + new_line = zalloc_or_die(sizeof(*new_line)); - /* At this point, the line to remove is in cur_line, and the previous - * one is in prev_line - */ + /* Fill in the data members of the new line */ + new_line->raw = NULL; + new_line->prefix = NULL; + new_line->unprocessed = new_text; + new_line->type = FILE_LINE_ACTION; - /* Unlink cur_line */ - prev_line->next = cur_line->next; - cur_line->next = NULL; + if (cur_line != NULL) + { + /* Link new_line into the list, after cur_line */ + new_line->next = cur_line->next; + cur_line->next = new_line; + } + else + { + /* Link new_line into the list, as first line */ + new_line->next = file->lines; + file->lines = new_line; + } - /* Free cur_line */ - edit_free_file_lines(cur_line); + /* Done making changes, now commit */ err = edit_write_file(file); if (err) { /* Error writing file */ + if (err == JB_ERR_FILE) + { + /* Read-only file. */ + err = cgi_error_file_read_only(csp, rsp, file->filename); + } edit_free_file(file); return err; } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); - string_append(&target, file->identifier); + snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u", + (long) time(NULL), file->identifier); edit_free_file(file); - if (target == NULL) - { - /* Out of memory */ - return JB_ERR_MEMORY; - } - - rsp->status = strdup("302 Local Redirect from Junkbuster"); - if (rsp->status == NULL) - { - free(target); - return JB_ERR_MEMORY; - } - err = enlist_unique_header(rsp->headers, "Location", target); - free(target); - - return err; + return cgi_redirect(rsp, target); } /********************************************************************* * - * Function : cgi_edit_actions_section_remove + * Function : cgi_edit_actions_section_swap * - * Description : CGI function that actually removes a whole section from - * the actions file. The section must be empty first - * (else JB_ERR_CGI_PARAMS). + * Description : CGI function that swaps the order of two sections + * in the actions file. Note that this CGI can actually + * swap any two arbitrary sections, but the GUI interface + * currently only allows consecutive sections to be + * specified. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters : - * filename : Identifies the file to edit - * ver : File's last-modified time - * section : Line number of section to edit - * pattern : Line number of pattern to edit + * f : (filename) Identifies the file to edit + * v : (version) File's last-modified time + * s1 : (section1) Line number of first section to swap + * s2 : (section2) Line number of second section to swap * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -3620,16 +3869,25 @@ jb_err cgi_edit_actions_remove_url(struct client_state *csp, * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions_section_remove(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_edit_actions_section_swap(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - unsigned sectionid; + unsigned section1; + unsigned section2; struct editable_file * file; struct file_line * cur_line; struct file_line * prev_line; + struct file_line * line_before_section1; + struct file_line * line_start_section1; + struct file_line * line_end_section1; + struct file_line * line_after_section1; + struct file_line * line_before_section2; + struct file_line * line_start_section2; + struct file_line * line_end_section2; + struct file_line * line_after_section2; unsigned line_number; - char * target; + char target[1024]; jb_err err; if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) @@ -3637,12 +3895,20 @@ jb_err cgi_edit_actions_section_remove(struct client_state *csp, return cgi_error_disabled(csp, rsp); } - err = get_number_param(csp, parameters, "section", §ionid); + err = get_number_param(csp, parameters, "s1", §ion1); + if (!err) err = get_number_param(csp, parameters, "s2", §ion2); if (err) { return err; } + if (section1 > section2) + { + unsigned temp = section2; + section2 = section1; + section1 = temp; + } + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); if (err) { @@ -3650,258 +3916,438 @@ jb_err cgi_edit_actions_section_remove(struct client_state *csp, return (err == JB_ERR_FILE ? JB_ERR_OK : err); } + /* Start at the beginning... */ line_number = 1; cur_line = file->lines; - prev_line = NULL; - while ((cur_line != NULL) && (line_number < sectionid)) + + /* ... find section1 ... */ + while ((cur_line != NULL) && (line_number < section1)) { prev_line = cur_line; cur_line = cur_line->next; line_number++; } - if ( (cur_line == NULL) - || (cur_line->type != FILE_LINE_ACTION) ) + if ((cur_line == NULL) + || (cur_line->type != FILE_LINE_ACTION)) { - /* Invalid "sectionid" parameter */ + /* Invalid "section1" parameter */ edit_free_file(file); return JB_ERR_CGI_PARAMS; } - if ( (cur_line->next != NULL) - && (cur_line->next->type == FILE_LINE_URL) ) + /* If no-op, we've validated params and can skip the rest. */ + if (section1 != section2) { - /* Section not empty. */ - edit_free_file(file); - return JB_ERR_CGI_PARAMS; - } + /* ... find the end of section1 ... */ + line_before_section1 = prev_line; + line_start_section1 = cur_line; + do + { + prev_line = cur_line; + cur_line = cur_line->next; + line_number++; + } + while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL)); + line_end_section1 = prev_line; + line_after_section1 = cur_line; - /* At this point, the line to remove is in cur_line, and the previous - * one is in prev_line - */ + /* ... find section2 ... */ + while ((cur_line != NULL) && (line_number < section2)) + { + prev_line = cur_line; + cur_line = cur_line->next; + line_number++; + } - /* Unlink cur_line */ - if (prev_line == NULL) + if ((cur_line == NULL) + || (cur_line->type != FILE_LINE_ACTION)) + { + /* Invalid "section2" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + + /* ... find the end of section2 ... */ + line_before_section2 = prev_line; + line_start_section2 = cur_line; + do + { + prev_line = cur_line; + cur_line = cur_line->next; + line_number++; + } + while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL)); + line_end_section2 = prev_line; + line_after_section2 = cur_line; + + /* Now have all the pointers we need. Do the swap. */ + + /* Change the pointer to section1 to point to section2 instead */ + if (line_before_section1 == NULL) + { + file->lines = line_start_section2; + } + else + { + line_before_section1->next = line_start_section2; + } + + if (line_before_section2 == line_end_section1) + { + /* Consecutive sections */ + line_end_section2->next = line_start_section1; + } + else + { + line_end_section2->next = line_after_section1; + line_before_section2->next = line_start_section1; + } + + /* Set the pointer from the end of section1 to the rest of the file */ + line_end_section1->next = line_after_section2; + + err = edit_write_file(file); + if (err) + { + /* Error writing file */ + if (err == JB_ERR_FILE) + { + /* Read-only file. */ + err = cgi_error_file_read_only(csp, rsp, file->filename); + } + edit_free_file(file); + return err; + } + } /* END if (section1 != section2) */ + + snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u", + (long) time(NULL), file->identifier); + + edit_free_file(file); + + return cgi_redirect(rsp, target); +} + + +/********************************************************************* + * + * Function : javascriptify + * + * Description : Converts a string into a form JavaScript will like. + * + * Netscape 4's JavaScript sucks - it doesn't use + * "id" parameters, so you have to set the "name" + * used to submit a form element to something JavaScript + * will like. (Or access the elements by index in an + * array. That array contains >60 elements and will + * be changed whenever we add a new action to the + * editor, so I'm NOT going to use indexes that have + * to be figured out by hand.) + * + * Currently the only thing we have to worry about + * is "-" ==> "_" conversion. + * + * This is a length-preserving operation so it is + * carried out in-place, no memory is allocated + * or freed. + * + * Parameters : + * 1 : identifier = String to make JavaScript-friendly. + * + * Returns : N/A + * + *********************************************************************/ +static void javascriptify(char * identifier) +{ + char * p = identifier; + while (NULL != (p = strchr(p, '-'))) { - /* Removing the first line from the file */ - file->lines = cur_line->next; + *p++ = '_'; } - else - { - prev_line->next = cur_line->next; +} + + +/********************************************************************* + * + * Function : actions_to_radio + * + * Description : Converts a actionsfile entry into settings for + * radio buttons and edit boxes on a HTML form. + * + * Parameters : + * 1 : exports = List of substitutions to add to. + * 2 : action = Action to read + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * + *********************************************************************/ +static jb_err actions_to_radio(struct map * exports, + const struct action_spec *action) +{ + unsigned long mask; + unsigned long add; + int mapped_param; + int checked; + char current_mode; + + assert(exports); + assert(action); + + mask = action->mask; + add = action->add; + + /* sanity - prevents "-feature +feature" */ + mask |= add; + + +#define DEFINE_ACTION_BOOL(name, bit) \ + if (!(mask & bit)) \ + { \ + current_mode = 'n'; \ + } \ + else if (add & bit) \ + { \ + current_mode = 'y'; \ + } \ + else \ + { \ + current_mode = 'x'; \ + } \ + if (map_radio(exports, name, "ynx", current_mode)) \ + { \ + return JB_ERR_MEMORY; \ } - cur_line->next = NULL; - /* Free cur_line */ - edit_free_file_lines(cur_line); +#define DEFINE_ACTION_STRING(name, bit, index) \ + DEFINE_ACTION_BOOL(name, bit); \ + mapped_param = 0; - err = edit_write_file(file); - if (err) - { - /* Error writing file */ - edit_free_file(file); - return err; +#define DEFINE_CGI_PARAM_RADIO(name, bit, index, value, is_default) \ + if (add & bit) \ + { \ + checked = !strcmp(action->string[index], value); \ + } \ + else \ + { \ + checked = is_default; \ + } \ + mapped_param |= checked; \ + if (map(exports, name "-param-" value, 1, (checked ? "checked" : ""), 1)) \ + { \ + return JB_ERR_MEMORY; \ } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); - string_append(&target, file->identifier); +#define DEFINE_CGI_PARAM_CUSTOM(name, bit, index, default_val) \ + if (map(exports, name "-param-custom", 1, \ + ((!mapped_param) ? "checked" : ""), 1)) \ + { \ + return JB_ERR_MEMORY; \ + } \ + if (map(exports, name "-param", 1, \ + (((add & bit) && !mapped_param) ? \ + action->string[index] : default_val), 1)) \ + { \ + return JB_ERR_MEMORY; \ + } - edit_free_file(file); +#define DEFINE_CGI_PARAM_NO_RADIO(name, bit, index, default_val) \ + if (map(exports, name "-param", 1, \ + ((add & bit) ? action->string[index] : default_val), 1)) \ + { \ + return JB_ERR_MEMORY; \ + } - if (target == NULL) - { - /* Out of memory */ - return JB_ERR_MEMORY; +#define DEFINE_ACTION_MULTI(name, index) \ + if (action->multi_add[index]->first) \ + { \ + current_mode = 'y'; \ + } \ + else if (action->multi_remove_all[index]) \ + { \ + current_mode = 'n'; \ + } \ + else if (action->multi_remove[index]->first) \ + { \ + current_mode = 'y'; \ + } \ + else \ + { \ + current_mode = 'x'; \ + } \ + if (map_radio(exports, name, "ynx", current_mode)) \ + { \ + return JB_ERR_MEMORY; \ } - rsp->status = strdup("302 Local Redirect from Junkbuster"); - if (rsp->status == NULL) - { - free(target); - return JB_ERR_MEMORY; - } - err = enlist_unique_header(rsp->headers, "Location", target); - free(target); +#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 +#undef DEFINE_CGI_PARAM_CUSTOM +#undef DEFINE_CGI_PARAM_RADIO +#undef DEFINE_CGI_PARAM_NO_RADIO - return err; + return JB_ERR_OK; } /********************************************************************* * - * Function : cgi_edit_actions_section_add + * Function : actions_from_radio * - * Description : CGI function that adds a new empty section to - * an actions file. + * Description : Converts a map of parameters passed to a CGI function + * into an actionsfile entry. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters - * - * CGI Parameters : - * filename : Identifies the file to edit - * ver : File's last-modified time - * section : Line number of section to add after, 0 for start - * of file. + * 1 : parameters = parameters to the CGI call + * 2 : action = Action to change. Must be valid before + * the call, actions not specified will be + * left unchanged. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory - * JB_ERR_CGI_PARAMS if the CGI parameters are not - * specified or not valid. * *********************************************************************/ -jb_err cgi_edit_actions_section_add(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +static jb_err actions_from_radio(const struct map * parameters, + struct action_spec *action) { - unsigned sectionid; - struct file_line * new_line; - char * new_text; - struct editable_file * file; - struct file_line * cur_line; - unsigned line_number; - char * target; - jb_err err; - - if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) - { - return cgi_error_disabled(csp, rsp); - } - - err = get_number_param(csp, parameters, "section", §ionid); - if (err) - { - return err; - } - - err = edit_read_actions_file(csp, rsp, parameters, 1, &file); - if (err) - { - /* No filename specified, can't read file, modified, or out of memory. */ - return (err == JB_ERR_FILE ? JB_ERR_OK : err); - } - - line_number = 1; - cur_line = file->lines; - - if (sectionid < 1U) - { - /* Add to start of file */ - if (cur_line != NULL) - { - /* There's something in the file, find the line before the first - * action. - */ - while ( (cur_line->next != NULL) - && (cur_line->next->type != FILE_LINE_ACTION) ) - { - cur_line = cur_line->next; - line_number++; - } - } - } - else - { - /* Add after stated section. */ - while ((cur_line != NULL) && (line_number < sectionid)) - { - cur_line = cur_line->next; - line_number++; - } - - if ( (cur_line == NULL) - || (cur_line->type != FILE_LINE_ACTION)) - { - /* Invalid "sectionid" parameter */ - edit_free_file(file); - return JB_ERR_CGI_PARAMS; - } + const char * param; + char * param_dup; + char ch; + const char * js_name; + jb_err err = JB_ERR_OK; - /* Skip through the section to find the last line in it. */ - while ( (cur_line->next != NULL) - && (cur_line->next->type != FILE_LINE_ACTION) ) - { - cur_line = cur_line->next; - line_number++; - } - } + assert(parameters); + assert(action); - /* At this point, the last line in the previous section is in cur_line - * - add after this. (Or if we need to add as the first line, cur_line - * will be NULL). + /* Statics are generally a potential race condition, + * but in this case we're safe and don't need semaphores. + * Be careful if you modify this function. + * - Jon + * The js_name_arr's are never free()d, but this is no + * problem, since they will only be created once and + * used by all threads thereafter. -oes */ - new_text = strdup("{}"); - if (NULL == new_text) - { - edit_free_file(file); - return JB_ERR_MEMORY; - } - - /* Allocate the new line */ - new_line = (struct file_line *)zalloc(sizeof(*new_line)); - if (new_line == NULL) - { - free(new_text); - edit_free_file(file); - return JB_ERR_MEMORY; - } - - /* Fill in the data members of the new line */ - new_line->raw = NULL; - new_line->prefix = NULL; - new_line->unprocessed = new_text; - new_line->type = FILE_LINE_ACTION; - - if (cur_line != NULL) - { - /* Link new_line into the list, after cur_line */ - new_line->next = cur_line->next; - cur_line->next = new_line; - } - else - { - /* Link new_line into the list, as first line */ - new_line->next = file->lines; - file->lines = new_line; - } +#define JAVASCRIPTIFY(dest_var, string) \ + { \ + static int first_time = 1; \ + static char *js_name_arr; \ + if (first_time) \ + { \ + js_name_arr = strdup(string); \ + javascriptify(js_name_arr); \ + } \ + dest_var = js_name_arr; \ + first_time = 0; \ + } \ - /* Done making changes, now commit */ +#define DEFINE_ACTION_BOOL(name, bit) \ + JAVASCRIPTIFY(js_name, name); \ + ch = get_char_param(parameters, js_name); \ + if (ch == 'Y') \ + { \ + action->add |= bit; \ + action->mask |= bit; \ + } \ + else if (ch == 'N') \ + { \ + action->add &= ~bit; \ + action->mask &= ~bit; \ + } \ + else if (ch == 'X') \ + { \ + action->add &= ~bit; \ + action->mask |= bit; \ + } \ - err = edit_write_file(file); - if (err) - { - /* Error writing file */ - edit_free_file(file); - return err; - } +#define DEFINE_ACTION_STRING(name, bit, index) \ + JAVASCRIPTIFY(js_name, name); \ + ch = get_char_param(parameters, js_name); \ + if (ch == 'Y') \ + { \ + param = NULL; \ + JAVASCRIPTIFY(js_name, name "-mode"); \ + if (!err) err = get_string_param(parameters, js_name, ¶m); \ + if ((param == NULL) || (0 == strcmp(param, "CUSTOM"))) \ + { \ + JAVASCRIPTIFY(js_name, name "-param"); \ + if (!err) err = get_string_param(parameters, js_name, ¶m); \ + } \ + if (param != NULL) \ + { \ + if (NULL == (param_dup = strdup(param))) \ + { \ + return JB_ERR_MEMORY; \ + } \ + freez(action->string[index]); \ + action->add |= bit; \ + action->mask |= bit; \ + action->string[index] = param_dup; \ + } \ + } \ + else if (ch == 'N') \ + { \ + if (action->add & bit) \ + { \ + freez(action->string[index]); \ + } \ + action->add &= ~bit; \ + action->mask &= ~bit; \ + } \ + else if (ch == 'X') \ + { \ + if (action->add & bit) \ + { \ + freez(action->string[index]); \ + } \ + action->add &= ~bit; \ + action->mask |= bit; \ + } \ - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); - string_append(&target, file->identifier); +#define DEFINE_ACTION_MULTI(name, index) \ + JAVASCRIPTIFY(js_name, name); \ + ch = get_char_param(parameters, js_name); \ + if (ch == 'Y') \ + { \ + /* FIXME */ \ + } \ + else if (ch == 'N') \ + { \ + list_remove_all(action->multi_add[index]); \ + list_remove_all(action->multi_remove[index]); \ + action->multi_remove_all[index] = 1; \ + } \ + else if (ch == 'X') \ + { \ + list_remove_all(action->multi_add[index]); \ + list_remove_all(action->multi_remove[index]); \ + action->multi_remove_all[index] = 0; \ + } \ - edit_free_file(file); +#define DEFINE_ACTION_ALIAS 0 /* No aliases for URL parsing */ - if (target == NULL) - { - /* Out of memory */ - return JB_ERR_MEMORY; - } +#include "actionlist.h" - rsp->status = strdup("302 Local Redirect from Junkbuster"); - if (rsp->status == NULL) - { - free(target); - return JB_ERR_MEMORY; - } - err = enlist_unique_header(rsp->headers, "Location", target); - free(target); +#undef DEFINE_ACTION_MULTI +#undef DEFINE_ACTION_STRING +#undef DEFINE_ACTION_BOOL +#undef DEFINE_ACTION_ALIAS +#undef JAVASCRIPTIFY return err; } +#endif /* def FEATURE_CGI_EDIT_ACTIONS */ +#ifdef FEATURE_TOGGLE /********************************************************************* * * Function : cgi_toggle @@ -3910,9 +4356,9 @@ jb_err cgi_edit_actions_section_add(struct client_state *csp, * an actions file. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters * * CGI Parameters : * set : If present, how to change toggle setting: @@ -3930,7 +4376,6 @@ jb_err cgi_toggle(struct client_state *csp, struct map *exports; char mode; const char *template_name; - jb_err err; assert(csp); assert(rsp); @@ -3941,45 +4386,38 @@ jb_err cgi_toggle(struct client_state *csp, return cgi_error_disabled(csp, rsp); } - if (NULL == (exports = default_exports(csp, "toggle"))) - { - return JB_ERR_MEMORY; - } - - mode = *(lookup(parameters, "set")); + mode = get_char_param(parameters, "set"); - if (mode == 'e') + if (mode == 'E') { /* Enable */ - g_bToggleIJB = 1; + global_toggle_state = 1; } - else if (mode == 'd') + else if (mode == 'D') { /* Disable */ - g_bToggleIJB = 0; + global_toggle_state = 0; } - else if (mode == 't') + else if (mode == 'T') { /* Toggle */ - g_bToggleIJB = !g_bToggleIJB; + global_toggle_state = !global_toggle_state; } - err = map_conditional(exports, "enabled", g_bToggleIJB); - if (err) + log_error(LOG_LEVEL_INFO, "Now toggled %s.", global_toggle_state ? "ON" : "OFF"); + + if (NULL == (exports = default_exports(csp, "toggle"))) { - free_map(exports); - return err; + return JB_ERR_MEMORY; } - template_name = (*(lookup(parameters, "mini")) + template_name = (get_char_param(parameters, "mini") ? "toggle-mini" : "toggle"); return template_fill_for_cgi(csp, template_name, exports, rsp); } - - -#endif /* def FEATURE_CGI_EDIT_ACTIONS */ +#endif /* def FEATURE_TOGGLE */ /*