1 const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.88 2016/02/26 12:29:38 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $
6 * Purpose : CGI-based actionsfile editor.
8 * NOTE: The CGIs in this file use parameter names
9 * such as "f" and "s" which are really *BAD* choices.
10 * However, I'm trying to save bytes in the
11 * edit-actions-list HTML page - the standard actions
12 * file generated a 550kbyte page, which is ridiculous.
14 * Stick to the short names in this file for consistency.
16 * Copyright : Written by and Copyright (C) 2001-2014 the
17 * Privoxy team. http://www.privoxy.org/
19 * Based on the Internet Junkbuster originally written
20 * by and Copyright (C) 1997 Anonymous Coders and
21 * Junkbusters Corporation. http://www.junkbusters.com
23 * This program is free software; you can redistribute it
24 * and/or modify it under the terms of the GNU General
25 * Public License as published by the Free Software
26 * Foundation; either version 2 of the License, or (at
27 * your option) any later version.
29 * This program is distributed in the hope that it will
30 * be useful, but WITHOUT ANY WARRANTY; without even the
31 * implied warranty of MERCHANTABILITY or FITNESS FOR A
32 * PARTICULAR PURPOSE. See the GNU General Public
33 * License for more details.
35 * The GNU General Public License should be included with
36 * this file. If not, you can view it at
37 * http://www.gnu.org/copyleft/gpl.html
38 * or write to the Free Software Foundation, Inc., 59
39 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
41 **********************************************************************/
47 * FIXME: Following includes copied from cgi.c - which are actually needed?
52 #include <sys/types.h>
61 #include "cgisimple.h"
69 /* loadcfg.h is for global_toggle_state only */
71 #endif /* def FEATURE_TOGGLE */
74 const char cgiedit_h_rcs[] = CGIEDIT_H_VERSION;
77 #ifdef FEATURE_CGI_EDIT_ACTIONS
80 * A line in an editable_file.
84 /** Next entry in the linked list */
85 struct file_line * next;
87 /** The raw data, to write out if this line is unmodified. */
90 /** Comments and/or whitespace to put before this line if it's modified
91 and then written out. */
94 /** The actual data, as a string. Line continuation and comment removal
95 are performed on the data read from file before it's stored here, so
96 it will be a single line of data. */
99 /** The type of data on this line. One of the FILE_LINE_xxx constants. */
102 /** The actual data, processed into some sensible data type. */
106 /** An action specification. */
107 struct action_spec action[1];
109 /** A name=value pair. */
113 /** The name in the name=value pair. */
116 /** The value in the name=value pair, as a string. */
119 /** The value in the name=value pair, as an integer. */
128 /** This file_line has not been processed yet. */
129 #define FILE_LINE_UNPROCESSED 1
131 /** This file_line is blank. Can only appear at the end of a file, due to
132 the way the parser works. */
133 #define FILE_LINE_BLANK 2
135 /** This file_line says {{alias}}. */
136 #define FILE_LINE_ALIAS_HEADER 3
138 /** This file_line defines an alias. */
139 #define FILE_LINE_ALIAS_ENTRY 4
141 /** This file_line defines an {action}. */
142 #define FILE_LINE_ACTION 5
144 /** This file_line specifies a URL pattern. */
145 #define FILE_LINE_URL 6
147 /** This file_line says {{settings}}. */
148 #define FILE_LINE_SETTINGS_HEADER 7
150 /** This file_line is in a {{settings}} block. */
151 #define FILE_LINE_SETTINGS_ENTRY 8
153 /** This file_line says {{description}}. */
154 #define FILE_LINE_DESCRIPTION_HEADER 9
156 /** This file_line is in a {{description}} block. */
157 #define FILE_LINE_DESCRIPTION_ENTRY 10
160 * Number of file modification time mismatches
161 * before the CGI editor gets turned off.
163 #define ACCEPTABLE_TIMESTAMP_MISMATCHES 3
166 * A configuration file, in a format that can be edited and written back to
171 struct file_line * lines; /**< The contents of the file. A linked list of lines. */
172 const char * filename; /**< Full pathname - e.g. "/etc/privoxy/wibble.action". */
173 unsigned identifier; /**< The file name's position in csp->config->actions_file[]. */
174 const char * version_str; /**< Last modification time, as a string. For CGI param. */
175 /**< Can be used in URL without using url_param(). */
176 unsigned version; /**< Last modification time - prevents chaos with
177 the browser's "back" button. Note that this is a
178 time_t cast to an unsigned. When comparing, always
179 cast the time_t to an unsigned, and *NOT* vice-versa.
180 This may lose the top few bits, but they're not
181 significant anyway. */
182 int newline; /**< Newline convention - one of the NEWLINE_xxx constants.
183 Note that changing this after the file has been
184 read in will cause a mess. */
185 struct file_line * parse_error; /**< On parse error, this is the offending line. */
186 const char * parse_error_text; /**< On parse error, this is the problem.
187 (Statically allocated) */
191 * Information about the filter types.
192 * Used for macro replacement in cgi_edit_actions_for_url.
194 struct filter_type_info
196 const int multi_action_index; /**< The multi action index as defined in project.h */
197 const char *macro_name; /**< Name of the macro that has to be replaced
198 with the prepared templates.
199 For example "content-filter-params" */
200 const char *type; /**< Name of the filter type,
201 for example "server-header-filter". */
202 /* XXX: check if these two can be combined. */
203 const char *disable_all_option; /**< Name of the catch-all radio option that has
204 to be checked or unchecked for this filter type. */
205 const char *disable_all_param; /**< Name of the parameter that causes all filters of
206 this type to be disabled. */
207 const char *abbr_type; /**< Abbreviation of the filter type, usually the
208 first or second character capitalized */
209 const char *anchor; /**< Anchor for the User Manual link,
210 for example "SERVER-HEADER-FILTER" */
213 /* Accessed by index, keep the order in the way the FT_ macros are defined. */
214 static const struct filter_type_info filter_type_info[] =
218 "content-filter-params", "filter",
219 "filter-all", "filter_all",
223 ACTION_MULTI_CLIENT_HEADER_FILTER,
224 "client-header-filter-params", "client-header-filter",
225 "client-header-filter-all", "client_header_filter_all",
226 "C", "CLIENT-HEADER-FILTER"
229 ACTION_MULTI_SERVER_HEADER_FILTER,
230 "server-header-filter-params", "server-header-filter",
231 "server-header-filter-all", "server_header_filter_all",
232 "S", "SERVER-HEADER-FILTER"
235 ACTION_MULTI_CLIENT_HEADER_TAGGER,
236 "client-header-tagger-params", "client-header-tagger",
237 "client-header-tagger-all", "client_header_tagger_all",
238 "L", "CLIENT-HEADER-TAGGER"
241 ACTION_MULTI_SERVER_HEADER_TAGGER,
242 "server-header-tagger-params", "server-header-tagger",
243 "server-header-tagger-all", "server_header_tagger_all",
244 "E", "SERVER-HEADER-TAGGER"
246 #ifdef FEATURE_EXTERNAL_FILTERS
248 ACTION_MULTI_EXTERNAL_FILTER,
249 "external-content-filter-params", "external-filter",
250 "external-content-filter-all", "external_content_filter_all",
251 "E", "EXTERNAL-CONTENT-FILTER"
256 /* FIXME: Following non-static functions should be prototyped in .h or made static */
258 /* Functions to read and write arbitrary config files */
259 jb_err edit_read_file(struct client_state *csp,
260 const struct map *parameters,
262 struct editable_file **pfile);
263 jb_err edit_write_file(struct editable_file * file);
264 void edit_free_file(struct editable_file * file);
266 /* Functions to read and write actions files */
267 jb_err edit_parse_actions_file(struct editable_file * file);
268 jb_err edit_read_actions_file(struct client_state *csp,
269 struct http_response *rsp,
270 const struct map *parameters,
272 struct editable_file **pfile);
275 jb_err cgi_error_modified(struct client_state *csp,
276 struct http_response *rsp,
277 const char *filename);
278 jb_err cgi_error_parse(struct client_state *csp,
279 struct http_response *rsp,
280 struct editable_file *file);
281 jb_err cgi_error_file(struct client_state *csp,
282 struct http_response *rsp,
283 const char *filename);
284 jb_err cgi_error_file_read_only(struct client_state *csp,
285 struct http_response *rsp,
286 const char *filename);
288 /* Internal arbitrary config file support functions */
289 static jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile, int *newline);
290 static void edit_free_file_lines(struct file_line * first_line);
292 /* Internal actions file support functions */
293 static int match_actions_file_header_line(const char * line, const char * name);
294 static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue);
296 /* Internal parameter parsing functions */
297 static jb_err get_url_spec_param(struct client_state *csp,
298 const struct map *parameters,
303 /* Internal actionsfile <==> HTML conversion functions */
304 static jb_err map_radio(struct map * exports,
305 const char * optionname,
308 static jb_err actions_to_radio(struct map * exports,
309 const struct action_spec *action);
310 static jb_err actions_from_radio(const struct map * parameters,
311 struct action_spec *action);
314 static jb_err map_copy_parameter_html(struct map *out,
315 const struct map *in,
318 static jb_err get_file_name_param(struct client_state *csp,
319 const struct map *parameters,
320 const char *param_name,
321 const char **pfilename);
323 /* Internal convenience functions */
324 static char *section_target(const unsigned sectionid);
326 /*********************************************************************
328 * Function : section_target
330 * Description : Given an unsigned (section id) n, produce a dynamically
331 * allocated string of the form #l<n>, for use in link
334 * XXX: The hash should be moved into the templates
335 * to make this function more generic and render
336 * stringify() obsolete.
339 * 1 : sectionid = start line number of section
341 * Returns : String with link target, or NULL if out of
344 *********************************************************************/
345 static char *section_target(const unsigned sectionid)
349 snprintf(buf, sizeof(buf), "#l%u", sectionid);
355 /*********************************************************************
357 * Function : stringify
359 * Description : Convert a number into a dynamically allocated string.
362 * 1 : number = The number to convert.
364 * Returns : String with link target, or NULL if out of memory
366 *********************************************************************/
367 static char *stringify(const unsigned number)
371 snprintf(buf, sizeof(buf), "%u", number);
376 /*********************************************************************
378 * Function : map_copy_parameter_html
380 * Description : Copy a CGI parameter from one map to another, HTML
384 * 1 : out = target map
385 * 2 : in = source map
386 * 3 : name = name of cgi parameter to copy
388 * Returns : JB_ERR_OK on success
389 * JB_ERR_MEMORY on out-of-memory
390 * JB_ERR_CGI_PARAMS if the parameter doesn't exist
393 *********************************************************************/
394 static jb_err map_copy_parameter_html(struct map *out,
395 const struct map *in,
405 value = lookup(in, name);
406 err = map(out, name, 1, html_encode(value), 0);
413 else if (*value == '\0')
415 return JB_ERR_CGI_PARAMS;
424 /*********************************************************************
426 * Function : cgi_edit_actions_url_form
428 * Description : CGI function that displays a form for
432 * 1 : csp = Current client state (buffers, headers, etc...)
433 * 2 : rsp = http_response data structure for output
434 * 3 : parameters = map of cgi parameters
437 * i : (action index) Identifies the file to edit
438 * v : (version) File's last-modified time
439 * p : (pattern) Line number of pattern to edit
441 * Returns : JB_ERR_OK on success
442 * JB_ERR_MEMORY on out-of-memory
443 * JB_ERR_CGI_PARAMS if the CGI parameters are not
444 * specified or not valid.
446 *********************************************************************/
447 jb_err cgi_edit_actions_url_form(struct client_state *csp,
448 struct http_response *rsp,
449 const struct map *parameters)
451 struct map * exports;
453 struct editable_file * file;
454 struct file_line * cur_line;
455 unsigned line_number;
456 unsigned section_start_line_number = 0;
463 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
465 return cgi_error_disabled(csp, rsp);
468 err = get_number_param(csp, parameters, "p", &patternid);
474 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
477 /* No filename specified, can't read file, modified, or out of memory. */
478 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
481 cur_line = file->lines;
483 for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++)
485 if (cur_line->type == FILE_LINE_ACTION)
487 section_start_line_number = line_number;
489 cur_line = cur_line->next;
492 if ( (cur_line == NULL)
493 || (line_number != patternid)
495 || (cur_line->type != FILE_LINE_URL))
497 /* Invalid "patternid" parameter */
498 edit_free_file(file);
499 return JB_ERR_CGI_PARAMS;
502 if (NULL == (exports = default_exports(csp, NULL)))
504 edit_free_file(file);
505 return JB_ERR_MEMORY;
508 err = map(exports, "f", 1, stringify(file->identifier), 0);
509 if (!err) err = map(exports, "v", 1, file->version_str, 1);
510 if (!err) err = map(exports, "p", 1, url_encode(lookup(parameters, "p")), 0);
511 if (!err) err = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0);
512 if (!err) err = map(exports, "jumptarget", 1, section_target(section_start_line_number), 0);
514 edit_free_file(file);
522 return template_fill_for_cgi(csp, "edit-actions-url-form", exports, rsp);
526 /*********************************************************************
528 * Function : cgi_edit_actions_add_url_form
530 * Description : CGI function that displays a form for
534 * 1 : csp = Current client state (buffers, headers, etc...)
535 * 2 : rsp = http_response data structure for output
536 * 3 : parameters = map of cgi parameters
539 * f : (filename) Identifies the file to edit
540 * v : (version) File's last-modified time
541 * s : (section) Line number of section to edit
543 * Returns : JB_ERR_OK on success
544 * JB_ERR_MEMORY on out-of-memory
545 * JB_ERR_CGI_PARAMS if the CGI parameters are not
546 * specified or not valid.
548 *********************************************************************/
549 jb_err cgi_edit_actions_add_url_form(struct client_state *csp,
550 struct http_response *rsp,
551 const struct map *parameters)
560 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
562 return cgi_error_disabled(csp, rsp);
565 if (NULL == (exports = default_exports(csp, NULL)))
567 return JB_ERR_MEMORY;
570 err = map_copy_parameter_html(exports, parameters, "f");
571 if (!err) err = map_copy_parameter_html(exports, parameters, "v");
572 if (!err) err = map_copy_parameter_html(exports, parameters, "s");
580 return template_fill_for_cgi(csp, "edit-actions-add-url-form", exports, rsp);
584 /*********************************************************************
586 * Function : cgi_edit_actions_remove_url_form
588 * Description : CGI function that displays a form for
592 * 1 : csp = Current client state (buffers, headers, etc...)
593 * 2 : rsp = http_response data structure for output
594 * 3 : parameters = map of cgi parameters
597 * f : (number) The action file identifier.
598 * v : (version) File's last-modified time
599 * p : (pattern) Line number of pattern to edit
601 * Returns : JB_ERR_OK on success
602 * JB_ERR_MEMORY on out-of-memory
603 * JB_ERR_CGI_PARAMS if the CGI parameters are not
604 * specified or not valid.
606 *********************************************************************/
607 jb_err cgi_edit_actions_remove_url_form(struct client_state *csp,
608 struct http_response *rsp,
609 const struct map *parameters)
611 struct map * exports;
613 struct editable_file * file;
614 struct file_line * cur_line;
615 unsigned line_number;
616 unsigned section_start_line_number = 0;
623 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
625 return cgi_error_disabled(csp, rsp);
628 err = get_number_param(csp, parameters, "p", &patternid);
634 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
637 /* No filename specified, can't read file, modified, or out of memory. */
638 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
641 cur_line = file->lines;
643 for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++)
645 if (cur_line->type == FILE_LINE_ACTION)
647 section_start_line_number = line_number;
649 cur_line = cur_line->next;
652 if ( (cur_line == NULL)
653 || (line_number != patternid)
655 || (cur_line->type != FILE_LINE_URL))
657 /* Invalid "patternid" parameter */
658 edit_free_file(file);
659 return JB_ERR_CGI_PARAMS;
662 if (NULL == (exports = default_exports(csp, NULL)))
664 edit_free_file(file);
665 return JB_ERR_MEMORY;
668 err = map(exports, "f", 1, stringify(file->identifier), 0);
669 if (!err) err = map(exports, "v", 1, file->version_str, 1);
670 if (!err) err = map(exports, "p", 1, url_encode(lookup(parameters, "p")), 0);
671 if (!err) err = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0);
672 if (!err) err = map(exports, "jumptarget", 1, section_target(section_start_line_number), 0);
673 if (!err) err = map(exports, "actions-file", 1, html_encode(file->filename), 0);
675 edit_free_file(file);
683 return template_fill_for_cgi(csp, "edit-actions-remove-url-form", exports, rsp);
687 /*********************************************************************
689 * Function : edit_write_file
691 * Description : Write a complete file to disk.
694 * 1 : file = File to write.
696 * Returns : JB_ERR_OK on success
697 * JB_ERR_FILE on error writing to file.
698 * JB_ERR_MEMORY on out of memory
700 *********************************************************************/
701 jb_err edit_write_file(struct editable_file * file)
704 struct file_line * cur_line;
705 struct stat statbuf[1];
706 char version_buf[22]; /* 22 = ceil(log10(2^64)) + 2 = max number of
707 digits in time_t, assuming this is a 64-bit
708 machine, plus null terminator, plus one
712 assert(file->filename);
714 if (NULL == (fp = fopen(file->filename, "wb")))
719 cur_line = file->lines;
720 while (cur_line != NULL)
724 if (fputs(cur_line->raw, fp) < 0)
732 if (cur_line->prefix)
734 if (fputs(cur_line->prefix, fp) < 0)
740 if (cur_line->unprocessed)
743 if (NULL != strchr(cur_line->unprocessed, '#'))
745 /* Must quote '#' characters */
752 /* Count number of # characters, so we know length of output string */
753 src = cur_line->unprocessed;
754 while (NULL != (src = strchr(src, '#')))
761 /* Allocate new memory for string */
762 len = strlen(cur_line->unprocessed) + (size_t)numhash;
763 str = malloc_or_die(len + 1);
765 /* Copy string but quote hashes */
766 src = cur_line->unprocessed;
774 assert(numhash >= 0);
780 assert(numhash == 0);
781 assert(strlen(str) == len);
782 assert(str == dest - len);
783 assert(src - len <= cur_line->unprocessed);
785 if ((strlen(str) != len) || (numhash != 0))
788 * Escaping didn't work as expected, go spread the news.
789 * Only reached in non-debugging builds.
791 log_error(LOG_LEVEL_ERROR,
792 "Looks like hash escaping failed. %s might be corrupted now.",
796 if (fputs(str, fp) < 0)
807 /* Can write without quoting '#' characters. */
808 if (fputs(cur_line->unprocessed, fp) < 0)
814 if (fputs(NEWLINE(file->newline), fp) < 0)
822 /* FIXME: Write data from file->data->whatever */
826 cur_line = cur_line->next;
832 /* Update the version stamp in the file structure, since we just
833 * wrote to the file & changed it's date.
835 if (stat(file->filename, statbuf) < 0)
837 /* Error, probably file not found. */
840 file->version = (unsigned)statbuf->st_mtime;
842 /* Correct file->version_str */
843 freez(file->version_str);
844 snprintf(version_buf, sizeof(version_buf), "%u", file->version);
845 version_buf[sizeof(version_buf)-1] = '\0';
846 file->version_str = strdup_or_die(version_buf);
852 /*********************************************************************
854 * Function : edit_free_file
856 * Description : Free a complete file in memory.
859 * 1 : file = Data structure to free.
863 *********************************************************************/
864 void edit_free_file(struct editable_file * file)
868 /* Silently ignore NULL pointer */
872 edit_free_file_lines(file->lines);
873 freez(file->version_str);
875 file->parse_error_text = NULL; /* Statically allocated */
876 file->parse_error = NULL;
882 /*********************************************************************
884 * Function : edit_free_file_lines
886 * Description : Free an entire linked list of file lines.
889 * 1 : first_line = Data structure to free.
893 *********************************************************************/
894 static void edit_free_file_lines(struct file_line * first_line)
896 struct file_line * next_line;
898 while (first_line != NULL)
900 next_line = first_line->next;
901 first_line->next = NULL;
902 freez(first_line->raw);
903 freez(first_line->prefix);
904 freez(first_line->unprocessed);
905 switch(first_line->type)
907 case 0: /* special case if memory zeroed */
908 case FILE_LINE_UNPROCESSED:
909 case FILE_LINE_BLANK:
910 case FILE_LINE_ALIAS_HEADER:
911 case FILE_LINE_SETTINGS_HEADER:
912 case FILE_LINE_DESCRIPTION_HEADER:
913 case FILE_LINE_DESCRIPTION_ENTRY:
914 case FILE_LINE_ALIAS_ENTRY:
916 /* No data is stored for these */
919 case FILE_LINE_ACTION:
920 free_action(first_line->data.action);
923 case FILE_LINE_SETTINGS_ENTRY:
924 freez(first_line->data.setting.name);
925 freez(first_line->data.setting.svalue);
928 /* Should never happen */
932 first_line->type = 0; /* paranoia */
934 first_line = next_line;
939 /*********************************************************************
941 * Function : match_actions_file_header_line
943 * Description : Match an actions file {{header}} line
946 * 1 : line = String from file
947 * 2 : name = Header to match against
949 * Returns : 0 iff they match.
951 *********************************************************************/
952 static int match_actions_file_header_line(const char * line, const char * name)
960 if ((line[0] != '{') || (line[1] != '{'))
966 /* Look for optional whitespace */
967 while ((*line == ' ') || (*line == '\t'))
972 /* Look for the specified name (case-insensitive) */
974 if (0 != strncmpic(line, name, len))
980 /* Look for optional whitespace */
981 while ((*line == ' ') || (*line == '\t'))
986 /* Look for "}}" and end of string*/
987 if ((line[0] != '}') || (line[1] != '}') || (line[2] != '\0'))
997 /*********************************************************************
999 * Function : match_actions_file_header_line
1001 * Description : Match an actions file {{header}} line
1004 * 1 : line = String from file. Must not start with
1005 * whitespace (else infinite loop!)
1006 * 2 : pname = Destination for name
1007 * 2 : pvalue = Destination for value
1009 * Returns : JB_ERR_OK on success
1010 * JB_ERR_MEMORY on out-of-memory
1011 * JB_ERR_PARSE if there's no "=" sign, or if there's
1012 * nothing before the "=" sign (but empty
1013 * values *after* the "=" sign are legal).
1015 *********************************************************************/
1016 static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue)
1018 const char * name_end;
1019 const char * value_start;
1025 assert(*line != ' ');
1026 assert(*line != '\t');
1031 value_start = strchr(line, '=');
1032 if ((value_start == NULL) || (value_start == line))
1034 return JB_ERR_PARSE;
1037 name_end = value_start - 1;
1039 /* Eat any whitespace before the '=' */
1040 while ((*name_end == ' ') || (*name_end == '\t'))
1043 * we already know we must have at least 1 non-ws char
1044 * at start of buf - no need to check
1049 name_len = (size_t)(name_end - line) + 1; /* Length excluding \0 */
1050 *pname = malloc_or_die(name_len + 1);
1051 strncpy(*pname, line, name_len);
1052 (*pname)[name_len] = '\0';
1054 /* Eat any the whitespace after the '=' */
1056 while ((*value_start == ' ') || (*value_start == '\t'))
1061 if (NULL == (*pvalue = strdup(value_start)))
1065 return JB_ERR_MEMORY;
1072 /*********************************************************************
1074 * Function : edit_parse_actions_file
1076 * Description : Parse an actions file in memory.
1078 * Passed linked list must have the "data" member
1079 * zeroed, and must contain valid "next" and
1080 * "unprocessed" fields. The "raw" and "prefix"
1081 * fields are ignored, and "type" is just overwritten.
1083 * Note that on error the file may have been
1087 * 1 : file = Actions file to be parsed in-place.
1089 * Returns : JB_ERR_OK on success
1090 * JB_ERR_MEMORY on out-of-memory
1091 * JB_ERR_PARSE on error
1093 *********************************************************************/
1094 jb_err edit_parse_actions_file(struct editable_file * file)
1096 struct file_line * cur_line;
1098 const char * text; /* Text from a line */
1099 char * name; /* For lines of the form name=value */
1100 char * value; /* For lines of the form name=value */
1101 struct action_alias * alias_list = NULL;
1102 jb_err err = JB_ERR_OK;
1104 /* alias_list contains the aliases defined in this file.
1105 * It might be better to use the "file_line.data" fields
1106 * in the relavent places instead.
1109 cur_line = file->lines;
1111 /* A note about blank line support: Blank lines should only
1112 * ever occur as the last line in the file. This function
1113 * is more forgiving than that - FILE_LINE_BLANK can occur
1117 /* Skip leading blanks. Should only happen if file is
1118 * empty (which is valid, but pointless).
1120 while ((cur_line != NULL)
1121 && (cur_line->unprocessed[0] == '\0'))
1124 cur_line->type = FILE_LINE_BLANK;
1125 cur_line = cur_line->next;
1128 if ((cur_line != NULL)
1129 && (cur_line->unprocessed[0] != '{'))
1131 /* File doesn't start with a header */
1132 file->parse_error = cur_line;
1133 file->parse_error_text = "First (non-comment) line of the file must contain a header.";
1134 return JB_ERR_PARSE;
1137 if ((cur_line != NULL) && (0 ==
1138 match_actions_file_header_line(cur_line->unprocessed, "settings")))
1140 cur_line->type = FILE_LINE_SETTINGS_HEADER;
1142 cur_line = cur_line->next;
1143 while ((cur_line != NULL) && (cur_line->unprocessed[0] != '{'))
1145 if (cur_line->unprocessed[0])
1147 cur_line->type = FILE_LINE_SETTINGS_ENTRY;
1149 err = split_line_on_equals(cur_line->unprocessed,
1150 &cur_line->data.setting.name,
1151 &cur_line->data.setting.svalue);
1152 if (err == JB_ERR_MEMORY)
1156 else if (err != JB_ERR_OK)
1158 /* Line does not contain a name=value pair */
1159 file->parse_error = cur_line;
1160 file->parse_error_text = "Expected a name=value pair on this {{description}} line, but couldn't find one.";
1161 return JB_ERR_PARSE;
1166 cur_line->type = FILE_LINE_BLANK;
1168 cur_line = cur_line->next;
1172 if ((cur_line != NULL) && (0 ==
1173 match_actions_file_header_line(cur_line->unprocessed, "description")))
1175 cur_line->type = FILE_LINE_DESCRIPTION_HEADER;
1177 cur_line = cur_line->next;
1178 while ((cur_line != NULL) && (cur_line->unprocessed[0] != '{'))
1180 if (cur_line->unprocessed[0])
1182 cur_line->type = FILE_LINE_DESCRIPTION_ENTRY;
1186 cur_line->type = FILE_LINE_BLANK;
1188 cur_line = cur_line->next;
1192 if ((cur_line != NULL) && (0 ==
1193 match_actions_file_header_line(cur_line->unprocessed, "alias")))
1195 cur_line->type = FILE_LINE_ALIAS_HEADER;
1197 cur_line = cur_line->next;
1198 while ((cur_line != NULL) && (cur_line->unprocessed[0] != '{'))
1200 if (cur_line->unprocessed[0])
1202 /* define an alias */
1203 struct action_alias * new_alias;
1205 cur_line->type = FILE_LINE_ALIAS_ENTRY;
1207 err = split_line_on_equals(cur_line->unprocessed, &name, &value);
1208 if (err == JB_ERR_MEMORY)
1210 free_alias_list(alias_list);
1213 else if (err != JB_ERR_OK)
1215 /* Line does not contain a name=value pair */
1216 file->parse_error = cur_line;
1217 file->parse_error_text = "Expected a name=value pair on this {{alias}} line, but couldn't find one.";
1218 free_alias_list(alias_list);
1219 return JB_ERR_PARSE;
1222 new_alias = zalloc_or_die(sizeof(*new_alias));
1224 err = get_actions(value, alias_list, new_alias->action);
1227 /* Invalid action or out of memory */
1231 free_alias_list(alias_list);
1232 if (err == JB_ERR_MEMORY)
1238 /* Line does not contain a name=value pair */
1239 file->parse_error = cur_line;
1240 file->parse_error_text = "This alias does not specify a valid set of actions.";
1241 return JB_ERR_PARSE;
1247 new_alias->name = name;
1250 new_alias->next = alias_list;
1251 alias_list = new_alias;
1255 cur_line->type = FILE_LINE_BLANK;
1257 cur_line = cur_line->next;
1261 /* Header done, process the main part of the file */
1262 while (cur_line != NULL)
1264 /* At this point, (cur_line->unprocessed[0] == '{') */
1265 assert(cur_line->unprocessed[0] == '{');
1266 text = cur_line->unprocessed + 1;
1267 len = strlen(text) - 1;
1268 if (text[len] != '}')
1270 /* No closing } on header */
1271 free_alias_list(alias_list);
1272 file->parse_error = cur_line;
1273 file->parse_error_text = "Headers starting with '{' must have a "
1274 "closing bracket ('}'). Headers starting with two brackets ('{{') "
1275 "must close with two brackets ('}}').";
1276 return JB_ERR_PARSE;
1281 /* An invalid {{ header. */
1282 free_alias_list(alias_list);
1283 file->parse_error = cur_line;
1284 file->parse_error_text = "Unknown or unexpected two-bracket header. "
1285 "Please remember that the system (two-bracket) headers must "
1286 "appear in the order {{settings}}, {{description}}, {{alias}}, "
1287 "and must appear before any actions (one-bracket) headers. "
1288 "Also note that system headers may not be repeated.";
1289 return JB_ERR_PARSE;
1292 while ((*text == ' ') || (*text == '\t'))
1297 while ((len > (size_t)0)
1298 && ((text[len - 1] == ' ')
1299 || (text[len - 1] == '\t')))
1304 cur_line->type = FILE_LINE_ACTION;
1306 /* Remove {} and make copy */
1307 value = malloc_or_die(len + 1);
1308 strncpy(value, text, len);
1312 err = get_actions(value, alias_list, cur_line->data.action);
1315 /* Invalid action or out of memory */
1317 free_alias_list(alias_list);
1318 if (err == JB_ERR_MEMORY)
1324 /* Line does not contain a name=value pair */
1325 file->parse_error = cur_line;
1326 file->parse_error_text = "This header does not specify a valid set of actions.";
1327 return JB_ERR_PARSE;
1331 /* Done with string - it was clobbered anyway */
1334 /* Process next line */
1335 cur_line = cur_line->next;
1337 /* Loop processing URL patterns */
1338 while ((cur_line != NULL) && (cur_line->unprocessed[0] != '{'))
1340 if (cur_line->unprocessed[0])
1342 /* Could parse URL here, but this isn't currently needed */
1344 cur_line->type = FILE_LINE_URL;
1348 cur_line->type = FILE_LINE_BLANK;
1350 cur_line = cur_line->next;
1352 } /* End main while(cur_line != NULL) loop */
1354 free_alias_list(alias_list);
1360 /*********************************************************************
1362 * Function : edit_read_file_lines
1364 * Description : Read all the lines of a file into memory.
1365 * Handles whitespace, comments and line continuation.
1368 * 1 : fp = File to read from. On return, this will be
1369 * at EOF but it will not have been closed.
1370 * 2 : pfile = Destination for a linked list of file_lines.
1371 * Will be set to NULL on error.
1372 * 3 : newline = How to handle newlines.
1374 * Returns : JB_ERR_OK on success
1375 * JB_ERR_MEMORY on out-of-memory
1377 *********************************************************************/
1378 jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile, int *newline)
1380 struct file_line * first_line; /* Keep for return value or to free */
1381 struct file_line * cur_line; /* Current line */
1382 struct file_line * prev_line; /* Entry with prev_line->next = cur_line */
1390 cur_line = first_line = zalloc_or_die(sizeof(struct file_line));
1392 cur_line->type = FILE_LINE_UNPROCESSED;
1394 rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed, newline, NULL);
1397 /* Out of memory or empty file. */
1398 /* Note that empty file is not an error we propagate up */
1400 return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval);
1405 prev_line = cur_line;
1406 cur_line = prev_line->next = zalloc_or_die(sizeof(struct file_line));
1408 cur_line->type = FILE_LINE_UNPROCESSED;
1410 rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed, newline, NULL);
1411 if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE))
1414 edit_free_file_lines(first_line);
1415 return JB_ERR_MEMORY;
1419 while (rval != JB_ERR_FILE);
1423 /* We allocated one too many - free it */
1424 prev_line->next = NULL;
1427 *pfile = first_line;
1432 /*********************************************************************
1434 * Function : edit_read_file
1436 * Description : Read a complete file into memory.
1437 * Handles CGI parameter parsing. If requested, also
1438 * checks the file's modification timestamp.
1441 * 1 : csp = Current client state (buffers, headers, etc...)
1442 * 2 : parameters = map of cgi parameters.
1443 * 3 : require_version = true to check "ver" parameter.
1444 * 4 : pfile = Destination for the file. Will be set
1448 * f : The action file identifier.
1449 * ver : (Only if require_version is nonzero)
1450 * Timestamp of the actions file. If wrong, this
1451 * function fails with JB_ERR_MODIFIED.
1453 * Returns : JB_ERR_OK on success
1454 * JB_ERR_MEMORY on out-of-memory
1455 * JB_ERR_CGI_PARAMS if "filename" was not specified
1457 * JB_ERR_FILE if the file cannot be opened or
1459 * JB_ERR_MODIFIED if version checking was requested and
1460 * failed - the file was modified outside
1461 * of this CGI editor instance.
1463 *********************************************************************/
1464 jb_err edit_read_file(struct client_state *csp,
1465 const struct map *parameters,
1466 int require_version,
1467 struct editable_file **pfile)
1469 struct file_line * lines;
1472 const char *filename = NULL;
1473 struct editable_file * file;
1474 unsigned version = 0;
1475 struct stat statbuf[1];
1476 char version_buf[22];
1477 int newline = NEWLINE_UNKNOWN;
1486 err = get_number_param(csp, parameters, "f", &i);
1487 if ((JB_ERR_OK == err) && (i < MAX_AF_FILES) && (NULL != csp->config->actions_file[i]))
1489 filename = csp->config->actions_file[i];
1491 else if (JB_ERR_CGI_PARAMS == err)
1494 * Probably an old-school URL like
1495 * http://config.privoxy.org/edit-actions-list?f=default
1497 get_file_name_param(csp, parameters, "f", &filename);
1500 if (NULL == filename || stat(filename, statbuf) < 0)
1502 /* Error, probably file not found. */
1505 version = (unsigned) statbuf->st_mtime;
1507 if (require_version)
1509 unsigned specified_version;
1510 err = get_number_param(csp, parameters, "v", &specified_version);
1516 if (version != specified_version)
1518 return JB_ERR_MODIFIED;
1522 if (NULL == (fp = fopen(filename,"rb")))
1527 err = edit_read_file_lines(fp, &lines, &newline);
1536 file = zalloc_or_die(sizeof(*file));
1538 file->lines = lines;
1539 file->newline = newline;
1540 file->filename = filename;
1541 file->version = version;
1542 file->identifier = i;
1544 /* Correct file->version_str */
1545 freez(file->version_str);
1546 snprintf(version_buf, sizeof(version_buf), "%u", file->version);
1547 version_buf[sizeof(version_buf)-1] = '\0';
1548 file->version_str = strdup_or_die(version_buf);
1555 /*********************************************************************
1557 * Function : edit_read_actions_file
1559 * Description : Read a complete actions file into memory.
1560 * Handles CGI parameter parsing. If requested, also
1561 * checks the file's modification timestamp.
1563 * If this function detects an error in the categories
1564 * JB_ERR_FILE, JB_ERR_MODIFIED, or JB_ERR_PARSE,
1565 * then it handles it by filling in the specified
1566 * response structure and returning JB_ERR_FILE.
1569 * 1 : csp = Current client state (buffers, headers, etc...)
1570 * 2 : rsp = HTTP response. Only filled in on error.
1571 * 2 : parameters = map of cgi parameters.
1572 * 3 : require_version = true to check "ver" parameter.
1573 * 4 : pfile = Destination for the file. Will be set
1577 * f : The actions file identifier.
1578 * ver : (Only if require_version is nonzero)
1579 * Timestamp of the actions file. If wrong, this
1580 * function fails with JB_ERR_MODIFIED.
1582 * Returns : JB_ERR_OK on success
1583 * JB_ERR_MEMORY on out-of-memory
1584 * JB_ERR_CGI_PARAMS if "filename" was not specified
1586 * JB_ERR_FILE if the file does not contain valid data,
1587 * or if file cannot be opened or
1588 * contains no data, or if version
1589 * checking was requested and failed.
1591 *********************************************************************/
1592 jb_err edit_read_actions_file(struct client_state *csp,
1593 struct http_response *rsp,
1594 const struct map *parameters,
1595 int require_version,
1596 struct editable_file **pfile)
1599 struct editable_file *file;
1600 static int acceptable_failures = ACCEPTABLE_TIMESTAMP_MISMATCHES - 1;
1608 err = edit_read_file(csp, parameters, require_version, &file);
1611 /* Try to handle if possible */
1612 if (err == JB_ERR_FILE)
1614 err = cgi_error_file(csp, rsp, lookup(parameters, "f"));
1616 else if (err == JB_ERR_MODIFIED)
1618 assert(require_version);
1619 err = cgi_error_modified(csp, rsp, lookup(parameters, "f"));
1620 log_error(LOG_LEVEL_ERROR,
1621 "Blocking CGI edit request due to modification time mismatch.");
1622 if (acceptable_failures > 0)
1624 log_error(LOG_LEVEL_INFO,
1625 "The CGI editor will be turned off after another %d mismatche(s).",
1626 acceptable_failures);
1627 acceptable_failures--;
1631 log_error(LOG_LEVEL_INFO,
1632 "Timestamp mismatch limit reached, turning CGI editor off. "
1633 "Reload the configuration file to re-enable it.");
1634 csp->config->feature_flags &= ~RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
1637 if (err == JB_ERR_OK)
1640 * Signal to higher-level CGI code that there was a problem but we
1641 * handled it, they should just return JB_ERR_OK.
1648 err = edit_parse_actions_file(file);
1651 if (err == JB_ERR_PARSE)
1653 err = cgi_error_parse(csp, rsp, file);
1654 if (err == JB_ERR_OK)
1657 * Signal to higher-level CGI code that there was a problem but we
1658 * handled it, they should just return JB_ERR_OK.
1663 edit_free_file(file);
1672 /*********************************************************************
1674 * Function : get_file_name_param
1676 * Description : Get the name of the file to edit from the parameters
1677 * passed to a CGI function using the old syntax.
1678 * This function handles security checks and only
1679 * accepts files that Privoxy already knows.
1682 * 1 : csp = Current client state (buffers, headers, etc...)
1683 * 2 : parameters = map of cgi parameters
1684 * 3 : param_name = The name of the parameter to read
1685 * 4 : pfilename = pointer to the filename in
1686 * csp->config->actions_file[] if found. Set to NULL on error.
1688 * Returns : JB_ERR_OK on success
1689 * JB_ERR_MEMORY on out-of-memory
1690 * JB_ERR_CGI_PARAMS if "filename" was not specified
1693 *********************************************************************/
1694 static jb_err get_file_name_param(struct client_state *csp,
1695 const struct map *parameters,
1696 const char *param_name,
1697 const char **pfilename)
1700 const char suffix[] = ".action";
1715 param = lookup(parameters, param_name);
1718 return JB_ERR_CGI_PARAMS;
1721 len = strlen(param);
1722 if (len >= FILENAME_MAX)
1725 return JB_ERR_CGI_PARAMS;
1729 * Check every character to see if it's legal.
1730 * Totally unnecessary but we do it anyway.
1733 while ((ch = *s++) != '\0')
1735 if ( ((ch < 'A') || (ch > 'Z'))
1736 && ((ch < 'a') || (ch > 'z'))
1737 && ((ch < '0') || (ch > '9'))
1741 /* Probable hack attempt. */
1742 return JB_ERR_CGI_PARAMS;
1746 /* Append extension */
1747 name_size = len + strlen(suffix) + 1;
1748 name = malloc_or_die(name_size);
1749 strlcpy(name, param, name_size);
1750 strlcat(name, suffix, name_size);
1753 fullpath = make_path(csp->config->confdir, name);
1756 if (fullpath == NULL)
1758 return JB_ERR_MEMORY;
1761 /* Check if the file is known */
1762 for (i = 0; i < MAX_AF_FILES; i++)
1764 if (NULL != csp->config->actions_file[i] &&
1765 !strcmp(fullpath, csp->config->actions_file[i]))
1768 *pfilename = csp->config->actions_file[i];
1776 return JB_ERR_CGI_PARAMS;
1780 /*********************************************************************
1782 * Function : get_url_spec_param
1784 * Description : Get a URL pattern from the parameters
1785 * passed to a CGI function. Removes leading/trailing
1786 * spaces and validates it.
1789 * 1 : csp = Current client state (buffers, headers, etc...)
1790 * 2 : parameters = map of cgi parameters
1791 * 3 : name = Name of CGI parameter to read
1792 * 4 : pvalue = destination for value. Will be malloc()'d.
1793 * Set to NULL on error.
1795 * Returns : JB_ERR_OK on success
1796 * JB_ERR_MEMORY on out-of-memory
1797 * JB_ERR_CGI_PARAMS if the parameter was not specified
1800 *********************************************************************/
1801 static jb_err get_url_spec_param(struct client_state *csp,
1802 const struct map *parameters,
1806 const char *orig_param;
1809 struct pattern_spec compiled[1];
1819 orig_param = lookup(parameters, name);
1822 return JB_ERR_CGI_PARAMS;
1825 /* Copy and trim whitespace */
1826 param = strdup(orig_param);
1829 return JB_ERR_MEMORY;
1833 /* Must be non-empty, and can't allow 1st character to be '{' */
1834 if (param[0] == '\0' || param[0] == '{')
1837 return JB_ERR_CGI_PARAMS;
1840 /* Check for embedded newlines */
1841 for (s = param; *s != '\0'; s++)
1843 if ((*s == '\r') || (*s == '\n'))
1846 return JB_ERR_CGI_PARAMS;
1850 /* Check that regex is valid */
1855 return JB_ERR_MEMORY;
1857 err = create_pattern_spec(compiled, s);
1862 return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS;
1864 free_pattern_spec(compiled);
1866 if (param[strlen(param) - 1] == '\\')
1869 * Must protect trailing '\\' from becoming line continuation character.
1870 * Two methods: 1) If it's a domain only, add a trailing '/'.
1871 * 2) For path, add the do-nothing PCRE expression (?:) to the end
1873 if (strchr(param, '/') == NULL)
1875 err = string_append(¶m, "/");
1879 err = string_append(¶m, "(?:)");
1886 /* Check that the modified regex is valid */
1891 return JB_ERR_MEMORY;
1893 err = create_pattern_spec(compiled, s);
1898 return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS;
1900 free_pattern_spec(compiled);
1907 /*********************************************************************
1909 * Function : map_radio
1911 * Description : Map a set of radio button values. E.g. if you have
1912 * 3 radio buttons, declare them as:
1913 * <option type="radio" name="xyz" @xyz-a@>
1914 * <option type="radio" name="xyz" @xyz-b@>
1915 * <option type="radio" name="xyz" @xyz-c@>
1916 * Then map one of the @xyz-?@ variables to "checked"
1917 * and all the others to empty by calling:
1918 * map_radio(exports, "xyz", "abc", sel)
1919 * Where 'sel' is 'a', 'b', or 'c'.
1922 * 1 : exports = Exports map to modify.
1923 * 2 : optionname = name for map
1924 * 3 : values = null-terminated list of values;
1925 * 4 : value = Selected value.
1927 * CGI Parameters : None
1929 * Returns : JB_ERR_OK on success
1930 * JB_ERR_MEMORY on out-of-memory
1932 *********************************************************************/
1933 static jb_err map_radio(struct map * exports,
1934 const char * optionname,
1935 const char * values,
1941 const size_t len = strlen(optionname);
1942 const size_t buf_size = len + 3;
1948 buf = malloc_or_die(buf_size);
1950 strlcpy(buf, optionname, buf_size);
1952 /* XXX: this looks ... interesting */
1957 while ((c = *values++) != '\0')
1962 if (map(exports, buf, 1, "", 1))
1964 return JB_ERR_MEMORY;
1970 return map(exports, buf, 0, "checked", 1);
1974 /*********************************************************************
1976 * Function : cgi_error_modified
1978 * Description : CGI function that is called when a file is modified
1979 * outside the CGI editor.
1982 * 1 : csp = Current client state (buffers, headers, etc...)
1983 * 2 : rsp = http_response data structure for output
1984 * 3 : filename = The file that was modified.
1986 * CGI Parameters : none
1988 * Returns : JB_ERR_OK on success
1989 * JB_ERR_MEMORY on out-of-memory error.
1991 *********************************************************************/
1992 jb_err cgi_error_modified(struct client_state *csp,
1993 struct http_response *rsp,
1994 const char *filename)
1996 struct map *exports;
2003 if (NULL == (exports = default_exports(csp, NULL)))
2005 return JB_ERR_MEMORY;
2008 err = map(exports, "f", 1, html_encode(filename), 0);
2015 return template_fill_for_cgi(csp, "cgi-error-modified", exports, rsp);
2019 /*********************************************************************
2021 * Function : cgi_error_parse
2023 * Description : CGI function that is called when a file cannot
2024 * be parsed by the CGI editor.
2027 * 1 : csp = Current client state (buffers, headers, etc...)
2028 * 2 : rsp = http_response data structure for output
2029 * 3 : file = The file that was modified.
2031 * CGI Parameters : none
2033 * Returns : JB_ERR_OK on success
2034 * JB_ERR_MEMORY on out-of-memory error.
2036 *********************************************************************/
2037 jb_err cgi_error_parse(struct client_state *csp,
2038 struct http_response *rsp,
2039 struct editable_file *file)
2041 struct map *exports;
2043 struct file_line *cur_line;
2049 if (NULL == (exports = default_exports(csp, NULL)))
2051 return JB_ERR_MEMORY;
2054 err = map(exports, "f", 1, stringify(file->identifier), 0);
2055 if (!err) err = map(exports, "parse-error", 1, html_encode(file->parse_error_text), 0);
2057 cur_line = file->parse_error;
2060 if (!err) err = map(exports, "line-raw", 1, html_encode(cur_line->raw), 0);
2061 if (!err) err = map(exports, "line-data", 1, html_encode(cur_line->unprocessed), 0);
2069 return template_fill_for_cgi(csp, "cgi-error-parse", exports, rsp);
2073 /*********************************************************************
2075 * Function : cgi_error_file
2077 * Description : CGI function that is called when a file cannot be
2078 * opened by the CGI editor.
2081 * 1 : csp = Current client state (buffers, headers, etc...)
2082 * 2 : rsp = http_response data structure for output
2083 * 3 : filename = The file that was modified.
2085 * CGI Parameters : none
2087 * Returns : JB_ERR_OK on success
2088 * JB_ERR_MEMORY on out-of-memory error.
2090 *********************************************************************/
2091 jb_err cgi_error_file(struct client_state *csp,
2092 struct http_response *rsp,
2093 const char *filename)
2095 struct map *exports;
2102 if (NULL == (exports = default_exports(csp, NULL)))
2104 return JB_ERR_MEMORY;
2107 err = map(exports, "f", 1, html_encode(filename), 0);
2114 return template_fill_for_cgi(csp, "cgi-error-file", exports, rsp);
2118 /*********************************************************************
2120 * Function : cgi_error_file_read_only
2122 * Description : CGI function that is called when a file cannot be
2123 * opened for writing by the CGI editor.
2126 * 1 : csp = Current client state (buffers, headers, etc...)
2127 * 2 : rsp = http_response data structure for output
2128 * 3 : filename = The file that we can't write to
2130 * CGI Parameters : none
2132 * Returns : JB_ERR_OK on success
2133 * JB_ERR_MEMORY on out-of-memory error.
2135 *********************************************************************/
2136 jb_err cgi_error_file_read_only(struct client_state *csp,
2137 struct http_response *rsp,
2138 const char *filename)
2140 struct map *exports;
2147 if (NULL == (exports = default_exports(csp, NULL)))
2149 return JB_ERR_MEMORY;
2152 err = map(exports, "f", 1, html_encode(filename), 0);
2159 return template_fill_for_cgi(csp, "cgi-error-file-read-only", exports, rsp);
2163 /*********************************************************************
2165 * Function : cgi_edit_actions
2167 * Description : CGI function that allows the user to choose which
2168 * actions file to edit.
2171 * 1 : csp = Current client state (buffers, headers, etc...)
2172 * 2 : rsp = http_response data structure for output
2173 * 3 : parameters = map of cgi parameters
2175 * CGI Parameters : None
2177 * Returns : JB_ERR_OK on success
2178 * JB_ERR_MEMORY on out-of-memory error
2180 *********************************************************************/
2181 jb_err cgi_edit_actions(struct client_state *csp,
2182 struct http_response *rsp,
2183 const struct map *parameters)
2187 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
2189 return cgi_error_disabled(csp, rsp);
2192 /* FIXME: Incomplete */
2194 return cgi_redirect(rsp, CGI_PREFIX "edit-actions-list?f=default");
2199 /*********************************************************************
2201 * Function : cgi_edit_actions_list
2203 * Description : CGI function that edits the actions list.
2204 * FIXME: This function shouldn't FATAL ever.
2205 * FIXME: This function doesn't check the retval of map()
2207 * 1 : csp = Current client state (buffers, headers, etc...)
2208 * 2 : rsp = http_response data structure for output
2209 * 3 : parameters = map of cgi parameters
2211 * CGI Parameters : filename
2213 * Returns : JB_ERR_OK on success
2214 * JB_ERR_MEMORY on out-of-memory
2215 * JB_ERR_FILE if the file cannot be opened or
2217 * JB_ERR_CGI_PARAMS if "filename" was not specified
2220 *********************************************************************/
2221 jb_err cgi_edit_actions_list(struct client_state *csp,
2222 struct http_response *rsp,
2223 const struct map *parameters)
2225 char * section_template;
2226 char * url_template;
2231 struct map * exports;
2232 struct map * section_exports;
2233 struct map * url_exports;
2234 struct editable_file * file;
2235 struct file_line * cur_line;
2236 unsigned line_number = 0;
2237 unsigned prev_section_line_number = ((unsigned) (-1));
2239 struct file_list * fl;
2240 struct url_actions * b;
2241 char * buttons = NULL;
2244 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
2246 return cgi_error_disabled(csp, rsp);
2249 if (NULL == (exports = default_exports(csp, NULL)))
2251 return JB_ERR_MEMORY;
2254 /* Load actions file */
2255 err = edit_read_actions_file(csp, rsp, parameters, 0, &file);
2258 /* No filename specified, can't read file, or out of memory. */
2260 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
2263 /* Find start of actions in file */
2264 cur_line = file->lines;
2266 while ((cur_line != NULL) && (cur_line->type != FILE_LINE_ACTION))
2268 cur_line = cur_line->next;
2273 * Conventional actions files should have a match all block
2275 * cur_line = {...global actions...}
2276 * cur_line->next = /
2277 * cur_line->next->next = {...actions...} or EOF
2279 if ( (cur_line != NULL)
2280 && (cur_line->type == FILE_LINE_ACTION)
2281 && (cur_line->next != NULL)
2282 && (cur_line->next->type == FILE_LINE_URL)
2283 && (0 == strcmp(cur_line->next->unprocessed, "/"))
2284 && ( (cur_line->next->next == NULL)
2285 || (cur_line->next->next->type != FILE_LINE_URL)
2289 * Generate string with buttons to set actions for "/" to
2290 * any predefined set of actions (named standard.*, probably
2291 * residing in standard.action).
2294 err = template_load(csp, §ion_template, "edit-actions-list-button", 0);
2297 edit_free_file(file);
2299 if (err == JB_ERR_FILE)
2301 return cgi_error_no_template(csp, rsp, "edit-actions-list-button");
2306 err = template_fill(§ion_template, exports);
2309 edit_free_file(file);
2314 buttons = strdup("");
2315 for (i = 0; i < MAX_AF_FILES; i++)
2317 if (((fl = csp->actions_list[i]) != NULL) && ((b = fl->f) != NULL))
2319 for (b = b->next; NULL != b; b = b->next)
2321 if (!strncmp(b->url->spec, "standard.", 9) && *(b->url->spec + 9) != '\0')
2326 free(section_template);
2327 edit_free_file(file);
2329 return JB_ERR_MEMORY;
2332 section_exports = new_map();
2333 err = map(section_exports, "button-name", 1, b->url->spec + 9, 1);
2335 if (err || (NULL == (s = strdup(section_template))))
2337 free_map(section_exports);
2339 free(section_template);
2340 edit_free_file(file);
2342 return JB_ERR_MEMORY;
2345 if (!err) err = template_fill(&s, section_exports);
2346 free_map(section_exports);
2347 if (!err) err = string_join(&buttons, s);
2352 freez(section_template);
2353 if (!err) err = map(exports, "all-urls-buttons", 1, buttons, 0);
2356 * Conventional actions file, supply extra editing help.
2357 * (e.g. don't allow them to make it an unconventional one).
2359 if (!err) err = map_conditional(exports, "all-urls-present", 1);
2361 snprintf(buf, sizeof(buf), "%u", line_number);
2362 if (!err) err = map(exports, "all-urls-s", 1, buf, 1);
2363 snprintf(buf, sizeof(buf), "%u", line_number + 2);
2364 if (!err) err = map(exports, "all-urls-s-next", 1, buf, 1);
2365 if (!err) err = map(exports, "all-urls-actions", 1,
2366 actions_to_html(csp, cur_line->data.action), 0);
2368 /* Skip the 2 lines */
2369 cur_line = cur_line->next->next;
2373 * Note that prev_section_line_number is NOT set here.
2374 * This is deliberate and not a bug. It stops a "Move up"
2375 * option appearing on the next section. Clicking "Move
2376 * up" would make the actions file unconventional, which
2377 * we don't want, so we hide this option.
2383 * Non-standard actions file - does not begin with
2384 * the "All URLs" section.
2386 if (!err) err = map_conditional(exports, "all-urls-present", 0);
2389 /* Set up global exports */
2391 if (!err) err = map(exports, "actions-file", 1, html_encode(file->filename), 0);
2392 if (!err) err = map(exports, "f", 1, stringify(file->identifier), 0);
2393 if (!err) err = map(exports, "v", 1, file->version_str, 1);
2395 /* Discourage private additions to default.action */
2397 if (!err) err = map_conditional(exports, "default-action",
2398 (strstr("default.action", file->filename) != NULL));
2401 edit_free_file(file);
2406 /* Should do all global exports above this point */
2408 /* Load templates */
2410 err = template_load(csp, §ion_template, "edit-actions-list-section", 0);
2413 edit_free_file(file);
2415 if (err == JB_ERR_FILE)
2417 return cgi_error_no_template(csp, rsp, "edit-actions-list-section");
2422 err = template_load(csp, &url_template, "edit-actions-list-url", 0);
2425 free(section_template);
2426 edit_free_file(file);
2428 if (err == JB_ERR_FILE)
2430 return cgi_error_no_template(csp, rsp, "edit-actions-list-url");
2435 err = template_fill(§ion_template, exports);
2439 edit_free_file(file);
2444 err = template_fill(&url_template, exports);
2447 free(section_template);
2448 edit_free_file(file);
2453 if (NULL == (sections = strdup("")))
2455 free(section_template);
2457 edit_free_file(file);
2459 return JB_ERR_MEMORY;
2462 while ((cur_line != NULL) && (cur_line->type == FILE_LINE_ACTION))
2464 section_exports = new_map();
2466 snprintf(buf, sizeof(buf), "%u", line_number);
2467 err = map(section_exports, "s", 1, buf, 1);
2468 if (!err) err = map(section_exports, "actions", 1,
2469 actions_to_html(csp, cur_line->data.action), 0);
2472 && (cur_line->next != NULL)
2473 && (cur_line->next->type == FILE_LINE_URL))
2475 /* This section contains at least one URL, don't allow delete */
2476 err = map_block_killer(section_exports, "empty-section");
2480 if (!err) err = map_block_keep(section_exports, "empty-section");
2483 if (prev_section_line_number != ((unsigned)(-1)))
2485 /* Not last section */
2486 snprintf(buf, sizeof(buf), "%u", prev_section_line_number);
2487 if (!err) err = map(section_exports, "s-prev", 1, buf, 1);
2488 if (!err) err = map_block_keep(section_exports, "s-prev-exists");
2493 if (!err) err = map_block_killer(section_exports, "s-prev-exists");
2495 prev_section_line_number = line_number;
2500 free(section_template);
2502 edit_free_file(file);
2504 free_map(section_exports);
2508 /* Should do all section-specific exports above this point */
2510 if (NULL == (urls = strdup("")))
2513 free(section_template);
2515 edit_free_file(file);
2517 free_map(section_exports);
2518 return JB_ERR_MEMORY;
2523 cur_line = cur_line->next;
2526 while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL))
2528 url_exports = new_map();
2530 snprintf(buf, sizeof(buf), "%u", line_number);
2531 err = map(url_exports, "p", 1, buf, 1);
2533 snprintf(buf, sizeof(buf), "%d", url_1_2);
2534 if (!err) err = map(url_exports, "url-1-2", 1, buf, 1);
2536 if (!err) err = map(url_exports, "url-html", 1,
2537 html_encode(cur_line->unprocessed), 0);
2538 if (!err) err = map(url_exports, "url", 1,
2539 url_encode(cur_line->unprocessed), 0);
2545 free(section_template);
2547 edit_free_file(file);
2549 free_map(section_exports);
2550 free_map(url_exports);
2554 if (NULL == (s = strdup(url_template)))
2558 free(section_template);
2560 edit_free_file(file);
2562 free_map(section_exports);
2563 free_map(url_exports);
2564 return JB_ERR_MEMORY;
2567 err = template_fill(&s, section_exports);
2568 if (!err) err = template_fill(&s, url_exports);
2569 if (!err) err = string_append(&urls, s);
2571 free_map(url_exports);
2578 free(section_template);
2580 edit_free_file(file);
2582 free_map(section_exports);
2586 url_1_2 = 3 - url_1_2;
2588 cur_line = cur_line->next;
2592 err = map(section_exports, "urls", 1, urls, 0);
2594 /* Could also do section-specific exports here, but it wouldn't be as fast */
2596 snprintf(buf, sizeof(buf), "%u", line_number);
2597 if (!err) err = map(section_exports, "s-next", 1, buf, 1);
2599 if ((cur_line != NULL)
2600 && (cur_line->type == FILE_LINE_ACTION))
2602 /* Not last section */
2603 if (!err) err = map_block_keep(section_exports, "s-next-exists");
2608 if (!err) err = map_block_killer(section_exports, "s-next-exists");
2614 free(section_template);
2616 edit_free_file(file);
2618 free_map(section_exports);
2622 if (NULL == (s = strdup(section_template)))
2625 free(section_template);
2627 edit_free_file(file);
2629 free_map(section_exports);
2630 return JB_ERR_MEMORY;
2633 err = template_fill(&s, section_exports);
2634 if (!err) err = string_append(§ions, s);
2637 free_map(section_exports);
2642 free(section_template);
2644 edit_free_file(file);
2650 edit_free_file(file);
2651 free(section_template);
2654 err = map(exports, "sections", 1, sections, 0);
2661 /* Could also do global exports here, but it wouldn't be as fast */
2663 return template_fill_for_cgi(csp, "edit-actions-list", exports, rsp);
2667 /*********************************************************************
2669 * Function : cgi_edit_actions_for_url
2671 * Description : CGI function that edits the Actions list.
2674 * 1 : csp = Current client state (buffers, headers, etc...)
2675 * 2 : rsp = http_response data structure for output
2676 * 3 : parameters = map of cgi parameters
2678 * CGI Parameters : None
2680 * Returns : JB_ERR_OK on success
2681 * JB_ERR_MEMORY on out-of-memory
2682 * JB_ERR_CGI_PARAMS if the CGI parameters are not
2683 * specified or not valid.
2685 *********************************************************************/
2686 jb_err cgi_edit_actions_for_url(struct client_state *csp,
2687 struct http_response *rsp,
2688 const struct map *parameters)
2690 struct map * exports;
2692 struct editable_file * file;
2693 struct file_line * cur_line;
2694 unsigned line_number;
2696 struct re_filterfile_spec *filter_group;
2697 int i, have_filters = 0;
2699 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
2701 return cgi_error_disabled(csp, rsp);
2704 err = get_number_param(csp, parameters, "s", §ionid);
2710 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
2713 /* No filename specified, can't read file, modified, or out of memory. */
2714 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
2717 cur_line = file->lines;
2719 for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++)
2721 cur_line = cur_line->next;
2724 if ( (cur_line == NULL)
2725 || (line_number != sectionid)
2727 || (cur_line->type != FILE_LINE_ACTION))
2729 /* Invalid "sectionid" parameter */
2730 edit_free_file(file);
2731 return JB_ERR_CGI_PARAMS;
2734 if (NULL == (exports = default_exports(csp, NULL)))
2736 edit_free_file(file);
2737 return JB_ERR_MEMORY;
2740 err = map(exports, "f", 1, stringify(file->identifier), 0);
2741 if (!err) err = map(exports, "v", 1, file->version_str, 1);
2742 if (!err) err = map(exports, "s", 1, url_encode(lookup(parameters, "s")), 0);
2744 if (!err) err = actions_to_radio(exports, cur_line->data.action);
2747 * XXX: Some browsers (at least IE6 and IE7) have an artificial URL
2748 * length limitation and ignore clicks on the Submit buttons if
2749 * the resulting GET URL would be longer than their limit.
2751 * In Privoxy 3.0.5 beta the standard edit-actions-for-url template
2752 * reached this limit and action editing stopped working in these
2753 * browsers (BR #1570678).
2755 * The config option split-large-forms works around this browser
2756 * bug (HTTP has no URL length limitation) by deviding the action
2757 * list form into multiple smaller ones. It means the URLs are shorter
2758 * and work in broken browsers as well, but the user can no longer change
2759 * all actions with one submit.
2761 * A better solution would be to switch to POST requests,
2762 * but this will do for now.
2764 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_SPLIT_LARGE_FORMS))
2766 /* Generate multiple smaller form by killing the big one. */
2767 err = map_block_killer(exports, "one-form-only");
2771 /* Default: Generate one large form by killing the smaller ones. */
2772 err = map_block_killer(exports, "multiple-forms");
2775 for (i = 0; i < MAX_AF_FILES; i++)
2777 if ((csp->rlist[i] != NULL) && (csp->rlist[i]->f != NULL))
2779 if (!err) err = map_conditional(exports, "any-filters-defined", 1);
2785 #ifndef FEATURE_EXTERNAL_FILTERS
2786 if (!err) err = map_block_killer(exports, "external-content-filters");
2791 edit_free_file(file);
2796 if (0 == have_filters)
2798 err = map(exports, "filter-params", 1, "", 1);
2803 * List available filters and their settings.
2805 char *filter_template;
2806 int filter_identifier = 0;
2807 char *prepared_templates[MAX_FILTER_TYPES];
2809 for (i = 0; i < MAX_FILTER_TYPES; i++)
2811 prepared_templates[i] = strdup("");
2814 err = template_load(csp, &filter_template, "edit-actions-for-url-filter", 0);
2817 edit_free_file(file);
2819 if (err == JB_ERR_FILE)
2821 return cgi_error_no_template(csp, rsp, "edit-actions-for-url-filter");
2826 err = template_fill(&filter_template, exports);
2828 for (i = 0; i < MAX_AF_FILES; i++)
2830 if ((csp->rlist[i] != NULL) && (csp->rlist[i]->f != NULL))
2832 filter_group = csp->rlist[i]->f;
2833 for (;(!err) && (filter_group != NULL); filter_group = filter_group->next)
2835 char current_mode = 'x';
2837 struct list_entry *filter_name;
2838 struct map *line_exports;
2839 const int type = filter_group->type;
2840 const int multi_action_index = filter_type_info[type].multi_action_index;
2842 assert(type < MAX_FILTER_TYPES);
2844 filter_name = cur_line->data.action->multi_add[multi_action_index]->first;
2845 while ((filter_name != NULL)
2846 && (0 != strcmp(filter_group->name, filter_name->str)))
2848 filter_name = filter_name->next;
2851 if (filter_name != NULL)
2857 filter_name = cur_line->data.action->multi_remove[multi_action_index]->first;
2858 while ((filter_name != NULL)
2859 && (0 != strcmp(filter_group->name, filter_name->str)))
2861 filter_name = filter_name->next;
2863 if (filter_name != NULL)
2869 /* Generate a unique serial number */
2870 snprintf(number, sizeof(number), "%x", filter_identifier++);
2871 number[sizeof(number) - 1] = '\0';
2873 line_exports = new_map();
2874 if (line_exports == NULL)
2876 err = JB_ERR_MEMORY;
2882 if (!err) err = map(line_exports, "index", 1, number, 1);
2883 if (!err) err = map(line_exports, "name", 1, filter_group->name, 1);
2884 if (!err) err = map(line_exports, "description", 1, filter_group->description, 1);
2885 if (!err) err = map_radio(line_exports, "this-filter", "ynx", current_mode);
2886 if (!err) err = map(line_exports, "filter-type", 1, filter_type_info[type].type, 1);
2887 if (!err) err = map(line_exports, "abbr-filter-type", 1, filter_type_info[type].abbr_type, 1);
2888 if (!err) err = map(line_exports, "anchor", 1, filter_type_info[type].anchor, 1);
2892 filter_line = strdup(filter_template);
2893 if (filter_line == NULL) err = JB_ERR_MEMORY;
2895 if (!err) err = template_fill(&filter_line, line_exports);
2896 string_join(&prepared_templates[type], filter_line);
2898 free_map(line_exports);
2903 freez(filter_template);
2905 /* Replace all filter macros with the aggregated templates */
2906 for (i = 0; i < MAX_FILTER_TYPES; i++)
2909 err = map(exports, filter_type_info[i].macro_name, 1, prepared_templates[i], 0);
2914 /* Free aggregated templates */
2915 for (i = 0; i < MAX_FILTER_TYPES; i++)
2917 freez(prepared_templates[i]);
2922 /* Check or uncheck the "disable all of this type" radio buttons. */
2923 for (i = 0; i < MAX_FILTER_TYPES; i++)
2925 const int a = filter_type_info[i].multi_action_index;
2926 const int disable_all = cur_line->data.action->multi_remove_all[a];
2928 err = map_radio(exports, filter_type_info[i].disable_all_option, "nx", (disable_all ? 'n' : 'x'));
2931 edit_free_file(file);
2939 return template_fill_for_cgi(csp, "edit-actions-for-url", exports, rsp);
2943 /*********************************************************************
2945 * Function : cgi_edit_actions_submit
2947 * Description : CGI function that actually edits the Actions list.
2950 * 1 : csp = Current client state (buffers, headers, etc...)
2951 * 2 : rsp = http_response data structure for output
2952 * 3 : parameters = map of cgi parameters
2954 * CGI Parameters : None
2956 * Returns : JB_ERR_OK on success
2957 * JB_ERR_MEMORY on out-of-memory
2958 * JB_ERR_CGI_PARAMS if the CGI parameters are not
2959 * specified or not valid.
2961 *********************************************************************/
2962 jb_err cgi_edit_actions_submit(struct client_state *csp,
2963 struct http_response *rsp,
2964 const struct map *parameters)
2969 size_t newtext_size;
2971 struct editable_file * file;
2972 struct file_line * cur_line;
2973 unsigned line_number;
2976 int filter_identifier;
2978 const char * action_set_name;
2979 struct file_list * fl;
2980 struct url_actions * b;
2982 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
2984 return cgi_error_disabled(csp, rsp);
2987 err = get_number_param(csp, parameters, "s", §ionid);
2993 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
2996 /* No filename specified, can't read file, modified, or out of memory. */
2997 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
3000 cur_line = file->lines;
3002 for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++)
3004 cur_line = cur_line->next;
3007 if ( (cur_line == NULL)
3008 || (line_number != sectionid)
3010 || (cur_line->type != FILE_LINE_ACTION))
3012 /* Invalid "sectionid" parameter */
3013 edit_free_file(file);
3014 return JB_ERR_CGI_PARAMS;
3017 get_string_param(parameters, "p", &action_set_name);
3018 if (action_set_name != NULL)
3020 for (filter_identifier = 0; filter_identifier < MAX_AF_FILES; filter_identifier++)
3022 if (((fl = csp->actions_list[filter_identifier]) != NULL) && ((b = fl->f) != NULL))
3024 for (b = b->next; NULL != b; b = b->next)
3026 if (!strncmp(b->url->spec, "standard.", 9) && !strcmp(b->url->spec + 9, action_set_name))
3028 copy_action(cur_line->data.action, b->action);
3034 edit_free_file(file);
3035 return JB_ERR_CGI_PARAMS;
3041 err = actions_from_radio(parameters, cur_line->data.action);
3047 edit_free_file(file);
3051 /* Check the "disable all of this type" parameters. */
3052 for (i = 0; i < MAX_FILTER_TYPES; i++)
3054 const int multi_action_index = filter_type_info[i].multi_action_index;
3055 const char ch = get_char_param(parameters, filter_type_info[i].disable_all_param);
3059 list_remove_all(cur_line->data.action->multi_add[multi_action_index]);
3060 list_remove_all(cur_line->data.action->multi_remove[multi_action_index]);
3061 cur_line->data.action->multi_remove_all[multi_action_index] = 1;
3065 cur_line->data.action->multi_remove_all[multi_action_index] = 0;
3069 for (filter_identifier = 0; !err; filter_identifier++)
3076 * Filter state. Valid states are: 'Y' (active),
3077 * 'N' (inactive) and 'X' (no change).
3081 * Abbreviated filter type. Valid types are: 'F' (content filter),
3082 * 'S' (server-header filter) and 'C' (client-header filter).
3084 int multi_action_index = 0;
3086 /* Generate the keys */
3087 snprintf(key_value, sizeof(key_value), "filter_r%x", filter_identifier);
3088 key_value[sizeof(key_value) - 1] = '\0'; /* XXX: Why? */
3089 snprintf(key_name, sizeof(key_name), "filter_n%x", filter_identifier);
3090 key_name[sizeof(key_name) - 1] = '\0'; /* XXX: Why? */
3091 snprintf(key_type, sizeof(key_type), "filter_t%x", filter_identifier);
3093 err = get_string_param(parameters, key_name, &name);
3102 type = get_char_param(parameters, key_type);
3106 multi_action_index = ACTION_MULTI_FILTER;
3109 multi_action_index = ACTION_MULTI_SERVER_HEADER_FILTER;
3112 multi_action_index = ACTION_MULTI_CLIENT_HEADER_FILTER;
3115 multi_action_index = ACTION_MULTI_CLIENT_HEADER_TAGGER;
3118 multi_action_index = ACTION_MULTI_SERVER_HEADER_TAGGER;
3121 log_error(LOG_LEVEL_ERROR,
3122 "Unknown filter type: %c for filter %s. Filter ignored.", type, name);
3125 assert(multi_action_index);
3127 value = get_char_param(parameters, key_value);
3130 list_remove_item(cur_line->data.action->multi_add[multi_action_index], name);
3131 if (!err) err = enlist(cur_line->data.action->multi_add[multi_action_index], name);
3132 list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name);
3134 else if (value == 'N')
3136 list_remove_item(cur_line->data.action->multi_add[multi_action_index], name);
3137 if (!cur_line->data.action->multi_remove_all[multi_action_index])
3139 list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name);
3140 if (!err) err = enlist(cur_line->data.action->multi_remove[multi_action_index], name);
3143 else if (value == 'X')
3145 list_remove_item(cur_line->data.action->multi_add[multi_action_index], name);
3146 list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name);
3153 edit_free_file(file);
3157 if (NULL == (actiontext = actions_to_text(cur_line->data.action)))
3160 edit_free_file(file);
3161 return JB_ERR_MEMORY;
3164 len = strlen(actiontext);
3168 * Empty action - must special-case this.
3169 * Simply setting len to 1 is sufficient...
3174 newtext_size = len + 2;
3175 newtext = malloc_or_die(newtext_size);
3176 strlcpy(newtext, actiontext, newtext_size);
3180 newtext[len + 1] = '\0';
3182 freez(cur_line->raw);
3183 freez(cur_line->unprocessed);
3184 cur_line->unprocessed = newtext;
3186 err = edit_write_file(file);
3189 /* Error writing file */
3190 if (err == JB_ERR_FILE)
3192 /* Read-only file. */
3193 err = cgi_error_file_read_only(csp, rsp, file->filename);
3195 edit_free_file(file);
3199 snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u",
3200 (long) time(NULL), file->identifier, sectionid);
3202 edit_free_file(file);
3204 return cgi_redirect(rsp, target);
3208 /*********************************************************************
3210 * Function : cgi_edit_actions_url
3212 * Description : CGI function that actually edits a URL pattern in
3216 * 1 : csp = Current client state (buffers, headers, etc...)
3217 * 2 : rsp = http_response data structure for output
3218 * 3 : parameters = map of cgi parameters
3221 * filename : Identifies the file to edit
3222 * ver : File's last-modified time
3223 * section : Line number of section to edit
3224 * pattern : Line number of pattern to edit
3225 * newval : New value for pattern
3227 * Returns : JB_ERR_OK on success
3228 * JB_ERR_MEMORY on out-of-memory
3229 * JB_ERR_CGI_PARAMS if the CGI parameters are not
3230 * specified or not valid.
3232 *********************************************************************/
3233 jb_err cgi_edit_actions_url(struct client_state *csp,
3234 struct http_response *rsp,
3235 const struct map *parameters)
3239 struct editable_file * file;
3240 struct file_line * cur_line;
3241 unsigned line_number;
3242 unsigned section_start_line_number = 0;
3250 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
3252 return cgi_error_disabled(csp, rsp);
3255 err = get_number_param(csp, parameters, "p", &patternid);
3262 return JB_ERR_CGI_PARAMS;
3265 err = get_url_spec_param(csp, parameters, "u", &new_pattern);
3271 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
3274 /* No filename specified, can't read file, modified, or out of memory. */
3276 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
3280 cur_line = file->lines;
3282 while ((cur_line != NULL) && (line_number < patternid))
3284 if (cur_line->type == FILE_LINE_ACTION)
3286 section_start_line_number = line_number;
3288 cur_line = cur_line->next;
3292 if ((cur_line == NULL)
3293 || (cur_line->type != FILE_LINE_URL))
3295 /* Invalid "patternid" parameter */
3297 edit_free_file(file);
3298 return JB_ERR_CGI_PARAMS;
3301 /* At this point, the line to edit is in cur_line */
3303 freez(cur_line->raw);
3304 freez(cur_line->unprocessed);
3305 cur_line->unprocessed = new_pattern;
3307 err = edit_write_file(file);
3310 /* Error writing file */
3311 if (err == JB_ERR_FILE)
3313 /* Read-only file. */
3314 err = cgi_error_file_read_only(csp, rsp, file->filename);
3316 edit_free_file(file);
3320 snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u",
3321 (long) time(NULL), file->identifier, section_start_line_number);
3323 edit_free_file(file);
3325 return cgi_redirect(rsp, target);
3329 /*********************************************************************
3331 * Function : cgi_edit_actions_add_url
3333 * Description : CGI function that actually adds a URL pattern to
3337 * 1 : csp = Current client state (buffers, headers, etc...)
3338 * 2 : rsp = http_response data structure for output
3339 * 3 : parameters = map of cgi parameters
3342 * filename : Identifies the file to edit
3343 * ver : File's last-modified time
3344 * section : Line number of section to edit
3345 * newval : New pattern
3347 * Returns : JB_ERR_OK on success
3348 * JB_ERR_MEMORY on out-of-memory
3349 * JB_ERR_CGI_PARAMS if the CGI parameters are not
3350 * specified or not valid.
3352 *********************************************************************/
3353 jb_err cgi_edit_actions_add_url(struct client_state *csp,
3354 struct http_response *rsp,
3355 const struct map *parameters)
3359 struct file_line * new_line;
3360 struct editable_file * file;
3361 struct file_line * cur_line;
3362 unsigned line_number;
3366 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
3368 return cgi_error_disabled(csp, rsp);
3371 err = get_number_param(csp, parameters, "s", §ionid);
3378 return JB_ERR_CGI_PARAMS;
3381 err = get_url_spec_param(csp, parameters, "u", &new_pattern);
3387 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
3390 /* No filename specified, can't read file, modified, or out of memory. */
3392 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
3396 cur_line = file->lines;
3398 while ((cur_line != NULL) && (line_number < sectionid))
3400 cur_line = cur_line->next;
3404 if ((cur_line == NULL)
3405 || (cur_line->type != FILE_LINE_ACTION))
3407 /* Invalid "sectionid" parameter */
3409 edit_free_file(file);
3410 return JB_ERR_CGI_PARAMS;
3413 /* At this point, the section header is in cur_line - add after this. */
3415 /* Allocate the new line */
3416 new_line = zalloc_or_die(sizeof(*new_line));
3418 /* Fill in the data members of the new line */
3419 new_line->raw = NULL;
3420 new_line->prefix = NULL;
3421 new_line->unprocessed = new_pattern;
3422 new_line->type = FILE_LINE_URL;
3424 /* Link new_line into the list, after cur_line */
3425 new_line->next = cur_line->next;
3426 cur_line->next = new_line;
3428 /* Done making changes, now commit */
3430 err = edit_write_file(file);
3433 /* Error writing file */
3434 if (err == JB_ERR_FILE)
3436 /* Read-only file. */
3437 err = cgi_error_file_read_only(csp, rsp, file->filename);
3439 edit_free_file(file);
3443 snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u",
3444 (long) time(NULL), file->identifier, sectionid);
3446 edit_free_file(file);
3448 return cgi_redirect(rsp, target);
3452 /*********************************************************************
3454 * Function : cgi_edit_actions_remove_url
3456 * Description : CGI function that actually removes a URL pattern from
3460 * 1 : csp = Current client state (buffers, headers, etc...)
3461 * 2 : rsp = http_response data structure for output
3462 * 3 : parameters = map of cgi parameters
3465 * f : (filename) Identifies the file to edit
3466 * v : (version) File's last-modified time
3467 * p : (pattern) Line number of pattern to remove
3469 * Returns : JB_ERR_OK on success
3470 * JB_ERR_MEMORY on out-of-memory
3471 * JB_ERR_CGI_PARAMS if the CGI parameters are not
3472 * specified or not valid.
3474 *********************************************************************/
3475 jb_err cgi_edit_actions_remove_url(struct client_state *csp,
3476 struct http_response *rsp,
3477 const struct map *parameters)
3480 struct editable_file * file;
3481 struct file_line * cur_line;
3482 struct file_line * prev_line;
3483 unsigned line_number;
3484 unsigned section_start_line_number = 0;
3488 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
3490 return cgi_error_disabled(csp, rsp);
3493 err = get_number_param(csp, parameters, "p", &patternid);
3499 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
3502 /* No filename specified, can't read file, modified, or out of memory. */
3503 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
3508 cur_line = file->lines;
3510 while ((cur_line != NULL) && (line_number < patternid))
3512 if (cur_line->type == FILE_LINE_ACTION)
3514 section_start_line_number = line_number;
3516 prev_line = cur_line;
3517 cur_line = cur_line->next;
3521 if ( (cur_line == NULL)
3522 || (prev_line == NULL)
3523 || (cur_line->type != FILE_LINE_URL))
3525 /* Invalid "patternid" parameter */
3526 edit_free_file(file);
3527 return JB_ERR_CGI_PARAMS;
3530 /* At this point, the line to remove is in cur_line, and the previous
3531 * one is in prev_line
3534 /* Unlink cur_line */
3535 prev_line->next = cur_line->next;
3536 cur_line->next = NULL;
3539 edit_free_file_lines(cur_line);
3541 err = edit_write_file(file);
3544 /* Error writing file */
3545 if (err == JB_ERR_FILE)
3547 /* Read-only file. */
3548 err = cgi_error_file_read_only(csp, rsp, file->filename);
3550 edit_free_file(file);
3554 snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u#l%u",
3555 (long) time(NULL), file->identifier, section_start_line_number);
3557 edit_free_file(file);
3559 return cgi_redirect(rsp, target);
3563 /*********************************************************************
3565 * Function : cgi_edit_actions_section_remove
3567 * Description : CGI function that actually removes a whole section from
3568 * the actions file. The section must be empty first
3569 * (else JB_ERR_CGI_PARAMS).
3572 * 1 : csp = Current client state (buffers, headers, etc...)
3573 * 2 : rsp = http_response data structure for output
3574 * 3 : parameters = map of cgi parameters
3577 * f : (filename) Identifies the file to edit
3578 * v : (version) File's last-modified time
3579 * s : (section) Line number of section to edit
3581 * Returns : JB_ERR_OK on success
3582 * JB_ERR_MEMORY on out-of-memory
3583 * JB_ERR_CGI_PARAMS if the CGI parameters are not
3584 * specified or not valid.
3586 *********************************************************************/
3587 jb_err cgi_edit_actions_section_remove(struct client_state *csp,
3588 struct http_response *rsp,
3589 const struct map *parameters)
3592 struct editable_file * file;
3593 struct file_line * cur_line;
3594 struct file_line * prev_line;
3595 unsigned line_number;
3599 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
3601 return cgi_error_disabled(csp, rsp);
3604 err = get_number_param(csp, parameters, "s", §ionid);
3610 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
3613 /* No filename specified, can't read file, modified, or out of memory. */
3614 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
3618 cur_line = file->lines;
3621 while ((cur_line != NULL) && (line_number < sectionid))
3623 prev_line = cur_line;
3624 cur_line = cur_line->next;
3628 if ((cur_line == NULL)
3629 || (cur_line->type != FILE_LINE_ACTION))
3631 /* Invalid "sectionid" parameter */
3632 edit_free_file(file);
3633 return JB_ERR_CGI_PARAMS;
3636 if ((cur_line->next != NULL)
3637 && (cur_line->next->type == FILE_LINE_URL))
3639 /* Section not empty. */
3640 edit_free_file(file);
3641 return JB_ERR_CGI_PARAMS;
3644 /* At this point, the line to remove is in cur_line, and the previous
3645 * one is in prev_line
3648 /* Unlink cur_line */
3649 if (prev_line == NULL)
3651 /* Removing the first line from the file */
3652 file->lines = cur_line->next;
3656 prev_line->next = cur_line->next;
3658 cur_line->next = NULL;
3661 edit_free_file_lines(cur_line);
3663 err = edit_write_file(file);
3666 /* Error writing file */
3667 if (err == JB_ERR_FILE)
3669 /* Read-only file. */
3670 err = cgi_error_file_read_only(csp, rsp, file->filename);
3672 edit_free_file(file);
3676 snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u",
3677 (long) time(NULL), file->identifier);
3679 edit_free_file(file);
3681 return cgi_redirect(rsp, target);
3685 /*********************************************************************
3687 * Function : cgi_edit_actions_section_add
3689 * Description : CGI function that adds a new empty section to
3693 * 1 : csp = Current client state (buffers, headers, etc...)
3694 * 2 : rsp = http_response data structure for output
3695 * 3 : parameters = map of cgi parameters
3698 * f : (filename) Identifies the file to edit
3699 * v : (version) File's last-modified time
3700 * s : (section) Line number of section to add after, 0 for
3703 * Returns : JB_ERR_OK on success
3704 * JB_ERR_MEMORY on out-of-memory
3705 * JB_ERR_CGI_PARAMS if the CGI parameters are not
3706 * specified or not valid.
3708 *********************************************************************/
3709 jb_err cgi_edit_actions_section_add(struct client_state *csp,
3710 struct http_response *rsp,
3711 const struct map *parameters)
3714 struct file_line * new_line;
3716 struct editable_file * file;
3717 struct file_line * cur_line;
3718 unsigned line_number;
3722 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
3724 return cgi_error_disabled(csp, rsp);
3727 err = get_number_param(csp, parameters, "s", §ionid);
3733 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
3736 /* No filename specified, can't read file, modified, or out of memory. */
3737 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
3741 cur_line = file->lines;
3743 if (sectionid <= 1U)
3745 /* Add to start of file */
3746 if (cur_line != NULL && cur_line->type != FILE_LINE_ACTION)
3748 /* There's something in the file, find the line before the first
3751 while ((cur_line->next != NULL)
3752 && (cur_line->next->type != FILE_LINE_ACTION))
3754 cur_line = cur_line->next;
3760 /* File starts with action line, so insert at top */
3766 /* Add after stated section. */
3767 while ((cur_line != NULL) && (line_number < sectionid))
3769 cur_line = cur_line->next;
3773 if ((cur_line == NULL)
3774 || (cur_line->type != FILE_LINE_ACTION))
3776 /* Invalid "sectionid" parameter */
3777 edit_free_file(file);
3778 return JB_ERR_CGI_PARAMS;
3781 /* Skip through the section to find the last line in it. */
3782 while ((cur_line->next != NULL)
3783 && (cur_line->next->type != FILE_LINE_ACTION))
3785 cur_line = cur_line->next;
3790 /* At this point, the last line in the previous section is in cur_line
3791 * - add after this. (Or if we need to add as the first line, cur_line
3795 new_text = strdup("{}");
3796 if (NULL == new_text)
3798 edit_free_file(file);
3799 return JB_ERR_MEMORY;
3802 /* Allocate the new line */
3803 new_line = zalloc_or_die(sizeof(*new_line));
3805 /* Fill in the data members of the new line */
3806 new_line->raw = NULL;
3807 new_line->prefix = NULL;
3808 new_line->unprocessed = new_text;
3809 new_line->type = FILE_LINE_ACTION;
3811 if (cur_line != NULL)
3813 /* Link new_line into the list, after cur_line */
3814 new_line->next = cur_line->next;
3815 cur_line->next = new_line;
3819 /* Link new_line into the list, as first line */
3820 new_line->next = file->lines;
3821 file->lines = new_line;
3824 /* Done making changes, now commit */
3826 err = edit_write_file(file);
3829 /* Error writing file */
3830 if (err == JB_ERR_FILE)
3832 /* Read-only file. */
3833 err = cgi_error_file_read_only(csp, rsp, file->filename);
3835 edit_free_file(file);
3839 snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u",
3840 (long) time(NULL), file->identifier);
3842 edit_free_file(file);
3844 return cgi_redirect(rsp, target);
3848 /*********************************************************************
3850 * Function : cgi_edit_actions_section_swap
3852 * Description : CGI function that swaps the order of two sections
3853 * in the actions file. Note that this CGI can actually
3854 * swap any two arbitrary sections, but the GUI interface
3855 * currently only allows consecutive sections to be
3859 * 1 : csp = Current client state (buffers, headers, etc...)
3860 * 2 : rsp = http_response data structure for output
3861 * 3 : parameters = map of cgi parameters
3864 * f : (filename) Identifies the file to edit
3865 * v : (version) File's last-modified time
3866 * s1 : (section1) Line number of first section to swap
3867 * s2 : (section2) Line number of second section to swap
3869 * Returns : JB_ERR_OK on success
3870 * JB_ERR_MEMORY on out-of-memory
3871 * JB_ERR_CGI_PARAMS if the CGI parameters are not
3872 * specified or not valid.
3874 *********************************************************************/
3875 jb_err cgi_edit_actions_section_swap(struct client_state *csp,
3876 struct http_response *rsp,
3877 const struct map *parameters)
3881 struct editable_file * file;
3882 struct file_line * cur_line;
3883 struct file_line * prev_line;
3884 struct file_line * line_before_section1;
3885 struct file_line * line_start_section1;
3886 struct file_line * line_end_section1;
3887 struct file_line * line_after_section1;
3888 struct file_line * line_before_section2;
3889 struct file_line * line_start_section2;
3890 struct file_line * line_end_section2;
3891 struct file_line * line_after_section2;
3892 unsigned line_number;
3896 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
3898 return cgi_error_disabled(csp, rsp);
3901 err = get_number_param(csp, parameters, "s1", §ion1);
3902 if (!err) err = get_number_param(csp, parameters, "s2", §ion2);
3908 if (section1 > section2)
3910 unsigned temp = section2;
3911 section2 = section1;
3915 err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
3918 /* No filename specified, can't read file, modified, or out of memory. */
3919 return (err == JB_ERR_FILE ? JB_ERR_OK : err);
3922 /* Start at the beginning... */
3924 cur_line = file->lines;
3927 /* ... find section1 ... */
3928 while ((cur_line != NULL) && (line_number < section1))
3930 prev_line = cur_line;
3931 cur_line = cur_line->next;
3935 if ((cur_line == NULL)
3936 || (cur_line->type != FILE_LINE_ACTION))
3938 /* Invalid "section1" parameter */
3939 edit_free_file(file);
3940 return JB_ERR_CGI_PARAMS;
3943 /* If no-op, we've validated params and can skip the rest. */
3944 if (section1 != section2)
3946 /* ... find the end of section1 ... */
3947 line_before_section1 = prev_line;
3948 line_start_section1 = cur_line;
3951 prev_line = cur_line;
3952 cur_line = cur_line->next;
3955 while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL));
3956 line_end_section1 = prev_line;
3957 line_after_section1 = cur_line;
3959 /* ... find section2 ... */
3960 while ((cur_line != NULL) && (line_number < section2))
3962 prev_line = cur_line;
3963 cur_line = cur_line->next;
3967 if ((cur_line == NULL)
3968 || (cur_line->type != FILE_LINE_ACTION))
3970 /* Invalid "section2" parameter */
3971 edit_free_file(file);
3972 return JB_ERR_CGI_PARAMS;
3975 /* ... find the end of section2 ... */
3976 line_before_section2 = prev_line;
3977 line_start_section2 = cur_line;
3980 prev_line = cur_line;
3981 cur_line = cur_line->next;
3984 while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL));
3985 line_end_section2 = prev_line;
3986 line_after_section2 = cur_line;
3988 /* Now have all the pointers we need. Do the swap. */
3990 /* Change the pointer to section1 to point to section2 instead */
3991 if (line_before_section1 == NULL)
3993 file->lines = line_start_section2;
3997 line_before_section1->next = line_start_section2;
4000 if (line_before_section2 == line_end_section1)
4002 /* Consecutive sections */
4003 line_end_section2->next = line_start_section1;
4007 line_end_section2->next = line_after_section1;
4008 line_before_section2->next = line_start_section1;
4011 /* Set the pointer from the end of section1 to the rest of the file */
4012 line_end_section1->next = line_after_section2;
4014 err = edit_write_file(file);
4017 /* Error writing file */
4018 if (err == JB_ERR_FILE)
4020 /* Read-only file. */
4021 err = cgi_error_file_read_only(csp, rsp, file->filename);
4023 edit_free_file(file);
4026 } /* END if (section1 != section2) */
4028 snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u",
4029 (long) time(NULL), file->identifier);
4031 edit_free_file(file);
4033 return cgi_redirect(rsp, target);
4037 /*********************************************************************
4039 * Function : javascriptify
4041 * Description : Converts a string into a form JavaScript will like.
4043 * Netscape 4's JavaScript sucks - it doesn't use
4044 * "id" parameters, so you have to set the "name"
4045 * used to submit a form element to something JavaScript
4046 * will like. (Or access the elements by index in an
4047 * array. That array contains >60 elements and will
4048 * be changed whenever we add a new action to the
4049 * editor, so I'm NOT going to use indexes that have
4050 * to be figured out by hand.)
4052 * Currently the only thing we have to worry about
4053 * is "-" ==> "_" conversion.
4055 * This is a length-preserving operation so it is
4056 * carried out in-place, no memory is allocated
4060 * 1 : identifier = String to make JavaScript-friendly.
4064 *********************************************************************/
4065 static void javascriptify(char * identifier)
4067 char * p = identifier;
4068 while (NULL != (p = strchr(p, '-')))
4075 /*********************************************************************
4077 * Function : actions_to_radio
4079 * Description : Converts a actionsfile entry into settings for
4080 * radio buttons and edit boxes on a HTML form.
4083 * 1 : exports = List of substitutions to add to.
4084 * 2 : action = Action to read
4086 * Returns : JB_ERR_OK on success
4087 * JB_ERR_MEMORY on out-of-memory
4089 *********************************************************************/
4090 static jb_err actions_to_radio(struct map * exports,
4091 const struct action_spec *action)
4102 mask = action->mask;
4105 /* sanity - prevents "-feature +feature" */
4109 #define DEFINE_ACTION_BOOL(name, bit) \
4110 if (!(mask & bit)) \
4112 current_mode = 'n'; \
4114 else if (add & bit) \
4116 current_mode = 'y'; \
4120 current_mode = 'x'; \
4122 if (map_radio(exports, name, "ynx", current_mode)) \
4124 return JB_ERR_MEMORY; \
4127 #define DEFINE_ACTION_STRING(name, bit, index) \
4128 DEFINE_ACTION_BOOL(name, bit); \
4131 #define DEFINE_CGI_PARAM_RADIO(name, bit, index, value, is_default) \
4134 checked = !strcmp(action->string[index], value); \
4138 checked = is_default; \
4140 mapped_param |= checked; \
4141 if (map(exports, name "-param-" value, 1, (checked ? "checked" : ""), 1)) \
4143 return JB_ERR_MEMORY; \
4146 #define DEFINE_CGI_PARAM_CUSTOM(name, bit, index, default_val) \
4147 if (map(exports, name "-param-custom", 1, \
4148 ((!mapped_param) ? "checked" : ""), 1)) \
4150 return JB_ERR_MEMORY; \
4152 if (map(exports, name "-param", 1, \
4153 (((add & bit) && !mapped_param) ? \
4154 action->string[index] : default_val), 1)) \
4156 return JB_ERR_MEMORY; \
4159 #define DEFINE_CGI_PARAM_NO_RADIO(name, bit, index, default_val) \
4160 if (map(exports, name "-param", 1, \
4161 ((add & bit) ? action->string[index] : default_val), 1)) \
4163 return JB_ERR_MEMORY; \
4166 #define DEFINE_ACTION_MULTI(name, index) \
4167 if (action->multi_add[index]->first) \
4169 current_mode = 'y'; \
4171 else if (action->multi_remove_all[index]) \
4173 current_mode = 'n'; \
4175 else if (action->multi_remove[index]->first) \
4177 current_mode = 'y'; \
4181 current_mode = 'x'; \
4183 if (map_radio(exports, name, "ynx", current_mode)) \
4185 return JB_ERR_MEMORY; \
4188 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
4190 #include "actionlist.h"
4192 #undef DEFINE_ACTION_MULTI
4193 #undef DEFINE_ACTION_STRING
4194 #undef DEFINE_ACTION_BOOL
4195 #undef DEFINE_ACTION_ALIAS
4196 #undef DEFINE_CGI_PARAM_CUSTOM
4197 #undef DEFINE_CGI_PARAM_RADIO
4198 #undef DEFINE_CGI_PARAM_NO_RADIO
4204 /*********************************************************************
4206 * Function : actions_from_radio
4208 * Description : Converts a map of parameters passed to a CGI function
4209 * into an actionsfile entry.
4212 * 1 : parameters = parameters to the CGI call
4213 * 2 : action = Action to change. Must be valid before
4214 * the call, actions not specified will be
4217 * Returns : JB_ERR_OK on success
4218 * JB_ERR_MEMORY on out-of-memory
4220 *********************************************************************/
4221 static jb_err actions_from_radio(const struct map * parameters,
4222 struct action_spec *action)
4227 const char * js_name;
4228 jb_err err = JB_ERR_OK;
4233 /* Statics are generally a potential race condition,
4234 * but in this case we're safe and don't need semaphores.
4235 * Be careful if you modify this function.
4237 * The js_name_arr's are never free()d, but this is no
4238 * problem, since they will only be created once and
4239 * used by all threads thereafter. -oes
4242 #define JAVASCRIPTIFY(dest_var, string) \
4244 static int first_time = 1; \
4245 static char *js_name_arr; \
4248 js_name_arr = strdup(string); \
4249 javascriptify(js_name_arr); \
4251 dest_var = js_name_arr; \
4255 #define DEFINE_ACTION_BOOL(name, bit) \
4256 JAVASCRIPTIFY(js_name, name); \
4257 ch = get_char_param(parameters, js_name); \
4260 action->add |= bit; \
4261 action->mask |= bit; \
4263 else if (ch == 'N') \
4265 action->add &= ~bit; \
4266 action->mask &= ~bit; \
4268 else if (ch == 'X') \
4270 action->add &= ~bit; \
4271 action->mask |= bit; \
4274 #define DEFINE_ACTION_STRING(name, bit, index) \
4275 JAVASCRIPTIFY(js_name, name); \
4276 ch = get_char_param(parameters, js_name); \
4280 JAVASCRIPTIFY(js_name, name "-mode"); \
4281 if (!err) err = get_string_param(parameters, js_name, ¶m); \
4282 if ((param == NULL) || (0 == strcmp(param, "CUSTOM"))) \
4284 JAVASCRIPTIFY(js_name, name "-param"); \
4285 if (!err) err = get_string_param(parameters, js_name, ¶m); \
4287 if (param != NULL) \
4289 if (NULL == (param_dup = strdup(param))) \
4291 return JB_ERR_MEMORY; \
4293 freez(action->string[index]); \
4294 action->add |= bit; \
4295 action->mask |= bit; \
4296 action->string[index] = param_dup; \
4299 else if (ch == 'N') \
4301 if (action->add & bit) \
4303 freez(action->string[index]); \
4305 action->add &= ~bit; \
4306 action->mask &= ~bit; \
4308 else if (ch == 'X') \
4310 if (action->add & bit) \
4312 freez(action->string[index]); \
4314 action->add &= ~bit; \
4315 action->mask |= bit; \
4318 #define DEFINE_ACTION_MULTI(name, index) \
4319 JAVASCRIPTIFY(js_name, name); \
4320 ch = get_char_param(parameters, js_name); \
4325 else if (ch == 'N') \
4327 list_remove_all(action->multi_add[index]); \
4328 list_remove_all(action->multi_remove[index]); \
4329 action->multi_remove_all[index] = 1; \
4331 else if (ch == 'X') \
4333 list_remove_all(action->multi_add[index]); \
4334 list_remove_all(action->multi_remove[index]); \
4335 action->multi_remove_all[index] = 0; \
4338 #define DEFINE_ACTION_ALIAS 0 /* No aliases for URL parsing */
4340 #include "actionlist.h"
4342 #undef DEFINE_ACTION_MULTI
4343 #undef DEFINE_ACTION_STRING
4344 #undef DEFINE_ACTION_BOOL
4345 #undef DEFINE_ACTION_ALIAS
4346 #undef JAVASCRIPTIFY
4350 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
4353 #ifdef FEATURE_TOGGLE
4354 /*********************************************************************
4356 * Function : cgi_toggle
4358 * Description : CGI function that adds a new empty section to
4362 * 1 : csp = Current client state (buffers, headers, etc...)
4363 * 2 : rsp = http_response data structure for output
4364 * 3 : parameters = map of cgi parameters
4367 * set : If present, how to change toggle setting:
4368 * "enable", "disable", "toggle", or none (default).
4369 * mini : If present, use mini reply template.
4371 * Returns : JB_ERR_OK on success
4372 * JB_ERR_MEMORY on out-of-memory
4374 *********************************************************************/
4375 jb_err cgi_toggle(struct client_state *csp,
4376 struct http_response *rsp,
4377 const struct map *parameters)
4379 struct map *exports;
4381 const char *template_name;
4387 if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_TOGGLE))
4389 return cgi_error_disabled(csp, rsp);
4392 mode = get_char_param(parameters, "set");
4397 global_toggle_state = 1;
4399 else if (mode == 'D')
4402 global_toggle_state = 0;
4404 else if (mode == 'T')
4407 global_toggle_state = !global_toggle_state;
4410 log_error(LOG_LEVEL_INFO, "Now toggled %s.", global_toggle_state ? "ON" : "OFF");
4412 if (NULL == (exports = default_exports(csp, "toggle")))
4414 return JB_ERR_MEMORY;
4417 template_name = (get_char_param(parameters, "mini")
4421 return template_fill_for_cgi(csp, template_name, exports, rsp);
4423 #endif /* def FEATURE_TOGGLE */