X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=actions.c;h=d9282cb4f125949dfa9581c37654141ae13085e0;hp=e58b6a85678479de9f9895d005c9c9de2a35ac32;hb=5d6f5f5cec8002999594c3276fc034e23809e604;hpb=1251e702bce39f773f2213aa419d0254cb0a4a2e
diff --git a/actions.c b/actions.c
index e58b6a85..d9282cb4 100644
--- a/actions.c
+++ b/actions.c
@@ -1,4 +1,4 @@
-const char actions_rcs[] = "$Id: actions.c,v 1.22 2002/01/21 00:27:02 jongfoster Exp $";
+const char actions_rcs[] = "$Id: actions.c,v 1.51 2008/04/27 16:20:19 fabiankeil Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/actions.c,v $
@@ -6,8 +6,8 @@ const char actions_rcs[] = "$Id: actions.c,v 1.22 2002/01/21 00:27:02 jongfoster
* 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
@@ -33,6 +33,145 @@ const char actions_rcs[] = "$Id: actions.c,v 1.22 2002/01/21 00:27:02 jongfoster
*
* Revisions :
* $Log: actions.c,v $
+ * Revision 1.51 2008/04/27 16:20:19 fabiankeil
+ * Complain about every block action without reason found.
+ *
+ * Revision 1.50 2008/03/30 14:52:00 fabiankeil
+ * Rename load_actions_file() and load_re_filterfile()
+ * as they load multiple files "now".
+ *
+ * Revision 1.49 2008/03/29 12:13:45 fabiankeil
+ * Remove send-wafer and send-vanilla-wafer actions.
+ *
+ * Revision 1.48 2008/03/28 18:17:14 fabiankeil
+ * In action_used_to_be_valid(), loop through an array of formerly
+ * valid actions instead of using an OR-chain of strcmpic() calls.
+ *
+ * Revision 1.47 2008/03/28 15:13:37 fabiankeil
+ * Remove inspect-jpegs action.
+ *
+ * Revision 1.46 2008/03/27 18:27:20 fabiankeil
+ * Remove kill-popups action.
+ *
+ * Revision 1.45 2008/03/24 11:21:02 fabiankeil
+ * Share the action settings for multiple patterns in the same
+ * section so we waste less memory for gigantic block lists
+ * (and load them slightly faster). Reported by Franz Schwartau.
+ *
+ * Revision 1.44 2008/03/04 18:30:34 fabiankeil
+ * Remove the treat-forbidden-connects-like-blocks action. We now
+ * use the "blocked" page for forbidden CONNECT requests by default.
+ *
+ * Revision 1.43 2008/03/01 14:00:43 fabiankeil
+ * Let the block action take the reason for the block
+ * as argument and show it on the "blocked" page.
+ *
+ * Revision 1.42 2008/02/09 15:15:38 fabiankeil
+ * List active and inactive actions in the show-url-info's
+ * "Final results" section separately. Patch submitted by Lee
+ * in #1830056, modified to list active actions first.
+ *
+ * Revision 1.41 2008/01/28 20:17:40 fabiankeil
+ * - Mark some parameters as immutable.
+ * - Hide update_action_bits_for_all_tags() while it's unused.
+ *
+ * Revision 1.40 2007/05/21 10:26:50 fabiankeil
+ * - Use strlcpy() instead of strcpy().
+ * - Provide a reason why loading the actions
+ * file might have failed.
+ *
+ * Revision 1.39 2007/04/17 18:21:45 fabiankeil
+ * Split update_action_bits() into
+ * update_action_bits_for_all_tags()
+ * and update_action_bits_for_tag().
+ *
+ * Revision 1.38 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.37 2007/03/11 15:56:12 fabiankeil
+ * Add kludge to log unknown aliases and actions before exiting.
+ *
+ * Revision 1.36 2006/12/28 17:15:42 fabiankeil
+ * Fix gcc43 conversion warning.
+ *
+ * Revision 1.35 2006/07/18 14:48:45 david__schmidt
+ * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
+ * with what was really the latest development (the v_3_0_branch branch)
+ *
+ * Revision 1.32.2.6 2006/01/29 23:10:56 david__schmidt
+ * Multiple filter file support
+ *
+ * Revision 1.32.2.5 2005/06/09 01:18:41 david__schmidt
+ * Tweaks to conditionally include pthread.h if FEATURE_PTHREAD is enabled -
+ * this becomes important when jcc.h gets included later down the line.
+ *
+ * Revision 1.32.2.4 2003/12/03 10:33:11 oes
+ * - Implemented Privoxy version requirement through
+ * for-privoxy-version= statement in {{settings}}
+ * block
+ * - Fix for unchecked out-of-memory condition
+ *
+ * Revision 1.32.2.3 2003/02/28 12:52:10 oes
+ * Fixed memory leak reported by Dan Price in Bug #694713
+ *
+ * Revision 1.32.2.2 2002/11/20 14:36:55 oes
+ * Extended unload_current_actions_file() to multiple AFs.
+ * Thanks to Oliver Stoeneberg for the hint.
+ *
+ * Revision 1.32.2.1 2002/05/26 12:13:16 roro
+ * Change unsigned to unsigned long in actions_name struct. This closes
+ * SourceForge Bug #539284.
+ *
+ * Revision 1.32 2002/05/12 21:36:29 jongfoster
+ * Correcting function comments
+ *
+ * Revision 1.31 2002/05/06 07:56:50 oes
+ * Made actions_to_html independent of FEATURE_CGI_EDIT_ACTIONS
+ *
+ * Revision 1.30 2002/04/30 11:14:52 oes
+ * Made csp the first parameter in *action_to_html
+ *
+ * Revision 1.29 2002/04/26 19:30:54 jongfoster
+ * - current_action_to_html(): Adding help link for the "-" form of
+ * one-string actions.
+ * - Some actions had "
-", some "
-" (note the space).
+ * Standardizing on no space.
+ * - Greatly simplifying some of the code by using string_join()
+ * where appropriate.
+ *
+ * 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,
@@ -136,6 +275,10 @@ const char actions_rcs[] = "$Id: actions.c,v 1.22 2002/01/21 00:27:02 jongfoster
#include
#include
+#ifdef FEATURE_PTHREAD
+#include
+#endif
+
#include "project.h"
#include "jcc.h"
#include "list.h"
@@ -143,10 +286,10 @@ const char actions_rcs[] = "$Id: actions.c,v 1.22 2002/01/21 00:27:02 jongfoster
#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;
@@ -174,10 +317,10 @@ 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[] */
};
/*
@@ -213,16 +356,19 @@ static const struct action_name action_names[] =
};
+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
*
@@ -293,9 +439,7 @@ jb_err merge_actions (struct action_spec *dest,
* 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.
@@ -310,6 +454,7 @@ jb_err copy_action (struct action_spec *dest,
int i;
jb_err err = JB_ERR_OK;
+ free_action(dest);
memset(dest, '\0', sizeof(*dest));
dest->mask = src->mask;
@@ -346,6 +491,24 @@ jb_err copy_action (struct action_spec *dest,
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);
+}
+
/*********************************************************************
*
@@ -490,6 +653,42 @@ jb_err get_action_token(char **line, char **name, char **value)
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"
+ };
+ int i;
+
+ for (i = 0; i < SZ(formerly_valid_actions); i++)
+ {
+ if (0 == strcmpic(action, formerly_valid_actions[i]))
+ {
+ return TRUE;
+ }
+ }
+
+ return FALSE;
+}
/*********************************************************************
*
@@ -500,7 +699,7 @@ jb_err get_action_token(char **line, char **name, char **value)
* 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.
*
@@ -557,7 +756,21 @@ jb_err get_actions(char *line,
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]);
@@ -651,9 +864,24 @@ jb_err get_actions(char *line,
/* Found it */
merge_actions(cur_action, alias->action);
}
+ else if ((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
{
/* 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;
}
}
@@ -772,6 +1000,99 @@ jb_err merge_current_action (struct current_action_spec *dest,
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 memorey while changing action bits");
+ }
+ /* and signal the change. */
+ updated = 1;
+ }
+ }
+ }
+
+ return updated;
+}
+
/*********************************************************************
*
@@ -804,6 +1125,41 @@ void free_current_action (struct current_action_spec *src)
}
+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
@@ -825,11 +1181,19 @@ void unload_actions_file(void *file_data)
{
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;
}
-
}
@@ -861,20 +1225,58 @@ void free_alias_list(struct action_alias *alias_list)
/*********************************************************************
*
- * 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.
@@ -899,19 +1301,17 @@ int load_actions_file(struct client_state *csp)
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 */
}
@@ -919,14 +1319,14 @@ int load_actions_file(struct client_state *csp)
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 */
}
@@ -938,7 +1338,7 @@ int load_actions_file(struct client_state *csp)
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-- != '}'))
@@ -947,7 +1347,7 @@ int load_actions_file(struct client_state *csp)
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 */
}
@@ -961,7 +1361,7 @@ int load_actions_file(struct client_state *csp)
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 */
}
@@ -993,7 +1393,7 @@ int load_actions_file(struct client_state *csp)
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;
}
@@ -1007,7 +1407,7 @@ int load_actions_file(struct client_state *csp)
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;
}
@@ -1029,7 +1429,7 @@ int load_actions_file(struct client_state *csp)
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;
}
@@ -1039,7 +1439,7 @@ int load_actions_file(struct client_state *csp)
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 */
}
}
@@ -1058,8 +1458,7 @@ int load_actions_file(struct client_state *csp)
{
if (!cur_action_used)
{
- free_action(cur_action);
- free(cur_action);
+ free_action_spec(cur_action);
}
cur_action = NULL;
}
@@ -1070,13 +1469,13 @@ int load_actions_file(struct client_state *csp)
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;
@@ -1086,7 +1485,7 @@ int load_actions_file(struct client_state *csp)
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';
@@ -1100,7 +1499,7 @@ int load_actions_file(struct client_state *csp)
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 */
}
}
@@ -1109,9 +1508,44 @@ int load_actions_file(struct client_state *csp)
{
/*
* 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)
{
@@ -1135,7 +1569,7 @@ int load_actions_file(struct client_state *csp)
{
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 */
}
@@ -1144,7 +1578,7 @@ int load_actions_file(struct client_state *csp)
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 */
}
@@ -1170,13 +1604,20 @@ int load_actions_file(struct client_state *csp)
{
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))
{
@@ -1184,7 +1625,7 @@ int load_actions_file(struct client_state *csp)
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 */
}
@@ -1202,12 +1643,12 @@ int load_actions_file(struct client_state *csp)
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))
@@ -1215,7 +1656,7 @@ int load_actions_file(struct client_state *csp)
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 */
}
@@ -1229,7 +1670,7 @@ int load_actions_file(struct client_state *csp)
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
@@ -1238,31 +1679,30 @@ int load_actions_file(struct client_state *csp)
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 = fs;
- }
+ csp->actions_list[fileid] = fs;
return(0);
@@ -1273,18 +1713,18 @@ int load_actions_file(struct client_state *csp)
*
* Function : actions_to_text
*
- * Description : Converts a actionsfile entry from numeric form
- * ("mask" and "add") 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 : 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;
@@ -1295,32 +1735,32 @@ char * actions_to_text(struct action_spec *action)
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_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); \
+ string_append(&result, " -" __name " \\\n"); \
} \
else if (add & __bit) \
{ \
string_append(&result, " +" __name "{"); \
string_append(&result, action->string[__index]); \
- string_append(&result, "}"); \
+ string_append(&result, "} \\\n"); \
}
#define DEFINE_ACTION_MULTI(__name, __index) \
if (action->multi_remove_all[__index]) \
{ \
- string_append(&result, " -" __name); \
+ string_append(&result, " -" __name " \\\n"); \
} \
else \
{ \
@@ -1329,7 +1769,7 @@ char * actions_to_text(struct action_spec *action)
{ \
string_append(&result, " -" __name "{"); \
string_append(&result, lst->str); \
- string_append(&result, "}"); \
+ string_append(&result, "} \\\n"); \
lst = lst->next; \
} \
} \
@@ -1338,7 +1778,7 @@ char * actions_to_text(struct action_spec *action)
{ \
string_append(&result, " +" __name "{"); \
string_append(&result, lst->str); \
- string_append(&result, "}"); \
+ string_append(&result, "} \\\n"); \
lst = lst->next; \
}
@@ -1355,28 +1795,29 @@ char * actions_to_text(struct action_spec *action)
}
-#ifdef FEATURE_CGI_EDIT_ACTIONS
/*********************************************************************
*
* Function : actions_to_html
*
* Description : Converts a actionsfile entry from numeric form
- * ("mask" and "add") to a
-seperated HTML string.
+ * ("mask" and "add") to a
-seperated HTML string
+ * in which each action is linked to its chapter in
+ * 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)
+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("");
- char * enc_str;
struct list_entry * lst;
/* sanity - prevents "-feature +feature" */
@@ -1386,59 +1827,45 @@ char * actions_to_html(struct action_spec *action)
#define DEFINE_ACTION_BOOL(__name, __bit) \
if (!(mask & __bit)) \
{ \
- string_append(&result, "\n
-" __name); \
+ string_append(&result, "\n
-"); \
+ string_join(&result, add_help_link(__name, csp->config)); \
} \
else if (add & __bit) \
{ \
- string_append(&result, "\n
+" __name); \
+ string_append(&result, "\n
+"); \
+ string_join(&result, add_help_link(__name, csp->config)); \
}
#define DEFINE_ACTION_STRING(__name, __bit, __index) \
if (!(mask & __bit)) \
{ \
- string_append(&result, "\n
-" __name); \
+ string_append(&result, "\n
-"); \
+ string_join(&result, add_help_link(__name, csp->config)); \
} \
else if (add & __bit) \
{ \
- string_append(&result, "\n
+" __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, "\n
+"); \
+ 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
-" __name); \
+ string_append(&result, "\n
-"); \
+ string_join(&result, add_help_link(__name, csp->config)); \
} \
else \
{ \
lst = action->multi_remove[__index]->first; \
while (lst) \
{ \
- string_append(&result, "\n
-" __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, "\n
-"); \
+ 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; \
} \
@@ -1446,19 +1873,10 @@ char * actions_to_html(struct action_spec *action)
lst = action->multi_add[__index]->first; \
while (lst) \
{ \
- string_append(&result, "\n
+" __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, "\n
+"); \
+ 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; \
}
@@ -1482,63 +1900,76 @@ char * actions_to_html(struct action_spec *action)
return result;
}
-#endif /* def FEATURE_CGI_EDIT_ACTIONS */
/*********************************************************************
*
- * Function : current_actions_to_text
+ * Function : current_actions_to_html
*
- * Description : Converts a actionsfile entry to text.
+ * Description : Converts a curren action spec to a
seperated HTML
+ * text in which each action is linked to its chapter in
+ * 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_text(struct current_action_spec *action)
+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, " +" __name); \
+ string_append(&active, "\n
+"); \
+ string_join(&active, add_help_link(__name, csp->config)); \
} \
else \
{ \
- string_append(&result, " -" __name); \
+ string_append(&inactive, "\n
-"); \
+ string_join(&inactive, add_help_link(__name, csp->config)); \
}
#define DEFINE_ACTION_STRING(__name, __bit, __index) \
if (flags & __bit) \
{ \
- string_append(&result, " +" __name "{"); \
- string_append(&result, action->string[__index]); \
- string_append(&result, "}"); \
+ string_append(&active, "\n
+"); \
+ 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, " -" __name); \
+ string_append(&inactive, "\n
-"); \
+ 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, " -" __name); \
+ string_append(&inactive, "\n
-"); \
+ string_join(&inactive, add_help_link(__name, csp->config)); \
} \
else \
{ \
while (lst) \
{ \
- string_append(&result, " +" __name "{"); \
- string_append(&result, lst->str); \
- string_append(&result, "}"); \
+ string_append(&active, "\n
+"); \
+ 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; \
} \
}
@@ -1552,5 +1983,16 @@ char * current_action_to_text(struct current_action_spec *action)
#undef DEFINE_ACTION_BOOL
#undef DEFINE_ACTION_ALIAS
+ if (active != NULL)
+ {
+ string_append(&result, active);
+ freez(active);
+ }
+ string_append(&result, "\n
");
+ if (inactive != NULL)
+ {
+ string_append(&result, inactive);
+ freez(inactive);
+ }
return result;
}