1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/actions.c,v $
5 * Purpose : Declares functions to work with actions files
7 * Copyright : Written by and Copyright (C) 2001-2016 the
8 * Privoxy team. http://www.privoxy.org/
10 * Based on the Internet Junkbuster originally written
11 * by and Copyright (C) 1997 Anonymous Coders and
12 * Junkbusters Corporation. http://www.junkbusters.com
14 * This program is free software; you can redistribute it
15 * and/or modify it under the terms of the GNU General
16 * Public License as published by the Free Software
17 * Foundation; either version 2 of the License, or (at
18 * your option) any later version.
20 * This program is distributed in the hope that it will
21 * be useful, but WITHOUT ANY WARRANTY; without even the
22 * implied warranty of MERCHANTABILITY or FITNESS FOR A
23 * PARTICULAR PURPOSE. See the GNU General Public
24 * License for more details.
26 * The GNU General Public License should be included with
27 * this file. If not, you can view it at
28 * http://www.gnu.org/copyleft/gpl.html
29 * or write to the Free Software Foundation, Inc., 59
30 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
32 *********************************************************************/
42 #ifdef FEATURE_PTHREAD
60 * We need the main list of options.
62 * First, we need a way to tell between boolean, string, and multi-string
63 * options. For string and multistring options, we also need to be
64 * able to tell the difference between a "+" and a "-". (For bools,
65 * the "+"/"-" information is encoded in "add" and "mask"). So we use
66 * an enumerated type (well, the preprocessor equivalent). Here are
69 enum action_value_type {
70 AV_NONE = 0, /* +opt -opt */
71 AV_ADD_STRING = 1, /* +stropt{string} */
72 AV_REM_STRING = 2, /* -stropt */
73 AV_ADD_MULTI = 3, /* +multiopt{string} +multiopt{string2} */
74 AV_REM_MULTI = 4 /* -multiopt{string} -multiopt */
78 * We need a structure to hold the name, flag changes,
79 * type, and string index.
84 unsigned long mask; /* a bit set to "0" = remove action */
85 unsigned long add; /* a bit set to "1" = add action */
86 enum action_value_type value_type; /* an AV_... constant */
87 int index; /* index into strings[] or multi[] */
91 * And with those building blocks in place, here's the array.
93 static const struct action_name action_names[] =
96 * Well actually there's no data here - it's in actionlist.h
97 * This keeps it together to make it easy to change.
99 * Here's the macros used to format it:
101 #define DEFINE_ACTION_MULTI(name,index) \
102 { "+" name, ACTION_MASK_ALL, 0, AV_ADD_MULTI, index }, \
103 { "-" name, ACTION_MASK_ALL, 0, AV_REM_MULTI, index },
104 #define DEFINE_ACTION_STRING(name,flag,index) \
105 { "+" name, ACTION_MASK_ALL, flag, AV_ADD_STRING, index }, \
106 { "-" name, ~flag, 0, AV_REM_STRING, index },
107 #define DEFINE_ACTION_BOOL(name,flag) \
108 { "+" name, ACTION_MASK_ALL, flag }, \
109 { "-" name, ~flag, 0 },
110 #define DEFINE_ACTION_ALIAS 1 /* Want aliases please */
112 #include "actionlist.h"
114 #undef DEFINE_ACTION_MULTI
115 #undef DEFINE_ACTION_STRING
116 #undef DEFINE_ACTION_BOOL
117 #undef DEFINE_ACTION_ALIAS
119 { NULL, 0, 0 } /* End marker */
126 int load_one_actions_file(struct client_state *csp, int fileid);
129 /*********************************************************************
131 * Function : merge_actions
133 * Description : Merge two actions together.
134 * Similar to "dest += src".
137 * 1 : dest = Actions to modify.
138 * 2 : src = Action to add.
140 * Returns : JB_ERR_OK or JB_ERR_MEMORY
142 *********************************************************************/
143 jb_err merge_actions (struct action_spec *dest,
144 const struct action_spec *src)
149 dest->mask &= src->mask;
150 dest->add &= src->mask;
151 dest->add |= src->add;
153 for (i = 0; i < ACTION_STRING_COUNT; i++)
155 char * str = src->string[i];
158 freez(dest->string[i]);
159 dest->string[i] = strdup_or_die(str);
163 for (i = 0; i < ACTION_MULTI_COUNT; i++)
165 if (src->multi_remove_all[i])
167 /* Remove everything from dest */
168 list_remove_all(dest->multi_remove[i]);
169 dest->multi_remove_all[i] = 1;
171 err = list_duplicate(dest->multi_add[i], src->multi_add[i]);
173 else if (dest->multi_remove_all[i])
176 * dest already removes everything, so we only need to worry
179 list_remove_list(dest->multi_add[i], src->multi_remove[i]);
180 err = list_append_list_unique(dest->multi_add[i], src->multi_add[i]);
184 /* No "remove all"s to worry about. */
185 list_remove_list(dest->multi_add[i], src->multi_remove[i]);
186 err = list_append_list_unique(dest->multi_remove[i], src->multi_remove[i]);
187 if (!err) err = list_append_list_unique(dest->multi_add[i], src->multi_add[i]);
200 /*********************************************************************
202 * Function : copy_action
204 * Description : Copy an action_specs.
205 * Similar to "dest = src".
208 * 1 : dest = Destination of copy.
209 * 2 : src = Source for copy.
211 * Returns : JB_ERR_OK or JB_ERR_MEMORY
213 *********************************************************************/
214 jb_err copy_action (struct action_spec *dest,
215 const struct action_spec *src)
218 jb_err err = JB_ERR_OK;
221 memset(dest, '\0', sizeof(*dest));
223 dest->mask = src->mask;
224 dest->add = src->add;
226 for (i = 0; i < ACTION_STRING_COUNT; i++)
228 char * str = src->string[i];
231 str = strdup_or_die(str);
232 dest->string[i] = str;
236 for (i = 0; i < ACTION_MULTI_COUNT; i++)
238 dest->multi_remove_all[i] = src->multi_remove_all[i];
239 err = list_duplicate(dest->multi_remove[i], src->multi_remove[i]);
244 err = list_duplicate(dest->multi_add[i], src->multi_add[i]);
253 /*********************************************************************
255 * Function : free_action_spec
257 * Description : Frees an action_spec and the memory used by it.
260 * 1 : src = Source to free.
264 *********************************************************************/
265 void free_action_spec(struct action_spec *src)
272 /*********************************************************************
274 * Function : free_action
276 * Description : Destroy an action_spec. Frees memory used by it,
277 * except for the memory used by the struct action_spec
281 * 1 : src = Source to free.
285 *********************************************************************/
286 void free_action (struct action_spec *src)
295 for (i = 0; i < ACTION_STRING_COUNT; i++)
297 freez(src->string[i]);
300 for (i = 0; i < ACTION_MULTI_COUNT; i++)
302 destroy_list(src->multi_remove[i]);
303 destroy_list(src->multi_add[i]);
306 memset(src, '\0', sizeof(*src));
310 /*********************************************************************
312 * Function : get_action_token
314 * Description : Parses a line for the first action.
315 * Modifies its input array, doesn't allocate memory.
317 * *line=" +abc{def} -ghi "
324 * 1 : line = [in] The line containing the action.
325 * [out] Start of next action on line, or
326 * NULL if we reached the end of line before
327 * we found an action.
328 * 2 : name = [out] Start of action name, null
329 * terminated. NULL on EOL
330 * 3 : value = [out] Start of action value, null
331 * terminated. NULL if none or EOL.
333 * Returns : JB_ERR_OK => Ok
334 * JB_ERR_PARSE => Mismatched {} (line was trashed anyway)
336 *********************************************************************/
337 jb_err get_action_token(char **line, char **name, char **value)
342 /* set default returns */
347 /* Eat any leading whitespace */
348 while ((*str == ' ') || (*str == '\t'))
360 /* null name, just value is prohibited */
367 while (((ch = *str) != '\0') &&
368 (ch != ' ') && (ch != '\t') && (ch != '{'))
372 /* error, '}' without '{' */
384 /* EOL - be careful not to run off buffer */
389 /* More to parse next time. */
398 /* The value ends with the first non-escaped closing curly brace */
399 while ((str = strchr(str, '}')) != NULL)
403 /* Overwrite the '\' so the action doesn't see it. */
404 string_move(str-1, str);
425 /*********************************************************************
427 * Function : action_used_to_be_valid
429 * Description : Checks if unrecognized actions were valid in earlier
433 * 1 : action = The string containing the action to check.
435 * Returns : True if yes, otherwise false.
437 *********************************************************************/
438 static int action_used_to_be_valid(const char *action)
440 static const char * const formerly_valid_actions[] = {
443 "send-vanilla-wafer",
445 "treat-forbidden-connects-like-blocks",
451 for (i = 0; i < SZ(formerly_valid_actions); i++)
453 if (0 == strcmpic(action, formerly_valid_actions[i]))
462 /*********************************************************************
464 * Function : get_actions
466 * Description : Parses a list of actions.
469 * 1 : line = The string containing the actions.
470 * Will be written to by this function.
471 * 2 : alias_list = Custom alias list, or NULL for none.
472 * 3 : cur_action = Where to store the action. Caller
475 * Returns : JB_ERR_OK => Ok
476 * JB_ERR_PARSE => Parse error (line was trashed anyway)
477 * nonzero => Out of memory (line was trashed anyway)
479 *********************************************************************/
480 jb_err get_actions(char *line,
481 struct action_alias * alias_list,
482 struct action_spec *cur_action)
485 init_action(cur_action);
486 cur_action->mask = ACTION_MASK_ALL;
490 char * option = NULL;
493 err = get_action_token(&line, &option, &value);
501 /* handle option in 'option' */
503 /* Check for standard action name */
504 const struct action_name * action = action_names;
506 while ((action->name != NULL) && (0 != strcmpic(action->name, option)))
510 if (action->name != NULL)
513 cur_action->mask &= action->mask;
514 cur_action->add &= action->mask;
515 cur_action->add |= action->add;
517 switch (action->value_type)
522 log_error(LOG_LEVEL_ERROR,
523 "Action %s does not take parameters but %s was given.",
524 action->name, value);
530 /* add single string. */
532 if ((value == NULL) || (*value == '\0'))
534 if (0 == strcmpic(action->name, "+block"))
537 * XXX: Temporary backwards compatibility hack.
538 * XXX: should include line number.
540 value = "No reason specified.";
541 log_error(LOG_LEVEL_ERROR,
542 "block action without reason found. This may "
543 "become a fatal error in future versions.");
550 /* FIXME: should validate option string here */
551 freez (cur_action->string[action->index]);
552 cur_action->string[action->index] = strdup(value);
553 if (NULL == cur_action->string[action->index])
555 return JB_ERR_MEMORY;
561 /* remove single string. */
563 freez (cur_action->string[action->index]);
568 /* append multi string. */
570 struct list * remove_p = cur_action->multi_remove[action->index];
571 struct list * add_p = cur_action->multi_add[action->index];
573 if ((value == NULL) || (*value == '\0'))
578 list_remove_item(remove_p, value);
579 err = enlist_unique(add_p, value, 0);
588 /* remove multi string. */
590 struct list * remove_p = cur_action->multi_remove[action->index];
591 struct list * add_p = cur_action->multi_add[action->index];
593 if ((value == NULL) || (*value == '\0')
594 || ((*value == '*') && (value[1] == '\0')))
597 * no option, or option == "*".
601 list_remove_all(remove_p);
602 list_remove_all(add_p);
603 cur_action->multi_remove_all[action->index] = 1;
607 /* Valid option - remove only 1 option */
609 if (!cur_action->multi_remove_all[action->index])
611 /* there isn't a catch-all in the remove list already */
612 err = enlist_unique(remove_p, value, 0);
618 list_remove_item(add_p, value);
623 /* Shouldn't get here unless there's memory corruption. */
630 /* try user aliases. */
631 const struct action_alias * alias = alias_list;
633 while ((alias != NULL) && (0 != strcmpic(alias->name, option)))
640 merge_actions(cur_action, alias->action);
642 else if (((size_t)2 < strlen(option)) && action_used_to_be_valid(option+1))
644 log_error(LOG_LEVEL_ERROR, "Action '%s' is no longer valid "
645 "in this Privoxy release. Ignored.", option+1);
647 else if (((size_t)2 < strlen(option)) && 0 == strcmpic(option+1, "hide-forwarded-for-headers"))
649 log_error(LOG_LEVEL_FATAL, "The action 'hide-forwarded-for-headers' "
650 "is no longer valid in this Privoxy release. "
651 "Use 'change-x-forwarded-for' instead.");
655 /* Bad action name */
657 * XXX: This is a fatal error and Privoxy will later on exit
658 * in load_one_actions_file() because of an "invalid line".
660 * It would be preferable to name the offending option in that
661 * error message, but currently there is no way to do that and
662 * we have to live with two error messages for basically the
665 log_error(LOG_LEVEL_ERROR, "Unknown action or alias: %s", option);
676 /*********************************************************************
678 * Function : init_current_action
680 * Description : Zero out an action.
683 * 1 : dest = An uninitialized current_action_spec.
687 *********************************************************************/
688 void init_current_action (struct current_action_spec *dest)
690 memset(dest, '\0', sizeof(*dest));
692 dest->flags = ACTION_MOST_COMPATIBLE;
696 /*********************************************************************
698 * Function : init_action
700 * Description : Zero out an action.
703 * 1 : dest = An uninitialized action_spec.
707 *********************************************************************/
708 void init_action (struct action_spec *dest)
710 memset(dest, '\0', sizeof(*dest));
714 /*********************************************************************
716 * Function : merge_current_action
718 * Description : Merge two actions together.
719 * Similar to "dest += src".
720 * Differences between this and merge_actions()
721 * is that this one doesn't allocate memory for
722 * strings (so "src" better be in memory for at least
723 * as long as "dest" is, and you'd better free
724 * "dest" using "free_current_action").
725 * Also, there is no mask or remove lists in dest.
726 * (If we're applying it to a URL, we don't need them)
729 * 1 : dest = Current actions, to modify.
730 * 2 : src = Action to add.
732 * Returns 0 : no error
733 * !=0 : error, probably JB_ERR_MEMORY.
735 *********************************************************************/
736 jb_err merge_current_action (struct current_action_spec *dest,
737 const struct action_spec *src)
740 jb_err err = JB_ERR_OK;
742 dest->flags &= src->mask;
743 dest->flags |= src->add;
745 for (i = 0; i < ACTION_STRING_COUNT; i++)
747 char * str = src->string[i];
750 str = strdup_or_die(str);
751 freez(dest->string[i]);
752 dest->string[i] = str;
756 for (i = 0; i < ACTION_MULTI_COUNT; i++)
758 if (src->multi_remove_all[i])
760 /* Remove everything from dest, then add src->multi_add */
761 err = list_duplicate(dest->multi[i], src->multi_add[i]);
769 list_remove_list(dest->multi[i], src->multi_remove[i]);
770 err = list_append_list_unique(dest->multi[i], src->multi_add[i]);
781 /*********************************************************************
783 * Function : update_action_bits_for_tag
785 * Description : Updates the action bits based on the action sections
786 * whose tag patterns match a provided tag.
789 * 1 : csp = Current client state (buffers, headers, etc...)
790 * 2 : tag = The tag on which the update should be based on
792 * Returns : 0 if no tag matched, or
795 *********************************************************************/
796 int update_action_bits_for_tag(struct client_state *csp, const char *tag)
798 struct file_list *fl;
799 struct url_actions *b;
805 assert(list_contains_item(csp->tags, tag));
807 /* Run through all action files, */
808 for (i = 0; i < MAX_AF_FILES; i++)
810 if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
812 /* Skip empty files */
816 /* and through all the action patterns, */
817 for (b = b->next; NULL != b; b = b->next)
819 /* skip everything but TAG patterns, */
820 if (!(b->url->flags & PATTERN_SPEC_TAG_PATTERN))
825 /* and check if one of the tag patterns matches the tag, */
826 if (0 == regexec(b->url->pattern.tag_regex, tag, 0, NULL, 0))
828 /* if it does, update the action bit map, */
829 if (merge_current_action(csp->action, b->action))
831 log_error(LOG_LEVEL_ERROR,
832 "Out of memory while changing action bits");
834 /* and signal the change. */
844 /*********************************************************************
846 * Function : check_negative_tag_patterns
848 * Description : Updates the action bits based on NO-*-TAG patterns.
851 * 1 : csp = Current client state (buffers, headers, etc...)
852 * 2 : flag = The tag pattern type
854 * Returns : JB_ERR_OK in case off success, or
855 * JB_ERR_MEMORY on out-of-memory error.
857 *********************************************************************/
858 jb_err check_negative_tag_patterns(struct client_state *csp, unsigned int flag)
860 struct list_entry *tag;
861 struct file_list *fl;
862 struct url_actions *b = NULL;
865 for (i = 0; i < MAX_AF_FILES; i++)
867 fl = csp->actions_list[i];
868 if ((fl == NULL) || ((b = fl->f) == NULL))
872 for (b = b->next; NULL != b; b = b->next)
875 if (0 == (b->url->flags & flag))
879 for (tag = csp->tags->first; NULL != tag; tag = tag->next)
881 if (0 == regexec(b->url->pattern.tag_regex, tag->str, 0, NULL, 0))
884 * The pattern matches at least one tag, thus the action
885 * section doesn't apply and we don't need to look at the
895 * The pattern doesn't match any tags,
896 * thus the action section applies.
898 if (merge_current_action(csp->action, b->action))
900 log_error(LOG_LEVEL_ERROR,
901 "Out of memory while changing action bits");
902 return JB_ERR_MEMORY;
904 log_error(LOG_LEVEL_HEADER, "Updated action bits based on: %s",
914 /*********************************************************************
916 * Function : free_current_action
918 * Description : Free memory used by a current_action_spec.
919 * Does not free the current_action_spec itself.
922 * 1 : src = Source to free.
926 *********************************************************************/
927 void free_current_action(struct current_action_spec *src)
931 for (i = 0; i < ACTION_STRING_COUNT; i++)
933 freez(src->string[i]);
936 for (i = 0; i < ACTION_MULTI_COUNT; i++)
938 destroy_list(src->multi[i]);
941 memset(src, '\0', sizeof(*src));
945 static struct file_list *current_actions_file[MAX_AF_FILES] = {
946 NULL, NULL, NULL, NULL, NULL,
947 NULL, NULL, NULL, NULL, NULL
951 #ifdef FEATURE_GRACEFUL_TERMINATION
952 /*********************************************************************
954 * Function : unload_current_actions_file
956 * Description : Unloads current actions file - reset to state at
957 * beginning of program.
963 *********************************************************************/
964 void unload_current_actions_file(void)
968 for (i = 0; i < MAX_AF_FILES; i++)
970 if (current_actions_file[i])
972 current_actions_file[i]->unloader = unload_actions_file;
973 current_actions_file[i] = NULL;
977 #endif /* FEATURE_GRACEFUL_TERMINATION */
980 /*********************************************************************
982 * Function : unload_actions_file
984 * Description : Unloads an actions module.
987 * 1 : file_data = the data structure associated with the
992 *********************************************************************/
993 void unload_actions_file(void *file_data)
995 struct url_actions * next;
996 struct url_actions * cur = (struct url_actions *)file_data;
1000 free_pattern_spec(cur->url);
1001 if ((next == NULL) || (next->action != cur->action))
1004 * As the action settings might be shared,
1005 * we can only free them if the current
1006 * url pattern is the last one, or if the
1007 * next one is using different settings.
1009 free_action_spec(cur->action);
1017 /*********************************************************************
1019 * Function : free_alias_list
1021 * Description : Free memory used by a list of aliases.
1024 * 1 : alias_list = Linked list to free.
1028 *********************************************************************/
1029 void free_alias_list(struct action_alias *alias_list)
1031 while (alias_list != NULL)
1033 struct action_alias * next = alias_list->next;
1034 alias_list->next = NULL;
1035 freez(alias_list->name);
1036 free_action(alias_list->action);
1043 /*********************************************************************
1045 * Function : load_action_files
1047 * Description : Read and parse all the action files and add to files
1051 * 1 : csp = Current client state (buffers, headers, etc...)
1053 * Returns : 0 => Ok, everything else is an error.
1055 *********************************************************************/
1056 int load_action_files(struct client_state *csp)
1061 for (i = 0; i < MAX_AF_FILES; i++)
1063 if (csp->config->actions_file[i])
1065 result = load_one_actions_file(csp, i);
1071 else if (current_actions_file[i])
1073 current_actions_file[i]->unloader = unload_actions_file;
1074 current_actions_file[i] = NULL;
1082 /*********************************************************************
1084 * Function : filter_type_to_string
1086 * Description : Converts a filter type enum into a string.
1089 * 1 : filter_type = filter_type as enum
1091 * Returns : Pointer to static string.
1093 *********************************************************************/
1094 static const char *filter_type_to_string(enum filter_type filter_type)
1096 switch (filter_type)
1098 case FT_CONTENT_FILTER:
1099 return "content filter";
1100 case FT_CLIENT_HEADER_FILTER:
1101 return "client-header filter";
1102 case FT_SERVER_HEADER_FILTER:
1103 return "server-header filter";
1104 case FT_CLIENT_HEADER_TAGGER:
1105 return "client-header tagger";
1106 case FT_SERVER_HEADER_TAGGER:
1107 return "server-header tagger";
1108 #ifdef FEATURE_EXTERNAL_FILTERS
1109 case FT_EXTERNAL_CONTENT_FILTER:
1110 return "external content filter";
1112 case FT_INVALID_FILTER:
1113 return "invalid filter type";
1116 return "unknown filter type";
1120 /*********************************************************************
1122 * Function : referenced_filters_are_missing
1124 * Description : Checks if any filters of a certain type referenced
1125 * in an action spec are missing.
1128 * 1 : csp = Current client state (buffers, headers, etc...)
1129 * 2 : cur_action = The action spec to check.
1130 * 3 : multi_index = The index where to look for the filter.
1131 * 4 : filter_type = The filter type the caller is interested in.
1133 * Returns : 0 => All referenced filters exist, everything else is an error.
1135 *********************************************************************/
1136 static int referenced_filters_are_missing(const struct client_state *csp,
1137 const struct action_spec *cur_action, int multi_index, enum filter_type filter_type)
1139 struct list_entry *filtername;
1141 for (filtername = cur_action->multi_add[multi_index]->first;
1142 filtername; filtername = filtername->next)
1144 if (NULL == get_filter(csp, filtername->str, filter_type))
1146 log_error(LOG_LEVEL_ERROR, "Missing %s '%s'",
1147 filter_type_to_string(filter_type), filtername->str);
1157 /*********************************************************************
1159 * Function : action_spec_is_valid
1161 * Description : Should eventually figure out if an action spec
1162 * is valid, but currently only checks that the
1163 * referenced filters are accounted for.
1166 * 1 : csp = Current client state (buffers, headers, etc...)
1167 * 2 : cur_action = The action spec to check.
1169 * Returns : 0 => No problems detected, everything else is an error.
1171 *********************************************************************/
1172 static int action_spec_is_valid(struct client_state *csp, const struct action_spec *cur_action)
1176 enum filter_type filter_type;
1178 {ACTION_MULTI_FILTER, FT_CONTENT_FILTER},
1179 {ACTION_MULTI_CLIENT_HEADER_FILTER, FT_CLIENT_HEADER_FILTER},
1180 {ACTION_MULTI_SERVER_HEADER_FILTER, FT_SERVER_HEADER_FILTER},
1181 {ACTION_MULTI_CLIENT_HEADER_TAGGER, FT_CLIENT_HEADER_TAGGER},
1182 {ACTION_MULTI_SERVER_HEADER_TAGGER, FT_SERVER_HEADER_TAGGER}
1187 for (i = 0; i < SZ(filter_map); i++)
1189 errors += referenced_filters_are_missing(csp, cur_action,
1190 filter_map[i].multi_index, filter_map[i].filter_type);
1198 /*********************************************************************
1200 * Function : load_one_actions_file
1202 * Description : Read and parse a action file and add to files
1206 * 1 : csp = Current client state (buffers, headers, etc...)
1207 * 2 : fileid = File index to load.
1209 * Returns : 0 => Ok, everything else is an error.
1211 *********************************************************************/
1215 int load_one_actions_file(struct client_state *csp, int fileid)
1220 * Note: Keep these in the order they occur in the file, they are
1221 * sometimes tested with <=
1224 MODE_START_OF_FILE = 1,
1226 MODE_DESCRIPTION = 3,
1232 struct url_actions *last_perm;
1233 struct url_actions *perm;
1235 struct file_list *fs;
1236 struct action_spec * cur_action = NULL;
1237 int cur_action_used = 0;
1238 struct action_alias * alias_list = NULL;
1239 unsigned long linenum = 0;
1240 mode = MODE_START_OF_FILE;
1242 if (!check_file_changed(current_actions_file[fileid], csp->config->actions_file[fileid], &fs))
1244 /* No need to load */
1245 csp->actions_list[fileid] = current_actions_file[fileid];
1250 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': %E. "
1251 "Note that beginning with Privoxy 3.0.7, actions files have to be specified "
1252 "with their complete file names.", csp->config->actions_file[fileid]);
1253 return 1; /* never get here */
1256 fs->f = last_perm = zalloc_or_die(sizeof(*last_perm));
1258 if ((fp = fopen(csp->config->actions_file[fileid], "r")) == NULL)
1260 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error opening file: %E",
1261 csp->config->actions_file[fileid]);
1262 return 1; /* never get here */
1265 log_error(LOG_LEVEL_INFO, "Loading actions file: %s", csp->config->actions_file[fileid]);
1267 while (read_config_line(fp, &linenum, &buf) != NULL)
1271 /* It's a header block */
1274 /* It's {{settings}} or {{alias}} */
1275 size_t len = strlen(buf);
1276 char * start = buf + 2;
1277 char * end = buf + len - 1;
1278 if ((len < (size_t)5) || (*end-- != '}') || (*end-- != '}'))
1282 log_error(LOG_LEVEL_FATAL,
1283 "can't load actions file '%s': invalid line (%lu): %s",
1284 csp->config->actions_file[fileid], linenum, buf);
1285 return 1; /* never get here */
1288 /* Trim leading and trailing whitespace. */
1296 log_error(LOG_LEVEL_FATAL,
1297 "can't load actions file '%s': invalid line (%lu): {{ }}",
1298 csp->config->actions_file[fileid], linenum);
1299 return 1; /* never get here */
1303 * An actionsfile can optionally contain the following blocks.
1304 * They *MUST* be in this order, to simplify processing:
1310 * ...free text, format TBD, but no line may start with a '{'...
1315 * The actual actions must be *after* these special blocks.
1316 * None of these special blocks may be repeated.
1319 if (0 == strcmpic(start, "settings"))
1321 /* it's a {{settings}} block */
1322 if (mode >= MODE_SETTINGS)
1324 /* {{settings}} must be first thing in file and must only
1328 log_error(LOG_LEVEL_FATAL,
1329 "can't load actions file '%s': line %lu: {{settings}} must only appear once, and it must be before anything else.",
1330 csp->config->actions_file[fileid], linenum);
1332 mode = MODE_SETTINGS;
1334 else if (0 == strcmpic(start, "description"))
1336 /* it's a {{description}} block */
1337 if (mode >= MODE_DESCRIPTION)
1339 /* {{description}} is a singleton and only {{settings}} may proceed it
1342 log_error(LOG_LEVEL_FATAL,
1343 "can't load actions file '%s': line %lu: {{description}} must only appear once, and only a {{settings}} block may be above it.",
1344 csp->config->actions_file[fileid], linenum);
1346 mode = MODE_DESCRIPTION;
1348 else if (0 == strcmpic(start, "alias"))
1350 /* it's an {{alias}} block */
1351 if (mode >= MODE_ALIAS)
1353 /* {{alias}} must be first thing in file, possibly after
1354 * {{settings}} and {{description}}
1356 * {{alias}} must only appear once.
1358 * Note that these are new restrictions introduced in
1359 * v2.9.10 in order to make actionsfile editing simpler.
1360 * (Otherwise, reordering actionsfile entries without
1361 * completely rewriting the file becomes non-trivial)
1364 log_error(LOG_LEVEL_FATAL,
1365 "can't load actions file '%s': line %lu: {{alias}} must only appear once, and it must be before all actions.",
1366 csp->config->actions_file[fileid], linenum);
1372 /* invalid {{something}} block */
1374 log_error(LOG_LEVEL_FATAL,
1375 "can't load actions file '%s': invalid line (%lu): {{%s}}",
1376 csp->config->actions_file[fileid], linenum, start);
1377 return 1; /* never get here */
1382 /* It's an actions block */
1388 mode = MODE_ACTIONS;
1390 /* free old action */
1393 if (!cur_action_used)
1395 free_action_spec(cur_action);
1399 cur_action_used = 0;
1400 cur_action = zalloc_or_die(sizeof(*cur_action));
1401 init_action(cur_action);
1404 * Copy the buffer before messing with it as we may need the
1405 * unmodified version in for the fatal error messages. Given
1406 * that this is not a common event, we could instead simply
1407 * read the line again.
1409 * buf + 1 to skip the leading '{'
1411 actions_buf = end = strdup_or_die(buf + 1);
1413 /* check we have a trailing } and then trim it */
1414 if (strlen(actions_buf))
1416 end += strlen(actions_buf) - 1;
1423 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1424 "Missing trailing '}' in action section starting at line (%lu): %s",
1425 csp->config->actions_file[fileid], linenum, buf);
1426 return 1; /* never get here */
1430 /* trim any whitespace immediately inside {} */
1433 if (get_actions(actions_buf, alias_list, cur_action))
1438 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1439 "can't completely parse the action section starting at line (%lu): %s",
1440 csp->config->actions_file[fileid], linenum, buf);
1441 return 1; /* never get here */
1444 if (action_spec_is_valid(csp, cur_action))
1446 log_error(LOG_LEVEL_ERROR, "Invalid action section in file '%s', "
1447 "starting at line %lu: %s",
1448 csp->config->actions_file[fileid], linenum, buf);
1454 else if (mode == MODE_SETTINGS)
1457 * Part of the {{settings}} block.
1458 * For now only serves to check if the file's minimum Privoxy
1459 * version requirement is met, but we may want to read & check
1460 * permissions when we go multi-user.
1462 if (!strncmp(buf, "for-privoxy-version=", 20))
1464 char *version_string, *fields[3];
1467 version_string = strdup_or_die(buf + 20);
1469 num_fields = ssplit(version_string, ".", fields, SZ(fields));
1471 if (num_fields < 1 || atoi(fields[0]) == 0)
1473 log_error(LOG_LEVEL_ERROR,
1474 "While loading actions file '%s': invalid line (%lu): %s",
1475 csp->config->actions_file[fileid], linenum, buf);
1477 else if ( (atoi(fields[0]) > VERSION_MAJOR)
1478 || ((num_fields > 1) && (atoi(fields[1]) > VERSION_MINOR))
1479 || ((num_fields > 2) && (atoi(fields[2]) > VERSION_POINT)))
1482 log_error(LOG_LEVEL_FATAL,
1483 "Actions file '%s', line %lu requires newer Privoxy version: %s",
1484 csp->config->actions_file[fileid], linenum, buf);
1485 return 1; /* never get here */
1487 free(version_string);
1490 else if (mode == MODE_DESCRIPTION)
1493 * Part of the {{description}} block.
1497 else if (mode == MODE_ALIAS)
1502 char actions_buf[BUFFER_SIZE];
1503 struct action_alias * new_alias;
1505 char * start = strchr(buf, '=');
1508 if ((start == NULL) || (start == buf))
1510 log_error(LOG_LEVEL_FATAL,
1511 "can't load actions file '%s': invalid alias line (%lu): %s",
1512 csp->config->actions_file[fileid], linenum, buf);
1513 return 1; /* never get here */
1516 new_alias = zalloc_or_die(sizeof(*new_alias));
1518 /* Eat any the whitespace before the '=' */
1520 while ((*end == ' ') || (*end == '\t'))
1523 * we already know we must have at least 1 non-ws char
1524 * at start of buf - no need to check
1530 /* Eat any the whitespace after the '=' */
1532 while ((*start == ' ') || (*start == '\t'))
1538 log_error(LOG_LEVEL_FATAL,
1539 "can't load actions file '%s': invalid alias line (%lu): %s",
1540 csp->config->actions_file[fileid], linenum, buf);
1541 return 1; /* never get here */
1544 new_alias->name = strdup_or_die(buf);
1546 strlcpy(actions_buf, start, sizeof(actions_buf));
1548 if (get_actions(actions_buf, alias_list, new_alias->action))
1552 log_error(LOG_LEVEL_FATAL,
1553 "can't load actions file '%s': invalid alias line (%lu): %s = %s",
1554 csp->config->actions_file[fileid], linenum, buf, start);
1555 return 1; /* never get here */
1559 new_alias->next = alias_list;
1560 alias_list = new_alias;
1562 else if (mode == MODE_ACTIONS)
1564 /* it's an URL pattern */
1566 /* allocate a new node */
1567 perm = zalloc_or_die(sizeof(*perm));
1569 perm->action = cur_action;
1570 cur_action_used = 1;
1572 /* Save the URL pattern */
1573 if (create_pattern_spec(perm->url, buf))
1576 log_error(LOG_LEVEL_FATAL,
1577 "can't load actions file '%s': line %lu: cannot create URL or TAG pattern from: %s",
1578 csp->config->actions_file[fileid], linenum, buf);
1579 return 1; /* never get here */
1582 /* add it to the list */
1583 last_perm->next = perm;
1586 else if (mode == MODE_START_OF_FILE)
1588 /* oops - please have a {} line as 1st line in file. */
1590 log_error(LOG_LEVEL_FATAL,
1591 "can't load actions file '%s': line %lu should begin with a '{': %s",
1592 csp->config->actions_file[fileid], linenum, buf);
1593 return 1; /* never get here */
1597 /* How did we get here? This is impossible! */
1599 log_error(LOG_LEVEL_FATAL,
1600 "can't load actions file '%s': INTERNAL ERROR - mode = %d",
1601 csp->config->actions_file[fileid], mode);
1602 return 1; /* never get here */
1609 if (!cur_action_used)
1611 free_action_spec(cur_action);
1613 free_alias_list(alias_list);
1615 /* the old one is now obsolete */
1616 if (current_actions_file[fileid])
1618 current_actions_file[fileid]->unloader = unload_actions_file;
1621 fs->next = files->next;
1623 current_actions_file[fileid] = fs;
1625 csp->actions_list[fileid] = fs;
1632 /*********************************************************************
1634 * Function : actions_to_text
1636 * Description : Converts a actionsfile entry from the internal
1637 * structure into a text line. The output is split
1638 * into one line for each action with line continuation.
1641 * 1 : action = The action to format.
1643 * Returns : A string. Caller must free it.
1644 * NULL on out-of-memory error.
1646 *********************************************************************/
1647 char * actions_to_text(const struct action_spec *action)
1649 unsigned long mask = action->mask;
1650 unsigned long add = action->add;
1651 char *result = strdup_or_die("");
1652 struct list_entry * lst;
1654 /* sanity - prevents "-feature +feature" */
1658 #define DEFINE_ACTION_BOOL(__name, __bit) \
1659 if (!(mask & __bit)) \
1661 string_append(&result, " -" __name " \\\n"); \
1663 else if (add & __bit) \
1665 string_append(&result, " +" __name " \\\n"); \
1668 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1669 if (!(mask & __bit)) \
1671 string_append(&result, " -" __name " \\\n"); \
1673 else if (add & __bit) \
1675 string_append(&result, " +" __name "{"); \
1676 string_append(&result, action->string[__index]); \
1677 string_append(&result, "} \\\n"); \
1680 #define DEFINE_ACTION_MULTI(__name, __index) \
1681 if (action->multi_remove_all[__index]) \
1683 string_append(&result, " -" __name " \\\n"); \
1687 lst = action->multi_remove[__index]->first; \
1690 string_append(&result, " -" __name "{"); \
1691 string_append(&result, lst->str); \
1692 string_append(&result, "} \\\n"); \
1696 lst = action->multi_add[__index]->first; \
1699 string_append(&result, " +" __name "{"); \
1700 string_append(&result, lst->str); \
1701 string_append(&result, "} \\\n"); \
1705 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1707 #include "actionlist.h"
1709 #undef DEFINE_ACTION_MULTI
1710 #undef DEFINE_ACTION_STRING
1711 #undef DEFINE_ACTION_BOOL
1712 #undef DEFINE_ACTION_ALIAS
1718 /*********************************************************************
1720 * Function : actions_to_html
1722 * Description : Converts a actionsfile entry from numeric form
1723 * ("mask" and "add") to a <br>-separated HTML string
1724 * in which each action is linked to its chapter in
1728 * 1 : csp = Client state (for config)
1729 * 2 : action = Action spec to be converted
1731 * Returns : A string. Caller must free it.
1732 * NULL on out-of-memory error.
1734 *********************************************************************/
1735 char * actions_to_html(const struct client_state *csp,
1736 const struct action_spec *action)
1738 unsigned long mask = action->mask;
1739 unsigned long add = action->add;
1740 char *result = strdup_or_die("");
1741 struct list_entry * lst;
1743 /* sanity - prevents "-feature +feature" */
1747 #define DEFINE_ACTION_BOOL(__name, __bit) \
1748 if (!(mask & __bit)) \
1750 string_append(&result, "\n<br>-"); \
1751 string_join(&result, add_help_link(__name, csp->config)); \
1753 else if (add & __bit) \
1755 string_append(&result, "\n<br>+"); \
1756 string_join(&result, add_help_link(__name, csp->config)); \
1759 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1760 if (!(mask & __bit)) \
1762 string_append(&result, "\n<br>-"); \
1763 string_join(&result, add_help_link(__name, csp->config)); \
1765 else if (add & __bit) \
1767 string_append(&result, "\n<br>+"); \
1768 string_join(&result, add_help_link(__name, csp->config)); \
1769 string_append(&result, "{"); \
1770 string_join(&result, html_encode(action->string[__index])); \
1771 string_append(&result, "}"); \
1774 #define DEFINE_ACTION_MULTI(__name, __index) \
1775 if (action->multi_remove_all[__index]) \
1777 string_append(&result, "\n<br>-"); \
1778 string_join(&result, add_help_link(__name, csp->config)); \
1782 lst = action->multi_remove[__index]->first; \
1785 string_append(&result, "\n<br>-"); \
1786 string_join(&result, add_help_link(__name, csp->config)); \
1787 string_append(&result, "{"); \
1788 string_join(&result, html_encode(lst->str)); \
1789 string_append(&result, "}"); \
1793 lst = action->multi_add[__index]->first; \
1796 string_append(&result, "\n<br>+"); \
1797 string_join(&result, add_help_link(__name, csp->config)); \
1798 string_append(&result, "{"); \
1799 string_join(&result, html_encode(lst->str)); \
1800 string_append(&result, "}"); \
1804 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1806 #include "actionlist.h"
1808 #undef DEFINE_ACTION_MULTI
1809 #undef DEFINE_ACTION_STRING
1810 #undef DEFINE_ACTION_BOOL
1811 #undef DEFINE_ACTION_ALIAS
1813 /* trim leading <br> */
1814 if (result && *result)
1817 result = strdup(result + 5);
1825 /*********************************************************************
1827 * Function : current_actions_to_html
1829 * Description : Converts a curren action spec to a <br> separated HTML
1830 * text in which each action is linked to its chapter in
1834 * 1 : csp = Client state (for config)
1835 * 2 : action = Current action spec to be converted
1837 * Returns : A string. Caller must free it.
1838 * NULL on out-of-memory error.
1840 *********************************************************************/
1841 char *current_action_to_html(const struct client_state *csp,
1842 const struct current_action_spec *action)
1844 unsigned long flags = action->flags;
1845 struct list_entry * lst;
1846 char *result = strdup_or_die("");
1847 char *active = strdup_or_die("");
1848 char *inactive = strdup_or_die("");
1850 #define DEFINE_ACTION_BOOL(__name, __bit) \
1851 if (flags & __bit) \
1853 string_append(&active, "\n<br>+"); \
1854 string_join(&active, add_help_link(__name, csp->config)); \
1858 string_append(&inactive, "\n<br>-"); \
1859 string_join(&inactive, add_help_link(__name, csp->config)); \
1862 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1863 if (flags & __bit) \
1865 string_append(&active, "\n<br>+"); \
1866 string_join(&active, add_help_link(__name, csp->config)); \
1867 string_append(&active, "{"); \
1868 string_join(&active, html_encode(action->string[__index])); \
1869 string_append(&active, "}"); \
1873 string_append(&inactive, "\n<br>-"); \
1874 string_join(&inactive, add_help_link(__name, csp->config)); \
1877 #define DEFINE_ACTION_MULTI(__name, __index) \
1878 lst = action->multi[__index]->first; \
1881 string_append(&inactive, "\n<br>-"); \
1882 string_join(&inactive, add_help_link(__name, csp->config)); \
1888 string_append(&active, "\n<br>+"); \
1889 string_join(&active, add_help_link(__name, csp->config)); \
1890 string_append(&active, "{"); \
1891 string_join(&active, html_encode(lst->str)); \
1892 string_append(&active, "}"); \
1897 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1899 #include "actionlist.h"
1901 #undef DEFINE_ACTION_MULTI
1902 #undef DEFINE_ACTION_STRING
1903 #undef DEFINE_ACTION_BOOL
1904 #undef DEFINE_ACTION_ALIAS
1908 string_append(&result, active);
1911 string_append(&result, "\n<br>");
1912 if (inactive != NULL)
1914 string_append(&result, inactive);
1921 /*********************************************************************
1923 * Function : action_to_line_of_text
1925 * Description : Converts a action spec to a single text line
1926 * listing the enabled actions.
1929 * 1 : action = Current action spec to be converted
1931 * Returns : A string. Caller must free it.
1932 * Out-of-memory errors are fatal.
1934 *********************************************************************/
1935 char *actions_to_line_of_text(const struct current_action_spec *action)
1938 struct list_entry *lst;
1940 const unsigned long flags = action->flags;
1942 active = strdup_or_die("");
1944 #define DEFINE_ACTION_BOOL(__name, __bit) \
1945 if (flags & __bit) \
1947 snprintf(buffer, sizeof(buffer), "+%s ", __name); \
1948 string_append(&active, buffer); \
1951 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1952 if (flags & __bit) \
1954 snprintf(buffer, sizeof(buffer), "+%s{%s} ", \
1955 __name, action->string[__index]); \
1956 string_append(&active, buffer); \
1959 #define DEFINE_ACTION_MULTI(__name, __index) \
1960 lst = action->multi[__index]->first; \
1961 while (lst != NULL) \
1963 snprintf(buffer, sizeof(buffer), "+%s{%s} ", \
1964 __name, lst->str); \
1965 string_append(&active, buffer); \
1969 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1971 #include "actionlist.h"
1973 #undef DEFINE_ACTION_MULTI
1974 #undef DEFINE_ACTION_STRING
1975 #undef DEFINE_ACTION_BOOL
1976 #undef DEFINE_ACTION_ALIAS
1980 log_error(LOG_LEVEL_FATAL, "Out of memory in action_to_line_of_text()");