X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgiedit.c;h=55499c89cac20f6417eaa63f880e335c34c38ac5;hp=4b727c8f366e1b314ddd2ea721cbb7f1c1858377;hb=9191f5d733a8cb851bcaf65ac6d90ba6158709f5;hpb=2465a9102eb7d4f7a53bd454596e61edd16acb85 diff --git a/cgiedit.c b/cgiedit.c index 4b727c8f..55499c89 100644 --- a/cgiedit.c +++ b/cgiedit.c @@ -1,21 +1,28 @@ -const char cgiedit_rcs[] = "$Id: cgi.c,v 1.25 2001/09/16 15:02:35 jongfoster Exp $"; +const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.32 2002/04/19 16:55:31 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 + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General * Public License as published by the Free Software * Foundation; either version 2 of the License, or (at @@ -34,7 +41,174 @@ const char cgiedit_rcs[] = "$Id: cgi.c,v 1.25 2001/09/16 15:02:35 jongfoster Exp * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * Revisions : - * $Log: cgi.c,v $ + * $Log: cgiedit.c,v $ + * Revision 1.32 2002/04/19 16:55:31 jongfoster + * Fixing newline problems. If we do our own text file newline + * mangling, we don't want the library to do any, so we need to + * open the files in *binary* mode. + * + * Revision 1.31 2002/04/18 19:21:08 jongfoster + * Added code to detect "conventional" action files, that start + * with a set of actions for all URLs (the pattern "/"). + * These are special-cased in the "edit-actions-list" CGI, so + * that a special UI can be written for them. + * + * Revision 1.30 2002/04/10 13:38:35 oes + * load_template signature changed + * + * Revision 1.29 2002/04/08 16:59:08 oes + * Fixed comment + * + * Revision 1.28 2002/03/27 12:30:29 oes + * Deleted unsused variable + * + * Revision 1.27 2002/03/26 23:06:04 jongfoster + * Removing duplicate @ifs on the toggle page + * + * Revision 1.26 2002/03/26 22:59:17 jongfoster + * Fixing /toggle to display status consistently. + * + * Revision 1.25 2002/03/26 22:29:54 swa + * we have a new homepage! + * + * Revision 1.24 2002/03/24 15:23:33 jongfoster + * Name changes + * + * Revision 1.23 2002/03/24 13:32:41 swa + * name change related issues + * + * Revision 1.22 2002/03/24 13:25:43 swa + * name change related issues + * + * Revision 1.21 2002/03/22 18:02:48 jongfoster + * Fixing remote toggle + * + * Revision 1.20 2002/03/16 20:28:34 oes + * Added descriptions to the filters so users will know what they select in the cgi editor + * + * 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. + * + * Revision 1.5 2001/10/25 03:40:48 david__schmidt + * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple + * threads to call select() simultaneously. So, it's time to do a real, live, + * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__ + * (native). Both versions will work, but using __OS2__ offers multi-threading. + * + * Revision 1.4 2001/10/23 21:48:19 jongfoster + * Cleaning up error handling in CGI functions - they now send back + * a HTML error page and should never cause a FATAL error. (Fixes one + * potential source of "denial of service" attacks). + * + * CGI actions file editor that works and is actually useful. + * + * Ability to toggle JunkBuster remotely using a CGI call. + * + * You can turn off both the above features in the main configuration + * file, e.g. if you are running a multi-user proxy. + * + * Revision 1.3 2001/10/14 22:12:49 jongfoster + * New version of CGI-based actionsfile editor. + * Major changes, including: + * - Completely new file parser and file output routines + * - edit-actions CGI renamed edit-actions-for-url + * - All CGIs now need a filename parameter, except for... + * - New CGI edit-actions which doesn't need a filename, + * to allow you to start the editor up. + * - edit-actions-submit now works, and now automatically + * redirects you back to the main edit-actions-list handler. + * + * Revision 1.2 2001/09/16 17:05:14 jongfoster + * Removing unused #include showarg.h + * + * Revision 1.1 2001/09/16 15:47:37 jongfoster + * First version of CGI-based edit interface. This is very much a + * work-in-progress, and you can't actually use it to edit anything + * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes + * to have any effect. + * * **********************************************************************/ @@ -46,11 +220,12 @@ const char cgiedit_rcs[] = "$Id: cgi.c,v 1.25 2001/09/16 15:02:35 jongfoster Exp */ #include -#include #include +#include #include #include #include +#include #ifdef _WIN32 #define snprintf _snprintf @@ -59,437 +234,4200 @@ const char cgiedit_rcs[] = "$Id: cgi.c,v 1.25 2001/09/16 15:02:35 jongfoster Exp #include "project.h" #include "cgi.h" #include "cgiedit.h" +#include "cgisimple.h" #include "list.h" #include "encode.h" -#include "ssplit.h" -#include "jcc.h" -#include "filters.h" #include "actions.h" -#include "errlog.h" #include "miscutil.h" -#include "showargs.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; #ifdef FEATURE_CGI_EDIT_ACTIONS - -/********************************************************************* - * - * Function : cgi_edit_actions_list - * - * 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 - * - * CGI Parameters : None - * - * Returns : 0 - * - *********************************************************************/ -int cgi_edit_actions_list(struct client_state *csp, struct http_response *rsp, - struct map *parameters) +struct file_line { - struct file_list *fl; - struct url_actions *actions; - char * actions_html; - char * next_actions_html; - char * section_template; - char * url_template; - char * sections; - char * urls; - struct map * exports = default_exports(csp, NULL); - struct map * section_exports; - struct map * url_exports; - int urlid; - char buf[50]; - char * s; - int url_1_2; + struct file_line * next; + char * raw; + char * prefix; + char * unprocessed; + int type; - if (((fl = csp->actions_list) == NULL) || ((actions = fl->f) == NULL)) + union { - /* FIXME: Oops, no file to edit */ - free_map(exports); - return cgi_default(csp, rsp, parameters); - } + struct action_spec action[1]; - /* Should do all global exports above this point */ + struct + { + char * name; + char * svalue; + int ivalue; + } setting; - section_template = template_load(csp, "edit-actions-list-section"); - url_template = template_load(csp, "edit-actions-list-url"); + /* Add more data types here... e.g. - template_fill(§ion_template, exports); - template_fill(&url_template, exports); - urlid = 0; - sections = strdup(""); + struct url_spec url[1]; - ++urlid; - actions = actions->next; - if (actions != NULL) - { - actions_html = actions_to_html(actions->action); - } + struct + { + struct action_spec action[1]; + const char * name; + } alias; - while (actions != NULL) - { - section_exports = new_map(); + */ - snprintf(buf, 50, "%d", urlid); - map(section_exports, "sectionid", 1, buf, 1); + } data; +}; - map(section_exports, "actions", 1, actions_html, 1); +#define FILE_LINE_UNPROCESSED 1 +#define FILE_LINE_BLANK 2 +#define FILE_LINE_ALIAS_HEADER 3 +#define FILE_LINE_ALIAS_ENTRY 4 +#define FILE_LINE_ACTION 5 +#define FILE_LINE_URL 6 +#define FILE_LINE_SETTINGS_HEADER 7 +#define FILE_LINE_SETTINGS_ENTRY 8 +#define FILE_LINE_DESCRIPTION_HEADER 9 +#define FILE_LINE_DESCRIPTION_ENTRY 10 - /* Should do all section-specific exports above this point */ - urls = strdup(""); - url_1_2 = 2; +struct editable_file +{ + struct file_line * lines; + const char * filename; /* Full pathname - e.g. "/etc/privoxy/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 + * cast the time_t to an unsigned, and *NOT* vice-versa. + * This may lose the top few bits, but they're not + * significant anyway. + */ + int newline; /* Newline convention - one of the NEWLINE_xxx constants. + * Note that changing this after the file has been + * read in will cause a mess. + */ + struct file_line * parse_error; /* On parse error, this is the offending line. */ + const char * parse_error_text; /* On parse error, this is the problem. + * (Statically allocated) */ +}; - next_actions_html = NULL; - do - { - freez(next_actions_html); +/* FIXME: Following non-static functions should be prototyped in .h or made static */ - url_exports = new_map(); +/* Functions to read and write arbitrary config files */ +jb_err edit_read_file(struct client_state *csp, + const struct map *parameters, + int require_version, + const char *suffix, + struct editable_file **pfile); +jb_err edit_write_file(struct editable_file * file); +void edit_free_file(struct editable_file * file); - snprintf(buf, 50, "%d", urlid); - map(url_exports, "urlid", 1, buf, 1); +/* Functions to read and write actions files */ +jb_err edit_parse_actions_file(struct editable_file * file); +jb_err edit_read_actions_file(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters, + int require_version, + struct editable_file **pfile); - snprintf(buf, 50, "%d", url_1_2); - map(url_exports, "url-1-2", 1, buf, 1); +/* Error handlers */ +jb_err cgi_error_modified(struct client_state *csp, + struct http_response *rsp, + const char *filename); +jb_err cgi_error_parse(struct client_state *csp, + struct http_response *rsp, + struct editable_file *file); +jb_err cgi_error_file(struct client_state *csp, + struct http_response *rsp, + const char *filename); +jb_err cgi_error_disabled(struct client_state *csp, + struct http_response *rsp); - s = html_encode(actions->url->spec); - map(url_exports, "url", 1, s, 1); +/* Internal arbitrary config file support functions */ +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); - s = strdup(url_template); - template_fill(&s, section_exports); - template_fill(&s, url_exports); - urls = strsav(urls, s); - free_map(url_exports); +/* Internal actions file support functions */ +static int match_actions_file_header_line(const char * line, const char * name); +static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue); - ++urlid; - url_1_2 = 3 - url_1_2; - actions = actions->next; - if (actions) - { - next_actions_html = actions_to_html(actions->action); - } - } - while (actions && (0 == strcmp(actions_html, next_actions_html))); +/* Internal parameter parsing functions */ +static jb_err get_file_name_param(struct client_state *csp, + const struct map *parameters, + const char *param_name, + const char *suffix, + char **pfilename, + const char **pparam); - map(section_exports, "urls", 1, urls, 0); +static jb_err get_url_spec_param(struct client_state *csp, + const struct map *parameters, + const char *name, + char **pvalue); - /* Could also do section-specific exports here, but it wouldn't be as fast */ - s = strdup(section_template); - template_fill(&s, section_exports); - sections = strsav(sections, s); - free_map(section_exports); +/* Internal actionsfile <==> HTML conversion functions */ +static jb_err map_radio(struct map * exports, + const char * optionname, + const char * values, + 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, + struct action_spec *action); - freez(actions_html); - actions_html = next_actions_html; - } - map(exports, "sections", 1, sections, 0); +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 */ - /* Could also do global exports here, but it wouldn't be as fast */ +/********************************************************************* + * + * Function : map_copy_parameter_html + * + * Description : Copy a CGI parameter from one map to another, HTML + * encoding it. + * + * Parameters : + * 1 : out = target map + * 2 : in = source map + * 3 : name = name of cgi parameter to copy + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the parameter doesn't exist + * in the source map + * + *********************************************************************/ +static jb_err map_copy_parameter_html(struct map *out, + const struct map *in, + const char *name) +{ + const char * value; + jb_err err; + + assert(out); + assert(in); + assert(name); - rsp->body = template_load(csp, "edit-actions-list"); - template_fill(&rsp->body, exports); - free_map(exports); + value = lookup(in, name); + err = map(out, name, 1, html_encode(value), 0); - return(0); + if (err) + { + /* Out of memory */ + return err; + } + else if (*value == '\0') + { + return JB_ERR_CGI_PARAMS; + } + else + { + return JB_ERR_OK; + } } +#if 0 /* unused function */ /********************************************************************* * - * Function : map_radio + * Function : map_copy_parameter_url * - * Description : Map a set of radio button values. E.g. if you have - * 3 radio buttons, declare them as: - *

Set" + " to %s

", b->url->spec + 9, b->url->spec + 9); + if (!err) err = string_append(&buttons, buf); + } + } + } + } + if (!err) err = map(exports, "all-urls-buttons", 1, buttons, 0); + + /* + * Conventional actions file, supply extra editing help. + * (e.g. don't allow them to make it an unconventional one). + */ + err = map_conditional(exports, "all-urls-present", 1); + + snprintf(buf, 150, "%d", line_number); + if (!err) err = map(exports, "all-urls-s", 1, buf, 1); + snprintf(buf, 150, "%d", line_number + 2); + if (!err) err = map(exports, "all-urls-s-next", 1, buf, 1); + if (!err) err = map(exports, "all-urls-actions", 1, + actions_to_html(cur_line->data.action), 0); + + /* Skip the 2 lines */ + cur_line = cur_line->next->next; + line_number += 2; + + /* + * Note that prev_section_line_number is NOT set here. + * This is deliberate and not a bug. It stops a "Move up" + * option appearing on the next section. Clicking "Move + * up" would make the actions file unconventional, which + * we don't want, so we hide this option. + */ + } + else + { + /* + * Non-standard actions file - does not begin with + * the "All URLs" section. + */ + err = map_conditional(exports, "all-urls-present", 0); + } + + /* Set up global exports */ + + err = map(exports, "f", 1, file->identifier, 1); + if (!err) err = map(exports, "v", 1, file->version_str, 1); + + /* Discourage private additions to default.action */ + + if (!err) err = map_conditional(exports, "default-action", + (strcmp("default", lookup(parameters, "f")) == 0)); + if (err) + { + edit_free_file(file); + free_map(exports); + return err; + } + + /* Should do all global exports above this point */ + + /* Load templates */ + + err = template_load(csp, §ion_template, "edit-actions-list-section", 0); + if (err) + { + edit_free_file(file); + free_map(exports); + if (err == JB_ERR_FILE) + { + return cgi_error_no_template(csp, rsp, "edit-actions-list-section"); + } + return err; + } + + err = template_load(csp, &url_template, "edit-actions-list-url", 0); + if (err) + { + free(section_template); + edit_free_file(file); + free_map(exports); + if (err == JB_ERR_FILE) + { + return cgi_error_no_template(csp, rsp, "edit-actions-list-url"); + } + return err; + } + + err = template_fill(§ion_template, exports); + if (err) + { + free(url_template); + edit_free_file(file); + free_map(exports); + free(url_template); + return err; + } + + err = template_fill(&url_template, exports); + if (err) + { + free(section_template); + edit_free_file(file); + free_map(exports); + return err; + } + + if (NULL == (sections = strdup(""))) + { + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + return JB_ERR_MEMORY; + } + + while ((cur_line != NULL) && (cur_line->type == FILE_LINE_ACTION)) + { + if (NULL == (section_exports = new_map())) + { + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + return JB_ERR_MEMORY; + } + + snprintf(buf, 150, "%d", line_number); + err = map(section_exports, "s", 1, buf, 1); + if (!err) err = map(section_exports, "actions", 1, + actions_to_html(cur_line->data.action), 0); + + if ( (!err) + && (cur_line->next != NULL) + && (cur_line->next->type == FILE_LINE_URL)) + { + /* This section contains at least one URL, don't allow delete */ + err = map_block_killer(section_exports, "empty-section"); + } + else + { + if (!err) err = map_block_keep(section_exports, "empty-section"); + } + + if (prev_section_line_number != ((unsigned)(-1))) + { + /* Not last section */ + snprintf(buf, 150, "%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) + { + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return err; + } + + /* Should do all section-specific exports above this point */ + + if (NULL == (urls = strdup(""))) + { + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return JB_ERR_MEMORY; + } + + url_1_2 = 2; + + cur_line = cur_line->next; + line_number++; + + while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL)) + { + if (NULL == (url_exports = new_map())) + { + free(urls); + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return JB_ERR_MEMORY; + } + + snprintf(buf, 150, "%d", line_number); + err = map(url_exports, "p", 1, buf, 1); + + snprintf(buf, 150, "%d", url_1_2); + if (!err) err = map(url_exports, "url-1-2", 1, buf, 1); + + if (!err) err = map(url_exports, "url-html", 1, + html_encode(cur_line->unprocessed), 0); + if (!err) err = map(url_exports, "url", 1, + url_encode(cur_line->unprocessed), 0); + + if (err) + { + free(urls); + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + free_map(url_exports); + return err; + } + + if (NULL == (s = strdup(url_template))) + { + free(urls); + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + free_map(url_exports); + return JB_ERR_MEMORY; + } + + err = template_fill(&s, section_exports); + if (!err) err = template_fill(&s, url_exports); + if (!err) err = string_append(&urls, s); + + free_map(url_exports); + freez(s); + + if (err) + { + freez(urls); + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return err; + } + + url_1_2 = 3 - url_1_2; + + cur_line = cur_line->next; + line_number++; + } + + err = map(section_exports, "urls", 1, urls, 0); + + /* Could also do section-specific exports here, but it wouldn't be as fast */ + + if ( (cur_line != NULL) + && (cur_line->type == FILE_LINE_ACTION)) + { + /* Not last section */ + snprintf(buf, 150, "%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); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return err; + } + + if (NULL == (s = strdup(section_template))) + { + free(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + free_map(section_exports); + return JB_ERR_MEMORY; + } + + err = template_fill(&s, section_exports); + if (!err) err = string_append(§ions, s); + + freez(s); + free_map(section_exports); + + if (err) + { + freez(sections); + free(section_template); + free(url_template); + edit_free_file(file); + free_map(exports); + return err; + } + } + + edit_free_file(file); + free(section_template); + free(url_template); + + err = map(exports, "sections", 1, sections, 0); + if (err) + { + free_map(exports); + return err; + } + + /* Could also do global exports here, but it wouldn't be as fast */ + + return template_fill_for_cgi(csp, "edit-actions-list", exports, rsp); +} + + +/********************************************************************* + * + * Function : cgi_edit_actions_for_url + * + * Description : CGI function that edits the Actions list. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters + * + * CGI Parameters : None + * + * 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_for_url(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + struct map * exports; + unsigned sectionid; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; + jb_err err; + struct 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, "s", §ionid); + if (err) + { + return err; + } + + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) + { + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } + + cur_line = file->lines; + + for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++) + { + cur_line = cur_line->next; + } + + if ( (cur_line == NULL) + || (line_number != sectionid) + || (sectionid < 1) + || (cur_line->type != FILE_LINE_ACTION)) + { + /* Invalid "sectionid" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + + if (NULL == (exports = default_exports(csp, NULL))) + { + edit_free_file(file); + return JB_ERR_MEMORY; + } + + err = map(exports, "f", 1, 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", 0); + if (err) + { + edit_free_file(file); + free_map(exports); + if (err == JB_ERR_FILE) + { + return cgi_error_no_template(csp, rsp, "edit-actions-for-url-filter"); + } + return err; + } + + 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); + + if (err) + { + free_map(exports); + return err; + } + + return template_fill_for_cgi(csp, "edit-actions-for-url", exports, rsp); +} + + +/********************************************************************* + * + * Function : cgi_edit_actions_submit + * + * 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 + * + * CGI Parameters : None + * + * 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_submit(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + unsigned sectionid; + char * actiontext; + char * newtext; + size_t len; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; + char * target; + jb_err err; + int index; + const char * action_set_name; + char ch; + struct file_list * fl; + struct url_actions * b; + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } + + err = get_number_param(csp, parameters, "s", §ionid); + if (err) + { + return err; + } + + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) + { + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } + + cur_line = file->lines; + + for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++) + { + cur_line = cur_line->next; + } + + if ( (cur_line == NULL) + || (line_number != sectionid) + || (sectionid < 1) + || (cur_line->type != FILE_LINE_ACTION)) + { + /* Invalid "sectionid" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + + get_string_param(parameters, "p", &action_set_name); + if (action_set_name != NULL) + { + for (index = 0; index < MAX_ACTION_FILES; index++) + { + if (((fl = csp->actions_list[index]) != NULL) && ((b = fl->f) != NULL)) + { + for (b = b->next; NULL != b; b = b->next) + { + if (!strncmp(b->url->spec, "standard.", 9) && !strcmp(b->url->spec + 9, action_set_name)) + { + copy_action(cur_line->data.action, b->action); + goto found; + } + } + } + } + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + + found: ; + } + else + { + err = actions_from_radio(parameters, cur_line->data.action); + } + + if(err) + { + /* Out of memory */ + edit_free_file(file); + 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 */ + edit_free_file(file); + return JB_ERR_MEMORY; + } + + len = strlen(actiontext); + if (len == 0) + { + /* + * Empty action - must special-case this. + * Simply setting len to 1 is sufficient... + */ + len = 1; + } + + if (NULL == (newtext = malloc(len + 2))) + { + /* Out of memory */ + free(actiontext); + edit_free_file(file); + return JB_ERR_MEMORY; + } + strcpy(newtext, actiontext); + free(actiontext); + newtext[0] = '{'; + newtext[len] = '}'; + newtext[len + 1] = '\0'; + + freez(cur_line->raw); + freez(cur_line->unprocessed); + cur_line->unprocessed = newtext; + + 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 Privoxy"); + 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_url + * + * Description : CGI function that actually edits a URL pattern in + * an actions file. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters + * + * CGI Parameters : + * filename : Identifies the file to edit + * ver : File's last-modified time + * section : Line number of section to edit + * pattern : Line number of pattern to edit + * newval : New value for pattern + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the CGI parameters are not + * specified or not valid. + * + *********************************************************************/ +jb_err cgi_edit_actions_url(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + unsigned patternid; + char * new_pattern; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; + char * target; + jb_err err; + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } + + err = get_number_param(csp, parameters, "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 = 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; + } + + 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 Privoxy"); + 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); + } + + 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); + } + + 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)) + { + /* Invalid "sectionid" parameter */ + free(new_pattern); + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + + /* 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 Privoxy"); + 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) + || (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 remove is in cur_line, and the previous + * one is in prev_line + */ + + /* Unlink cur_line */ + prev_line->next = cur_line->next; + cur_line->next = NULL; + + /* Free cur_line */ + edit_free_file_lines(cur_line); + + 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 Privoxy"); + 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_section_remove + * + * 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 + * + * CGI Parameters : + * 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 + * JB_ERR_CGI_PARAMS if the CGI parameters are not + * specified or not valid. + * + *********************************************************************/ +jb_err cgi_edit_actions_section_remove(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + unsigned sectionid; + 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, "s", §ionid); + if (err) + { + return err; + } + + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) + { + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } + + 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) ) + { + /* Invalid "sectionid" 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; + } + + /* 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) + { + /* Removing the first line from the file */ + file->lines = cur_line->next; + } + else + { + prev_line->next = cur_line->next; + } + cur_line->next = NULL; + + /* Free cur_line */ + edit_free_file_lines(cur_line); + + 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 Privoxy"); + 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_section_add + * + * 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 + * + * CGI Parameters : + * 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 + * 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) +{ + unsigned sectionid; + struct file_line * new_line; + char * new_text; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; + char * target; + jb_err err; + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } + + err = get_number_param(csp, parameters, "s", §ionid); + if (err) + { + return err; + } + + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) + { + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } + + line_number = 1; + cur_line = file->lines; + + if (sectionid < 1U) + { + /* Add to start of file */ + if (cur_line != NULL) + { + /* There's something in the file, find the line before the first + * action. + */ + while ( (cur_line->next != NULL) + && (cur_line->next->type != FILE_LINE_ACTION) ) + { + cur_line = cur_line->next; + line_number++; + } + } + } + else + { + /* Add after stated section. */ + while ((cur_line != NULL) && (line_number < sectionid)) + { + cur_line = cur_line->next; + line_number++; + } + + if ( (cur_line == NULL) + || (cur_line->type != FILE_LINE_ACTION)) + { + /* Invalid "sectionid" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; + } + + /* 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++; + } + } + + /* 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) + { + edit_free_file(file); + return JB_ERR_MEMORY; + } + + /* Allocate the new line */ + new_line = (struct file_line *)zalloc(sizeof(*new_line)); + if (new_line == NULL) + { + free(new_text); + edit_free_file(file); + return JB_ERR_MEMORY; + } + + /* Fill in the data members of the new line */ + new_line->raw = NULL; + new_line->prefix = NULL; + new_line->unprocessed = new_text; + new_line->type = FILE_LINE_ACTION; + + if (cur_line != NULL) + { + /* Link new_line into the list, after cur_line */ + new_line->next = cur_line->next; + cur_line->next = new_line; + } + else + { + /* Link new_line into the list, as first line */ + new_line->next = file->lines; + file->lines = new_line; + } + + /* 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 Privoxy"); + 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_section_swap + * + * 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 + * + * CGI Parameters : + * 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 + * JB_ERR_CGI_PARAMS if the CGI parameters are not + * specified or not valid. + * + *********************************************************************/ +jb_err cgi_edit_actions_section_swap(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + 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; + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } + + 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) + { + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); + } + + /* Start at the beginning... */ + line_number = 1; + cur_line = file->lines; + prev_line = NULL; + + /* ... find section1 ... */ + while ((cur_line != NULL) && (line_number < section1)) + { + prev_line = cur_line; + cur_line = cur_line->next; + line_number++; + } + + if ( (cur_line == NULL) + || (cur_line->type != FILE_LINE_ACTION) ) + { + /* Invalid "section1" parameter */ + 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. */ + + /* Change the pointer to section1 to point to section2 instead */ + if (line_before_section1 == NULL) + { + file->lines = line_start_section2; + } + else + { + line_before_section1->next = line_start_section2; + } + + if (line_before_section2 == line_end_section1) + { + /* Consecutive sections */ + line_end_section2->next = line_start_section1; + } + else + { + line_end_section2->next = line_after_section1; + line_before_section2->next = line_start_section1; + } + + /* Set the pointer from the end of section1 to the rest of the file */ + line_end_section1->next = line_after_section2; + + err = edit_write_file(file); + if (err) + { + /* Error writing file */ + edit_free_file(file); + return err; + } + } /* END if (section1 != section2) */ + + 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 Privoxy"); + if (rsp->status == NULL) + { + free(target); + return JB_ERR_MEMORY; + } + err = enlist_unique_header(rsp->headers, "Location", target); + free(target); + + return err; +} + + +/********************************************************************* + * + * 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 + * + * CGI Parameters : + * 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_toggle(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + struct map *exports; + char mode; + const char *template_name; + + assert(csp); + assert(rsp); + assert(parameters); + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_TOGGLE)) + { + return cgi_error_disabled(csp, rsp); + } + + 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; + } + + if (NULL == (exports = default_exports(csp, "toggle"))) + { + return JB_ERR_MEMORY; + } + + template_name = (get_char_param(parameters, "mini") + ? "toggle-mini" + : "toggle"); + + 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, '-'))) + { + *p++ = '_'; + } +} + + +/********************************************************************* + * + * 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; \ + } + +#define DEFINE_ACTION_STRING(name, bit, index) \ + DEFINE_ACTION_BOOL(name, bit); \ + mapped_param = 0; + +#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; \ + } + +#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; \ + } + +#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; \ + } + +#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */ + +#include "actionlist.h" + +#undef DEFINE_ACTION_MULTI +#undef DEFINE_ACTION_STRING +#undef DEFINE_ACTION_BOOL +#undef DEFINE_ACTION_ALIAS +#undef DEFINE_CGI_PARAM_CUSTOM +#undef DEFINE_CGI_PARAM_RADIO +#undef DEFINE_CGI_PARAM_NO_RADIO + + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : actions_from_radio + * + * Description : Converts a map of parameters passed to a CGI function + * into an actionsfile entry. + * + * 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. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * + *********************************************************************/ +static jb_err actions_from_radio(const struct map * parameters, + struct action_spec *action) +{ + static int first_time = 1; + const char * param; + char * param_dup; + char ch; + const char * js_name; + jb_err err = JB_ERR_OK; + + assert(parameters); + assert(action); + + /* Statics are generally a potential race condition, + * but in this case we're safe and don't need semaphores. + * Be careful if you modify this function. + * - Jon + */ + +#define JAVASCRIPTIFY(dest_var, string) \ + { \ + static char js_name_arr[] = string; \ + if (first_time) \ + { \ + javascriptify(js_name_arr); \ + } \ + dest_var = js_name_arr; \ + } \ + +#define DEFINE_ACTION_BOOL(name, bit) \ + JAVASCRIPTIFY(js_name, name); \ + 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; \ + } \ + +#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; \ + } \ + +#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; \ + } \ + +#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 - rsp->body = template_load(csp, "edit-actions-submit"); - template_fill(&rsp->body, exports); - free_map(exports); + first_time = 0; - return(0); + return err; }