-const char actions_rcs[] = "$Id: actions.c,v 1.28 2002/04/26 12:53:15 oes Exp $";
+const char actions_rcs[] = "$Id: actions.c,v 1.57 2009/04/04 18:13:51 fabiankeil Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/actions.c,v $
* Purpose : Declares functions to work with actions files
* Functions declared include: FIXME
*
- * Copyright : Written by and Copyright (C) 2001 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
* or write to the Free Software Foundation, Inc., 59
* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
- * Revisions :
- * $Log: actions.c,v $
- * Revision 1.28 2002/04/26 12:53:15 oes
- * - CGI AF editor now writes action lines split into
- * single lines with line continuation
- * - actions_to_html now embeds each action name in
- * link to chapter
- * - current_action_to_text is now called current_action_to_html
- * and acts like actions_to_html
- *
- * Revision 1.27 2002/04/24 02:10:31 oes
- * - Jon's patch for multiple AFs:
- * - split load_actions_file, add load_one_actions_file
- * - make csp->actions_list files an array
- * - remember file id with each action
- * - Copy_action now frees dest action before copying
- *
- * Revision 1.26 2002/03/26 22:29:54 swa
- * we have a new homepage!
- *
- * Revision 1.25 2002/03/24 13:25:43 swa
- * name change related issues
- *
- * Revision 1.24 2002/03/16 23:54:06 jongfoster
- * Adding graceful termination feature, to help look for memory leaks.
- * If you enable this (which, by design, has to be done by hand
- * editing config.h) and then go to http://i.j.b/die, then the program
- * will exit cleanly after the *next* request. It should free all the
- * memory that was used.
- *
- * Revision 1.23 2002/03/07 03:46:16 oes
- * Fixed compiler warnings
- *
- * Revision 1.22 2002/01/21 00:27:02 jongfoster
- * Allowing free_action(NULL).
- * Moving the functions that #include actionlist.h to the end of the file,
- * because the Visual C++ 97 debugger gets extremely confused if you try
- * to debug any code that comes after them in the file.
- *
- * Revision 1.21 2002/01/17 20:54:44 jongfoster
- * Renaming free_url to free_url_spec, since it frees a struct url_spec.
- *
- * Revision 1.20 2001/11/22 21:56:49 jongfoster
- * Making action_spec->flags into an unsigned long rather than just an
- * unsigned int.
- * Fixing a bug in the display of -add-header and -wafer
- *
- * Revision 1.19 2001/11/13 00:14:07 jongfoster
- * Fixing stupid bug now I've figured out what || means.
- * (It always returns 0 or 1, not one of it's paramaters.)
- *
- * Revision 1.18 2001/11/07 00:06:06 steudten
- * Add line number in error output for lineparsing for
- * actionsfile.
- *
- * Revision 1.17 2001/10/25 03:40:47 david__schmidt
- * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
- * threads to call select() simultaneously. So, it's time to do a real, live,
- * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
- * (native). Both versions will work, but using __OS2__ offers multi-threading.
- *
- * Revision 1.16 2001/10/23 21:30:30 jongfoster
- * Adding error-checking to selected functions.
- *
- * Revision 1.15 2001/10/14 21:58:22 jongfoster
- * Adding support for the CGI-based editor:
- * - Exported get_actions()
- * - Added new function free_alias_list()
- * - Added support for {{settings}} and {{description}} blocks
- * in the actions file. They are currently ignored.
- * - Added restriction to only one {{alias}} block which must appear
- * first in the file, to simplify the editor's rewriting rules.
- * - Note that load_actions_file() is no longer used by the CGI-based
- * editor, but some of the other routines in this file are.
- *
- * Revision 1.14 2001/09/22 16:36:59 jongfoster
- * Removing unused parameter fs from read_config_line()
- *
- * Revision 1.13 2001/09/16 15:47:37 jongfoster
- * First version of CGI-based edit interface. This is very much a
- * work-in-progress, and you can't actually use it to edit anything
- * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
- * to have any effect.
- *
- * Revision 1.12 2001/09/16 13:21:27 jongfoster
- * Changes to use new list functions.
- *
- * Revision 1.11 2001/09/14 00:17:32 jongfoster
- * Tidying up memory allocation. New function init_action().
- *
- * Revision 1.10 2001/09/10 10:14:34 oes
- * Removing unused variable
- *
- * Revision 1.9 2001/07/30 22:08:36 jongfoster
- * Tidying up #defines:
- * - All feature #defines are now of the form FEATURE_xxx
- * - Permanently turned off WIN_GUI_EDIT
- * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
- *
- * Revision 1.8 2001/06/29 13:19:52 oes
- * Removed logentry from cancelled commit
- *
- * Revision 1.7 2001/06/09 10:55:28 jongfoster
- * Changing BUFSIZ ==> BUFFER_SIZE
- *
- * Revision 1.6 2001/06/07 23:04:34 jongfoster
- * Made get_actions() static.
- *
- * Revision 1.5 2001/06/03 19:11:48 oes
- * adapted to new enlist_unique arg format
- *
- * Revision 1.4 2001/06/01 20:03:42 jongfoster
- * Better memory management - current_action->strings[] now
- * contains copies of the strings, not the original.
- *
- * Revision 1.3 2001/06/01 18:49:17 jongfoster
- * Replaced "list_share" with "list" - the tiny memory gain was not
- * worth the extra complexity.
- *
- * Revision 1.2 2001/05/31 21:40:00 jongfoster
- * Removing some commented out, obsolete blocks of code.
- *
- * Revision 1.1 2001/05/31 21:16:46 jongfoster
- * Moved functions to process the action list into this new file.
- *
- *
*********************************************************************/
-\f
+
#include "config.h"
#include <assert.h>
#include <stdlib.h>
+#ifdef FEATURE_PTHREAD
+#include <pthread.h>
+#endif
+
#include "project.h"
#include "jcc.h"
#include "list.h"
#include "miscutil.h"
#include "errlog.h"
#include "loaders.h"
-#ifdef FEATURE_CGI_EDIT_ACTIONS
#include "encode.h"
-#endif /* def FEATURE_CGI_EDIT_ACTIONS */
#include "urlmatch.h"
#include "cgi.h"
+#include "ssplit.h"
const char actions_h_rcs[] = ACTIONS_H_VERSION;
struct action_name
{
const char * name;
- unsigned mask; /* a bit set to "0" = remove action */
- unsigned add; /* a bit set to "1" = add action */
- int takes_value; /* an AV_... constant */
- int index; /* index into strings[] or multi[] */
+ unsigned long mask; /* a bit set to "0" = remove action */
+ unsigned long add; /* a bit set to "1" = add action */
+ int takes_value; /* an AV_... constant */
+ int index; /* index into strings[] or multi[] */
};
/*
* Function : merge_actions
*
* Description : Merge two actions together.
- * Similar to "cur_action += new_action".
+ * Similar to "dest += src".
*
* Parameters :
- * 1 : cur_action = Current actions, to modify.
- * 2 : new_action = Action to add.
+ * 1 : dest = Actions to modify.
+ * 2 : src = Action to add.
*
* Returns : JB_ERR_OK or JB_ERR_MEMORY
*
* Function : copy_action
*
* Description : Copy an action_specs.
- * Similar to "cur_action = new_action".
+ * Similar to "dest = src".
*
* Parameters :
* 1 : dest = Destination of copy.
return err;
}
+/*********************************************************************
+ *
+ * Function : free_action_spec
+ *
+ * Description : Frees an action_spec and the memory used by it.
+ *
+ * Parameters :
+ * 1 : src = Source to free.
+ *
+ * Returns : N/A
+ *
+ *********************************************************************/
+void free_action_spec(struct action_spec *src)
+{
+ free_action(src);
+ freez(src);
+}
+
/*********************************************************************
*
return JB_ERR_OK;
}
+/*********************************************************************
+ *
+ * Function : action_used_to_be_valid
+ *
+ * Description : Checks if unrecognized actions were valid in earlier
+ * releases.
+ *
+ * Parameters :
+ * 1 : action = The string containing the action to check.
+ *
+ * Returns : True if yes, otherwise false.
+ *
+ *********************************************************************/
+static int action_used_to_be_valid(const char *action)
+{
+ static const char *formerly_valid_actions[] = {
+ "inspect-jpegs",
+ "kill-popups",
+ "send-vanilla-wafer",
+ "send-wafer",
+ "treat-forbidden-connects-like-blocks",
+ "vanilla-wafer",
+ "wafer"
+ };
+ unsigned int i;
+
+ for (i = 0; i < SZ(formerly_valid_actions); i++)
+ {
+ if (0 == strcmpic(action, formerly_valid_actions[i]))
+ {
+ return TRUE;
+ }
+ }
+
+ return FALSE;
+}
/*********************************************************************
*
* Parameters :
* 1 : line = The string containing the actions.
* Will be written to by this function.
- * 2 : aliases = Custom alias list, or NULL for none.
+ * 2 : alias_list = Custom alias list, or NULL for none.
* 3 : cur_action = Where to store the action. Caller
* allocates memory.
*
if ((value == NULL) || (*value == '\0'))
{
- return JB_ERR_PARSE;
+ if (0 != strcmpic(action->name, "block"))
+ {
+ /*
+ * XXX: Temporary backwards compatibility hack.
+ * XXX: should include line number.
+ */
+ value = "No reason specified.";
+ log_error(LOG_LEVEL_ERROR,
+ "block action without reason found. This may "
+ "become a fatal error in future versions.");
+ }
+ else
+ {
+ return JB_ERR_PARSE;
+ }
}
/* FIXME: should validate option string here */
freez (cur_action->string[action->index]);
/* Found it */
merge_actions(cur_action, alias->action);
}
+ else if (((size_t)2 < strlen(option)) && action_used_to_be_valid(option+1))
+ {
+ log_error(LOG_LEVEL_ERROR, "Action '%s' is no longer valid "
+ "in this Privoxy release. Ignored.", option+1);
+ }
+ else if (((size_t)2 < strlen(option)) && 0 == strcmpic(option+1, "hide-forwarded-for-headers"))
+ {
+ log_error(LOG_LEVEL_FATAL, "The action 'hide-forwarded-for-headers' "
+ "is no longer valid in this Privoxy release. "
+ "Use 'change-x-forwarded-for' instead.");
+ }
else
{
/* Bad action name */
+ /*
+ * XXX: This is a fatal error and Privoxy will later on exit
+ * in load_one_actions_file() because of an "invalid line".
+ *
+ * It would be preferable to name the offending option in that
+ * error message, but currently there is no way to do that and
+ * we have to live with two error messages for basically the
+ * same reason.
+ */
+ log_error(LOG_LEVEL_ERROR, "Unknown action or alias: %s", option);
return JB_ERR_PARSE;
}
}
return err;
}
+#if 0
+/*********************************************************************
+ *
+ * Function : update_action_bits_for_all_tags
+ *
+ * Description : Updates the action bits based on all matching tags.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ *
+ * Returns : 0 if no tag matched, or
+ * 1 otherwise
+ *
+ *********************************************************************/
+int update_action_bits_for_all_tags(struct client_state *csp)
+{
+ struct list_entry *tag;
+ int updated = 0;
+
+ for (tag = csp->tags->first; tag != NULL; tag = tag->next)
+ {
+ if (update_action_bits_for_tag(csp, tag->str))
+ {
+ updated = 1;
+ }
+ }
+
+ return updated;
+}
+#endif
+
+/*********************************************************************
+ *
+ * Function : update_action_bits_for_tag
+ *
+ * Description : Updates the action bits based on the action sections
+ * whose tag patterns match a provided tag.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : tag = The tag on which the update should be based on
+ *
+ * Returns : 0 if no tag matched, or
+ * 1 otherwise
+ *
+ *********************************************************************/
+int update_action_bits_for_tag(struct client_state *csp, const char *tag)
+{
+ struct file_list *fl;
+ struct url_actions *b;
+
+ int updated = 0;
+ int i;
+
+ assert(tag);
+ assert(list_contains_item(csp->tags, tag));
+
+ /* Run through all action files, */
+ for (i = 0; i < MAX_AF_FILES; i++)
+ {
+ if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
+ {
+ /* Skip empty files */
+ continue;
+ }
+
+ /* and through all the action patterns, */
+ for (b = b->next; NULL != b; b = b->next)
+ {
+ /* skip the URL patterns, */
+ if (NULL == b->url->tag_regex)
+ {
+ continue;
+ }
+
+ /* and check if one of the tag patterns matches the tag, */
+ if (0 == regexec(b->url->tag_regex, tag, 0, NULL, 0))
+ {
+ /* if it does, update the action bit map, */
+ if (merge_current_action(csp->action, b->action))
+ {
+ log_error(LOG_LEVEL_ERROR,
+ "Out of memory while changing action bits");
+ }
+ /* and signal the change. */
+ updated = 1;
+ }
+ }
+ }
+
+ return updated;
+}
+
/*********************************************************************
*
* Returns : N/A
*
*********************************************************************/
-void free_current_action (struct current_action_spec *src)
+void free_current_action(struct current_action_spec *src)
{
int i;
}
-static struct file_list *current_actions_file[MAX_ACTION_FILES] = {
+static struct file_list *current_actions_file[MAX_AF_FILES] = {
NULL, NULL, NULL, NULL, NULL,
NULL, NULL, NULL, NULL, NULL
};
*********************************************************************/
void unload_current_actions_file(void)
{
- if (current_actions_file)
+ int i;
+
+ for (i = 0; i < MAX_AF_FILES; i++)
{
- current_actions_file->unloader = unload_actions_file;
- current_actions_file = NULL;
+ if (current_actions_file[i])
+ {
+ current_actions_file[i]->unloader = unload_actions_file;
+ current_actions_file[i] = NULL;
+ }
}
}
#endif /* FEATURE_GRACEFUL_TERMINATION */
{
next = cur->next;
free_url_spec(cur->url);
- free_action(cur->action);
+ if ((next == NULL) || (next->action != cur->action))
+ {
+ /*
+ * As the action settings might be shared,
+ * we can only free them if the current
+ * url pattern is the last one, or if the
+ * next one is using different settings.
+ */
+ free_action_spec(cur->action);
+ }
freez(cur);
cur = next;
}
-
}
/*********************************************************************
*
- * Function : load_actions_file
+ * Function : load_action_files
*
* Description : Read and parse all the action files and add to files
* list.
* Returns : 0 => Ok, everything else is an error.
*
*********************************************************************/
-int load_actions_file(struct client_state *csp)
+int load_action_files(struct client_state *csp)
{
int i;
int result;
- for (i = 0; i < MAX_ACTION_FILES; i++)
+ for (i = 0; i < MAX_AF_FILES; i++)
{
if (csp->config->actions_file[i])
{
}
if (!fs)
{
- log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error finding file: %E",
- csp->config->actions_file[fileid]);
+ log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': %E. "
+ "Note that beginning with Privoxy 3.0.7, actions files have to be specified "
+ "with their complete file names.", csp->config->actions_file[fileid]);
return 1; /* never get here */
}
if (buf[1] == '{')
{
/* It's {{settings}} or {{alias}} */
- int len = strlen(buf);
+ size_t len = strlen(buf);
char * start = buf + 2;
char * end = buf + len - 1;
- if ((len < 5) || (*end-- != '}') || (*end-- != '}'))
+ if ((len < (size_t)5) || (*end-- != '}') || (*end-- != '}'))
{
/* too short */
fclose(fp);
{
if (!cur_action_used)
{
- free_action(cur_action);
- free(cur_action);
+ free_action_spec(cur_action);
}
cur_action = NULL;
}
init_action(cur_action);
/* trim { */
- strcpy(actions_buf, buf + 1);
+ strlcpy(actions_buf, buf + 1, sizeof(actions_buf));
/* check we have a trailing } and then trim it */
end = actions_buf + strlen(actions_buf) - 1;
{
/*
* Part of the {{settings}} block.
- * Ignore for now, but we may want to read & check permissions
- * when we go multi-user.
+ * For now only serves to check if the file's minimum Privoxy
+ * version requirement is met, but we may want to read & check
+ * permissions when we go multi-user.
*/
+ if (!strncmp(buf, "for-privoxy-version=", 20))
+ {
+ char *version_string, *fields[3];
+ int num_fields;
+
+ if ((version_string = strdup(buf + 20)) == NULL)
+ {
+ fclose(fp);
+ log_error(LOG_LEVEL_FATAL,
+ "can't load actions file '%s': out of memory!",
+ csp->config->actions_file[fileid]);
+ return 1; /* never get here */
+ }
+
+ num_fields = ssplit(version_string, ".", fields, 3, TRUE, FALSE);
+
+ if (num_fields < 1 || atoi(fields[0]) == 0)
+ {
+ log_error(LOG_LEVEL_ERROR,
+ "While loading actions file '%s': invalid line (%lu): %s",
+ csp->config->actions_file[fileid], linenum, buf);
+ }
+ else if ( atoi(fields[0]) > VERSION_MAJOR
+ || (num_fields > 1 && atoi(fields[1]) > VERSION_MINOR)
+ || (num_fields > 2 && atoi(fields[2]) > VERSION_POINT))
+ {
+ fclose(fp);
+ log_error(LOG_LEVEL_FATAL,
+ "Actions file '%s', line %lu requires newer Privoxy version: %s",
+ csp->config->actions_file[fileid], linenum, buf );
+ return 1; /* never get here */
+ }
+ free(version_string);
+ }
}
else if (mode == MODE_DESCRIPTION)
{
return 1; /* never get here */
}
- new_alias->name = strdup(buf);
+ if ((new_alias->name = strdup(buf)) == NULL)
+ {
+ fclose(fp);
+ log_error(LOG_LEVEL_FATAL,
+ "can't load actions file '%s': out of memory!",
+ csp->config->actions_file[fileid]);
+ return 1; /* never get here */
+ }
- strcpy(actions_buf, start);
+ strlcpy(actions_buf, start, sizeof(actions_buf));
if (get_actions(actions_buf, alias_list, new_alias->action))
{
return 1; /* never get here */
}
- /* Save flags */
- copy_action (perm->action, cur_action);
+ perm->action = cur_action;
+ cur_action_used = 1;
/* Save the URL pattern */
if (create_url_spec(perm->url, buf))
fclose(fp);
- free_action(cur_action);
-
+ if (!cur_action_used)
+ {
+ free_action_spec(cur_action);
+ }
free_alias_list(alias_list);
/* the old one is now obsolete */
*
* Function : actions_to_text
*
- * Description : Converts a actionsfile entry from numeric form
- * ("mask" and "add") to a text line which is split
+ * Description : Converts a actionsfile entry from the internal
+ * structure into a text line. The output is split
* into one line for each action with line continuation.
*
* Parameters :
- * 1 : mask = As from struct url_actions
- * 2 : add = As from struct url_actions
+ * 1 : action = The action to format.
*
* Returns : A string. Caller must free it.
* NULL on out-of-memory error.
*
*********************************************************************/
-char * actions_to_text(struct action_spec *action)
+char * actions_to_text(const struct action_spec *action)
{
- unsigned mask = action->mask;
- unsigned add = action->add;
- char * result = strdup("");
+ unsigned long mask = action->mask;
+ unsigned long add = action->add;
+ char *result = strdup("");
struct list_entry * lst;
/* sanity - prevents "-feature +feature" */
}
-#ifdef FEATURE_CGI_EDIT_ACTIONS
/*********************************************************************
*
* Function : actions_to_html
* the user manual.
*
* Parameters :
- * 1 : mask = As from struct url_actions
- * 2 : add = As from struct url_actions
+ * 1 : csp = Client state (for config)
+ * 2 : action = Action spec to be converted
*
* Returns : A string. Caller must free it.
* NULL on out-of-memory error.
*
*********************************************************************/
-char * actions_to_html(struct action_spec *action,
- struct client_state *csp)
+char * actions_to_html(const struct client_state *csp,
+ const struct action_spec *action)
{
- unsigned mask = action->mask;
- unsigned add = action->add;
- char * result = strdup("");
+ unsigned long mask = action->mask;
+ unsigned long add = action->add;
+ char *result = strdup("");
struct list_entry * lst;
/* sanity - prevents "-feature +feature" */
return result;
}
-#endif /* def FEATURE_CGI_EDIT_ACTIONS */
/*********************************************************************
* the user manual.
*
* Parameters :
- * 1 : action = Action
+ * 1 : csp = Client state (for config)
+ * 2 : action = Current action spec to be converted
*
* Returns : A string. Caller must free it.
* NULL on out-of-memory error.
*
*********************************************************************/
-char *current_action_to_html(struct current_action_spec *action,
- struct client_state *csp)
+char *current_action_to_html(const struct client_state *csp,
+ const struct current_action_spec *action)
{
unsigned long flags = action->flags;
- char * result = strdup("");
struct list_entry * lst;
+ char *result = strdup("");
+ char *active = strdup("");
+ char *inactive = strdup("");
#define DEFINE_ACTION_BOOL(__name, __bit) \
if (flags & __bit) \
{ \
- string_append(&result, "\n<br>+"); \
- string_join(&result, add_help_link(__name, csp->config)); \
+ string_append(&active, "\n<br>+"); \
+ string_join(&active, add_help_link(__name, csp->config)); \
} \
else \
{ \
- string_append(&result, "\n<br>-"); \
- string_join(&result, add_help_link(__name, csp->config)); \
+ string_append(&inactive, "\n<br>-"); \
+ string_join(&inactive, add_help_link(__name, csp->config)); \
}
#define DEFINE_ACTION_STRING(__name, __bit, __index) \
if (flags & __bit) \
{ \
- string_append(&result, "\n<br>+"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- string_append(&result, "{"); \
- string_join(&result, html_encode(action->string[__index])); \
- string_append(&result, "}"); \
+ string_append(&active, "\n<br>+"); \
+ string_join(&active, add_help_link(__name, csp->config)); \
+ string_append(&active, "{"); \
+ string_join(&active, html_encode(action->string[__index])); \
+ string_append(&active, "}"); \
} \
else \
{ \
- string_append(&result, "\n<br>-"); \
- string_join(&result, add_help_link(__name, csp->config)); \
+ string_append(&inactive, "\n<br>-"); \
+ string_join(&inactive, add_help_link(__name, csp->config)); \
}
#define DEFINE_ACTION_MULTI(__name, __index) \
lst = action->multi[__index]->first; \
if (lst == NULL) \
{ \
- string_append(&result, "\n<br>-"); \
- string_join(&result, add_help_link(__name, csp->config)); \
+ string_append(&inactive, "\n<br>-"); \
+ string_join(&inactive, add_help_link(__name, csp->config)); \
} \
else \
{ \
while (lst) \
{ \
- string_append(&result, "\n<br>+"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- string_append(&result, "{"); \
- string_join(&result, html_encode(lst->str)); \
- string_append(&result, "}"); \
+ string_append(&active, "\n<br>+"); \
+ string_join(&active, add_help_link(__name, csp->config)); \
+ string_append(&active, "{"); \
+ string_join(&active, html_encode(lst->str)); \
+ string_append(&active, "}"); \
lst = lst->next; \
} \
}
#undef DEFINE_ACTION_BOOL
#undef DEFINE_ACTION_ALIAS
+ if (active != NULL)
+ {
+ string_append(&result, active);
+ freez(active);
+ }
+ string_append(&result, "\n<br>");
+ if (inactive != NULL)
+ {
+ string_append(&result, inactive);
+ freez(inactive);
+ }
return result;
}