-const char actions_rcs[] = "$Id: actions.c,v 1.18 2001/11/07 00:06:06 steudten 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
- * IJBSWA team. http://ijbswa.sourceforge.net
+ * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge
+ * Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* by and Copyright (C) 1997 Anonymous Coders and
* 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.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;
#define AV_ADD_STRING 1 /* +stropt{string} */
#define AV_REM_STRING 2 /* -stropt */
#define AV_ADD_MULTI 3 /* +multiopt{string} +multiopt{string2} */
-#define AV_REM_MULTI 4 /* -multiopt{string} -multiopt{*} */
+#define AV_REM_MULTI 4 /* -multiopt{string} -multiopt */
/*
* We need a structure to hold the name, flag changes,
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[] */
};
/*
};
+static int load_one_actions_file(struct client_state *csp, int fileid);
+
+
/*********************************************************************
*
* 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".
- * Note that dest better not contain valid data
- * - it's overwritten, not freed.
+ * Similar to "dest = src".
*
* Parameters :
* 1 : dest = Destination of copy.
int i;
jb_err err = JB_ERR_OK;
+ free_action(dest);
memset(dest, '\0', sizeof(*dest));
dest->mask = src->mask;
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);
+}
+
/*********************************************************************
*
{
int i;
+ if (src == NULL)
+ {
+ return;
+ }
+
for (i = 0; i < ACTION_STRING_COUNT; i++)
{
freez(src->string[i]);
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]);
{
/* append multi string. */
- struct list * remove = cur_action->multi_remove[action->index];
- struct list * add = cur_action->multi_add[action->index];
+ struct list * remove_p = cur_action->multi_remove[action->index];
+ struct list * add_p = cur_action->multi_add[action->index];
if ((value == NULL) || (*value == '\0'))
{
return JB_ERR_PARSE;
}
- list_remove_item(remove, value);
- err = enlist_unique(add, value, 0);
+ list_remove_item(remove_p, value);
+ err = enlist_unique(add_p, value, 0);
if (err)
{
return err;
{
/* remove multi string. */
- struct list * remove = cur_action->multi_remove[action->index];
- struct list * add = cur_action->multi_add[action->index];
+ struct list * remove_p = cur_action->multi_remove[action->index];
+ struct list * add_p = cur_action->multi_add[action->index];
if ( (value == NULL) || (*value == '\0')
|| ((*value == '*') && (value[1] == '\0')) )
*
* Remove *ALL*.
*/
- list_remove_all(remove);
- list_remove_all(add);
+ list_remove_all(remove_p);
+ list_remove_all(add_p);
cur_action->multi_remove_all[action->index] = 1;
}
else
if ( !cur_action->multi_remove_all[action->index] )
{
/* there isn't a catch-all in the remove list already */
- err = enlist_unique(remove, value, 0);
+ err = enlist_unique(remove_p, value, 0);
if (err)
{
return err;
}
}
- list_remove_item(add, value);
+ list_remove_item(add_p, value);
}
break;
}
/* 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;
}
}
/*********************************************************************
*
- * Function : actions_to_text
+ * Function : init_current_action
*
- * Description : Converts a actionsfile entry from numeric form
- * ("mask" and "add") to text.
+ * Description : Zero out an action.
*
* Parameters :
- * 1 : mask = As from struct url_actions
- * 2 : add = As from struct url_actions
+ * 1 : dest = An uninitialized current_action_spec.
*
- * Returns : A string. Caller must free it.
- * NULL on out-of-memory error.
+ * Returns : N/A
*
*********************************************************************/
-char * actions_to_text(struct action_spec *action)
+void init_current_action (struct current_action_spec *dest)
{
- unsigned mask = action->mask;
- unsigned add = action->add;
- char * result = strdup("");
- struct list_entry * lst;
-
- /* sanity - prevents "-feature +feature" */
- mask |= add;
-
-
-#define DEFINE_ACTION_BOOL(__name, __bit) \
- if (!(mask & __bit)) \
- { \
- string_append(&result, " -" __name); \
- } \
- else if (add & __bit) \
- { \
- string_append(&result, " +" __name); \
- }
-
-#define DEFINE_ACTION_STRING(__name, __bit, __index) \
- if (!(mask & __bit)) \
- { \
- string_append(&result, " -" __name); \
- } \
- else if (add & __bit) \
- { \
- string_append(&result, " +" __name "{"); \
- string_append(&result, action->string[__index]); \
- string_append(&result, "}"); \
- }
-
-#define DEFINE_ACTION_MULTI(__name, __index) \
- if (action->multi_remove_all[__index]) \
- { \
- string_append(&result, " -" __name "{*}"); \
- } \
- else \
- { \
- lst = action->multi_remove[__index]->first; \
- while (lst) \
- { \
- string_append(&result, " -" __name "{"); \
- string_append(&result, lst->str); \
- string_append(&result, "}"); \
- lst = lst->next; \
- } \
- } \
- lst = action->multi_add[__index]->first; \
- while (lst) \
- { \
- string_append(&result, " +" __name "{"); \
- string_append(&result, lst->str); \
- string_append(&result, "}"); \
- lst = lst->next; \
- }
-
-#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
-
-#include "actionlist.h"
-
-#undef DEFINE_ACTION_MULTI
-#undef DEFINE_ACTION_STRING
-#undef DEFINE_ACTION_BOOL
-#undef DEFINE_ACTION_ALIAS
+ memset(dest, '\0', sizeof(*dest));
- return result;
+ dest->flags = ACTION_MOST_COMPATIBLE;
}
-#ifdef FEATURE_CGI_EDIT_ACTIONS
/*********************************************************************
*
- * Function : actions_to_html
+ * Function : init_action
*
- * Description : Converts a actionsfile entry from numeric form
- * ("mask" and "add") to a <br>-seperated HTML string.
+ * Description : Zero out an action.
*
* Parameters :
- * 1 : mask = As from struct url_actions
- * 2 : add = As from struct url_actions
+ * 1 : dest = An uninitialized action_spec.
*
- * Returns : A string. Caller must free it.
- * NULL on out-of-memory error.
+ * Returns : N/A
*
*********************************************************************/
-char * actions_to_html(struct action_spec *action)
+void init_action (struct action_spec *dest)
{
- unsigned mask = action->mask;
- unsigned add = action->add;
- char * result = strdup("");
- char * enc_str;
- struct list_entry * lst;
-
- /* sanity - prevents "-feature +feature" */
- mask |= add;
-
-
-#define DEFINE_ACTION_BOOL(__name, __bit) \
- if (!(mask & __bit)) \
- { \
- string_append(&result, "\n<br>-" __name); \
- } \
- else if (add & __bit) \
- { \
- string_append(&result, "\n<br>+" __name); \
- }
-
-#define DEFINE_ACTION_STRING(__name, __bit, __index) \
- if (!(mask & __bit)) \
- { \
- string_append(&result, "\n<br>-" __name); \
- } \
- else if (add & __bit) \
- { \
- string_append(&result, "\n<br>+" __name "{"); \
- if (NULL == result) \
- { \
- return NULL; \
- } \
- enc_str = html_encode(action->string[__index]);\
- if (NULL == enc_str) \
- { \
- free(result); \
- return NULL; \
- } \
- string_append(&result, enc_str); \
- free(enc_str); \
- string_append(&result, "}"); \
- }
-
-#define DEFINE_ACTION_MULTI(__name, __index) \
- if (action->multi_remove_all[__index]) \
- { \
- string_append(&result, "\n<br>-" __name "{*}"); \
- } \
- else \
- { \
- lst = action->multi_remove[__index]->first; \
- while (lst) \
- { \
- string_append(&result, "\n<br>-" __name "{");\
- if (NULL == result) \
- { \
- return NULL; \
- } \
- enc_str = html_encode(lst->str); \
- if (NULL == enc_str) \
- { \
- free(result); \
- return NULL; \
- } \
- string_append(&result, enc_str); \
- free(enc_str); \
- string_append(&result, "}"); \
- lst = lst->next; \
- } \
- } \
- lst = action->multi_add[__index]->first; \
- while (lst) \
- { \
- string_append(&result, "\n<br>+" __name "{"); \
- if (NULL == result) \
- { \
- return NULL; \
- } \
- enc_str = html_encode(lst->str); \
- if (NULL == enc_str) \
- { \
- free(result); \
- return NULL; \
- } \
- string_append(&result, enc_str); \
- free(enc_str); \
- string_append(&result, "}"); \
- lst = lst->next; \
- }
-
-#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
-
-#include "actionlist.h"
-
-#undef DEFINE_ACTION_MULTI
-#undef DEFINE_ACTION_STRING
-#undef DEFINE_ACTION_BOOL
-#undef DEFINE_ACTION_ALIAS
-
- /* trim leading <br> */
- if (result && *result)
- {
- char * s = result;
- result = strdup(result + 5);
- free(s);
- }
-
- return result;
+ memset(dest, '\0', sizeof(*dest));
}
-#endif /* def FEATURE_CGI_EDIT_ACTIONS */
/*********************************************************************
*
- * Function : current_actions_to_text
+ * Function : merge_current_action
*
- * Description : Converts a actionsfile entry to text.
+ * Description : Merge two actions together.
+ * Similar to "dest += src".
+ * Differences between this and merge_actions()
+ * is that this one doesn't allocate memory for
+ * strings (so "src" better be in memory for at least
+ * as long as "dest" is, and you'd better free
+ * "dest" using "free_current_action").
+ * Also, there is no mask or remove lists in dest.
+ * (If we're applying it to a URL, we don't need them)
*
* Parameters :
- * 1 : action = Action
+ * 1 : dest = Current actions, to modify.
+ * 2 : src = Action to add.
*
- * Returns : A string. Caller must free it.
- * NULL on out-of-memory error.
+ * Returns 0 : no error
+ * !=0 : error, probably JB_ERR_MEMORY.
*
*********************************************************************/
-char * current_action_to_text(struct current_action_spec *action)
+jb_err merge_current_action (struct current_action_spec *dest,
+ const struct action_spec *src)
{
- unsigned flags = action->flags;
- char * result = strdup("");
- struct list_entry * lst;
+ int i;
+ jb_err err = JB_ERR_OK;
-#define DEFINE_ACTION_BOOL(__name, __bit) \
- if (flags & __bit) \
- { \
- string_append(&result, " +" __name); \
- } \
- else \
- { \
- string_append(&result, " -" __name); \
- }
+ dest->flags &= src->mask;
+ dest->flags |= src->add;
-#define DEFINE_ACTION_STRING(__name, __bit, __index) \
- if (flags & __bit) \
- { \
- string_append(&result, " +" __name "{"); \
- string_append(&result, action->string[__index]); \
- string_append(&result, "}"); \
- } \
- else \
- { \
- string_append(&result, " -" __name); \
+ for (i = 0; i < ACTION_STRING_COUNT; i++)
+ {
+ char * str = src->string[i];
+ if (str)
+ {
+ str = strdup(str);
+ if (!str)
+ {
+ return JB_ERR_MEMORY;
+ }
+ freez(dest->string[i]);
+ dest->string[i] = str;
+ }
}
-#define DEFINE_ACTION_MULTI(__name, __index) \
- lst = action->multi[__index]->first; \
- if (lst == NULL) \
- { \
- string_append(&result, " -" __name); \
- } \
- else \
- { \
- while (lst) \
- { \
- string_append(&result, " +" __name "{"); \
- string_append(&result, lst->str); \
- string_append(&result, "}"); \
- lst = lst->next; \
- } \
+ for (i = 0; i < ACTION_MULTI_COUNT; i++)
+ {
+ if (src->multi_remove_all[i])
+ {
+ /* Remove everything from dest, then add src->multi_add */
+ err = list_duplicate(dest->multi[i], src->multi_add[i]);
+ if (err)
+ {
+ return err;
+ }
+ }
+ else
+ {
+ list_remove_list(dest->multi[i], src->multi_remove[i]);
+ err = list_append_list_unique(dest->multi[i], src->multi_add[i]);
+ if (err)
+ {
+ return err;
+ }
+ }
}
-
-#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
-
-#include "actionlist.h"
-
-#undef DEFINE_ACTION_MULTI
-#undef DEFINE_ACTION_STRING
-#undef DEFINE_ACTION_BOOL
-#undef DEFINE_ACTION_ALIAS
-
- return result;
+ return err;
}
-
+#if 0
/*********************************************************************
*
- * Function : init_current_action
+ * Function : update_action_bits_for_all_tags
*
- * Description : Zero out an action.
+ * Description : Updates the action bits based on all matching tags.
*
* Parameters :
- * 1 : dest = An uninitialized current_action_spec.
+ * 1 : csp = Current client state (buffers, headers, etc...)
*
- * Returns : N/A
+ * Returns : 0 if no tag matched, or
+ * 1 otherwise
*
*********************************************************************/
-void init_current_action (struct current_action_spec *dest)
+int update_action_bits_for_all_tags(struct client_state *csp)
{
- memset(dest, '\0', sizeof(*dest));
-
- dest->flags = ACTION_MOST_COMPATIBLE;
-}
+ 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;
+ }
+ }
-/*********************************************************************
- *
- * Function : init_action
- *
- * Description : Zero out an action.
- *
- * Parameters :
- * 1 : dest = An uninitialized action_spec.
- *
- * Returns : N/A
- *
- *********************************************************************/
-void init_action (struct action_spec *dest)
-{
- memset(dest, '\0', sizeof(*dest));
+ return updated;
}
-
+#endif
/*********************************************************************
*
- * Function : merge_current_action
+ * Function : update_action_bits_for_tag
*
- * Description : Merge two actions together.
- * Similar to "dest += src".
- * Differences between this and merge_actions()
- * is that this one doesn't allocate memory for
- * strings (so "src" better be in memory for at least
- * as long as "dest" is, and you'd better free
- * "dest" using "free_current_action").
- * Also, there is no mask or remove lists in dest.
- * (If we're applying it to a URL, we don't need them)
+ * Description : Updates the action bits based on the action sections
+ * whose tag patterns match a provided tag.
*
* Parameters :
- * 1 : dest = Current actions, to modify.
- * 2 : src = Action to add.
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : tag = The tag on which the update should be based on
*
- * Returns 0 : no error
- * !=0 : error
+ * Returns : 0 if no tag matched, or
+ * 1 otherwise
*
*********************************************************************/
-jb_err merge_current_action (struct current_action_spec *dest,
- const struct action_spec *src)
+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;
- jb_err err = JB_ERR_OK;
- dest->flags &= src->mask;
- dest->flags |= src->add;
+ assert(tag);
+ assert(list_contains_item(csp->tags, tag));
- for (i = 0; i < ACTION_STRING_COUNT; i++)
+ /* Run through all action files, */
+ for (i = 0; i < MAX_AF_FILES; i++)
{
- char * str = src->string[i];
- if (str)
+ if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
{
- str = strdup(str);
- if (!str)
- {
- return JB_ERR_MEMORY;
- }
- freez(dest->string[i]);
- dest->string[i] = str;
+ /* Skip empty files */
+ continue;
}
- }
- for (i = 0; i < ACTION_MULTI_COUNT; i++)
- {
- if (src->multi_remove_all[i])
+ /* and through all the action patterns, */
+ for (b = b->next; NULL != b; b = b->next)
{
- /* Remove everything from dest, then add src->multi_add */
- err = list_duplicate(dest->multi[i], src->multi_add[i]);
- if (err)
+ /* skip the URL patterns, */
+ if (NULL == b->url->tag_regex)
{
- return err;
+ continue;
}
- }
- else
- {
- list_remove_list(dest->multi[i], src->multi_remove[i]);
- err = list_append_list_unique(dest->multi[i], src->multi_add[i]);
- if (err)
+
+ /* and check if one of the tag patterns matches the tag, */
+ if (0 == regexec(b->url->tag_regex, tag, 0, NULL, 0))
{
- return err;
+ /* 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 err;
+
+ 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_AF_FILES] = {
+ NULL, NULL, NULL, NULL, NULL,
+ NULL, NULL, NULL, NULL, NULL
+};
+
+
+#ifdef FEATURE_GRACEFUL_TERMINATION
+/*********************************************************************
+ *
+ * Function : unload_current_actions_file
+ *
+ * Description : Unloads current actions file - reset to state at
+ * beginning of program.
+ *
+ * Parameters : None
+ *
+ * Returns : N/A
+ *
+ *********************************************************************/
+void unload_current_actions_file(void)
+{
+ int i;
+
+ for (i = 0; i < MAX_AF_FILES; i++)
+ {
+ if (current_actions_file[i])
+ {
+ current_actions_file[i]->unloader = unload_actions_file;
+ current_actions_file[i] = NULL;
+ }
+ }
+}
+#endif /* FEATURE_GRACEFUL_TERMINATION */
+
+
/*********************************************************************
*
* Function : unload_actions_file
while (cur != NULL)
{
next = cur->next;
- free_url(cur->url);
- free_action(cur->action);
+ free_url_spec(cur->url);
+ 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.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ *
+ * Returns : 0 => Ok, everything else is an error.
+ *
+ *********************************************************************/
+int load_action_files(struct client_state *csp)
+{
+ int i;
+ int result;
+
+ for (i = 0; i < MAX_AF_FILES; i++)
+ {
+ if (csp->config->actions_file[i])
+ {
+ result = load_one_actions_file(csp, i);
+ if (result)
+ {
+ return result;
+ }
+ }
+ else if (current_actions_file[i])
+ {
+ current_actions_file[i]->unloader = unload_actions_file;
+ current_actions_file[i] = NULL;
+ }
+ }
+
+ return 0;
+}
+
+/*********************************************************************
+ *
+ * Function : load_one_actions_file
*
* Description : Read and parse a action file and add to files
* list.
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : fileid = File index to load.
*
* Returns : 0 => Ok, everything else is an error.
*
*********************************************************************/
-int load_actions_file(struct client_state *csp)
+static int load_one_actions_file(struct client_state *csp, int fileid)
{
- static struct file_list *current_actions_file = NULL;
/*
* Parser mode.
struct action_alias * alias_list = NULL;
unsigned long linenum = 0;
- if (!check_file_changed(current_actions_file, csp->config->actions_file, &fs))
+ if (!check_file_changed(current_actions_file[fileid], csp->config->actions_file[fileid], &fs))
{
/* No need to load */
- if (csp)
- {
- csp->actions_list = current_actions_file;
- }
+ csp->actions_list[fileid] = current_actions_file[fileid];
return 0;
}
if (!fs)
{
- log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error finding file: %E",
- csp->config->actions_file);
+ 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 (last_perm == NULL)
{
log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': out of memory!",
- csp->config->actions_file);
+ csp->config->actions_file[fileid]);
return 1; /* never get here */
}
- if ((fp = fopen(csp->config->actions_file, "r")) == NULL)
+ if ((fp = fopen(csp->config->actions_file[fileid], "r")) == NULL)
{
log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error opening file: %E",
- csp->config->actions_file);
+ 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);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': invalid line (%lu): %s",
- csp->config->actions_file, linenum, buf);
+ csp->config->actions_file[fileid], linenum, buf);
return 1; /* never get here */
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': invalid line (%lu): {{ }}",
- csp->config->actions_file, linenum);
+ csp->config->actions_file[fileid], linenum);
return 1; /* never get here */
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': line %lu: {{settings}} must only appear once, and it must be before anything else.",
- csp->config->actions_file, linenum);
+ csp->config->actions_file[fileid], linenum);
}
mode = MODE_SETTINGS;
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': line %lu: {{description}} must only appear once, and only a {{settings}} block may be above it.",
- csp->config->actions_file, linenum);
+ csp->config->actions_file[fileid], linenum);
}
mode = MODE_DESCRIPTION;
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': line %lu: {{alias}} must only appear once, and it must be before all actions.",
- csp->config->actions_file, linenum);
+ csp->config->actions_file[fileid], linenum);
}
mode = MODE_ALIAS;
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': invalid line (%lu): {{%s}}",
- csp->config->actions_file, linenum, start);
+ csp->config->actions_file[fileid], linenum, start);
return 1; /* never get here */
}
}
{
if (!cur_action_used)
{
- free_action(cur_action);
- free(cur_action);
+ free_action_spec(cur_action);
}
cur_action = NULL;
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': out of memory",
- csp->config->actions_file);
+ csp->config->actions_file[fileid]);
return 1; /* never get here */
}
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;
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': invalid line (%lu): %s",
- csp->config->actions_file, linenum, buf);
+ csp->config->actions_file[fileid], linenum, buf);
return 1; /* never get here */
}
*end = '\0';
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': invalid line (%lu): %s",
- csp->config->actions_file, linenum, buf);
+ csp->config->actions_file[fileid], linenum, buf);
return 1; /* never get here */
}
}
{
/*
* 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)
{
{
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': invalid alias line (%lu): %s",
- csp->config->actions_file, linenum, buf);
+ csp->config->actions_file[fileid], linenum, buf);
return 1; /* never get here */
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': out of memory!",
- csp->config->actions_file);
+ csp->config->actions_file[fileid]);
return 1; /* never get here */
}
{
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': invalid alias line (%lu): %s",
- csp->config->actions_file, linenum, buf);
+ csp->config->actions_file[fileid], linenum, buf);
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))
{
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': invalid alias line (%lu): %s = %s",
- csp->config->actions_file, linenum, buf, start);
+ csp->config->actions_file[fileid], linenum, buf, start);
return 1; /* never get here */
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': out of memory!",
- csp->config->actions_file);
+ csp->config->actions_file[fileid]);
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);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': line %lu: cannot create URL pattern from: %s",
- csp->config->actions_file, linenum, buf);
+ csp->config->actions_file[fileid], linenum, buf);
return 1; /* never get here */
}
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': first needed line (%lu) is invalid: %s",
- csp->config->actions_file, linenum, buf);
+ csp->config->actions_file[fileid], linenum, buf);
return 1; /* never get here */
}
else
fclose(fp);
log_error(LOG_LEVEL_FATAL,
"can't load actions file '%s': INTERNAL ERROR - mode = %d",
- csp->config->actions_file, mode);
+ csp->config->actions_file[fileid], mode);
return 1; /* never get here */
}
}
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 */
- if (current_actions_file)
+ if (current_actions_file[fileid])
{
- current_actions_file->unloader = unload_actions_file;
+ current_actions_file[fileid]->unloader = unload_actions_file;
}
fs->next = files->next;
files->next = fs;
- current_actions_file = fs;
+ current_actions_file[fileid] = fs;
- if (csp)
+ csp->actions_list[fileid] = fs;
+
+ return(0);
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : actions_to_text
+ *
+ * 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 : action = The action to format.
+ *
+ * Returns : A string. Caller must free it.
+ * NULL on out-of-memory error.
+ *
+ *********************************************************************/
+char * actions_to_text(const struct action_spec *action)
+{
+ unsigned long mask = action->mask;
+ unsigned long add = action->add;
+ char *result = strdup("");
+ struct list_entry * lst;
+
+ /* sanity - prevents "-feature +feature" */
+ mask |= add;
+
+
+#define DEFINE_ACTION_BOOL(__name, __bit) \
+ if (!(mask & __bit)) \
+ { \
+ string_append(&result, " -" __name " \\\n"); \
+ } \
+ else if (add & __bit) \
+ { \
+ string_append(&result, " +" __name " \\\n"); \
+ }
+
+#define DEFINE_ACTION_STRING(__name, __bit, __index) \
+ if (!(mask & __bit)) \
+ { \
+ string_append(&result, " -" __name " \\\n"); \
+ } \
+ else if (add & __bit) \
+ { \
+ string_append(&result, " +" __name "{"); \
+ string_append(&result, action->string[__index]); \
+ string_append(&result, "} \\\n"); \
+ }
+
+#define DEFINE_ACTION_MULTI(__name, __index) \
+ if (action->multi_remove_all[__index]) \
+ { \
+ string_append(&result, " -" __name " \\\n"); \
+ } \
+ else \
+ { \
+ lst = action->multi_remove[__index]->first; \
+ while (lst) \
+ { \
+ string_append(&result, " -" __name "{"); \
+ string_append(&result, lst->str); \
+ string_append(&result, "} \\\n"); \
+ lst = lst->next; \
+ } \
+ } \
+ lst = action->multi_add[__index]->first; \
+ while (lst) \
+ { \
+ string_append(&result, " +" __name "{"); \
+ string_append(&result, lst->str); \
+ string_append(&result, "} \\\n"); \
+ lst = lst->next; \
+ }
+
+#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
+
+#include "actionlist.h"
+
+#undef DEFINE_ACTION_MULTI
+#undef DEFINE_ACTION_STRING
+#undef DEFINE_ACTION_BOOL
+#undef DEFINE_ACTION_ALIAS
+
+ return result;
+}
+
+
+/*********************************************************************
+ *
+ * Function : actions_to_html
+ *
+ * Description : Converts a actionsfile entry from numeric form
+ * ("mask" and "add") to a <br>-seperated HTML string
+ * in which each action is linked to its chapter in
+ * the user manual.
+ *
+ * Parameters :
+ * 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(const struct client_state *csp,
+ const struct action_spec *action)
+{
+ unsigned long mask = action->mask;
+ unsigned long add = action->add;
+ char *result = strdup("");
+ struct list_entry * lst;
+
+ /* sanity - prevents "-feature +feature" */
+ mask |= add;
+
+
+#define DEFINE_ACTION_BOOL(__name, __bit) \
+ if (!(mask & __bit)) \
+ { \
+ string_append(&result, "\n<br>-"); \
+ string_join(&result, add_help_link(__name, csp->config)); \
+ } \
+ else if (add & __bit) \
+ { \
+ string_append(&result, "\n<br>+"); \
+ string_join(&result, add_help_link(__name, csp->config)); \
+ }
+
+#define DEFINE_ACTION_STRING(__name, __bit, __index) \
+ if (!(mask & __bit)) \
+ { \
+ string_append(&result, "\n<br>-"); \
+ string_join(&result, add_help_link(__name, csp->config)); \
+ } \
+ else if (add & __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, "}"); \
+ }
+
+#define DEFINE_ACTION_MULTI(__name, __index) \
+ if (action->multi_remove_all[__index]) \
+ { \
+ string_append(&result, "\n<br>-"); \
+ string_join(&result, add_help_link(__name, csp->config)); \
+ } \
+ else \
+ { \
+ lst = action->multi_remove[__index]->first; \
+ 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, "}"); \
+ lst = lst->next; \
+ } \
+ } \
+ lst = action->multi_add[__index]->first; \
+ 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, "}"); \
+ lst = lst->next; \
+ }
+
+#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
+
+#include "actionlist.h"
+
+#undef DEFINE_ACTION_MULTI
+#undef DEFINE_ACTION_STRING
+#undef DEFINE_ACTION_BOOL
+#undef DEFINE_ACTION_ALIAS
+
+ /* trim leading <br> */
+ if (result && *result)
{
- csp->actions_list = fs;
+ char * s = result;
+ result = strdup(result + 5);
+ free(s);
}
- return(0);
+ return result;
+}
+
+
+/*********************************************************************
+ *
+ * Function : current_actions_to_html
+ *
+ * Description : Converts a curren action spec to a <br> seperated HTML
+ * text in which each action is linked to its chapter in
+ * the user manual.
+ *
+ * Parameters :
+ * 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(const struct client_state *csp,
+ const struct current_action_spec *action)
+{
+ unsigned long flags = action->flags;
+ struct list_entry * lst;
+ char *result = strdup("");
+ char *active = strdup("");
+ char *inactive = strdup("");
+
+#define DEFINE_ACTION_BOOL(__name, __bit) \
+ if (flags & __bit) \
+ { \
+ string_append(&active, "\n<br>+"); \
+ string_join(&active, add_help_link(__name, csp->config)); \
+ } \
+ else \
+ { \
+ 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(&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(&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(&inactive, "\n<br>-"); \
+ string_join(&inactive, add_help_link(__name, csp->config)); \
+ } \
+ else \
+ { \
+ while (lst) \
+ { \
+ 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; \
+ } \
+ }
+
+#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
+#include "actionlist.h"
+
+#undef DEFINE_ACTION_MULTI
+#undef DEFINE_ACTION_STRING
+#undef DEFINE_ACTION_BOOL
+#undef DEFINE_ACTION_ALIAS
+
+ 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;
}