+ /* Load templates */
+
+ err = template_load(csp, §ion_template, "edit-actions-list-section", 0);
+ if (err)
+ {
+ edit_free_file(file);
+ free_map(exports);
+ if (err == JB_ERR_FILE)
+ {
+ return cgi_error_no_template(csp, rsp, "edit-actions-list-section");
+ }
+ return err;
+ }
+
+ err = template_load(csp, &url_template, "edit-actions-list-url", 0);
+ if (err)
+ {
+ free(section_template);
+ edit_free_file(file);
+ free_map(exports);
+ if (err == JB_ERR_FILE)
+ {
+ return cgi_error_no_template(csp, rsp, "edit-actions-list-url");
+ }
+ return err;
+ }
+
+ err = template_fill(§ion_template, exports);
+ if (err)
+ {
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ return err;
+ }
+
+ err = template_fill(&url_template, exports);
+ if (err)
+ {
+ free(section_template);
+ edit_free_file(file);
+ free_map(exports);
+ return err;
+ }
+
+ if (NULL == (sections = strdup("")))
+ {
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+
+ while ((cur_line != NULL) && (cur_line->type == FILE_LINE_ACTION))
+ {
+ section_exports = new_map();
+
+ snprintf(buf, sizeof(buf), "%u", line_number);
+ err = map(section_exports, "s", 1, buf, 1);
+ if (!err) err = map(section_exports, "actions", 1,
+ actions_to_html(csp, cur_line->data.action), 0);
+
+ if ((!err)
+ && (cur_line->next != NULL)
+ && (cur_line->next->type == FILE_LINE_URL))
+ {
+ /* This section contains at least one URL, don't allow delete */
+ err = map_block_killer(section_exports, "empty-section");
+ }
+ else
+ {
+ if (!err) err = map_block_keep(section_exports, "empty-section");
+ }
+
+ if (prev_section_line_number != ((unsigned)(-1)))
+ {
+ /* Not last section */
+ snprintf(buf, sizeof(buf), "%u", prev_section_line_number);
+ if (!err) err = map(section_exports, "s-prev", 1, buf, 1);
+ if (!err) err = map_block_keep(section_exports, "s-prev-exists");
+ }
+ else
+ {
+ /* Last section */
+ if (!err) err = map_block_killer(section_exports, "s-prev-exists");
+ }
+ prev_section_line_number = line_number;
+
+ if (err)
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return err;
+ }
+
+ /* Should do all section-specific exports above this point */
+
+ if (NULL == (urls = strdup("")))
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return JB_ERR_MEMORY;
+ }
+
+ url_1_2 = 2;
+
+ cur_line = cur_line->next;
+ line_number++;
+
+ while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL))
+ {
+ url_exports = new_map();
+
+ snprintf(buf, sizeof(buf), "%u", line_number);
+ err = map(url_exports, "p", 1, buf, 1);
+
+ snprintf(buf, sizeof(buf), "%d", url_1_2);
+ if (!err) err = map(url_exports, "url-1-2", 1, buf, 1);
+
+ if (!err) err = map(url_exports, "url-html", 1,
+ html_encode(cur_line->unprocessed), 0);
+ if (!err) err = map(url_exports, "url", 1,
+ url_encode(cur_line->unprocessed), 0);
+
+ if (err)
+ {
+ free(urls);
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ free_map(url_exports);
+ return err;
+ }
+
+ if (NULL == (s = strdup(url_template)))
+ {
+ free(urls);
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ free_map(url_exports);
+ return JB_ERR_MEMORY;
+ }
+
+ err = template_fill(&s, section_exports);
+ if (!err) err = template_fill(&s, url_exports);
+ if (!err) err = string_append(&urls, s);
+
+ free_map(url_exports);
+ freez(s);
+
+ if (err)
+ {
+ freez(urls);
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return err;
+ }
+
+ url_1_2 = 3 - url_1_2;
+
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ err = map(section_exports, "urls", 1, urls, 0);
+
+ /* Could also do section-specific exports here, but it wouldn't be as fast */
+
+ snprintf(buf, sizeof(buf), "%u", line_number);
+ if (!err) err = map(section_exports, "s-next", 1, buf, 1);
+
+ if ((cur_line != NULL)
+ && (cur_line->type == FILE_LINE_ACTION))
+ {
+ /* Not last section */
+ if (!err) err = map_block_keep(section_exports, "s-next-exists");
+ }
+ else
+ {
+ /* Last section */
+ if (!err) err = map_block_killer(section_exports, "s-next-exists");
+ }
+
+ if (err)
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return err;
+ }
+
+ if (NULL == (s = strdup(section_template)))
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return JB_ERR_MEMORY;
+ }
+
+ err = template_fill(&s, section_exports);
+ if (!err) err = string_append(§ions, s);
+
+ freez(s);
+ free_map(section_exports);
+
+ if (err)
+ {
+ freez(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ return err;
+ }
+ }
+
+ edit_free_file(file);
+ free(section_template);
+ free(url_template);
+
+ err = map(exports, "sections", 1, sections, 0);
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ /* Could also do global exports here, but it wouldn't be as fast */
+
+ return template_fill_for_cgi(csp, "edit-actions-list", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_for_url
+ *
+ * Description : CGI function that edits the Actions list.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters : None
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_for_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ struct map * exports;
+ unsigned sectionid;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ jb_err err;
+ struct re_filterfile_spec *filter_group;
+ int i, have_filters = 0;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "s", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ cur_line = file->lines;
+
+ for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++)
+ {
+ cur_line = cur_line->next;
+ }
+
+ if ( (cur_line == NULL)
+ || (line_number != sectionid)
+ || (sectionid < 1)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ err = map(exports, "f", 1, stringify(file->identifier), 0);
+ if (!err) err = map(exports, "v", 1, file->version_str, 1);
+ if (!err) err = map(exports, "s", 1, url_encode(lookup(parameters, "s")), 0);
+
+ if (!err) err = actions_to_radio(exports, cur_line->data.action);
+
+ /*
+ * XXX: Some browsers (at least IE6 and IE7) have an artificial URL
+ * length limitation and ignore clicks on the Submit buttons if
+ * the resulting GET URL would be longer than their limit.
+ *
+ * In Privoxy 3.0.5 beta the standard edit-actions-for-url template
+ * reached this limit and action editing stopped working in these
+ * browsers (BR #1570678).
+ *
+ * The config option split-large-forms works around this browser
+ * bug (HTTP has no URL length limitation) by deviding the action
+ * list form into multiple smaller ones. It means the URLs are shorter
+ * and work in broken browsers as well, but the user can no longer change
+ * all actions with one submit.
+ *
+ * A better solution would be to switch to POST requests,
+ * but this will do for now.
+ */
+ if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_SPLIT_LARGE_FORMS))
+ {
+ /* Generate multiple smaller form by killing the big one. */
+ err = map_block_killer(exports, "one-form-only");
+ }
+ else
+ {
+ /* Default: Generate one large form by killing the smaller ones. */
+ err = map_block_killer(exports, "multiple-forms");
+ }
+
+ for (i = 0; i < MAX_AF_FILES; i++)
+ {
+ if ((csp->rlist[i] != NULL) && (csp->rlist[i]->f != NULL))
+ {
+ if (!err) err = map_conditional(exports, "any-filters-defined", 1);
+ have_filters = 1;
+ break;
+ }
+ }
+
+#ifndef FEATURE_EXTERNAL_FILTERS
+ if (!err) err = map_block_killer(exports, "external-content-filters");
+#endif
+
+ if (err)
+ {
+ edit_free_file(file);
+ free_map(exports);
+ return err;
+ }
+
+ if (0 == have_filters)
+ {
+ err = map(exports, "filter-params", 1, "", 1);
+ }
+ else
+ {
+ /*
+ * List available filters and their settings.
+ */
+ char *filter_template;
+ int filter_identifier = 0;
+ char *prepared_templates[MAX_FILTER_TYPES];
+
+ for (i = 0; i < MAX_FILTER_TYPES; i++)
+ {
+ prepared_templates[i] = strdup("");
+ }
+
+ err = template_load(csp, &filter_template, "edit-actions-for-url-filter", 0);
+ if (err)
+ {
+ edit_free_file(file);
+ free_map(exports);
+ if (err == JB_ERR_FILE)
+ {
+ return cgi_error_no_template(csp, rsp, "edit-actions-for-url-filter");
+ }
+ return err;
+ }
+
+ err = template_fill(&filter_template, exports);
+
+ for (i = 0; i < MAX_AF_FILES; i++)
+ {
+ if ((csp->rlist[i] != NULL) && (csp->rlist[i]->f != NULL))
+ {
+ filter_group = csp->rlist[i]->f;
+ for (;(!err) && (filter_group != NULL); filter_group = filter_group->next)
+ {
+ char current_mode = 'x';
+ char number[20];
+ struct list_entry *filter_name;
+ struct map *line_exports;
+ const enum filter_type type = filter_group->type;
+ const int multi_action_index = filter_type_info[type].multi_action_index;
+
+ assert(type < MAX_FILTER_TYPES);
+
+ filter_name = cur_line->data.action->multi_add[multi_action_index]->first;
+ while ((filter_name != NULL)
+ && (0 != strcmp(filter_group->name, filter_name->str)))
+ {
+ filter_name = filter_name->next;
+ }
+
+ if (filter_name != NULL)
+ {
+ current_mode = 'y';
+ }
+ else
+ {
+ filter_name = cur_line->data.action->multi_remove[multi_action_index]->first;
+ while ((filter_name != NULL)
+ && (0 != strcmp(filter_group->name, filter_name->str)))
+ {
+ filter_name = filter_name->next;
+ }
+ if (filter_name != NULL)
+ {
+ current_mode = 'n';
+ }
+ }
+
+ /* Generate a unique serial number */
+ snprintf(number, sizeof(number), "%x", filter_identifier++);
+ number[sizeof(number) - 1] = '\0';
+
+ line_exports = new_map();
+ if (line_exports == NULL)
+ {
+ err = JB_ERR_MEMORY;
+ }
+ else
+ {
+ char *filter_line;
+
+ if (!err) err = map(line_exports, "index", 1, number, 1);
+ if (!err) err = map(line_exports, "name", 1, filter_group->name, 1);
+ if (!err) err = map(line_exports, "description", 1, filter_group->description, 1);
+ if (!err) err = map_radio(line_exports, "this-filter", "ynx", current_mode);
+ if (!err) err = map(line_exports, "filter-type", 1, filter_type_info[type].type, 1);
+ if (!err) err = map(line_exports, "abbr-filter-type", 1, filter_type_info[type].abbr_type, 1);
+ if (!err) err = map(line_exports, "anchor", 1, filter_type_info[type].anchor, 1);
+
+ if (!err)
+ {
+ filter_line = strdup(filter_template);
+ if (filter_line == NULL) err = JB_ERR_MEMORY;
+ }
+ if (!err) err = template_fill(&filter_line, line_exports);
+ string_join(&prepared_templates[type], filter_line);
+
+ free_map(line_exports);
+ }
+ }
+ }
+ }
+ freez(filter_template);
+
+ /* Replace all filter macros with the aggregated templates */
+ for (i = 0; i < MAX_FILTER_TYPES; i++)
+ {
+ if (err) break;
+ err = map(exports, filter_type_info[i].macro_name, 1, prepared_templates[i], 0);
+ }
+
+ if (err)
+ {
+ /* Free aggregated templates */
+ for (i = 0; i < MAX_FILTER_TYPES; i++)
+ {
+ freez(prepared_templates[i]);
+ }
+ }
+ }
+
+ /* Check or uncheck the "disable all of this type" radio buttons. */
+ for (i = 0; i < MAX_FILTER_TYPES; i++)
+ {
+ const int a = filter_type_info[i].multi_action_index;
+ const int disable_all = cur_line->data.action->multi_remove_all[a];
+ if (err) break;
+ err = map_radio(exports, filter_type_info[i].disable_all_option, "nx", (disable_all ? 'n' : 'x'));
+ }
+
+ edit_free_file(file);
+
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ return template_fill_for_cgi(csp, "edit-actions-for-url", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_submit
+ *
+ * Description : CGI function that actually edits the Actions list.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters : None
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_submit(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ char * actiontext;
+ char * newtext;
+ size_t newtext_size;
+ size_t len;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ char target[1024];
+ jb_err err;
+ int filter_identifier;
+ int i;
+ const char * action_set_name;
+ struct file_list * fl;
+ struct url_actions * b;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "s", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ cur_line = file->lines;
+
+ for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++)
+ {
+ cur_line = cur_line->next;
+ }
+
+ if ( (cur_line == NULL)
+ || (line_number != sectionid)
+ || (sectionid < 1)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ get_string_param(parameters, "p", &action_set_name);
+ if (action_set_name != NULL)
+ {
+ for (filter_identifier = 0; filter_identifier < MAX_AF_FILES; filter_identifier++)
+ {
+ if (((fl = csp->actions_list[filter_identifier]) != NULL) && ((b = fl->f) != NULL))
+ {
+ for (b = b->next; NULL != b; b = b->next)
+ {
+ if (!strncmp(b->url->spec, "standard.", 9) && !strcmp(b->url->spec + 9, action_set_name))
+ {
+ copy_action(cur_line->data.action, b->action);
+ goto found;
+ }
+ }
+ }
+ }
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+
+ found: ;
+ }
+ else
+ {
+ err = actions_from_radio(parameters, cur_line->data.action);
+ }
+
+ if (err)
+ {
+ /* Out of memory */
+ edit_free_file(file);
+ return err;
+ }
+
+ /* Check the "disable all of this type" parameters. */
+ for (i = 0; i < MAX_FILTER_TYPES; i++)
+ {
+ const int multi_action_index = filter_type_info[i].multi_action_index;
+ const char ch = get_char_param(parameters, filter_type_info[i].disable_all_param);
+
+ if (ch == 'N')
+ {
+ list_remove_all(cur_line->data.action->multi_add[multi_action_index]);
+ list_remove_all(cur_line->data.action->multi_remove[multi_action_index]);
+ cur_line->data.action->multi_remove_all[multi_action_index] = 1;
+ }
+ else if (ch == 'X')
+ {
+ cur_line->data.action->multi_remove_all[multi_action_index] = 0;
+ }
+ }
+
+ for (filter_identifier = 0; !err; filter_identifier++)
+ {
+ char key_value[30];
+ char key_name[30];
+ char key_type[30];
+ const char *name;
+ char value; /*
+ * Filter state. Valid states are: 'Y' (active),
+ * 'N' (inactive) and 'X' (no change).
+ * XXX: bad name.
+ */
+ char type; /*
+ * Abbreviated filter type. Valid types are: 'F' (content filter),
+ * 'S' (server-header filter) and 'C' (client-header filter).
+ */
+ int multi_action_index = 0;
+
+ /* Generate the keys */
+ snprintf(key_value, sizeof(key_value), "filter_r%x", filter_identifier);
+ key_value[sizeof(key_value) - 1] = '\0'; /* XXX: Why? */
+ snprintf(key_name, sizeof(key_name), "filter_n%x", filter_identifier);
+ key_name[sizeof(key_name) - 1] = '\0'; /* XXX: Why? */
+ snprintf(key_type, sizeof(key_type), "filter_t%x", filter_identifier);
+
+ err = get_string_param(parameters, key_name, &name);
+ if (err) break;
+
+ if (name == NULL)
+ {
+ /* End of list */
+ break;
+ }
+
+ type = get_char_param(parameters, key_type);
+ switch (type)
+ {
+ case 'F':
+ multi_action_index = ACTION_MULTI_FILTER;
+ break;
+ case 'S':
+ multi_action_index = ACTION_MULTI_SERVER_HEADER_FILTER;
+ break;
+ case 'C':
+ multi_action_index = ACTION_MULTI_CLIENT_HEADER_FILTER;
+ break;
+ case 'L':
+ multi_action_index = ACTION_MULTI_CLIENT_HEADER_TAGGER;
+ break;
+ case 'E':
+ multi_action_index = ACTION_MULTI_SERVER_HEADER_TAGGER;
+ break;
+ default:
+ log_error(LOG_LEVEL_ERROR,
+ "Unknown filter type: %c for filter %s. Filter ignored.", type, name);
+ continue;
+ }
+ assert(multi_action_index);
+
+ value = get_char_param(parameters, key_value);
+ if (value == 'Y')
+ {
+ list_remove_item(cur_line->data.action->multi_add[multi_action_index], name);
+ if (!err) err = enlist(cur_line->data.action->multi_add[multi_action_index], name);
+ list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name);
+ }
+ else if (value == 'N')
+ {
+ list_remove_item(cur_line->data.action->multi_add[multi_action_index], name);
+ if (!cur_line->data.action->multi_remove_all[multi_action_index])
+ {
+ list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name);
+ if (!err) err = enlist(cur_line->data.action->multi_remove[multi_action_index], name);
+ }
+ }
+ else if (value == 'X')
+ {
+ list_remove_item(cur_line->data.action->multi_add[multi_action_index], name);
+ list_remove_item(cur_line->data.action->multi_remove[multi_action_index], name);
+ }
+ }
+
+ if (err)
+ {
+ /* Out of memory */
+ edit_free_file(file);
+ return err;
+ }
+
+ if (NULL == (actiontext = actions_to_text(cur_line->data.action)))
+ {
+ /* Out of memory */
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ len = strlen(actiontext);
+ if (len == 0)
+ {
+ /*
+ * Empty action - must special-case this.
+ * Simply setting len to 1 is sufficient...
+ */
+ len = 1;
+ }
+
+ newtext_size = len + 2;
+ newtext = malloc_or_die(newtext_size);
+ strlcpy(newtext, actiontext, newtext_size);
+ free(actiontext);
+ newtext[0] = '{';
+ newtext[len] = '}';
+ newtext[len + 1] = '\0';
+
+ freez(cur_line->raw);
+ freez(cur_line->unprocessed);
+ cur_line->unprocessed = newtext;
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ if (err == JB_ERR_FILE)
+ {
+ /* Read-only file. */
+ err = cgi_error_file_read_only(csp, rsp, file->filename);
+ }
+ edit_free_file(file);
+ return err;
+ }
+
+ snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u",
+ (long) time(NULL), file->identifier, sectionid);
+
+ edit_free_file(file);
+
+ return cgi_redirect(rsp, target);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_url
+ *
+ * Description : CGI function that actually edits a URL pattern in
+ * an actions file.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters :
+ * filename : Identifies the file to edit
+ * ver : File's last-modified time
+ * section : Line number of section to edit
+ * pattern : Line number of pattern to edit
+ * newval : New value for pattern
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned patternid;
+ char * new_pattern;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ unsigned section_start_line_number = 0;
+ char target[1024];
+ jb_err err;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "p", &patternid);
+ if (err)
+ {
+ return err;
+ }
+ if (patternid < 1U)
+ {
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ err = get_url_spec_param(csp, parameters, "u", &new_pattern);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ free(new_pattern);
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ cur_line = file->lines;
+
+ while ((cur_line != NULL) && (line_number < patternid))
+ {
+ if (cur_line->type == FILE_LINE_ACTION)
+ {
+ section_start_line_number = line_number;
+ }
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ((cur_line == NULL)
+ || (cur_line->type != FILE_LINE_URL))
+ {
+ /* Invalid "patternid" parameter */
+ free(new_pattern);
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* At this point, the line to edit is in cur_line */
+
+ freez(cur_line->raw);
+ freez(cur_line->unprocessed);
+ cur_line->unprocessed = new_pattern;
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ if (err == JB_ERR_FILE)
+ {
+ /* Read-only file. */
+ err = cgi_error_file_read_only(csp, rsp, file->filename);
+ }
+ edit_free_file(file);
+ return err;
+ }
+
+ snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u",
+ (long) time(NULL), file->identifier, section_start_line_number);
+
+ edit_free_file(file);
+
+ return cgi_redirect(rsp, target);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_add_url
+ *
+ * Description : CGI function that actually adds a URL pattern to
+ * an actions file.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters :
+ * filename : Identifies the file to edit
+ * ver : File's last-modified time
+ * section : Line number of section to edit
+ * newval : New pattern
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_add_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ char * new_pattern;
+ struct file_line * new_line;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ char target[1024];
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "s", §ionid);
+ if (err)
+ {
+ return err;
+ }
+ if (sectionid < 1U)
+ {
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ err = get_url_spec_param(csp, parameters, "u", &new_pattern);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ free(new_pattern);
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ cur_line = file->lines;
+
+ while ((cur_line != NULL) && (line_number < sectionid))
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ((cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ free(new_pattern);
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* At this point, the section header is in cur_line - add after this. */
+
+ /* Allocate the new line */
+ new_line = zalloc_or_die(sizeof(*new_line));
+
+ /* Fill in the data members of the new line */
+ new_line->raw = NULL;
+ new_line->prefix = NULL;
+ new_line->unprocessed = new_pattern;
+ new_line->type = FILE_LINE_URL;
+
+ /* Link new_line into the list, after cur_line */
+ new_line->next = cur_line->next;
+ cur_line->next = new_line;
+
+ /* Done making changes, now commit */
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ if (err == JB_ERR_FILE)
+ {
+ /* Read-only file. */
+ err = cgi_error_file_read_only(csp, rsp, file->filename);
+ }
+ edit_free_file(file);
+ return err;
+ }
+
+ snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%i#l%u",
+ (long) time(NULL), file->identifier, sectionid);
+
+ edit_free_file(file);
+
+ return cgi_redirect(rsp, target);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_remove_url
+ *
+ * Description : CGI function that actually removes a URL pattern from
+ * the actions file.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters :
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * p : (pattern) Line number of pattern to remove
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_remove_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned patternid;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ struct file_line * prev_line;
+ unsigned line_number;
+ unsigned section_start_line_number = 0;
+ char target[1024];
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "p", &patternid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ prev_line = NULL;
+ cur_line = file->lines;
+
+ while ((cur_line != NULL) && (line_number < patternid))
+ {
+ if (cur_line->type == FILE_LINE_ACTION)
+ {
+ section_start_line_number = line_number;
+ }
+ prev_line = cur_line;
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ( (cur_line == NULL)
+ || (prev_line == NULL)
+ || (cur_line->type != FILE_LINE_URL))
+ {
+ /* Invalid "patternid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* At this point, the line to remove is in cur_line, and the previous
+ * one is in prev_line
+ */
+
+ /* Unlink cur_line */
+ prev_line->next = cur_line->next;
+ cur_line->next = NULL;
+
+ /* Free cur_line */
+ edit_free_file_lines(cur_line);
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ if (err == JB_ERR_FILE)
+ {
+ /* Read-only file. */
+ err = cgi_error_file_read_only(csp, rsp, file->filename);
+ }
+ edit_free_file(file);
+ return err;
+ }
+
+ snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u#l%u",
+ (long) time(NULL), file->identifier, section_start_line_number);
+
+ edit_free_file(file);
+
+ return cgi_redirect(rsp, target);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_section_remove
+ *
+ * Description : CGI function that actually removes a whole section from
+ * the actions file. The section must be empty first
+ * (else JB_ERR_CGI_PARAMS).
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters :
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * s : (section) Line number of section to edit
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_section_remove(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ struct file_line * prev_line;
+ unsigned line_number;
+ char target[1024];
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "s", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ cur_line = file->lines;
+
+ prev_line = NULL;
+ while ((cur_line != NULL) && (line_number < sectionid))
+ {
+ prev_line = cur_line;
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ((cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ if ((cur_line->next != NULL)
+ && (cur_line->next->type == FILE_LINE_URL))
+ {
+ /* Section not empty. */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* At this point, the line to remove is in cur_line, and the previous
+ * one is in prev_line
+ */
+
+ /* Unlink cur_line */
+ if (prev_line == NULL)
+ {
+ /* Removing the first line from the file */
+ file->lines = cur_line->next;
+ }
+ else
+ {
+ prev_line->next = cur_line->next;
+ }
+ cur_line->next = NULL;
+
+ /* Free cur_line */
+ edit_free_file_lines(cur_line);
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ if (err == JB_ERR_FILE)
+ {
+ /* Read-only file. */
+ err = cgi_error_file_read_only(csp, rsp, file->filename);
+ }
+ edit_free_file(file);
+ return err;
+ }
+
+ snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u",
+ (long) time(NULL), file->identifier);
+
+ edit_free_file(file);
+
+ return cgi_redirect(rsp, target);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_section_add
+ *
+ * Description : CGI function that adds a new empty section to
+ * an actions file.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters :
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * s : (section) Line number of section to add after, 0 for
+ * start of file.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_section_add(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ struct file_line * new_line;
+ char * new_text;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ char target[1024];
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "s", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ cur_line = file->lines;
+
+ if (sectionid <= 1U)
+ {
+ /* Add to start of file */
+ if (cur_line != NULL && cur_line->type != FILE_LINE_ACTION)
+ {
+ /* There's something in the file, find the line before the first
+ * action.
+ */
+ while ((cur_line->next != NULL)
+ && (cur_line->next->type != FILE_LINE_ACTION))
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+ }
+ else
+ {
+ /* File starts with action line, so insert at top */
+ cur_line = NULL;
+ }
+ }
+ else
+ {
+ /* Add after stated section. */
+ while ((cur_line != NULL) && (line_number < sectionid))
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ((cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* Skip through the section to find the last line in it. */
+ while ((cur_line->next != NULL)
+ && (cur_line->next->type != FILE_LINE_ACTION))
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+ }
+
+ /* At this point, the last line in the previous section is in cur_line
+ * - add after this. (Or if we need to add as the first line, cur_line
+ * will be NULL).
+ */
+
+ new_text = strdup("{}");
+ if (NULL == new_text)
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ /* Allocate the new line */
+ new_line = zalloc_or_die(sizeof(*new_line));
+
+ /* Fill in the data members of the new line */
+ new_line->raw = NULL;
+ new_line->prefix = NULL;
+ new_line->unprocessed = new_text;
+ new_line->type = FILE_LINE_ACTION;
+
+ if (cur_line != NULL)
+ {
+ /* Link new_line into the list, after cur_line */
+ new_line->next = cur_line->next;
+ cur_line->next = new_line;
+ }
+ else
+ {
+ /* Link new_line into the list, as first line */
+ new_line->next = file->lines;
+ file->lines = new_line;
+ }
+
+ /* Done making changes, now commit */
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ if (err == JB_ERR_FILE)
+ {
+ /* Read-only file. */
+ err = cgi_error_file_read_only(csp, rsp, file->filename);
+ }
+ edit_free_file(file);
+ return err;
+ }
+
+ snprintf(target, sizeof(target), CGI_PREFIX "edit-actions-list?foo=%lu&f=%u",
+ (long) time(NULL), file->identifier);
+
+ edit_free_file(file);
+
+ return cgi_redirect(rsp, target);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_section_swap
+ *
+ * Description : CGI function that swaps the order of two sections
+ * in the actions file. Note that this CGI can actually
+ * swap any two arbitrary sections, but the GUI interface
+ * currently only allows consecutive sections to be
+ * specified.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters :
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * s1 : (section1) Line number of first section to swap
+ * s2 : (section2) Line number of second section to swap
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_section_swap(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned section1;
+ unsigned section2;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ struct file_line * prev_line;
+ struct file_line * line_before_section1;
+ struct file_line * line_start_section1;
+ struct file_line * line_end_section1;
+ struct file_line * line_after_section1;
+ struct file_line * line_before_section2;
+ struct file_line * line_start_section2;
+ struct file_line * line_end_section2;
+ struct file_line * line_after_section2;
+ unsigned line_number;
+ char target[1024];
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "s1", §ion1);
+ if (!err) err = get_number_param(csp, parameters, "s2", §ion2);
+ if (err)
+ {
+ return err;
+ }
+
+ if (section1 > section2)