-const char actions_rcs[] = "$Id: actions.c,v 1.6 2001/06/07 23:04:34 jongfoster Exp $";
+const char actions_rcs[] = "$Id: actions.c,v 1.14 2001/09/22 16:36:59 jongfoster Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/actions.c,v $
*
* Revisions :
* $Log: actions.c,v $
- * 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.5 2001/06/03 11:03:48 oes
- * Makefile/in
- *
- * introduced cgi.c
- *
- * actions.c:
- *
- * adapted to new enlist_unique arg format
- *
- * conf loadcfg.c
- *
- * introduced confdir option
+ * Revision 1.14 2001/09/22 16:36:59 jongfoster
+ * Removing unused parameter fs from read_config_line()
*
- * filters.c filtrers.h
+ * 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.
*
- * extracted-CGI relevant stuff
+ * Revision 1.12 2001/09/16 13:21:27 jongfoster
+ * Changes to use new list functions.
*
- * jbsockets.c
+ * Revision 1.11 2001/09/14 00:17:32 jongfoster
+ * Tidying up memory allocation. New function init_action().
*
- * filled comment
+ * Revision 1.10 2001/09/10 10:14:34 oes
+ * Removing unused variable
*
- * jcc.c
+ * 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
*
- * support for new cgi mechansim
+ * Revision 1.8 2001/06/29 13:19:52 oes
+ * Removed logentry from cancelled commit
*
- * list.c list.h
+ * Revision 1.7 2001/06/09 10:55:28 jongfoster
+ * Changing BUFSIZ ==> BUFFER_SIZE
*
- * functions for new list type: "map"
- * extended enlist_unique
- *
- * miscutil.c .h
- * introduced bindup()
- *
- * parsers.c parsers.h
- *
- * deleted const struct interceptors
- *
- * pcrs.c
- * added FIXME
- *
- * project.h
- *
- * added struct map
- * added struct http_response
- * changes struct interceptors to struct cgi_dispatcher
- * moved HTML stuff to cgi.h
- *
- * re_filterfile:
- *
- * changed
+ * Revision 1.6 2001/06/07 23:04:34 jongfoster
+ * Made get_actions() static.
*
- * showargs.c
- * NO TIME LEFT
+ * 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
#include "miscutil.h"
#include "errlog.h"
#include "loaders.h"
+#ifdef FEATURE_CGI_EDIT_ACTIONS
+#include "encode.h"
+#endif /* def FEATURE_CGI_EDIT_ACTIONS */
const char actions_h_rcs[] = ACTIONS_H_VERSION;
-/* Turn off everything except forwarding */
-/* This structure is used to hold user-defined aliases */
-struct action_alias
-{
- const char * name;
- struct action_spec action[1];
- struct action_alias * next;
-};
-
-
-/*
- * Must declare this in this file for the above structure.
- */
-static int get_actions (char *line,
- struct action_alias * alias_list,
- struct action_spec *cur_action);
-
/*
* We need the main list of options.
*
if (src->multi_remove_all[i])
{
/* Remove everything from dest */
- destroy_list(dest->multi_remove[i]);
- destroy_list(dest->multi_add[i]);
+ list_remove_all(dest->multi_remove[i]);
dest->multi_remove_all[i] = 1;
+
list_duplicate(dest->multi_add[i], src->multi_add[i]);
}
else if (dest->multi_remove_all[i])
*
* Description : Copy an action_specs.
* Similar to "cur_action = new_action".
+ * Note that dest better not contain valid data
+ * - it's overwritten, not freed.
*
* Parameters :
* 1 : dest = Destination of copy.
{
int i;
+ memset(dest, '\0', sizeof(*dest));
+
dest->mask = src->mask;
dest->add = src->add;
*
* Function : free_action
*
- * Description : Free an action_specs.
+ * Description : Destroy an action_spec. Frees memory used by it,
+ * except for the memory used by the struct action_spec
+ * itself.
*
* Parameters :
* 1 : src = Source to free.
* nonzero => Error (line was trashed anyway)
*
*********************************************************************/
-static int get_actions(char *line,
- struct action_alias * alias_list,
- struct action_spec *cur_action)
+int get_actions(char *line,
+ struct action_alias * alias_list,
+ struct action_spec *cur_action)
{
- memset(cur_action, '\0', sizeof(*cur_action));
+ init_action(cur_action);
cur_action->mask = ACTION_MASK_ALL;
while (line)
*
* Remove *ALL*.
*/
- destroy_list(remove);
- destroy_list(add);
+ list_remove_all(remove);
+ list_remove_all(add);
cur_action->multi_remove_all[action->index] = 1;
}
else
unsigned mask = action->mask;
unsigned add = action->add;
char * result = strdup("");
- struct list * lst;
+ struct list_entry * lst;
/* sanity - prevents "-feature +feature" */
mask |= add;
} \
else \
{ \
- lst = action->multi_remove[__index]->next; \
+ lst = action->multi_remove[__index]->first; \
while (lst) \
{ \
result = strsav(result, " -" __name "{"); \
lst = lst->next; \
} \
} \
- lst = action->multi_add[__index]->next; \
+ lst = action->multi_add[__index]->first; \
while (lst) \
{ \
result = strsav(result, " +" __name "{"); \
}
+#ifdef FEATURE_CGI_EDIT_ACTIONS
+/*********************************************************************
+ *
+ * Function : actions_to_html
+ *
+ * Description : Converts a actionsfile entry from numeric form
+ * ("mask" and "add") to a <br>-seperated HTML string.
+ *
+ * Parameters :
+ * 1 : mask = As from struct url_actions
+ * 2 : add = As from struct url_actions
+ *
+ * Returns : A string. Caller must free it.
+ *
+ *********************************************************************/
+char * actions_to_html(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" */
+ mask |= add;
+
+
+#define DEFINE_ACTION_BOOL(__name, __bit) \
+ if (!(mask & __bit)) \
+ { \
+ result = strsav(result, "\n<br>-" __name); \
+ } \
+ else if (add & __bit) \
+ { \
+ result = strsav(result, "\n<br>+" __name); \
+ }
+
+#define DEFINE_ACTION_STRING(__name, __bit, __index) \
+ if (!(mask & __bit)) \
+ { \
+ result = strsav(result, "\n<br>-" __name); \
+ } \
+ else if (add & __bit) \
+ { \
+ result = strsav(result, "\n<br>+" __name "{"); \
+ enc_str = html_encode(action->string[__index]);\
+ result = strsav(result, enc_str); \
+ freez(enc_str); \
+ result = strsav(result, "}"); \
+ }
+
+#define DEFINE_ACTION_MULTI(__name, __index) \
+ if (action->multi_remove_all[__index]) \
+ { \
+ result = strsav(result, "\n<br>-" __name "{*}"); \
+ } \
+ else \
+ { \
+ lst = action->multi_remove[__index]->first; \
+ while (lst) \
+ { \
+ result = strsav(result, "\n<br>-" __name "{");\
+ enc_str = html_encode(lst->str); \
+ result = strsav(result, enc_str); \
+ freez(enc_str); \
+ result = strsav(result, "}"); \
+ lst = lst->next; \
+ } \
+ } \
+ lst = action->multi_add[__index]->first; \
+ while (lst) \
+ { \
+ result = strsav(result, "\n<br>+" __name "{"); \
+ result = strsav(result, lst->str); \
+ result = strsav(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;
+}
+#endif /* def FEATURE_CGI_EDIT_ACTIONS */
+
+
/*********************************************************************
*
* Function : current_actions_to_text
{
unsigned flags = action->flags;
char * result = strdup("");
- struct list * lst;
+ struct list_entry * lst;
#define DEFINE_ACTION_BOOL(__name, __bit) \
if (flags & __bit) \
}
#define DEFINE_ACTION_MULTI(__name, __index) \
- lst = action->multi[__index]->next; \
+ lst = action->multi[__index]->first; \
if (lst == NULL) \
{ \
result = strsav(result, " -" __name); \
void init_current_action (struct current_action_spec *dest)
{
memset(dest, '\0', sizeof(*dest));
+
dest->flags = ACTION_MOST_COMPATIBLE;
}
+/*********************************************************************
+ *
+ * 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));
+}
+
+
/*********************************************************************
*
* Function : merge_current_action
* 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 "current_free_action").
+ * "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)
*
{
if (src->multi_remove_all[i])
{
- /* Remove everything from dest */
- destroy_list(dest->multi[i]);
+ /* Remove everything from dest, then add src->multi_add */
list_duplicate(dest->multi[i], src->multi_add[i]);
}
else
*
* Function : free_current_action
*
- * Description : Free a current_action_spec.
+ * Description : Free memory used by a current_action_spec.
+ * Does not free the current_action_spec itself.
*
* Parameters :
* 1 : src = Source to free.
{
next = cur->next;
free_url(cur->url);
+ free_action(cur->action);
freez(cur);
cur = next;
}
}
+/*********************************************************************
+ *
+ * Function : free_alias_list
+ *
+ * Description : Free memory used by a list of aliases.
+ *
+ * Parameters :
+ * 1 : alias_list = Linked list to free.
+ *
+ * Returns : N/A
+ *
+ *********************************************************************/
+void free_alias_list(struct action_alias *alias_list)
+{
+ while (alias_list != NULL)
+ {
+ struct action_alias * next = alias_list->next;
+ alias_list->next = NULL;
+ freez((char *)alias_list->name);
+ free_action(alias_list->action);
+ free(alias_list);
+ alias_list = next;
+ }
+}
+
+
/*********************************************************************
*
* Function : load_actions_file
{
static struct file_list *current_actions_file = NULL;
- FILE *fp;
+ /*
+ * Parser mode.
+ * Note: Keep these in the order they occur in the file, they are
+ * sometimes tested with <=
+ */
+#define MODE_START_OF_FILE 1
+#define MODE_SETTINGS 2
+#define MODE_DESCRIPTION 3
+#define MODE_ALIAS 4
+#define MODE_ACTIONS 5
+
+ int mode = MODE_START_OF_FILE;
+ FILE *fp;
struct url_actions *last_perm;
struct url_actions *perm;
char buf[BUFFER_SIZE];
struct file_list *fs;
-#define MODE_START_OF_FILE 1
-#define MODE_ACTIONS 2
-#define MODE_ALIAS 3
- int mode = MODE_START_OF_FILE;
- struct action_spec cur_action[1];
+ struct action_spec * cur_action = NULL;
+ int cur_action_used = 0;
struct action_alias * alias_list = NULL;
- memset(cur_action, '\0', sizeof(*cur_action));
-
if (!check_file_changed(current_actions_file, csp->config->actions_file, &fs))
{
/* No need to load */
return 1; /* never get here */
}
- while (read_config_line(buf, sizeof(buf), fp, fs) != NULL)
+ while (read_config_line(buf, sizeof(buf), fp) != NULL)
{
if (*buf == '{')
{
return 1; /* never get here */
}
- if (0 == strcmpic(start, "alias"))
+ /*
+ * An actionsfile can optionally contain the following blocks.
+ * They *MUST* be in this order, to simplify processing:
+ *
+ * {{settings}}
+ * name=value...
+ *
+ * {{description}}
+ * ...free text, format TBD, but no line may start with a '{'...
+ *
+ * {{alias}}
+ * name=actions...
+ *
+ * The actual actions must be *after* these special blocks.
+ * None of these special blocks may be repeated.
+ *
+ */
+ if (0 == strcmpic(start, "settings"))
+ {
+ /* it's a {{settings}} block */
+ if (mode >= MODE_SETTINGS)
+ {
+ /* {{settings}} must be first thing in file and must only
+ * appear once.
+ */
+ fclose(fp);
+ log_error(LOG_LEVEL_FATAL,
+ "can't load actions file '%s': {{settings}} must only appear once, and it must be before anything else.",
+ csp->config->actions_file);
+ }
+ mode = MODE_SETTINGS;
+ }
+ else if (0 == strcmpic(start, "description"))
+ {
+ /* it's a {{description}} block */
+ if (mode >= MODE_DESCRIPTION)
+ {
+ /* {{description}} is a singleton and only {{settings}} may proceed it
+ */
+ fclose(fp);
+ log_error(LOG_LEVEL_FATAL,
+ "can't load actions file '%s': {{description}} must only appear once, and only a {{settings}} block may be above it.",
+ csp->config->actions_file);
+ }
+ mode = MODE_DESCRIPTION;
+ }
+ else if (0 == strcmpic(start, "alias"))
{
/* it's an {{alias}} block */
-
+ if (mode >= MODE_ALIAS)
+ {
+ /* {{alias}} must be first thing in file, possibly after
+ * {{settings}} and {{description}}
+ *
+ * {{alias}} must only appear once.
+ *
+ * Note that these are new restrictions introduced in
+ * v2.9.10 in order to make actionsfile editing simpler.
+ * (Otherwise, reordering actionsfile entries without
+ * completely rewriting the file becomes non-trivial)
+ */
+ fclose(fp);
+ log_error(LOG_LEVEL_FATAL,
+ "can't load actions file '%s': {{alias}} must only appear once, and it must be before all actions.",
+ csp->config->actions_file, start);
+ }
mode = MODE_ALIAS;
}
else
mode = MODE_ACTIONS;
/* free old action */
- free_action(cur_action);
+ if (cur_action)
+ {
+ if (!cur_action_used)
+ {
+ free_action(cur_action);
+ free(cur_action);
+ }
+ cur_action = NULL;
+ }
+ cur_action_used = 0;
+ cur_action = (struct action_spec *)zalloc(sizeof(*cur_action));
+ if (cur_action == NULL)
+ {
+ fclose(fp);
+ log_error(LOG_LEVEL_FATAL,
+ "can't load actions file '%s': out of memory",
+ csp->config->actions_file);
+ return 1; /* never get here */
+ }
+ init_action(cur_action);
/* trim { */
strcpy(actions_buf, buf + 1);
}
}
}
+ else if (mode == MODE_SETTINGS)
+ {
+ /*
+ * Part of the {{settings}} block.
+ * Ignore for now, but we may want to read & check permissions
+ * when we go multi-user.
+ */
+ }
+ else if (mode == MODE_DESCRIPTION)
+ {
+ /*
+ * Part of the {{description}} block.
+ * Ignore for now.
+ */
+ }
else if (mode == MODE_ALIAS)
{
- /* define an alias */
+ /*
+ * define an alias
+ */
char actions_buf[BUFFER_SIZE];
struct action_alias * new_alias;
- int more = 1;
char * start = strchr(buf, '=');
char * end = start;
free_action(cur_action);
- while (alias_list != NULL)
- {
- struct action_alias * next = alias_list->next;
- freez((char *)alias_list->name);
- free_action(alias_list->action);
- free(alias_list);
- alias_list = next;
- }
-
-#ifndef SPLIT_PROXY_ARGS
- if (!suppress_blocklists)
- {
- fs->proxy_args = strsav(fs->proxy_args, "</pre>");
- }
-#endif /* ndef SPLIT_PROXY_ARGS */
+ free_alias_list(alias_list);
/* the old one is now obsolete */
if (current_actions_file)
projects / privoxy.git / blobdiff