X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgiedit.c;h=c6058e7ab128b9911cd445a7ef1c0ee037a96ac4;hp=1b0ca29ea2f9f3b5b767107419325c4565c17269;hb=c88fbf28546a609fb39415ccac6b97bfa1f5d185;hpb=4f72d7e5449fbbb7e7b4d3a9354ea55647ed3f1e diff --git a/cgiedit.c b/cgiedit.c index 1b0ca29e..c6058e7a 100644 --- a/cgiedit.c +++ b/cgiedit.c @@ -1,12 +1,19 @@ -const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.6 2001/10/29 03:48:09 david__schmidt Exp $"; +const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.19 2002/03/16 18:38:14 jongfoster Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $ * * Purpose : CGI-based actionsfile editor. * - * Functions declared include: + * Functions declared include: cgi_edit_* * + * 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 @@ -35,6 +42,87 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.6 2001/10/29 03:48:09 david__schm * * Revisions : * $Log: cgiedit.c,v $ + * Revision 1.19 2002/03/16 18:38:14 jongfoster + * Stopping stupid or malicious users from breaking the actions + * file using the web-based editor. + * + * Revision 1.18 2002/03/16 14:57:44 jongfoster + * Full support for enabling/disabling modular filters. + * + * Revision 1.17 2002/03/16 14:26:42 jongfoster + * First version of modular filters support - READ ONLY! + * Fixing a double-free bug in the out-of-memory handling in map_radio(). + * + * Revision 1.16 2002/03/07 03:46:17 oes + * Fixed compiler warnings + * + * Revision 1.15 2002/03/06 22:54:35 jongfoster + * Automated function-comment nitpicking. + * + * Revision 1.14 2002/03/05 00:24:51 jongfoster + * Patch to always edit the current actions file. + * + * Revision 1.13 2002/03/04 02:07:59 david__schmidt + * Enable web editing of actions file on OS/2 (it had been broken all this time!) + * + * Revision 1.12 2002/03/03 09:18:03 joergs + * Made jumbjuster work on AmigaOS again. + * + * Revision 1.11 2002/01/23 01:03:31 jongfoster + * Fixing gcc [CygWin] compiler warnings + * + * Revision 1.10 2002/01/23 00:22:59 jongfoster + * Adding new function cgi_edit_actions_section_swap(), to reorder + * the actions file. + * + * Adding get_url_spec_param() to get a validated URL pattern. + * + * Moving edit_read_line() out of this file and into loaders.c. + * + * Adding missing html_encode() to many CGI functions. + * + * Moving the functions that #include actionlist.h to the end of the file, + * because the Visual C++ 97 debugger gets extremely confused if you try + * to debug any code that comes after them in the file. + * + * Major optimizations in cgi_edit_actions_list() to reduce the size of + * the generated HTML (down 40% from 550k to 304k), with major side-effects + * throughout the editor and templates. In particular, the length of the + * URLs throughout the editor has been drastically reduced, by cutting + * paramater names down to 1 character and CGI names down to 3-4 + * characters, by removing all non-essential CGI paramaters even at the + * expense of having to re-read the actions file for the most trivial + * page, and by using relative rather than absolute URLs. This means + * that this (typical example): + * + * + * + * is now this: + * + * + * + * Revision 1.9 2002/01/17 20:56:22 jongfoster + * Replacing hard references to the URL of the config interface + * with #defines from project.h + * + * Revision 1.8 2001/11/30 23:35:51 jongfoster + * Renaming actionsfile to ijb.action + * + * Revision 1.7 2001/11/13 00:28:24 jongfoster + * - Renaming parameters from edit-actions-for-url so that they only + * contain legal JavaScript characters. If we wanted to write + * JavaScript that worked with Netscape 4, this is nessacery. + * (Note that at the moment the JavaScript doesn't actually work + * with Netscape 4, but now this is purely a template issue, not + * one affecting code). + * - Adding new CGIs for use by non-JavaScript browsers: + * edit-actions-url-form + * edit-actions-add-url-form + * edit-actions-remove-url-form + * - Fixing || bug. + * * 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. @@ -109,8 +197,10 @@ 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" #include "loadcfg.h" /* loadcfg.h is for g_bToggleIJB only */ +#include "urlmatch.h" const char cgiedit_h_rcs[] = CGIEDIT_H_VERSION; @@ -169,7 +259,9 @@ 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. */ + /* Pre-encoded with url_encode() for ease of use. */ 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 @@ -177,11 +269,17 @@ struct editable_file * 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) */ }; +#define CGI_ACTION_PARAM_LEN_MAX 500 + /* FIXME: Following non-static functions should be prototyped in .h or made static */ /* Functions to read and write arbitrary config files */ @@ -215,10 +313,8 @@ jb_err cgi_error_disabled(struct client_state *csp, struct http_response *rsp); /* 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); @@ -235,12 +331,19 @@ 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); +static jb_err get_string_param(const struct map *parameters, + const char *param_name, + const char **pparam); /* 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,10 +353,11 @@ 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); +#if 0 /* unused function */ static jb_err map_copy_parameter_url(struct map *out, const struct map *in, const char *name); - +#endif /* unused function */ /********************************************************************* * @@ -263,9 +367,9 @@ static jb_err map_copy_parameter_url(struct map *out, * 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 @@ -303,6 +407,7 @@ static jb_err map_copy_parameter_html(struct map *out, } +#if 0 /* unused function */ /********************************************************************* * * Function : map_copy_parameter_html @@ -311,9 +416,9 @@ static jb_err map_copy_parameter_html(struct map *out, * 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 @@ -349,7 +454,7 @@ static jb_err map_copy_parameter_url(struct map *out, return JB_ERR_OK; } } - +#endif /* 0 - unused function */ /********************************************************************* * @@ -359,16 +464,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 + * f : (filename) 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 +483,11 @@ 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; jb_err err; assert(csp); @@ -392,16 +499,48 @@ 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++) + { + cur_line = cur_line->next; + } + + if ( (cur_line == NULL) + || (line_number != patternid) + || (patternid < 1) + || (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, file->identifier, 1); + 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); + + edit_free_file(file); if (err) { @@ -421,14 +560,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 +596,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 +618,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 : (filename) 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 @@ -500,7 +637,11 @@ 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; jb_err err; assert(csp); @@ -512,341 +653,56 @@ jb_err cgi_edit_actions_remove_url_form(struct client_state *csp, return cgi_error_disabled(csp, rsp); } - if (NULL == (exports = default_exports(csp, NULL))) - { - 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 = get_number_param(csp, parameters, "p", &patternid); if (err) { - free_map(exports); return err; } - return template_fill_for_cgi(csp, "edit-actions-remove-url-form", exports, rsp); -} - - -/********************************************************************* - * - * 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. - * - * - * 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 - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory - * JB_ERR_FILE on EOF. - * - *********************************************************************/ -static jb_err simple_read_line(char **dest, FILE *fp) -{ - int len; - char * buf; - char * newbuf; - - assert(fp); - assert(dest); - - *dest = NULL; - - if (NULL == (buf = malloc(BUFFER_SIZE))) + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) { - 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); } - *buf = '\0'; - len = 0; + cur_line = file->lines; - while (FOREVER) + for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++) { - newbuf = buf + len; - if ((!fgets(newbuf, BUFFER_SIZE, fp)) || (*newbuf == '\0')) - { - /* (*newbuf == '\0') should never happen unless fgets fails */ - if (*buf == '\0') - { - free(buf); - return JB_ERR_FILE; - } - else - { - *dest = buf; - return JB_ERR_OK; - } - } - len = strlen(buf); - if ((buf[len - 1] == '\n') || (buf[len - 1] == '\r')) - { - *dest = buf; - return JB_ERR_OK; - } - - if (NULL == (newbuf = realloc(buf, len + BUFFER_SIZE))) - { - free(buf); - return JB_ERR_MEMORY; - } - buf = newbuf; + cur_line = cur_line->next; } -} - - -/********************************************************************* - * - * 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; - - assert(fp); - /* Set output parameters to NULL */ - if (raw_out) - { - *raw_out = NULL; - } - if (prefix_out) - { - *prefix_out = NULL; - } - if (data_out) + if ( (cur_line == NULL) + || (line_number != patternid) + || (patternid < 1) + || (cur_line->type != FILE_LINE_URL)) { - *data_out = NULL; + /* Invalid "patternid" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; } - /* Set string variables to new, empty strings. */ - - raw = malloc(1); - prefix = malloc(1); - data = malloc(1); - - if ((raw == NULL) || (prefix == NULL) || (data == NULL)) + if (NULL == (exports = default_exports(csp, NULL))) { - freez(raw); - freez(prefix); - freez(data); + edit_free_file(file); 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; - } + err = map(exports, "f", 1, file->identifier, 1); + 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 = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0); + edit_free_file(file); - if (*raw) + if (err) { - /* 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; + free_map(exports); + return err; } - else - { - /* EOF and no data there. */ - - free(raw); - free(prefix); - free(data); - return JB_ERR_FILE; - } + return template_fill_for_cgi(csp, "edit-actions-remove-url-form", exports, rsp); } @@ -878,7 +734,11 @@ jb_err edit_write_file(struct editable_file * file) assert(file); assert(file->filename); +#if defined(AMIGA) || defined(__OS2__) + if (NULL == (fp = fopen(file->filename, "w"))) +#else if (NULL == (fp = fopen(file->filename, "wt"))) +#endif /* def AMIGA */ { return JB_ERR_FILE; } @@ -906,12 +766,72 @@ jb_err edit_write_file(struct editable_file * file) } if (cur_line->unprocessed) { - if (fputs(cur_line->unprocessed, fp) < 0) + /* This should be a single line - sanity check. */ + assert(NULL == strchr(cur_line->unprocessed, '\r')); + assert(NULL == strchr(cur_line->unprocessed, '\n')); + + if (NULL != strchr(cur_line->unprocessed, '#')) { - fclose(fp); - return JB_ERR_FILE; + /* Must quote '#' characters */ + int numhash = 0; + int 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); + if (NULL == (str = malloc((size_t) len + 1 + numhash))) + { + /* Uh oh, just trashed file! */ + fclose(fp); + return JB_ERR_MEMORY; + } + + /* Loop through string from end */ + src = cur_line->unprocessed + len; + dest = str + len + numhash; + for ( ; len >= 0; len--) + { + if ((*dest-- = *src--) == '#') + { + *dest-- = '\\'; + numhash--; + assert(numhash >= 0); + } + } + assert(numhash == 0); + assert(src + 1 == cur_line->unprocessed); + assert(dest + 1 == str); + + if (fputs(str, fp) < 0) + { + free(str); + fclose(fp); + return JB_ERR_FILE; + } + + free(str); + } + else + { + /* 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; @@ -1049,15 +969,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); @@ -1107,10 +1027,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 : name = Destination for name + * 2 : name = Destination for value * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory @@ -1123,7 +1043,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); @@ -1203,7 +1123,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 */ @@ -1493,7 +1413,7 @@ jb_err edit_parse_actions_file(struct editable_file * file) * 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 */ @@ -1513,7 +1433,7 @@ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) 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. */ @@ -1535,7 +1455,7 @@ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) 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 */ @@ -1606,6 +1526,7 @@ jb_err edit_read_file(struct client_state *csp, unsigned version = 0; struct stat statbuf[1]; char version_buf[22]; + int newline = NEWLINE_UNKNOWN; assert(csp); assert(parameters); @@ -1613,7 +1534,7 @@ jb_err edit_read_file(struct client_state *csp, *pfile = NULL; - err = get_file_name_param(csp, parameters, "filename", suffix, + err = get_file_name_param(csp, parameters, "f", suffix, &filename, &identifier); if (err) { @@ -1631,7 +1552,7 @@ 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); @@ -1644,13 +1565,17 @@ jb_err edit_read_file(struct client_state *csp, } } +#if defined(AMIGA) || defined(__OS2__) + if (NULL == (fp = fopen(filename,"r"))) +#else if (NULL == (fp = fopen(filename,"rt"))) +#endif /* def AMIGA */ { free(filename); return JB_ERR_FILE; } - err = edit_read_file_lines(fp, &lines); + err = edit_read_file_lines(fp, &lines, &newline); fclose(fp); @@ -1669,9 +1594,10 @@ jb_err edit_read_file(struct client_state *csp, } file->lines = lines; + file->newline = newline; file->filename = filename; file->version = version; - file->identifier = strdup(identifier); + file->identifier = url_encode(identifier); if (file->identifier == NULL) { @@ -1754,11 +1680,11 @@ jb_err edit_read_actions_file(struct client_state *csp, /* 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")); + err = cgi_error_modified(csp, rsp, lookup(parameters, "f")); } if (err == JB_ERR_OK) { @@ -1816,12 +1742,13 @@ jb_err edit_read_actions_file(struct client_state *csp, * secure. * * 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 + * 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 : suffix = File extension, e.g. ".actions" + * 5 : pfilename = destination for full filename. Caller * free()s. Set to NULL on error. - * 5 : pparam = destination for partial filename, + * 6 : 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. @@ -1841,7 +1768,9 @@ static jb_err get_file_name_param(struct client_state *csp, { const char *param; const char *s; +#if 0 /* Patch to make 3.0.0 work properly. */ char *name; +#endif /* 0 - Patch to make 3.0.0 work properly. */ char *fullpath; char ch; int len; @@ -1885,6 +1814,13 @@ static jb_err get_file_name_param(struct client_state *csp, } } + /* + * FIXME Following is a hack to make 3.0.0 work properly. + * Change "#if 0" --> "#if 1" below when we have modular action + * files. + * -- Jon + */ +#if 0 /* Patch to make 3.0.0 work properly. */ /* Append extension */ name = malloc(len + strlen(suffix) + 1); if (name == NULL) @@ -1897,6 +1833,16 @@ static jb_err get_file_name_param(struct client_state *csp, /* Prepend path */ fullpath = make_path(csp->config->confdir, name); free(name); +#else /* 1 - Patch to make 3.0.0 work properly. */ + if ((csp->actions_list == NULL) + || (csp->actions_list->filename == NULL)) + { + return JB_ERR_CGI_PARAMS; + } + + fullpath = ( (csp->actions_list && csp->actions_list->filename) + ? strdup(csp->actions_list->filename) : NULL); +#endif /* 1 - Patch to make 3.0.0 work properly. */ if (fullpath == NULL) { return JB_ERR_MEMORY; @@ -1909,6 +1855,111 @@ static jb_err get_file_name_param(struct client_state *csp, } +/********************************************************************* + * + * Function : get_char_param + * + * Description : Get a single-character parameter passed to a CGI + * function. + * + * Parameters : + * 1 : parameters = map of cgi parameters + * 2 : param_name = The name of the parameter to read + * + * Returns : Uppercase character on success, '\0' on error. + * + *********************************************************************/ +static char get_char_param(const struct map *parameters, + const char *param_name) +{ + char ch; + + assert(parameters); + assert(param_name); + + ch = *(lookup(parameters, param_name)); + if ((ch >= 'a') && (ch <= 'z')) + { + ch = ch - 'a' + 'A'; + } + + return ch; +} + + +/********************************************************************* + * + * Function : get_string_param + * + * Description : Get a string paramater, to be used as an + * ACTION_STRING or ACTION_MULTI paramater. + * Validates the input to prevent stupid/malicious + * users from corrupting their action file. + * + * Parameters : + * 1 : parameters = map of cgi parameters + * 2 : param_name = The name of the parameter to read + * 3 : pparam = destination for paramater. Allocated as + * part of the map "parameters", so don't free it. + * Set to NULL if not specified. + * + * Returns : JB_ERR_OK on success, or if the paramater + * was not specified. + * JB_ERR_MEMORY on out-of-memory. + * JB_ERR_CGI_PARAMS if the paramater is not valid. + * + *********************************************************************/ +static jb_err get_string_param(const struct map *parameters, + const char *param_name, + const char **pparam) +{ + const char *param; + const char *s; + char ch; + + assert(parameters); + assert(param_name); + assert(pparam); + + *pparam = NULL; + + param = lookup(parameters, param_name); + if (!*param) + { + return JB_ERR_OK; + } + + if (strlen(param) >= CGI_ACTION_PARAM_LEN_MAX) + { + /* + * Too long. + * + * Note that the length limit is arbitrary, it just seems + * sensible to limit it to *something*. There's no + * technical reason for any limit at all. + */ + return JB_ERR_CGI_PARAMS; + } + + /* Check every character to see if it's legal */ + s = param; + while ((ch = *s++) != '\0') + { + if ( ((unsigned char)ch < (unsigned char)' ') + || (ch == '}') ) + { + /* Probable hack attempt, or user accidentally used '}'. */ + return JB_ERR_CGI_PARAMS; + } + } + + /* Success */ + *pparam = param; + + return JB_ERR_OK; +} + + /********************************************************************* * * Function : get_number_param @@ -1917,10 +1968,10 @@ static jb_err get_file_name_param(struct client_state *csp, * passed to a CGI function. * * 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. + * 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. * * Returns : JB_ERR_OK on success @@ -1943,7 +1994,7 @@ static jb_err get_number_param(struct client_state *csp, assert(name); assert(pvalue); - *pvalue = -1; + *pvalue = 0; param = lookup(parameters, name); if (!*param) @@ -1982,9 +2033,137 @@ static jb_err get_number_param(struct client_state *csp, *pvalue = value; return JB_ERR_OK; + } +/********************************************************************* + * + * Function : get_url_spec_param + * + * 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. Will be malloc()'d. + * Set to NULL on error. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the parameter was not specified + * or is not valid. + * + *********************************************************************/ +static jb_err get_url_spec_param(struct client_state *csp, + const struct map *parameters, + const char *name, + char **pvalue) +{ + const char *orig_param; + char *param; + char *s; + struct url_spec compiled[1]; + jb_err err; + + assert(csp); + assert(parameters); + assert(name); + assert(pvalue); + + *pvalue = NULL; + + orig_param = lookup(parameters, name); + if (!*orig_param) + { + return JB_ERR_CGI_PARAMS; + } + + /* 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; + } + + /* Check for embedded newlines */ + for (s = param; *s != '\0'; s++) + { + if ((*s == '\r') || (*s == '\n')) + { + free(param); + return JB_ERR_CGI_PARAMS; + } + } + + /* Check that regex is valid */ + s = strdup(param); + if (s == NULL) + { + free(param); + return JB_ERR_MEMORY; + } + err = create_url_spec(compiled, s); + free(s); + if (err) + { + free(param); + return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS; + } + free_url_spec(compiled); + + 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 (strchr(param, '/') == NULL) + { + err = string_append(¶m, "/"); + } + else + { + err = string_append(¶m, "(?:)"); + } + if (err) + { + return err; + } + + /* Check that the modified regex is valid */ + s = strdup(param); + if (s == NULL) + { + free(param); + return JB_ERR_MEMORY; + } + err = create_url_spec(compiled, s); + free(s); + if (err) + { + free(param); + return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS; + } + free_url_spec(compiled); + } + + *pvalue = param; + return JB_ERR_OK; +} + /********************************************************************* * * Function : map_radio @@ -2000,10 +2179,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,9 +2193,9 @@ 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; + size_t len; char * buf; char * p; char c; @@ -2044,620 +2223,302 @@ 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)) + return map(exports, buf, 0, "checked", 1); +} + + +/********************************************************************* + * + * 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); + + if (NULL == (exports = default_exports(csp, NULL))) { - free(buf); return JB_ERR_MEMORY; } - return JB_ERR_OK; + 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); } /********************************************************************* * - * Function : actions_to_radio + * Function : cgi_error_parse * - * 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 cannot + * be parsed by 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 : file = 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_parse(struct client_state *csp, + struct http_response *rsp, + struct editable_file *file) { - unsigned mask = action->mask; - unsigned add = action->add; - int mapped_param; - int checked; - char current_mode; + struct map *exports; + jb_err err; + struct file_line *cur_line; - assert(exports); - assert(action); + assert(csp); + assert(rsp); + assert(file); - mask = action->mask; - add = action->add; + if (NULL == (exports = default_exports(csp, NULL))) + { + return JB_ERR_MEMORY; + } - /* sanity - prevents "-feature +feature" */ - mask |= add; + err = map(exports, "f", 1, file->identifier, 1); + if (!err) err = map(exports, "parse-error", 1, html_encode(file->parse_error_text), 0); + + 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); -#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; \ + 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-parse", 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_file + * + * Description : CGI function that is called when a file cannot be + * opened by 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_file(struct client_state *csp, + struct http_response *rsp, + const char *filename) +{ + struct map *exports; + jb_err err; -#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(filename); -#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 */ - -#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 + err = map(exports, "f", 1, html_encode(filename), 0); + if (err) + { + free_map(exports); + return err; + } - return JB_ERR_OK; + return template_fill_for_cgi(csp, "cgi-error-file", exports, rsp); } /********************************************************************* * - * Function : javascriptify + * Function : cgi_error_bad_param * - * Description : Converts a string into a form JavaScript will like. + * Description : CGI function that is called if the parameters + * (query string) for a CGI were wrong. * - * 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.) + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output * - * Currently the only thing we have to worry about - * is "-" ==> "_" conversion. + * CGI Parameters : none * - * This is a length-preserving operation so it is - * carried out in-place, no memory is allocated - * or freed. + * 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))) + { + return JB_ERR_MEMORY; + } + + return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp); +} + + +/********************************************************************* + * + * Function : cgi_edit_actions + * + * Description : CGI function that allows the user to choose which + * actions file to edit. * * 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 : parameters = map of cgi parameters * - * 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_edit_actions(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - char * p = identifier; - while (NULL != (p = strchr(p, '-'))) + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) { - *p++ = '_'; + return cgi_error_disabled(csp, rsp); + } + + /* FIXME: Incomplete */ + rsp->status = strdup("302 Local Redirect from Junkbuster"); + if (rsp->status == NULL) + { + return JB_ERR_MEMORY; + } + if (enlist_unique_header(rsp->headers, "Location", + CGI_PREFIX "edit-actions-list?f=ijb")) + { + free(rsp->status); + rsp->status = NULL; + return JB_ERR_MEMORY; } + + return JB_ERR_OK; } /********************************************************************* * - * Function : actions_from_radio - * - * Description : Converts a map of parameters passed to a CGI function - * into an actionsfile entry. + * 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 : 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 : parameters = map of cgi parameters + * + * CGI Parameters : filename * * 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. * *********************************************************************/ -static jb_err actions_from_radio(const struct map * parameters, - struct action_spec *action) +jb_err cgi_edit_actions_list(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - static int first_time = 1; - const char * param; - char * param_dup; - char ch; - const char * js_name; + 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; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number = 0; + unsigned prev_section_line_number = ((unsigned) (-1)); + int url_1_2; + jb_err err; - assert(parameters); - assert(action); + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } - /* 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 - */ + err = edit_read_actions_file(csp, rsp, parameters, 0, &file); + if (err) + { + /* No filename specified, can't read file, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } -#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); - - if (NULL == (exports = default_exports(csp, NULL))) - { - return JB_ERR_MEMORY; - } - - err = map(exports, "filename", 1, filename, 1); - if (err) - { - free_map(exports); - return err; - } - - return template_fill_for_cgi(csp, "cgi-error-modified", exports, rsp); -} - - -/********************************************************************* - * - * 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; - - assert(csp); - assert(rsp); - assert(file); - - if (NULL == (exports = default_exports(csp, NULL))) - { - return JB_ERR_MEMORY; - } - - 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); - - if (err) - { - free_map(exports); - return err; - } - - 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. - * - * 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_file(struct client_state *csp, - struct http_response *rsp, - const char *filename) -{ - struct map *exports; - jb_err err; - - assert(csp); - assert(rsp); - assert(filename); - - if (NULL == (exports = default_exports(csp, NULL))) - { - return JB_ERR_MEMORY; - } - - err = map(exports, "filename", 1, filename, 1); - if (err) - { - free_map(exports); - return err; - } - - return template_fill_for_cgi(csp, "cgi-error-file", exports, rsp); -} + if (NULL == (exports = default_exports(csp, NULL))) + { + edit_free_file(file); + return JB_ERR_MEMORY; + } - -/********************************************************************* - * - * 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))) - { - return JB_ERR_MEMORY; - } - - return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp); -} - - -/********************************************************************* - * - * Function : cgi_edit_actions - * - * 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 : parameters = map of cgi parameters - * - * CGI Parameters : None - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error - * - *********************************************************************/ -jb_err cgi_edit_actions(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) -{ - - if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) - { - return cgi_error_disabled(csp, rsp); - } - - /* FIXME: Incomplete */ - rsp->status = strdup("302 Local Redirect from Junkbuster"); - if (rsp->status == NULL) - { - return JB_ERR_MEMORY; - } - if (enlist_unique_header(rsp->headers, "Location", "http://ijbswa.sourceforge.net/config/edit-actions-list?filename=edit")) - { - free(rsp->status); - rsp->status = NULL; - return JB_ERR_MEMORY; - } - - return JB_ERR_OK; -} - - -/********************************************************************* - * - * 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 : parameters = map of cgi parameters - * - * CGI Parameters : filename - * - * 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_edit_actions_list(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; - struct editable_file * file; - struct file_line * cur_line; - unsigned line_number = 0; - int url_1_2; - jb_err err; - - 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); - if (err) - { - /* No filename specified, can't read file, or out of memory. */ - return (err == JB_ERR_FILE ? JB_ERR_OK : err); - } - - 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); + err = map(exports, "f", 1, file->identifier, 1); + if (!err) err = map(exports, "v", 1, file->version_str, 1); if (err) { @@ -2743,7 +2604,7 @@ jb_err cgi_edit_actions_list(struct client_state *csp, } snprintf(buf, 50, "%d", line_number); - err = map(section_exports, "sectionid", 1, buf, 1); + err = map(section_exports, "s", 1, buf, 1); if (!err) err = map(section_exports, "actions", 1, actions_to_html(cur_line->data.action), 0); @@ -2754,6 +2615,24 @@ jb_err cgi_edit_actions_list(struct client_state *csp, /* 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, 50, "%d", 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) { @@ -2799,7 +2678,7 @@ jb_err cgi_edit_actions_list(struct client_state *csp, } snprintf(buf, 50, "%d", line_number); - err = map(url_exports, "urlid", 1, buf, 1); + err = map(url_exports, "p", 1, buf, 1); snprintf(buf, 50, "%d", url_1_2); if (!err) err = map(url_exports, "url-1-2", 1, buf, 1); @@ -2862,6 +2741,22 @@ jb_err cgi_edit_actions_list(struct client_state *csp, err = map(section_exports, "urls", 1, urls, 0); + /* Could also do section-specific exports here, but it wouldn't be as fast */ + + if ( (cur_line != NULL) + && (cur_line->type == FILE_LINE_ACTION)) + { + /* Not last section */ + snprintf(buf, 50, "%d", line_number); + if (!err) err = map(section_exports, "s-next", 1, buf, 1); + 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); @@ -2873,8 +2768,6 @@ jb_err cgi_edit_actions_list(struct client_state *csp, return err; } - /* Could also do section-specific exports here, but it wouldn't be as fast */ - if (NULL == (s = strdup(section_template))) { free(sections); @@ -2927,9 +2820,9 @@ jb_err cgi_edit_actions_list(struct client_state *csp, * 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 * @@ -2949,13 +2842,15 @@ jb_err cgi_edit_actions_for_url(struct client_state *csp, struct file_line * cur_line; unsigned line_number; jb_err err; + struct file_list *filter_file; + struct re_filterfile_spec *filter_group; 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, "s", §ionid); if (err) { return err; @@ -2991,11 +2886,123 @@ jb_err cgi_edit_actions_for_url(struct client_state *csp, 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); + err = map(exports, "f", 1, file->identifier, 1); + 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); + + filter_file = csp->rlist; + filter_group = ((filter_file != NULL) ? filter_file->f : NULL); + + if (!err) err = map_conditional(exports, "any-filters-defined", (filter_group != NULL)); + + if (err) + { + edit_free_file(file); + free_map(exports); + return err; + } + + if (filter_group == NULL) + { + err = map(exports, "filter-params", 1, "", 1); + } + else + { + /* We have some entries in the filter list */ + char * result; + int index = 0; + char * filter_template; + + err = template_load(csp, &filter_template, "edit-actions-for-url-filter"); + 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; + } + + result = strdup(""); + + for (;(!err) && (filter_group != NULL); filter_group = filter_group->next) + { + char current_mode = 'x'; + struct list_entry *filter_name; + char * this_line; + struct map *line_exports; + char number[20]; + + filter_name = cur_line->data.action->multi_add[ACTION_MULTI_FILTER]->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[ACTION_MULTI_FILTER]->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", index++); + number[sizeof(number) - 1] = '\0'; + + line_exports = new_map(); + if (line_exports == NULL) + { + err = JB_ERR_MEMORY; + freez(result); + } + else + { + 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); + + this_line = NULL; + if (!err) + { + this_line = strdup(filter_template); + if (this_line == NULL) err = JB_ERR_MEMORY; + } + if (!err) err = template_fill(&this_line, line_exports); + string_join(&result, this_line); + + free_map(line_exports); + } + } + if (!err) + { + err = map(exports, "filter-params", 1, result, 0); + } + else + { + freez(result); + } + } + + if (!err) err = map_radio(exports, "filter-all", "nx", + (cur_line->data.action->multi_remove_all[ACTION_MULTI_FILTER] ? 'n' : 'x')); edit_free_file(file); @@ -3016,9 +3023,9 @@ jb_err cgi_edit_actions_for_url(struct client_state *csp, * Description : CGI function that actually 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 * @@ -3035,19 +3042,21 @@ jb_err cgi_edit_actions_submit(struct client_state *csp, unsigned sectionid; char * actiontext; char * newtext; - int len; + size_t len; struct editable_file * file; struct file_line * cur_line; unsigned line_number; char * target; jb_err err; + int index; + char ch; 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, "s", §ionid); if (err) { return err; @@ -3085,6 +3094,71 @@ jb_err cgi_edit_actions_submit(struct client_state *csp, return err; } + ch = get_char_param(parameters, "filter_all"); + if (ch == 'N') + { + list_remove_all(cur_line->data.action->multi_add[ACTION_MULTI_FILTER]); + list_remove_all(cur_line->data.action->multi_remove[ACTION_MULTI_FILTER]); + cur_line->data.action->multi_remove_all[ACTION_MULTI_FILTER] = 1; + } + else if (ch == 'X') + { + cur_line->data.action->multi_remove_all[ACTION_MULTI_FILTER] = 0; + } + + for (index = 0; !err; index++) + { + char key_value[30]; + char key_name[30]; + const char *name; + char value; + + /* Generate the keys */ + snprintf(key_value, sizeof(key_value), "filter_r%x", index); + key_value[sizeof(key_value) - 1] = '\0'; + snprintf(key_name, sizeof(key_name), "filter_n%x", index); + key_name[sizeof(key_name) - 1] = '\0'; + + err = get_string_param(parameters, key_name, &name); + if (err) break; + + if (name == NULL) + { + /* End of list */ + break; + } + + + value = get_char_param(parameters, key_value); + if (value == 'Y') + { + list_remove_item(cur_line->data.action->multi_add[ACTION_MULTI_FILTER], name); + if (!err) err = enlist(cur_line->data.action->multi_add[ACTION_MULTI_FILTER], name); + list_remove_item(cur_line->data.action->multi_remove[ACTION_MULTI_FILTER], name); + } + else if (value == 'N') + { + list_remove_item(cur_line->data.action->multi_add[ACTION_MULTI_FILTER], name); + if (!cur_line->data.action->multi_remove_all[ACTION_MULTI_FILTER]) + { + list_remove_item(cur_line->data.action->multi_remove[ACTION_MULTI_FILTER], name); + if (!err) err = enlist(cur_line->data.action->multi_remove[ACTION_MULTI_FILTER], name); + } + } + else if (value == 'X') + { + list_remove_item(cur_line->data.action->multi_add[ACTION_MULTI_FILTER], name); + list_remove_item(cur_line->data.action->multi_remove[ACTION_MULTI_FILTER], name); + } + } + + if(err) + { + /* Out of memory */ + edit_free_file(file); + return err; + } + if (NULL == (actiontext = actions_to_text(cur_line->data.action))) { /* Out of memory */ @@ -3127,7 +3201,7 @@ jb_err cgi_edit_actions_submit(struct client_state *csp, return err; } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); + target = strdup(CGI_PREFIX "edit-actions-list?f="); string_append(&target, file->identifier); edit_free_file(file); @@ -3159,9 +3233,9 @@ jb_err cgi_edit_actions_submit(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 : * filename : Identifies the file to edit @@ -3180,9 +3254,7 @@ jb_err cgi_edit_actions_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; @@ -3195,29 +3267,149 @@ 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; + } + if (patternid < 1U) + { + return JB_ERR_CGI_PARAMS; + } + + err = get_url_spec_param(csp, parameters, "u", &new_pattern); if (err) { return err; } - err = get_number_param(csp, parameters, "pattern", &patternid); + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + 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; + + while ((cur_line != NULL) && (line_number < patternid)) + { + cur_line = cur_line->next; + line_number++; + } + + if ( (cur_line == NULL) + || (cur_line->type != FILE_LINE_URL)) + { + /* Invalid "patternid" parameter */ + free(new_pattern); + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + + /* At this point, the line to edit is in cur_line */ + + freez(cur_line->raw); + freez(cur_line->unprocessed); + cur_line->unprocessed = new_pattern; + + err = edit_write_file(file); if (err) { + /* Error writing file */ + edit_free_file(file); return err; } - newval = lookup(parameters, "newval"); + target = strdup(CGI_PREFIX "edit-actions-list?f="); + string_append(&target, 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; +} + + +/********************************************************************* + * + * Function : cgi_edit_actions_add_url + * + * 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 + * + * 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 + * JB_ERR_CGI_PARAMS if the CGI parameters are not + * specified or not valid. + * + *********************************************************************/ +jb_err cgi_edit_actions_add_url(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + unsigned sectionid; + char * new_pattern; + struct file_line * new_line; + 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); + } - if ((*newval == '\0') || (sectionid < 1U) || (patternid < 1U)) + 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; + } + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); 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); } @@ -3234,44 +3426,149 @@ jb_err cgi_edit_actions_url(struct client_state *csp, || (cur_line->type != FILE_LINE_ACTION)) { /* Invalid "sectionid" parameter */ + free(new_pattern); edit_free_file(file); return JB_ERR_CGI_PARAMS; } - while (line_number < patternid) + /* At this point, the section header is in cur_line - add after this. */ + + /* Allocate the new line */ + new_line = (struct file_line *)zalloc(sizeof(*new_line)); + if (new_line == NULL) + { + free(new_pattern); + 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_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 */ + + err = edit_write_file(file); + if (err) + { + /* Error writing file */ + edit_free_file(file); + return err; + } + + target = strdup(CGI_PREFIX "edit-actions-list?f="); + string_append(&target, 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; +} + + +/********************************************************************* + * + * Function : cgi_edit_actions_remove_url + * + * 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 + * + * CGI Parameters : + * 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 + * JB_ERR_CGI_PARAMS if the CGI parameters are not + * specified or not valid. + * + *********************************************************************/ +jb_err cgi_edit_actions_remove_url(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + unsigned patternid; + struct editable_file * file; + struct file_line * cur_line; + struct file_line * prev_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, "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); + } + + line_number = 1; + prev_line = NULL; + cur_line = file->lines; + + while ((cur_line != NULL) && (line_number < patternid)) { + prev_line = cur_line; 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) + if ( (cur_line == NULL) + || (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) @@ -3281,7 +3578,7 @@ jb_err cgi_edit_actions_url(struct client_state *csp, return err; } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); + target = strdup(CGI_PREFIX "edit-actions-list?f="); string_append(&target, file->identifier); edit_free_file(file); @@ -3307,21 +3604,21 @@ jb_err cgi_edit_actions_url(struct client_state *csp, /********************************************************************* * - * 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,16 +3626,14 @@ 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; jb_err err; @@ -3348,19 +3643,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,49 +3659,48 @@ 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)) + || (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) @@ -3423,7 +3710,7 @@ jb_err cgi_edit_actions_add_url(struct client_state *csp, return err; } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); + target = strdup(CGI_PREFIX "edit-actions-list?f="); string_append(&target, file->identifier); edit_free_file(file); @@ -3449,21 +3736,21 @@ jb_err cgi_edit_actions_add_url(struct client_state *csp, /********************************************************************* * - * 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,15 +3758,15 @@ 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; jb_err err; @@ -3489,19 +3776,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); - if (err) - { - return err; - } - - err = get_number_param(csp, parameters, "pattern", &patternid); + err = get_number_param(csp, parameters, "s", §ionid); if (err) { return err; } - err = edit_read_actions_file(csp, rsp, parameters, 1, &file); if (err) { @@ -3512,56 +3792,89 @@ 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) + { + /* 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++; + } + } } - - 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) ) ) + || (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 = (struct file_line *)zalloc(sizeof(*new_line)); + if (new_line == NULL) + { + free(new_text); + edit_free_file(file); + return JB_ERR_MEMORY; + } - /* 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) @@ -3571,7 +3884,7 @@ jb_err cgi_edit_actions_remove_url(struct client_state *csp, return err; } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); + target = strdup(CGI_PREFIX "edit-actions-list?f="); string_append(&target, file->identifier); edit_free_file(file); @@ -3597,22 +3910,24 @@ jb_err cgi_edit_actions_remove_url(struct client_state *csp, /********************************************************************* * - * 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,14 +3935,23 @@ 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; jb_err err; @@ -3637,12 +3961,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,11 +3982,13 @@ 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; @@ -3664,47 +3998,92 @@ jb_err cgi_edit_actions_section_remove(struct client_state *csp, 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) ) - { - /* Section not empty. */ - edit_free_file(file); - return JB_ERR_CGI_PARAMS; - } + /* If no-op, we've validated params and can skip the rest. */ + if (section1 != section2) + { + /* ... 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; + + /* ... find section2 ... */ + while ((cur_line != NULL) && (line_number < section2)) + { + prev_line = cur_line; + cur_line = cur_line->next; + line_number++; + } + + 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. */ - /* At this point, the line to remove is in cur_line, and the previous - * one is in prev_line - */ + /* 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; + } - /* Unlink cur_line */ - if (prev_line == NULL) - { - /* Removing the first line from the file */ - file->lines = cur_line->next; - } - else - { - prev_line->next = cur_line->next; - } - cur_line->next = NULL; + 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; + } - /* Free cur_line */ - edit_free_file_lines(cur_line); + /* 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 */ - edit_free_file(file); - return err; - } + err = edit_write_file(file); + if (err) + { + /* Error writing file */ + edit_free_file(file); + return err; + } + } /* END if (section1 != section2) */ - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); + target = strdup(CGI_PREFIX "edit-actions-list?f="); string_append(&target, file->identifier); edit_free_file(file); @@ -3730,252 +4109,390 @@ jb_err cgi_edit_actions_section_remove(struct client_state *csp, /********************************************************************* * - * Function : cgi_edit_actions_section_add + * Function : cgi_toggle * * 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 add after, 0 for start - * of file. + * set : If present, how to change toggle setting: + * "enable", "disable", "toggle", or none (default). + * mini : If present, use mini reply template. * * 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) +jb_err cgi_toggle(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - unsigned sectionid; - struct file_line * new_line; - char * new_text; - struct editable_file * file; - struct file_line * cur_line; - unsigned line_number; - char * target; + struct map *exports; + char mode; + const char *template_name; jb_err err; - if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + assert(csp); + assert(rsp); + assert(parameters); + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_TOGGLE)) { return cgi_error_disabled(csp, rsp); } - err = get_number_param(csp, parameters, "section", §ionid); - if (err) + if (NULL == (exports = default_exports(csp, "toggle"))) { - return err; + return JB_ERR_MEMORY; } - err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + mode = get_char_param(parameters, "set"); + + if (mode == 'e') + { + /* Enable */ + g_bToggleIJB = 1; + } + else if (mode == 'd') + { + /* Disable */ + g_bToggleIJB = 0; + } + else if (mode == 't') + { + /* Toggle */ + g_bToggleIJB = !g_bToggleIJB; + } + + err = map_conditional(exports, "enabled", g_bToggleIJB); if (err) { - /* No filename specified, can't read file, modified, or out of memory. */ - return (err == JB_ERR_FILE ? JB_ERR_OK : err); + free_map(exports); + return err; } - line_number = 1; - cur_line = file->lines; + template_name = (get_char_param(parameters, "mini") + ? "toggle-mini" + : "toggle"); - if (sectionid < 1U) + return template_fill_for_cgi(csp, template_name, 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. + * + * 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, '-'))) { - /* 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++; - } - } + *p++ = '_'; } - 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; - } - /* 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++; - } +/********************************************************************* + * + * 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 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; + + /* 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; \ } - /* 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). - */ +#define DEFINE_ACTION_STRING(name, bit, index) \ + DEFINE_ACTION_BOOL(name, bit); \ + mapped_param = 0; - new_text = strdup("{}"); - if (NULL == new_text) - { - edit_free_file(file); - return JB_ERR_MEMORY; +#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; \ } - /* 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; +#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; \ } - /* 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 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; \ } - /* Done making changes, now commit */ - - err = edit_write_file(file); - if (err) - { - /* Error writing file */ - edit_free_file(file); - return err; +#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; \ } - target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename="); - string_append(&target, file->identifier); - - edit_free_file(file); +#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */ - 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 DEFINE_CGI_PARAM_CUSTOM +#undef DEFINE_CGI_PARAM_RADIO +#undef DEFINE_CGI_PARAM_NO_RADIO - return err; + return JB_ERR_OK; } /********************************************************************* * - * Function : cgi_toggle + * 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 : - * set : If present, how to change toggle setting: - * "enable", "disable", "toggle", or none (default). - * mini : If present, use mini reply template. + * 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_toggle(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) { - struct map *exports; - char mode; - const char *template_name; - jb_err err; + static int first_time = 1; + const char * param; + char * param_dup; + char ch; + const char * js_name; + jb_err err = JB_ERR_OK; - assert(csp); - assert(rsp); assert(parameters); + assert(action); - if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_TOGGLE)) - { - return cgi_error_disabled(csp, rsp); - } + /* 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 + */ - if (NULL == (exports = default_exports(csp, "toggle"))) - { - return JB_ERR_MEMORY; - } +#define JAVASCRIPTIFY(dest_var, string) \ + { \ + static char js_name_arr[] = string; \ + if (first_time) \ + { \ + javascriptify(js_name_arr); \ + } \ + dest_var = js_name_arr; \ + } \ - mode = *(lookup(parameters, "set")); +#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; \ + } \ - if (mode == 'e') - { - /* Enable */ - g_bToggleIJB = 1; - } - else if (mode == 'd') - { - /* Disable */ - g_bToggleIJB = 0; - } - else if (mode == 't') - { - /* Toggle */ - g_bToggleIJB = !g_bToggleIJB; - } +#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; \ + } \ - err = map_conditional(exports, "enabled", g_bToggleIJB); - if (err) - { - free_map(exports); - return err; - } +#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; \ + } \ - template_name = (*(lookup(parameters, "mini")) - ? "toggle-mini" - : "toggle"); +#define DEFINE_ACTION_ALIAS 0 /* No aliases for URL parsing */ - return template_fill_for_cgi(csp, template_name, exports, rsp); +#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 err; }