-const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.51 2007/04/08 13:21:05 fabiankeil Exp $";
+const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.60 2008/03/15 14:52:35 fabiankeil Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $
*
* Stick to the short names in this file for consistency.
*
- * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
*
* Revisions :
* $Log: cgiedit.c,v $
+ * Revision 1.60 2008/03/15 14:52:35 fabiankeil
+ * Add CGI editor support for the "disable all filters of this type"
+ * directives "-client-header-filter", "-server-header-filter",
+ * "-client-header-tagger" and "-server-header-tagger".
+ *
+ * Revision 1.59 2008/03/08 16:25:56 fabiankeil
+ * After three file modification time mismatches, turn the CGI editor off.
+ *
+ * Revision 1.58 2007/11/28 17:57:01 fabiankeil
+ * Fix double free in cgi_edit_actions_list().
+ * Reported by adlab in BR#1840145.
+ *
+ * Revision 1.57 2007/10/27 13:32:23 fabiankeil
+ * Plug minor 5-year-old memory leak. Spotted by
+ * Valgrind and triggered by Privoxy-Regression-Test.
+ *
+ * Revision 1.56 2007/08/05 13:47:03 fabiankeil
+ * #1763173 from Stefan Huehner: s@const static@static const@.
+ *
+ * Revision 1.55 2007/05/31 11:50:20 fabiankeil
+ * Re-enable support for old-school URLs like
+ * http://config.privoxy.org/edit-actions-list?f=default
+ * in the action editor.
+ *
+ * They are no longer used by the CGI pages, but make it easier
+ * to reach the editor directly, without knowing the requested
+ * file's index in csp->config->actions_file[].
+ *
+ * Revision 1.54 2007/05/14 10:33:51 fabiankeil
+ * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
+ *
+ * Revision 1.53 2007/04/15 16:39:20 fabiankeil
+ * Introduce tags as alternative way to specify which
+ * actions apply to a request. At the moment tags can be
+ * created based on client and server headers.
+ *
+ * Revision 1.52 2007/04/12 10:41:23 fabiankeil
+ * - Don't mistake VC++'s _snprintf() for a snprintf() replacement.
+ * - Move some cgi_edit_actions_for_url() variables into structs.
+ * - Remove bogus comment.
+ *
* Revision 1.51 2007/04/08 13:21:05 fabiankeil
* Reference action files in CGI URLs by id instead
* of using the first part of the file name.
/** This file_line is in a {{description}} block. */
#define FILE_LINE_DESCRIPTION_ENTRY 10
+/*
+ * Number of file modification time mismatches
+ * before the CGI editor gets turned off.
+ */
+#define ACCEPTABLE_TIMESTAMP_MISMATCHES 3
/**
* A configuration file, in a format that can be edited and written back to
};
/**
- * Used by cgi_edit_actions_for_url() to replace filter related macros.
+ * Information about the filter types.
+ * Used for macro replacement in cgi_edit_actions_for_url.
*/
-struct cgi_filter_info
+struct filter_type_info
{
const int multi_action_index; /**< The multi action index as defined in project.h */
- char *prepared_templates; /**< Temporary space for the filled-in templates for
- this filter. Once all templated are aggregated
- they replace the @$filtername-params@ macro. */
+ const char *macro_name; /**< Name of the macro that has to be replaced
+ with the prepared templates.
+ For example "content-filter-params" */
const char *type; /**< Name of the filter type,
for example "server-header-filter". */
- const char *abbr_type; /**< Abbreviation of the filter type,
- usually the first character capitalized */
+ /* XXX: check if these two can be combined. */
+ const char *disable_all_option; /**< Name of the catch-all radio option that has
+ to be checked or unchecked for this filter type. */
+ const char *disable_all_param; /**< Name of the parameter that causes all filters of
+ this type to be disabled. */
+ const char *abbr_type; /**< Abbreviation of the filter type, usually the
+ first or second character capitalized */
const char *anchor; /**< Anchor for the User Manual link,
for example "SERVER-HEADER-FILTER" */
};
+/* Accessed by index, keep the order in the way the FT_ macros are defined. */
+static const struct filter_type_info filter_type_info[] =
+{
+ {
+ ACTION_MULTI_FILTER,
+ "content-filter-params", "filter",
+ "filter-all", "filter_all",
+ "F", "FILTER"
+ },
+ {
+ ACTION_MULTI_CLIENT_HEADER_FILTER,
+ "client-header-filter-params", "client-header-filter",
+ "client-header-filter-all", "client_header_filter_all",
+ "C", "CLIENT-HEADER-FILTER"
+ },
+ {
+ ACTION_MULTI_SERVER_HEADER_FILTER,
+ "server-header-filter-params", "server-header-filter",
+ "server-header-filter-all", "server_header_filter_all",
+ "S", "SERVER-HEADER-FILTER"
+ },
+ {
+ ACTION_MULTI_CLIENT_HEADER_TAGGER,
+ "client-header-tagger-params", "client-header-tagger",
+ "client-header-tagger-all", "client_header_tagger_all",
+ "L", "CLIENT-HEADER-TAGGER"
+ },
+ {
+ ACTION_MULTI_SERVER_HEADER_TAGGER,
+ "server-header-tagger-params", "server-header-tagger",
+ "server-header-tagger-all", "server_header_tagger_all",
+ "E", "SERVER-HEADER-TAGGER"
+ },
+};
/* FIXME: Following non-static functions should be prototyped in .h or made static */
const char *name);
#endif /* unused function */
+static jb_err get_file_name_param(struct client_state *csp,
+ const struct map *parameters,
+ const char *param_name,
+ const char **pfilename);
+
/* Internal convenience functions */
static char *section_target(const unsigned sectionid);
{
char buf[30];
- snprintf(buf, 30, "#l%d", sectionid);
+ snprintf(buf, sizeof(buf), "#l%d", sectionid);
return(strdup(buf));
}
/* Correct file->version_str */
freez(file->version_str);
- snprintf(version_buf, 22, "%u", file->version);
- version_buf[21] = '\0';
+ snprintf(version_buf, sizeof(version_buf), "%u", file->version);
+ version_buf[sizeof(version_buf)-1] = '\0';
file->version_str = strdup(version_buf);
if (version_buf == NULL)
{
struct file_line * lines;
FILE * fp;
jb_err err;
- const char * filename = NULL;
+ const char *filename = NULL;
struct editable_file * file;
unsigned version = 0;
struct stat statbuf[1];
*pfile = NULL;
- if ((JB_ERR_OK == get_number_param(csp, parameters, "f", &i))
- && (i < MAX_AF_FILES) && (NULL != csp->config->actions_file[i]))
+ err = get_number_param(csp, parameters, "f", &i);
+ if ((JB_ERR_OK == err) && (i < MAX_AF_FILES) && (NULL != csp->config->actions_file[i]))
{
filename = csp->config->actions_file[i];
}
+ else if (JB_ERR_CGI_PARAMS == err)
+ {
+ /*
+ * Probably an old-school URL like
+ * http://config.privoxy.org/edit-actions-list?f=default
+ */
+ err = get_file_name_param(csp, parameters, "f", &filename);
+ }
- if (filename == NULL || stat(filename, statbuf) < 0)
+ if (NULL == filename || stat(filename, statbuf) < 0)
{
/* Error, probably file not found. */
return JB_ERR_FILE;
/* Correct file->version_str */
freez(file->version_str);
- snprintf(version_buf, 22, "%u", file->version);
- version_buf[21] = '\0';
+ snprintf(version_buf, sizeof(version_buf), "%u", file->version);
+ version_buf[sizeof(version_buf)-1] = '\0';
file->version_str = strdup(version_buf);
if (version_buf == NULL)
{
{
jb_err err;
struct editable_file *file;
+ static int acceptable_failures = ACCEPTABLE_TIMESTAMP_MISMATCHES - 1;
assert(csp);
assert(parameters);
}
else if (err == JB_ERR_MODIFIED)
{
+ assert(require_version);
err = cgi_error_modified(csp, rsp, lookup(parameters, "f"));
+ log_error(LOG_LEVEL_ERROR,
+ "Blocking CGI edit request due to modification time mismatch.");
+ if (acceptable_failures > 0)
+ {
+ log_error(LOG_LEVEL_INFO,
+ "The CGI editor will be turned off after another %d mismatche(s).",
+ acceptable_failures);
+ acceptable_failures--;
+ }
+ else
+ {
+ log_error(LOG_LEVEL_INFO,
+ "Timestamp mismatch limit reached, turning CGI editor off. "
+ "Reload the configuration file to reenable it.");
+ csp->config->feature_flags &= ~RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
+ }
}
if (err == JB_ERR_OK)
{
}
-#if 0
-/*
- * Currently not needed, but may become useful again in the future.
- */
/*********************************************************************
*
* Function : get_file_name_param
*
* Description : Get the name of the file to edit from the parameters
- * passed to a CGI function. This function handles
- * security checks such as blocking urls containing
- * "/" or ".", prepending the config file directory,
- * and adding the specified suffix.
- *
- * (This is an essential security check, otherwise
- * users may be able to pass "../../../etc/passwd"
- * and overwrite the password file [linux], "prn:"
- * and print random data [Windows], etc...)
- *
- * This function only allows filenames contining the
- * characters '-', '_', 'A'-'Z', 'a'-'z', and '0'-'9'.
- * That's probably too restrictive but at least it's
- * secure.
+ * passed to a CGI function using the old syntax.
+ * This function handles security checks and only
+ * accepts files that Privoxy already knows.
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
* 2 : parameters = map of cgi parameters
* 3 : param_name = The name of the parameter to read
- * 4 : suffix = File extension, e.g. ".actions"
- * 5 : pfilename = destination for full filename. Caller
- * free()s. Set to NULL on error.
- * 6 : pparam = destination for partial filename,
- * suitable for use in another URL. Allocated as part
- * of the map "parameters", so don't free it.
- * Set to NULL if not specified.
+ * 4 : pfilename = pointer to the filename in
+ * csp->config->actions_file[] if found. Set to NULL on error.
*
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
static jb_err get_file_name_param(struct client_state *csp,
const struct map *parameters,
const char *param_name,
- const char *suffix,
- char **pfilename,
- const char **pparam)
+ const char **pfilename)
{
const char *param;
+ const char suffix[] = ".action";
const char *s;
char *name;
char *fullpath;
char ch;
size_t len;
+ size_t name_size;
+ int i;
assert(csp);
assert(parameters);
- assert(suffix);
assert(pfilename);
- assert(pparam);
*pfilename = NULL;
- *pparam = NULL;
param = lookup(parameters, param_name);
if (!*param)
return JB_ERR_CGI_PARAMS;
}
- *pparam = param;
-
len = strlen(param);
if (len >= FILENAME_MAX)
{
return JB_ERR_CGI_PARAMS;
}
- /* Check every character to see if it's legal */
+ /*
+ * Check every character to see if it's legal.
+ * Totally unnecessary but we do it anyway.
+ */
s = param;
while ((ch = *s++) != '\0')
{
}
/* Append extension */
- name = malloc(len + strlen(suffix) + 1);
+ name_size = len + strlen(suffix) + 1;
+ name = malloc(name_size);
if (name == NULL)
{
return JB_ERR_MEMORY;
}
- strcpy(name, param);
- strcpy(name + len, suffix);
+ strlcpy(name, param, name_size);
+ strlcat(name, suffix, name_size);
/* Prepend path */
fullpath = make_path(csp->config->confdir, name);
return JB_ERR_MEMORY;
}
- /* Success */
- *pfilename = fullpath;
+ /* Check if the file is known */
+ for (i = 0; i < MAX_AF_FILES; i++)
+ {
+ if (NULL != csp->config->actions_file[i] &&
+ !strcmp(fullpath, csp->config->actions_file[i]))
+ {
+ /* Success */
+ *pfilename = csp->config->actions_file[i];
+ freez(fullpath);
+
+ return JB_ERR_OK;
+ }
+ }
+ freez(fullpath);
- return JB_ERR_OK;
+ return JB_ERR_CGI_PARAMS;
}
-#endif /*0*/
/*********************************************************************
const char * values,
int value)
{
- size_t len;
char * buf;
char * p;
char c;
+ const size_t len = strlen(optionname);
+ const size_t buf_size = len + 3;
assert(exports);
assert(optionname);
assert(values);
- len = strlen(optionname);
- buf = malloc(len + 3);
+ buf = malloc(buf_size);
if (buf == NULL)
{
return JB_ERR_MEMORY;
}
- strcpy(buf, optionname);
+ strlcpy(buf, optionname, buf_size);
+
+ /* XXX: this looks ... interesting */
p = buf + len;
*p++ = '-';
p[1] = '\0';
if (err)
{
/* No filename specified, can't read file, or out of memory. */
+ free_map(exports);
return (err == JB_ERR_FILE ? JB_ERR_OK : err);
}
*/
if (!err) err = map_conditional(exports, "all-urls-present", 1);
- snprintf(buf, 150, "%d", line_number);
+ snprintf(buf, sizeof(buf), "%d", line_number);
if (!err) err = map(exports, "all-urls-s", 1, buf, 1);
- snprintf(buf, 150, "%d", line_number + 2);
+ snprintf(buf, sizeof(buf), "%d", line_number + 2);
if (!err) err = map(exports, "all-urls-s-next", 1, buf, 1);
if (!err) err = map(exports, "all-urls-actions", 1,
actions_to_html(csp, cur_line->data.action), 0);
free(url_template);
edit_free_file(file);
free_map(exports);
- free(url_template);
return err;
}
return JB_ERR_MEMORY;
}
- snprintf(buf, 150, "%d", line_number);
+ snprintf(buf, sizeof(buf), "%d", 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 (prev_section_line_number != ((unsigned)(-1)))
{
/* Not last section */
- snprintf(buf, 150, "%d", prev_section_line_number);
+ snprintf(buf, sizeof(buf), "%d", prev_section_line_number);
if (!err) err = map(section_exports, "s-prev", 1, buf, 1);
if (!err) err = map_block_keep(section_exports, "s-prev-exists");
}
return JB_ERR_MEMORY;
}
- snprintf(buf, 150, "%d", line_number);
+ snprintf(buf, sizeof(buf), "%d", line_number);
err = map(url_exports, "p", 1, buf, 1);
- snprintf(buf, 150, "%d", url_1_2);
+ 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,
/* Could also do section-specific exports here, but it wouldn't be as fast */
- snprintf(buf, 150, "%d", line_number);
+ snprintf(buf, sizeof(buf), "%d", line_number);
if (!err) err = map(section_exports, "s-next", 1, buf, 1);
if ( (cur_line != NULL)
*/
char *filter_template;
int filter_identifier = 0;
- /* XXX: Should we put these into an array? */
- static struct cgi_filter_info content_filter = {
- ACTION_MULTI_FILTER, NULL,
- "filter", "F", "FILTER"
- };
- static struct cgi_filter_info server_header_filter = {
- ACTION_MULTI_SERVER_HEADER_FILTER, NULL,
- "server-header-filter", "S", "SERVER-HEADER-FILTER"
- };
- static struct cgi_filter_info client_header_filter = {
- ACTION_MULTI_CLIENT_HEADER_FILTER, NULL,
- "client-header-filter", "C", "CLIENT-HEADER-FILTER"
- };
-
- content_filter.prepared_templates = strdup("");
- server_header_filter.prepared_templates = strdup("");
- client_header_filter.prepared_templates = strdup("");
+ 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)
filter_group = csp->rlist[i]->f;
for (;(!err) && (filter_group != NULL); filter_group = filter_group->next)
{
- int multi_action_index;
char current_mode = 'x';
char number[20];
struct list_entry *filter_name;
struct map *line_exports;
- struct cgi_filter_info *current_filter = NULL;
+ const int type = filter_group->type;
+ const int multi_action_index = filter_type_info[type].multi_action_index;
- switch (filter_group->type)
- {
- case FT_CONTENT_FILTER:
- current_filter = &content_filter;
- break;
- case FT_SERVER_HEADER_FILTER:
- current_filter = &server_header_filter;
- break;
- case FT_CLIENT_HEADER_FILTER:
- current_filter = &client_header_filter;
- break;
- default:
- log_error(LOG_LEVEL_FATAL,
- "cgi_edit_actions_for_url: Unknown filter type: %u for filter %s.",
- filter_group->type, filter_group->name);
- /* Not reached. */
- }
- assert(current_filter != NULL);
- multi_action_index = current_filter->multi_action_index;
+ assert(type < MAX_FILTER_TYPES);
filter_name = cur_line->data.action->multi_add[multi_action_index]->first;
while ((filter_name != NULL)
if (line_exports == NULL)
{
err = JB_ERR_MEMORY;
- freez(current_filter->prepared_templates); /* XXX: really necessary? */
}
else
{
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, current_filter->type, 1);
- if (!err) err = map(line_exports, "abbr-filter-type", 1, current_filter->abbr_type, 1);
- if (!err) err = map(line_exports, "anchor", 1, current_filter->anchor, 1);
+ 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)
{
if (filter_line == NULL) err = JB_ERR_MEMORY;
}
if (!err) err = template_fill(&filter_line, line_exports);
- string_join(¤t_filter->prepared_templates, filter_line);
+ string_join(&prepared_templates[type], filter_line);
free_map(line_exports);
}
}
freez(filter_template);
- if (!err) err = map(exports, "content-filter-params", 1, content_filter.prepared_templates, 0);
- if (!err) err = map(exports, "server-header-filter-params", 1, server_header_filter.prepared_templates, 0);
- if (!err) err = map(exports, "client-header-filter-params", 1, client_header_filter.prepared_templates, 0);
+ /* 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)
{
- freez(content_filter.prepared_templates);
- freez(server_header_filter.prepared_templates);
- freez(client_header_filter.prepared_templates);
+ /* Free aggregated templates */
+ for (i = 0; i < MAX_FILTER_TYPES; i++)
+ {
+ freez(prepared_templates[i]);
+ }
}
}
- if (!err) err = map_radio(exports, "filter-all", "nx",
- (cur_line->data.action->multi_remove_all[ACTION_MULTI_FILTER] ? 'n' : 'x'));
+ /* 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);
unsigned sectionid;
char * actiontext;
char * newtext;
+ size_t newtext_size;
size_t len;
struct editable_file * file;
struct file_line * cur_line;
char target[1024];
jb_err err;
int filter_identifier;
+ int i;
const char * action_set_name;
- char ch;
struct file_list * fl;
struct url_actions * b;
{
if (!strncmp(b->url->spec, "standard.", 9) && !strcmp(b->url->spec + 9, action_set_name))
{
- copy_action(cur_line->data.action, b->action);
+ copy_action(cur_line->data.action, b->action);
goto found;
}
}
err = actions_from_radio(parameters, cur_line->data.action);
}
- if(err)
+ if (err)
{
/* Out of memory */
edit_free_file(file);
return err;
}
- ch = get_char_param(parameters, "filter_all");
- if (ch == 'N')
+ /* Check the "disable all of this type" parameters. */
+ for (i = 0; i < MAX_FILTER_TYPES; i++)
{
- list_remove_all(cur_line->data.action->multi_add[ACTION_MULTI_FILTER]);
- list_remove_all(cur_line->data.action->multi_remove[ACTION_MULTI_FILTER]);
- cur_line->data.action->multi_remove_all[ACTION_MULTI_FILTER] = 1;
- }
- else if (ch == 'X')
- {
- cur_line->data.action->multi_remove_all[ACTION_MULTI_FILTER] = 0;
+ 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++)
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);
len = 1;
}
- if (NULL == (newtext = malloc(len + 2)))
+ newtext_size = len + 2;
+ if (NULL == (newtext = malloc(newtext_size)))
{
/* Out of memory */
free(actiontext);
edit_free_file(file);
return JB_ERR_MEMORY;
}
- strcpy(newtext, actiontext);
+ strlcpy(newtext, actiontext, newtext_size);
free(actiontext);
newtext[0] = '{';
newtext[len] = '}';
projects / privoxy.git / blobdiff