1 const char actions_rcs[] = "$Id: actions.c,v 1.75 2011/12/31 14:49:58 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/actions.c,v $
6 * Purpose : Declares functions to work with actions files
8 * Copyright : Written by and Copyright (C) 2001-2011 the
9 * Privoxy team. http://www.privoxy.org/
11 * Based on the Internet Junkbuster originally written
12 * by and Copyright (C) 1997 Anonymous Coders and
13 * Junkbusters Corporation. http://www.junkbusters.com
15 * This program is free software; you can redistribute it
16 * and/or modify it under the terms of the GNU General
17 * Public License as published by the Free Software
18 * Foundation; either version 2 of the License, or (at
19 * your option) any later version.
21 * This program is distributed in the hope that it will
22 * be useful, but WITHOUT ANY WARRANTY; without even the
23 * implied warranty of MERCHANTABILITY or FITNESS FOR A
24 * PARTICULAR PURPOSE. See the GNU General Public
25 * License for more details.
27 * The GNU General Public License should be included with
28 * this file. If not, you can view it at
29 * http://www.gnu.org/copyleft/gpl.html
30 * or write to the Free Software Foundation, Inc., 59
31 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 *********************************************************************/
43 #ifdef FEATURE_PTHREAD
59 const char actions_h_rcs[] = ACTIONS_H_VERSION;
63 * We need the main list of options.
65 * First, we need a way to tell between boolean, string, and multi-string
66 * options. For string and multistring options, we also need to be
67 * able to tell the difference between a "+" and a "-". (For bools,
68 * the "+"/"-" information is encoded in "add" and "mask"). So we use
69 * an enumerated type (well, the preprocessor equivalent). Here are
72 #define AV_NONE 0 /* +opt -opt */
73 #define AV_ADD_STRING 1 /* +stropt{string} */
74 #define AV_REM_STRING 2 /* -stropt */
75 #define AV_ADD_MULTI 3 /* +multiopt{string} +multiopt{string2} */
76 #define AV_REM_MULTI 4 /* -multiopt{string} -multiopt */
79 * We need a structure to hold the name, flag changes,
80 * type, and string index.
85 unsigned long mask; /* a bit set to "0" = remove action */
86 unsigned long add; /* a bit set to "1" = add action */
87 int takes_value; /* an AV_... constant */
88 int index; /* index into strings[] or multi[] */
92 * And with those building blocks in place, here's the array.
94 static const struct action_name action_names[] =
97 * Well actually there's no data here - it's in actionlist.h
98 * This keeps it together to make it easy to change.
100 * Here's the macros used to format it:
102 #define DEFINE_ACTION_MULTI(name,index) \
103 { "+" name, ACTION_MASK_ALL, 0, AV_ADD_MULTI, index }, \
104 { "-" name, ACTION_MASK_ALL, 0, AV_REM_MULTI, index },
105 #define DEFINE_ACTION_STRING(name,flag,index) \
106 { "+" name, ACTION_MASK_ALL, flag, AV_ADD_STRING, index }, \
107 { "-" name, ~flag, 0, AV_REM_STRING, index },
108 #define DEFINE_ACTION_BOOL(name,flag) \
109 { "+" name, ACTION_MASK_ALL, flag }, \
110 { "-" name, ~flag, 0 },
111 #define DEFINE_ACTION_ALIAS 1 /* Want aliases please */
113 #include "actionlist.h"
115 #undef DEFINE_ACTION_MULTI
116 #undef DEFINE_ACTION_STRING
117 #undef DEFINE_ACTION_BOOL
118 #undef DEFINE_ACTION_ALIAS
120 { NULL, 0, 0 } /* End marker */
124 static int load_one_actions_file(struct client_state *csp, int fileid);
127 /*********************************************************************
129 * Function : merge_actions
131 * Description : Merge two actions together.
132 * Similar to "dest += src".
135 * 1 : dest = Actions to modify.
136 * 2 : src = Action to add.
138 * Returns : JB_ERR_OK or JB_ERR_MEMORY
140 *********************************************************************/
141 jb_err merge_actions (struct action_spec *dest,
142 const struct action_spec *src)
147 dest->mask &= src->mask;
148 dest->add &= src->mask;
149 dest->add |= src->add;
151 for (i = 0; i < ACTION_STRING_COUNT; i++)
153 char * str = src->string[i];
156 freez(dest->string[i]);
157 dest->string[i] = strdup(str);
158 if (NULL == dest->string[i])
160 return JB_ERR_MEMORY;
165 for (i = 0; i < ACTION_MULTI_COUNT; i++)
167 if (src->multi_remove_all[i])
169 /* Remove everything from dest */
170 list_remove_all(dest->multi_remove[i]);
171 dest->multi_remove_all[i] = 1;
173 err = list_duplicate(dest->multi_add[i], src->multi_add[i]);
175 else if (dest->multi_remove_all[i])
178 * dest already removes everything, so we only need to worry
181 list_remove_list(dest->multi_add[i], src->multi_remove[i]);
182 err = list_append_list_unique(dest->multi_add[i], src->multi_add[i]);
186 /* No "remove all"s to worry about. */
187 list_remove_list(dest->multi_add[i], src->multi_remove[i]);
188 err = list_append_list_unique(dest->multi_remove[i], src->multi_remove[i]);
189 if (!err) err = list_append_list_unique(dest->multi_add[i], src->multi_add[i]);
202 /*********************************************************************
204 * Function : copy_action
206 * Description : Copy an action_specs.
207 * Similar to "dest = src".
210 * 1 : dest = Destination of copy.
211 * 2 : src = Source for copy.
215 *********************************************************************/
216 jb_err copy_action (struct action_spec *dest,
217 const struct action_spec *src)
220 jb_err err = JB_ERR_OK;
223 memset(dest, '\0', sizeof(*dest));
225 dest->mask = src->mask;
226 dest->add = src->add;
228 for (i = 0; i < ACTION_STRING_COUNT; i++)
230 char * str = src->string[i];
236 return JB_ERR_MEMORY;
238 dest->string[i] = str;
242 for (i = 0; i < ACTION_MULTI_COUNT; i++)
244 dest->multi_remove_all[i] = src->multi_remove_all[i];
245 err = list_duplicate(dest->multi_remove[i], src->multi_remove[i]);
250 err = list_duplicate(dest->multi_add[i], src->multi_add[i]);
259 /*********************************************************************
261 * Function : free_action_spec
263 * Description : Frees an action_spec and the memory used by it.
266 * 1 : src = Source to free.
270 *********************************************************************/
271 void free_action_spec(struct action_spec *src)
278 /*********************************************************************
280 * Function : free_action
282 * Description : Destroy an action_spec. Frees memory used by it,
283 * except for the memory used by the struct action_spec
287 * 1 : src = Source to free.
291 *********************************************************************/
292 void free_action (struct action_spec *src)
301 for (i = 0; i < ACTION_STRING_COUNT; i++)
303 freez(src->string[i]);
306 for (i = 0; i < ACTION_MULTI_COUNT; i++)
308 destroy_list(src->multi_remove[i]);
309 destroy_list(src->multi_add[i]);
312 memset(src, '\0', sizeof(*src));
316 /*********************************************************************
318 * Function : get_action_token
320 * Description : Parses a line for the first action.
321 * Modifies its input array, doesn't allocate memory.
323 * *line=" +abc{def} -ghi "
330 * 1 : line = [in] The line containing the action.
331 * [out] Start of next action on line, or
332 * NULL if we reached the end of line before
333 * we found an action.
334 * 2 : name = [out] Start of action name, null
335 * terminated. NULL on EOL
336 * 3 : value = [out] Start of action value, null
337 * terminated. NULL if none or EOL.
339 * Returns : JB_ERR_OK => Ok
340 * JB_ERR_PARSE => Mismatched {} (line was trashed anyway)
342 *********************************************************************/
343 jb_err get_action_token(char **line, char **name, char **value)
348 /* set default returns */
353 /* Eat any leading whitespace */
354 while ((*str == ' ') || (*str == '\t'))
366 /* null name, just value is prohibited */
373 while (((ch = *str) != '\0') &&
374 (ch != ' ') && (ch != '\t') && (ch != '{'))
378 /* error, '}' without '{' */
390 /* EOL - be careful not to run off buffer */
395 /* More to parse next time. */
404 str = strchr(str, '}');
421 /*********************************************************************
423 * Function : action_used_to_be_valid
425 * Description : Checks if unrecognized actions were valid in earlier
429 * 1 : action = The string containing the action to check.
431 * Returns : True if yes, otherwise false.
433 *********************************************************************/
434 static int action_used_to_be_valid(const char *action)
436 static const char * const formerly_valid_actions[] = {
439 "send-vanilla-wafer",
441 "treat-forbidden-connects-like-blocks",
447 for (i = 0; i < SZ(formerly_valid_actions); i++)
449 if (0 == strcmpic(action, formerly_valid_actions[i]))
458 /*********************************************************************
460 * Function : get_actions
462 * Description : Parses a list of actions.
465 * 1 : line = The string containing the actions.
466 * Will be written to by this function.
467 * 2 : alias_list = Custom alias list, or NULL for none.
468 * 3 : cur_action = Where to store the action. Caller
471 * Returns : JB_ERR_OK => Ok
472 * JB_ERR_PARSE => Parse error (line was trashed anyway)
473 * nonzero => Out of memory (line was trashed anyway)
475 *********************************************************************/
476 jb_err get_actions(char *line,
477 struct action_alias * alias_list,
478 struct action_spec *cur_action)
481 init_action(cur_action);
482 cur_action->mask = ACTION_MASK_ALL;
486 char * option = NULL;
489 err = get_action_token(&line, &option, &value);
497 /* handle option in 'option' */
499 /* Check for standard action name */
500 const struct action_name * action = action_names;
502 while ( (action->name != NULL) && (0 != strcmpic(action->name, option)) )
506 if (action->name != NULL)
509 cur_action->mask &= action->mask;
510 cur_action->add &= action->mask;
511 cur_action->add |= action->add;
513 switch (action->takes_value)
516 /* ignore any option. */
520 /* add single string. */
522 if ((value == NULL) || (*value == '\0'))
524 if (0 == strcmpic(action->name, "+block"))
527 * XXX: Temporary backwards compatibility hack.
528 * XXX: should include line number.
530 value = "No reason specified.";
531 log_error(LOG_LEVEL_ERROR,
532 "block action without reason found. This may "
533 "become a fatal error in future versions.");
540 /* FIXME: should validate option string here */
541 freez (cur_action->string[action->index]);
542 cur_action->string[action->index] = strdup(value);
543 if (NULL == cur_action->string[action->index])
545 return JB_ERR_MEMORY;
551 /* remove single string. */
553 freez (cur_action->string[action->index]);
558 /* append multi string. */
560 struct list * remove_p = cur_action->multi_remove[action->index];
561 struct list * add_p = cur_action->multi_add[action->index];
563 if ((value == NULL) || (*value == '\0'))
568 list_remove_item(remove_p, value);
569 err = enlist_unique(add_p, value, 0);
578 /* remove multi string. */
580 struct list * remove_p = cur_action->multi_remove[action->index];
581 struct list * add_p = cur_action->multi_add[action->index];
583 if ( (value == NULL) || (*value == '\0')
584 || ((*value == '*') && (value[1] == '\0')) )
587 * no option, or option == "*".
591 list_remove_all(remove_p);
592 list_remove_all(add_p);
593 cur_action->multi_remove_all[action->index] = 1;
597 /* Valid option - remove only 1 option */
599 if ( !cur_action->multi_remove_all[action->index] )
601 /* there isn't a catch-all in the remove list already */
602 err = enlist_unique(remove_p, value, 0);
608 list_remove_item(add_p, value);
613 /* Shouldn't get here unless there's memory corruption. */
620 /* try user aliases. */
621 const struct action_alias * alias = alias_list;
623 while ( (alias != NULL) && (0 != strcmpic(alias->name, option)) )
630 merge_actions(cur_action, alias->action);
632 else if (((size_t)2 < strlen(option)) && action_used_to_be_valid(option+1))
634 log_error(LOG_LEVEL_ERROR, "Action '%s' is no longer valid "
635 "in this Privoxy release. Ignored.", option+1);
637 else if (((size_t)2 < strlen(option)) && 0 == strcmpic(option+1, "hide-forwarded-for-headers"))
639 log_error(LOG_LEVEL_FATAL, "The action 'hide-forwarded-for-headers' "
640 "is no longer valid in this Privoxy release. "
641 "Use 'change-x-forwarded-for' instead.");
645 /* Bad action name */
647 * XXX: This is a fatal error and Privoxy will later on exit
648 * in load_one_actions_file() because of an "invalid line".
650 * It would be preferable to name the offending option in that
651 * error message, but currently there is no way to do that and
652 * we have to live with two error messages for basically the
655 log_error(LOG_LEVEL_ERROR, "Unknown action or alias: %s", option);
666 /*********************************************************************
668 * Function : init_current_action
670 * Description : Zero out an action.
673 * 1 : dest = An uninitialized current_action_spec.
677 *********************************************************************/
678 void init_current_action (struct current_action_spec *dest)
680 memset(dest, '\0', sizeof(*dest));
682 dest->flags = ACTION_MOST_COMPATIBLE;
686 /*********************************************************************
688 * Function : init_action
690 * Description : Zero out an action.
693 * 1 : dest = An uninitialized action_spec.
697 *********************************************************************/
698 void init_action (struct action_spec *dest)
700 memset(dest, '\0', sizeof(*dest));
704 /*********************************************************************
706 * Function : merge_current_action
708 * Description : Merge two actions together.
709 * Similar to "dest += src".
710 * Differences between this and merge_actions()
711 * is that this one doesn't allocate memory for
712 * strings (so "src" better be in memory for at least
713 * as long as "dest" is, and you'd better free
714 * "dest" using "free_current_action").
715 * Also, there is no mask or remove lists in dest.
716 * (If we're applying it to a URL, we don't need them)
719 * 1 : dest = Current actions, to modify.
720 * 2 : src = Action to add.
722 * Returns 0 : no error
723 * !=0 : error, probably JB_ERR_MEMORY.
725 *********************************************************************/
726 jb_err merge_current_action (struct current_action_spec *dest,
727 const struct action_spec *src)
730 jb_err err = JB_ERR_OK;
732 dest->flags &= src->mask;
733 dest->flags |= src->add;
735 for (i = 0; i < ACTION_STRING_COUNT; i++)
737 char * str = src->string[i];
743 return JB_ERR_MEMORY;
745 freez(dest->string[i]);
746 dest->string[i] = str;
750 for (i = 0; i < ACTION_MULTI_COUNT; i++)
752 if (src->multi_remove_all[i])
754 /* Remove everything from dest, then add src->multi_add */
755 err = list_duplicate(dest->multi[i], src->multi_add[i]);
763 list_remove_list(dest->multi[i], src->multi_remove[i]);
764 err = list_append_list_unique(dest->multi[i], src->multi_add[i]);
775 /*********************************************************************
777 * Function : update_action_bits_for_tag
779 * Description : Updates the action bits based on the action sections
780 * whose tag patterns match a provided tag.
783 * 1 : csp = Current client state (buffers, headers, etc...)
784 * 2 : tag = The tag on which the update should be based on
786 * Returns : 0 if no tag matched, or
789 *********************************************************************/
790 int update_action_bits_for_tag(struct client_state *csp, const char *tag)
792 struct file_list *fl;
793 struct url_actions *b;
799 assert(list_contains_item(csp->tags, tag));
801 /* Run through all action files, */
802 for (i = 0; i < MAX_AF_FILES; i++)
804 if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
806 /* Skip empty files */
810 /* and through all the action patterns, */
811 for (b = b->next; NULL != b; b = b->next)
813 /* skip the URL patterns, */
814 if (NULL == b->url->tag_regex)
819 /* and check if one of the tag patterns matches the tag, */
820 if (0 == regexec(b->url->tag_regex, tag, 0, NULL, 0))
822 /* if it does, update the action bit map, */
823 if (merge_current_action(csp->action, b->action))
825 log_error(LOG_LEVEL_ERROR,
826 "Out of memory while changing action bits");
828 /* and signal the change. */
838 /*********************************************************************
840 * Function : free_current_action
842 * Description : Free memory used by a current_action_spec.
843 * Does not free the current_action_spec itself.
846 * 1 : src = Source to free.
850 *********************************************************************/
851 void free_current_action(struct current_action_spec *src)
855 for (i = 0; i < ACTION_STRING_COUNT; i++)
857 freez(src->string[i]);
860 for (i = 0; i < ACTION_MULTI_COUNT; i++)
862 destroy_list(src->multi[i]);
865 memset(src, '\0', sizeof(*src));
869 static struct file_list *current_actions_file[MAX_AF_FILES] = {
870 NULL, NULL, NULL, NULL, NULL,
871 NULL, NULL, NULL, NULL, NULL
875 #ifdef FEATURE_GRACEFUL_TERMINATION
876 /*********************************************************************
878 * Function : unload_current_actions_file
880 * Description : Unloads current actions file - reset to state at
881 * beginning of program.
887 *********************************************************************/
888 void unload_current_actions_file(void)
892 for (i = 0; i < MAX_AF_FILES; i++)
894 if (current_actions_file[i])
896 current_actions_file[i]->unloader = unload_actions_file;
897 current_actions_file[i] = NULL;
901 #endif /* FEATURE_GRACEFUL_TERMINATION */
904 /*********************************************************************
906 * Function : unload_actions_file
908 * Description : Unloads an actions module.
911 * 1 : file_data = the data structure associated with the
916 *********************************************************************/
917 void unload_actions_file(void *file_data)
919 struct url_actions * next;
920 struct url_actions * cur = (struct url_actions *)file_data;
924 free_url_spec(cur->url);
925 if ((next == NULL) || (next->action != cur->action))
928 * As the action settings might be shared,
929 * we can only free them if the current
930 * url pattern is the last one, or if the
931 * next one is using different settings.
933 free_action_spec(cur->action);
941 /*********************************************************************
943 * Function : free_alias_list
945 * Description : Free memory used by a list of aliases.
948 * 1 : alias_list = Linked list to free.
952 *********************************************************************/
953 void free_alias_list(struct action_alias *alias_list)
955 while (alias_list != NULL)
957 struct action_alias * next = alias_list->next;
958 alias_list->next = NULL;
959 freez(alias_list->name);
960 free_action(alias_list->action);
967 /*********************************************************************
969 * Function : load_action_files
971 * Description : Read and parse all the action files and add to files
975 * 1 : csp = Current client state (buffers, headers, etc...)
977 * Returns : 0 => Ok, everything else is an error.
979 *********************************************************************/
980 int load_action_files(struct client_state *csp)
985 for (i = 0; i < MAX_AF_FILES; i++)
987 if (csp->config->actions_file[i])
989 result = load_one_actions_file(csp, i);
995 else if (current_actions_file[i])
997 current_actions_file[i]->unloader = unload_actions_file;
998 current_actions_file[i] = NULL;
1006 /*********************************************************************
1008 * Function : referenced_filters_are_missing
1010 * Description : Checks if any filters of a certain type referenced
1011 * in an action spec are missing.
1014 * 1 : csp = Current client state (buffers, headers, etc...)
1015 * 2 : cur_action = The action spec to check.
1016 * 3 : multi_index = The index where to look for the filter.
1017 * 4 : filter_type = The filter type the caller is interested in.
1019 * Returns : 0 => All referenced filters exists, everything else is an error.
1021 *********************************************************************/
1022 static int referenced_filters_are_missing(const struct client_state *csp,
1023 const struct action_spec *cur_action, int multi_index, enum filter_type filter_type)
1026 struct file_list *fl;
1027 struct re_filterfile_spec *b;
1028 struct list_entry *filtername;
1030 for (filtername = cur_action->multi_add[multi_index]->first;
1031 filtername; filtername = filtername->next)
1033 int filter_found = 0;
1034 for (i = 0; i < MAX_AF_FILES; i++)
1037 if ((NULL == fl) || (NULL == fl->f))
1042 for (b = fl->f; b; b = b->next)
1044 if (b->type != filter_type)
1048 if (strcmp(b->name, filtername->str) == 0)
1056 log_error(LOG_LEVEL_ERROR, "Missing filter '%s'", filtername->str);
1066 /*********************************************************************
1068 * Function : action_spec_is_valid
1070 * Description : Should eventually figure out if an action spec
1071 * is valid, but currently only checks that the
1072 * referenced filters are accounted for.
1075 * 1 : csp = Current client state (buffers, headers, etc...)
1076 * 2 : cur_action = The action spec to check.
1078 * Returns : 0 => No problems detected, everything else is an error.
1080 *********************************************************************/
1081 static int action_spec_is_valid(struct client_state *csp, const struct action_spec *cur_action)
1085 enum filter_type filter_type;
1087 {ACTION_MULTI_FILTER, FT_CONTENT_FILTER},
1088 {ACTION_MULTI_CLIENT_HEADER_FILTER, FT_CLIENT_HEADER_FILTER},
1089 {ACTION_MULTI_SERVER_HEADER_FILTER, FT_SERVER_HEADER_FILTER},
1090 {ACTION_MULTI_CLIENT_HEADER_TAGGER, FT_CLIENT_HEADER_TAGGER},
1091 {ACTION_MULTI_SERVER_HEADER_TAGGER, FT_SERVER_HEADER_TAGGER}
1096 for (i = 0; i < SZ(filter_map); i++)
1098 errors += referenced_filters_are_missing(csp, cur_action,
1099 filter_map[i].multi_index, filter_map[i].filter_type);
1107 /*********************************************************************
1109 * Function : load_one_actions_file
1111 * Description : Read and parse a action file and add to files
1115 * 1 : csp = Current client state (buffers, headers, etc...)
1116 * 2 : fileid = File index to load.
1118 * Returns : 0 => Ok, everything else is an error.
1120 *********************************************************************/
1121 static int load_one_actions_file(struct client_state *csp, int fileid)
1126 * Note: Keep these in the order they occur in the file, they are
1127 * sometimes tested with <=
1130 MODE_START_OF_FILE = 1,
1132 MODE_DESCRIPTION = 3,
1138 struct url_actions *last_perm;
1139 struct url_actions *perm;
1141 struct file_list *fs;
1142 struct action_spec * cur_action = NULL;
1143 int cur_action_used = 0;
1144 struct action_alias * alias_list = NULL;
1145 unsigned long linenum = 0;
1146 mode = MODE_START_OF_FILE;
1148 if (!check_file_changed(current_actions_file[fileid], csp->config->actions_file[fileid], &fs))
1150 /* No need to load */
1151 csp->actions_list[fileid] = current_actions_file[fileid];
1156 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': %E. "
1157 "Note that beginning with Privoxy 3.0.7, actions files have to be specified "
1158 "with their complete file names.", csp->config->actions_file[fileid]);
1159 return 1; /* never get here */
1162 fs->f = last_perm = (struct url_actions *)zalloc(sizeof(*last_perm));
1163 if (last_perm == NULL)
1165 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': out of memory!",
1166 csp->config->actions_file[fileid]);
1167 return 1; /* never get here */
1170 if ((fp = fopen(csp->config->actions_file[fileid], "r")) == NULL)
1172 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error opening file: %E",
1173 csp->config->actions_file[fileid]);
1174 return 1; /* never get here */
1177 log_error(LOG_LEVEL_INFO, "Loading actions file: %s", csp->config->actions_file[fileid]);
1179 while (read_config_line(fp, &linenum, &buf) != NULL)
1183 /* It's a header block */
1186 /* It's {{settings}} or {{alias}} */
1187 size_t len = strlen(buf);
1188 char * start = buf + 2;
1189 char * end = buf + len - 1;
1190 if ((len < (size_t)5) || (*end-- != '}') || (*end-- != '}'))
1194 log_error(LOG_LEVEL_FATAL,
1195 "can't load actions file '%s': invalid line (%lu): %s",
1196 csp->config->actions_file[fileid], linenum, buf);
1197 return 1; /* never get here */
1200 /* Trim leading and trailing whitespace. */
1208 log_error(LOG_LEVEL_FATAL,
1209 "can't load actions file '%s': invalid line (%lu): {{ }}",
1210 csp->config->actions_file[fileid], linenum);
1211 return 1; /* never get here */
1215 * An actionsfile can optionally contain the following blocks.
1216 * They *MUST* be in this order, to simplify processing:
1222 * ...free text, format TBD, but no line may start with a '{'...
1227 * The actual actions must be *after* these special blocks.
1228 * None of these special blocks may be repeated.
1231 if (0 == strcmpic(start, "settings"))
1233 /* it's a {{settings}} block */
1234 if (mode >= MODE_SETTINGS)
1236 /* {{settings}} must be first thing in file and must only
1240 log_error(LOG_LEVEL_FATAL,
1241 "can't load actions file '%s': line %lu: {{settings}} must only appear once, and it must be before anything else.",
1242 csp->config->actions_file[fileid], linenum);
1244 mode = MODE_SETTINGS;
1246 else if (0 == strcmpic(start, "description"))
1248 /* it's a {{description}} block */
1249 if (mode >= MODE_DESCRIPTION)
1251 /* {{description}} is a singleton and only {{settings}} may proceed it
1254 log_error(LOG_LEVEL_FATAL,
1255 "can't load actions file '%s': line %lu: {{description}} must only appear once, and only a {{settings}} block may be above it.",
1256 csp->config->actions_file[fileid], linenum);
1258 mode = MODE_DESCRIPTION;
1260 else if (0 == strcmpic(start, "alias"))
1262 /* it's an {{alias}} block */
1263 if (mode >= MODE_ALIAS)
1265 /* {{alias}} must be first thing in file, possibly after
1266 * {{settings}} and {{description}}
1268 * {{alias}} must only appear once.
1270 * Note that these are new restrictions introduced in
1271 * v2.9.10 in order to make actionsfile editing simpler.
1272 * (Otherwise, reordering actionsfile entries without
1273 * completely rewriting the file becomes non-trivial)
1276 log_error(LOG_LEVEL_FATAL,
1277 "can't load actions file '%s': line %lu: {{alias}} must only appear once, and it must be before all actions.",
1278 csp->config->actions_file[fileid], linenum);
1284 /* invalid {{something}} block */
1286 log_error(LOG_LEVEL_FATAL,
1287 "can't load actions file '%s': invalid line (%lu): {{%s}}",
1288 csp->config->actions_file[fileid], linenum, start);
1289 return 1; /* never get here */
1294 /* It's an actions block */
1300 mode = MODE_ACTIONS;
1302 /* free old action */
1305 if (!cur_action_used)
1307 free_action_spec(cur_action);
1311 cur_action_used = 0;
1312 cur_action = (struct action_spec *)zalloc(sizeof(*cur_action));
1313 if (cur_action == NULL)
1316 log_error(LOG_LEVEL_FATAL,
1317 "can't load actions file '%s': out of memory",
1318 csp->config->actions_file[fileid]);
1319 return 1; /* never get here */
1321 init_action(cur_action);
1324 * Copy the buffer before messing with it as we may need the
1325 * unmodified version in for the fatal error messages. Given
1326 * that this is not a common event, we could instead simply
1327 * read the line again.
1329 * buf + 1 to skip the leading '{'
1331 actions_buf = strdup(buf + 1);
1332 if (actions_buf == NULL)
1335 log_error(LOG_LEVEL_FATAL,
1336 "can't load actions file '%s': out of memory",
1337 csp->config->actions_file[fileid]);
1338 return 1; /* never get here */
1341 /* check we have a trailing } and then trim it */
1342 end = actions_buf + strlen(actions_buf) - 1;
1348 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1349 "Missing trailing '}' in action section starting at line (%lu): %s",
1350 csp->config->actions_file[fileid], linenum, buf);
1351 return 1; /* never get here */
1355 /* trim any whitespace immediately inside {} */
1358 if (get_actions(actions_buf, alias_list, cur_action))
1363 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1364 "can't completely parse the action section starting at line (%lu): %s",
1365 csp->config->actions_file[fileid], linenum, buf);
1366 return 1; /* never get here */
1369 if (action_spec_is_valid(csp, cur_action))
1371 log_error(LOG_LEVEL_ERROR, "Invalid action section in file '%s', "
1372 "starting at line %lu: %s",
1373 csp->config->actions_file[fileid], linenum, buf);
1379 else if (mode == MODE_SETTINGS)
1382 * Part of the {{settings}} block.
1383 * For now only serves to check if the file's minimum Privoxy
1384 * version requirement is met, but we may want to read & check
1385 * permissions when we go multi-user.
1387 if (!strncmp(buf, "for-privoxy-version=", 20))
1389 char *version_string, *fields[3];
1392 if ((version_string = strdup(buf + 20)) == NULL)
1395 log_error(LOG_LEVEL_FATAL,
1396 "can't load actions file '%s': out of memory!",
1397 csp->config->actions_file[fileid]);
1398 return 1; /* never get here */
1401 num_fields = ssplit(version_string, ".", fields, SZ(fields), TRUE, FALSE);
1403 if (num_fields < 1 || atoi(fields[0]) == 0)
1405 log_error(LOG_LEVEL_ERROR,
1406 "While loading actions file '%s': invalid line (%lu): %s",
1407 csp->config->actions_file[fileid], linenum, buf);
1409 else if ( atoi(fields[0]) > VERSION_MAJOR
1410 || (num_fields > 1 && atoi(fields[1]) > VERSION_MINOR)
1411 || (num_fields > 2 && atoi(fields[2]) > VERSION_POINT))
1414 log_error(LOG_LEVEL_FATAL,
1415 "Actions file '%s', line %lu requires newer Privoxy version: %s",
1416 csp->config->actions_file[fileid], linenum, buf );
1417 return 1; /* never get here */
1419 free(version_string);
1422 else if (mode == MODE_DESCRIPTION)
1425 * Part of the {{description}} block.
1429 else if (mode == MODE_ALIAS)
1434 char actions_buf[BUFFER_SIZE];
1435 struct action_alias * new_alias;
1437 char * start = strchr(buf, '=');
1440 if ((start == NULL) || (start == buf))
1442 log_error(LOG_LEVEL_FATAL,
1443 "can't load actions file '%s': invalid alias line (%lu): %s",
1444 csp->config->actions_file[fileid], linenum, buf);
1445 return 1; /* never get here */
1448 if ((new_alias = zalloc(sizeof(*new_alias))) == NULL)
1451 log_error(LOG_LEVEL_FATAL,
1452 "can't load actions file '%s': out of memory!",
1453 csp->config->actions_file[fileid]);
1454 return 1; /* never get here */
1457 /* Eat any the whitespace before the '=' */
1459 while ((*end == ' ') || (*end == '\t'))
1462 * we already know we must have at least 1 non-ws char
1463 * at start of buf - no need to check
1469 /* Eat any the whitespace after the '=' */
1471 while ((*start == ' ') || (*start == '\t'))
1477 log_error(LOG_LEVEL_FATAL,
1478 "can't load actions file '%s': invalid alias line (%lu): %s",
1479 csp->config->actions_file[fileid], linenum, buf);
1480 return 1; /* never get here */
1483 if ((new_alias->name = strdup(buf)) == NULL)
1486 log_error(LOG_LEVEL_FATAL,
1487 "can't load actions file '%s': out of memory!",
1488 csp->config->actions_file[fileid]);
1489 return 1; /* never get here */
1492 strlcpy(actions_buf, start, sizeof(actions_buf));
1494 if (get_actions(actions_buf, alias_list, new_alias->action))
1498 log_error(LOG_LEVEL_FATAL,
1499 "can't load actions file '%s': invalid alias line (%lu): %s = %s",
1500 csp->config->actions_file[fileid], linenum, buf, start);
1501 return 1; /* never get here */
1505 new_alias->next = alias_list;
1506 alias_list = new_alias;
1508 else if (mode == MODE_ACTIONS)
1510 /* it's an URL pattern */
1512 /* allocate a new node */
1513 if ((perm = zalloc(sizeof(*perm))) == NULL)
1516 log_error(LOG_LEVEL_FATAL,
1517 "can't load actions file '%s': out of memory!",
1518 csp->config->actions_file[fileid]);
1519 return 1; /* never get here */
1522 perm->action = cur_action;
1523 cur_action_used = 1;
1525 /* Save the URL pattern */
1526 if (create_url_spec(perm->url, buf))
1529 log_error(LOG_LEVEL_FATAL,
1530 "can't load actions file '%s': line %lu: cannot create URL or TAG pattern from: %s",
1531 csp->config->actions_file[fileid], linenum, buf);
1532 return 1; /* never get here */
1535 /* add it to the list */
1536 last_perm->next = perm;
1539 else if (mode == MODE_START_OF_FILE)
1541 /* oops - please have a {} line as 1st line in file. */
1543 log_error(LOG_LEVEL_FATAL,
1544 "can't load actions file '%s': line %lu should begin with a '{': %s",
1545 csp->config->actions_file[fileid], linenum, buf);
1546 return 1; /* never get here */
1550 /* How did we get here? This is impossible! */
1552 log_error(LOG_LEVEL_FATAL,
1553 "can't load actions file '%s': INTERNAL ERROR - mode = %d",
1554 csp->config->actions_file[fileid], mode);
1555 return 1; /* never get here */
1562 if (!cur_action_used)
1564 free_action_spec(cur_action);
1566 free_alias_list(alias_list);
1568 /* the old one is now obsolete */
1569 if (current_actions_file[fileid])
1571 current_actions_file[fileid]->unloader = unload_actions_file;
1574 fs->next = files->next;
1576 current_actions_file[fileid] = fs;
1578 csp->actions_list[fileid] = fs;
1585 /*********************************************************************
1587 * Function : actions_to_text
1589 * Description : Converts a actionsfile entry from the internal
1590 * structure into a text line. The output is split
1591 * into one line for each action with line continuation.
1594 * 1 : action = The action to format.
1596 * Returns : A string. Caller must free it.
1597 * NULL on out-of-memory error.
1599 *********************************************************************/
1600 char * actions_to_text(const struct action_spec *action)
1602 unsigned long mask = action->mask;
1603 unsigned long add = action->add;
1604 char *result = strdup("");
1605 struct list_entry * lst;
1607 /* sanity - prevents "-feature +feature" */
1611 #define DEFINE_ACTION_BOOL(__name, __bit) \
1612 if (!(mask & __bit)) \
1614 string_append(&result, " -" __name " \\\n"); \
1616 else if (add & __bit) \
1618 string_append(&result, " +" __name " \\\n"); \
1621 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1622 if (!(mask & __bit)) \
1624 string_append(&result, " -" __name " \\\n"); \
1626 else if (add & __bit) \
1628 string_append(&result, " +" __name "{"); \
1629 string_append(&result, action->string[__index]); \
1630 string_append(&result, "} \\\n"); \
1633 #define DEFINE_ACTION_MULTI(__name, __index) \
1634 if (action->multi_remove_all[__index]) \
1636 string_append(&result, " -" __name " \\\n"); \
1640 lst = action->multi_remove[__index]->first; \
1643 string_append(&result, " -" __name "{"); \
1644 string_append(&result, lst->str); \
1645 string_append(&result, "} \\\n"); \
1649 lst = action->multi_add[__index]->first; \
1652 string_append(&result, " +" __name "{"); \
1653 string_append(&result, lst->str); \
1654 string_append(&result, "} \\\n"); \
1658 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1660 #include "actionlist.h"
1662 #undef DEFINE_ACTION_MULTI
1663 #undef DEFINE_ACTION_STRING
1664 #undef DEFINE_ACTION_BOOL
1665 #undef DEFINE_ACTION_ALIAS
1671 /*********************************************************************
1673 * Function : actions_to_html
1675 * Description : Converts a actionsfile entry from numeric form
1676 * ("mask" and "add") to a <br>-separated HTML string
1677 * in which each action is linked to its chapter in
1681 * 1 : csp = Client state (for config)
1682 * 2 : action = Action spec to be converted
1684 * Returns : A string. Caller must free it.
1685 * NULL on out-of-memory error.
1687 *********************************************************************/
1688 char * actions_to_html(const struct client_state *csp,
1689 const struct action_spec *action)
1691 unsigned long mask = action->mask;
1692 unsigned long add = action->add;
1693 char *result = strdup("");
1694 struct list_entry * lst;
1696 /* sanity - prevents "-feature +feature" */
1700 #define DEFINE_ACTION_BOOL(__name, __bit) \
1701 if (!(mask & __bit)) \
1703 string_append(&result, "\n<br>-"); \
1704 string_join(&result, add_help_link(__name, csp->config)); \
1706 else if (add & __bit) \
1708 string_append(&result, "\n<br>+"); \
1709 string_join(&result, add_help_link(__name, csp->config)); \
1712 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1713 if (!(mask & __bit)) \
1715 string_append(&result, "\n<br>-"); \
1716 string_join(&result, add_help_link(__name, csp->config)); \
1718 else if (add & __bit) \
1720 string_append(&result, "\n<br>+"); \
1721 string_join(&result, add_help_link(__name, csp->config)); \
1722 string_append(&result, "{"); \
1723 string_join(&result, html_encode(action->string[__index])); \
1724 string_append(&result, "}"); \
1727 #define DEFINE_ACTION_MULTI(__name, __index) \
1728 if (action->multi_remove_all[__index]) \
1730 string_append(&result, "\n<br>-"); \
1731 string_join(&result, add_help_link(__name, csp->config)); \
1735 lst = action->multi_remove[__index]->first; \
1738 string_append(&result, "\n<br>-"); \
1739 string_join(&result, add_help_link(__name, csp->config)); \
1740 string_append(&result, "{"); \
1741 string_join(&result, html_encode(lst->str)); \
1742 string_append(&result, "}"); \
1746 lst = action->multi_add[__index]->first; \
1749 string_append(&result, "\n<br>+"); \
1750 string_join(&result, add_help_link(__name, csp->config)); \
1751 string_append(&result, "{"); \
1752 string_join(&result, html_encode(lst->str)); \
1753 string_append(&result, "}"); \
1757 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1759 #include "actionlist.h"
1761 #undef DEFINE_ACTION_MULTI
1762 #undef DEFINE_ACTION_STRING
1763 #undef DEFINE_ACTION_BOOL
1764 #undef DEFINE_ACTION_ALIAS
1766 /* trim leading <br> */
1767 if (result && *result)
1770 result = strdup(result + 5);
1778 /*********************************************************************
1780 * Function : current_actions_to_html
1782 * Description : Converts a curren action spec to a <br> separated HTML
1783 * text in which each action is linked to its chapter in
1787 * 1 : csp = Client state (for config)
1788 * 2 : action = Current action spec to be converted
1790 * Returns : A string. Caller must free it.
1791 * NULL on out-of-memory error.
1793 *********************************************************************/
1794 char *current_action_to_html(const struct client_state *csp,
1795 const struct current_action_spec *action)
1797 unsigned long flags = action->flags;
1798 struct list_entry * lst;
1799 char *result = strdup("");
1800 char *active = strdup("");
1801 char *inactive = strdup("");
1803 #define DEFINE_ACTION_BOOL(__name, __bit) \
1804 if (flags & __bit) \
1806 string_append(&active, "\n<br>+"); \
1807 string_join(&active, add_help_link(__name, csp->config)); \
1811 string_append(&inactive, "\n<br>-"); \
1812 string_join(&inactive, add_help_link(__name, csp->config)); \
1815 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1816 if (flags & __bit) \
1818 string_append(&active, "\n<br>+"); \
1819 string_join(&active, add_help_link(__name, csp->config)); \
1820 string_append(&active, "{"); \
1821 string_join(&active, html_encode(action->string[__index])); \
1822 string_append(&active, "}"); \
1826 string_append(&inactive, "\n<br>-"); \
1827 string_join(&inactive, add_help_link(__name, csp->config)); \
1830 #define DEFINE_ACTION_MULTI(__name, __index) \
1831 lst = action->multi[__index]->first; \
1834 string_append(&inactive, "\n<br>-"); \
1835 string_join(&inactive, add_help_link(__name, csp->config)); \
1841 string_append(&active, "\n<br>+"); \
1842 string_join(&active, add_help_link(__name, csp->config)); \
1843 string_append(&active, "{"); \
1844 string_join(&active, html_encode(lst->str)); \
1845 string_append(&active, "}"); \
1850 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1852 #include "actionlist.h"
1854 #undef DEFINE_ACTION_MULTI
1855 #undef DEFINE_ACTION_STRING
1856 #undef DEFINE_ACTION_BOOL
1857 #undef DEFINE_ACTION_ALIAS
1861 string_append(&result, active);
1864 string_append(&result, "\n<br>");
1865 if (inactive != NULL)
1867 string_append(&result, inactive);