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. https://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 #ifdef FEATURE_EXTENDED_STATISTICS
551 if (0 == strcmpic(action->name, "+block"))
553 register_block_reason_for_statistics(value);
556 /* FIXME: should validate option string here */
557 freez (cur_action->string[action->index]);
558 cur_action->string[action->index] = strdup(value);
559 if (NULL == cur_action->string[action->index])
561 return JB_ERR_MEMORY;
567 /* remove single string. */
569 freez (cur_action->string[action->index]);
574 /* append multi string. */
576 struct list * remove_p = cur_action->multi_remove[action->index];
577 struct list * add_p = cur_action->multi_add[action->index];
579 if ((value == NULL) || (*value == '\0'))
584 list_remove_item(remove_p, value);
585 err = enlist_unique(add_p, value, 0);
594 /* remove multi string. */
596 struct list * remove_p = cur_action->multi_remove[action->index];
597 struct list * add_p = cur_action->multi_add[action->index];
599 if ((value == NULL) || (*value == '\0')
600 || ((*value == '*') && (value[1] == '\0')))
603 * no option, or option == "*".
607 list_remove_all(remove_p);
608 list_remove_all(add_p);
609 cur_action->multi_remove_all[action->index] = 1;
613 /* Valid option - remove only 1 option */
615 if (!cur_action->multi_remove_all[action->index])
617 /* there isn't a catch-all in the remove list already */
618 err = enlist_unique(remove_p, value, 0);
624 list_remove_item(add_p, value);
629 /* Shouldn't get here unless there's memory corruption. */
636 /* try user aliases. */
637 const struct action_alias * alias = alias_list;
639 while ((alias != NULL) && (0 != strcmpic(alias->name, option)))
646 merge_actions(cur_action, alias->action);
648 else if (((size_t)2 < strlen(option)) && action_used_to_be_valid(option+1))
650 log_error(LOG_LEVEL_ERROR, "Action '%s' is no longer valid "
651 "in this Privoxy release. Ignored.", option+1);
653 else if (((size_t)2 < strlen(option)) && 0 == strcmpic(option+1, "hide-forwarded-for-headers"))
655 log_error(LOG_LEVEL_FATAL, "The action 'hide-forwarded-for-headers' "
656 "is no longer valid in this Privoxy release. "
657 "Use 'change-x-forwarded-for' instead.");
661 /* Bad action name */
663 * XXX: This is a fatal error and Privoxy will later on exit
664 * in load_one_actions_file() because of an "invalid line".
666 * It would be preferable to name the offending option in that
667 * error message, but currently there is no way to do that and
668 * we have to live with two error messages for basically the
671 log_error(LOG_LEVEL_ERROR, "Unknown action or alias: %s", option);
682 /*********************************************************************
684 * Function : init_current_action
686 * Description : Zero out an action.
689 * 1 : dest = An uninitialized current_action_spec.
693 *********************************************************************/
694 void init_current_action (struct current_action_spec *dest)
696 memset(dest, '\0', sizeof(*dest));
698 dest->flags = ACTION_MOST_COMPATIBLE;
702 /*********************************************************************
704 * Function : init_action
706 * Description : Zero out an action.
709 * 1 : dest = An uninitialized action_spec.
713 *********************************************************************/
714 void init_action (struct action_spec *dest)
716 memset(dest, '\0', sizeof(*dest));
720 /*********************************************************************
722 * Function : merge_current_action
724 * Description : Merge two actions together.
725 * Similar to "dest += src".
726 * Differences between this and merge_actions()
727 * is that this one doesn't allocate memory for
728 * strings (so "src" better be in memory for at least
729 * as long as "dest" is, and you'd better free
730 * "dest" using "free_current_action").
731 * Also, there is no mask or remove lists in dest.
732 * (If we're applying it to a URL, we don't need them)
735 * 1 : dest = Current actions, to modify.
736 * 2 : src = Action to add.
738 * Returns 0 : no error
739 * !=0 : error, probably JB_ERR_MEMORY.
741 *********************************************************************/
742 jb_err merge_current_action (struct current_action_spec *dest,
743 const struct action_spec *src)
746 jb_err err = JB_ERR_OK;
748 dest->flags &= src->mask;
749 dest->flags |= src->add;
751 for (i = 0; i < ACTION_STRING_COUNT; i++)
753 char * str = src->string[i];
756 str = strdup_or_die(str);
757 freez(dest->string[i]);
758 dest->string[i] = str;
762 for (i = 0; i < ACTION_MULTI_COUNT; i++)
764 if (src->multi_remove_all[i])
766 /* Remove everything from dest, then add src->multi_add */
767 err = list_duplicate(dest->multi[i], src->multi_add[i]);
775 list_remove_list(dest->multi[i], src->multi_remove[i]);
776 err = list_append_list_unique(dest->multi[i], src->multi_add[i]);
787 /*********************************************************************
789 * Function : update_action_bits_for_tag
791 * Description : Updates the action bits based on the action sections
792 * whose tag patterns match a provided tag.
795 * 1 : csp = Current client state (buffers, headers, etc...)
796 * 2 : tag = The tag on which the update should be based on
798 * Returns : 0 if no tag matched, or
801 *********************************************************************/
802 int update_action_bits_for_tag(struct client_state *csp, const char *tag)
804 struct file_list *fl;
805 struct url_actions *b;
811 assert(list_contains_item(csp->tags, tag));
813 /* Run through all action files, */
814 for (i = 0; i < MAX_AF_FILES; i++)
816 if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
818 /* Skip empty files */
822 /* and through all the action patterns, */
823 for (b = b->next; NULL != b; b = b->next)
825 /* skip everything but TAG patterns, */
826 if (!(b->url->flags & PATTERN_SPEC_TAG_PATTERN))
832 if (pcre2_pattern_matches(b->url->pattern.tag_regex, tag))
834 /* and check if one of the tag patterns matches the tag, */
835 if (0 == regexec(b->url->pattern.tag_regex, tag, 0, NULL, 0))
838 /* if it does, update the action bit map, */
839 if (merge_current_action(csp->action, b->action))
841 log_error(LOG_LEVEL_ERROR,
842 "Out of memory while changing action bits");
844 /* and signal the change. */
854 /*********************************************************************
856 * Function : check_negative_tag_patterns
858 * Description : Updates the action bits based on NO-*-TAG patterns.
861 * 1 : csp = Current client state (buffers, headers, etc...)
862 * 2 : flag = The tag pattern type
864 * Returns : JB_ERR_OK in case off success, or
865 * JB_ERR_MEMORY on out-of-memory error.
867 *********************************************************************/
868 jb_err check_negative_tag_patterns(struct client_state *csp, unsigned int flag)
870 struct list_entry *tag;
871 struct file_list *fl;
872 struct url_actions *b = NULL;
875 for (i = 0; i < MAX_AF_FILES; i++)
877 fl = csp->actions_list[i];
878 if ((fl == NULL) || ((b = fl->f) == NULL))
882 for (b = b->next; NULL != b; b = b->next)
885 if (0 == (b->url->flags & flag))
889 for (tag = csp->tags->first; NULL != tag; tag = tag->next)
892 if (pcre2_pattern_matches(b->url->pattern.tag_regex, tag->str))
894 if (0 == regexec(b->url->pattern.tag_regex, tag->str, 0, NULL, 0))
898 * The pattern matches at least one tag, thus the action
899 * section doesn't apply and we don't need to look at the
909 * The pattern doesn't match any tags,
910 * thus the action section applies.
912 if (merge_current_action(csp->action, b->action))
914 log_error(LOG_LEVEL_ERROR,
915 "Out of memory while changing action bits");
916 return JB_ERR_MEMORY;
918 log_error(LOG_LEVEL_HEADER, "Updated action bits based on: %s",
928 /*********************************************************************
930 * Function : free_current_action
932 * Description : Free memory used by a current_action_spec.
933 * Does not free the current_action_spec itself.
936 * 1 : src = Source to free.
940 *********************************************************************/
941 void free_current_action(struct current_action_spec *src)
945 for (i = 0; i < ACTION_STRING_COUNT; i++)
947 freez(src->string[i]);
950 for (i = 0; i < ACTION_MULTI_COUNT; i++)
952 destroy_list(src->multi[i]);
955 memset(src, '\0', sizeof(*src));
959 static struct file_list *current_actions_file[MAX_AF_FILES] = {
960 NULL, NULL, NULL, NULL, NULL,
961 NULL, NULL, NULL, NULL, NULL
965 #ifdef FEATURE_GRACEFUL_TERMINATION
966 /*********************************************************************
968 * Function : unload_current_actions_file
970 * Description : Unloads current actions file - reset to state at
971 * beginning of program.
977 *********************************************************************/
978 void unload_current_actions_file(void)
982 for (i = 0; i < MAX_AF_FILES; i++)
984 if (current_actions_file[i])
986 current_actions_file[i]->unloader = unload_actions_file;
987 current_actions_file[i] = NULL;
991 #endif /* FEATURE_GRACEFUL_TERMINATION */
994 /*********************************************************************
996 * Function : unload_actions_file
998 * Description : Unloads an actions module.
1001 * 1 : file_data = the data structure associated with the
1006 *********************************************************************/
1007 void unload_actions_file(void *file_data)
1009 struct url_actions * next;
1010 struct url_actions * cur = (struct url_actions *)file_data;
1014 free_pattern_spec(cur->url);
1015 if ((next == NULL) || (next->action != cur->action))
1018 * As the action settings might be shared,
1019 * we can only free them if the current
1020 * url pattern is the last one, or if the
1021 * next one is using different settings.
1023 free_action_spec(cur->action);
1031 /*********************************************************************
1033 * Function : free_alias_list
1035 * Description : Free memory used by a list of aliases.
1038 * 1 : alias_list = Linked list to free.
1042 *********************************************************************/
1043 void free_alias_list(struct action_alias *alias_list)
1045 while (alias_list != NULL)
1047 struct action_alias * next = alias_list->next;
1048 alias_list->next = NULL;
1049 freez(alias_list->name);
1050 free_action(alias_list->action);
1057 /*********************************************************************
1059 * Function : load_action_files
1061 * Description : Read and parse all the action files and add to files
1065 * 1 : csp = Current client state (buffers, headers, etc...)
1067 * Returns : 0 => Ok, everything else is an error.
1069 *********************************************************************/
1070 int load_action_files(struct client_state *csp)
1075 for (i = 0; i < MAX_AF_FILES; i++)
1077 if (csp->config->actions_file[i])
1079 result = load_one_actions_file(csp, i);
1085 else if (current_actions_file[i])
1087 current_actions_file[i]->unloader = unload_actions_file;
1088 current_actions_file[i] = NULL;
1096 /*********************************************************************
1098 * Function : filter_type_to_string
1100 * Description : Converts a filter type enum into a string.
1103 * 1 : filter_type = filter_type as enum
1105 * Returns : Pointer to static string.
1107 *********************************************************************/
1108 static const char *filter_type_to_string(enum filter_type filter_type)
1110 switch (filter_type)
1112 case FT_CONTENT_FILTER:
1113 return "content filter";
1114 case FT_CLIENT_HEADER_FILTER:
1115 return "client-header filter";
1116 case FT_SERVER_HEADER_FILTER:
1117 return "server-header filter";
1118 case FT_CLIENT_HEADER_TAGGER:
1119 return "client-header tagger";
1120 case FT_SERVER_HEADER_TAGGER:
1121 return "server-header tagger";
1122 case FT_SUPPRESS_TAG:
1123 return "suppress tag filter";
1124 case FT_CLIENT_BODY_FILTER:
1125 return "client body filter";
1126 case FT_CLIENT_BODY_TAGGER:
1127 return "client body tagger";
1129 return "add-header action";
1130 #ifdef FEATURE_EXTERNAL_FILTERS
1131 case FT_EXTERNAL_CONTENT_FILTER:
1132 return "external content filter";
1134 case FT_INVALID_FILTER:
1135 return "invalid filter type";
1138 return "unknown filter type";
1142 /*********************************************************************
1144 * Function : referenced_filters_are_missing
1146 * Description : Checks if any filters of a certain type referenced
1147 * in an action spec are missing.
1150 * 1 : csp = Current client state (buffers, headers, etc...)
1151 * 2 : cur_action = The action spec to check.
1152 * 3 : multi_index = The index where to look for the filter.
1153 * 4 : filter_type = The filter type the caller is interested in.
1155 * Returns : 0 => All referenced filters exist, everything else is an error.
1157 *********************************************************************/
1158 static int referenced_filters_are_missing(const struct client_state *csp,
1159 const struct action_spec *cur_action, int multi_index, enum filter_type filter_type)
1161 struct list_entry *filtername;
1163 for (filtername = cur_action->multi_add[multi_index]->first;
1164 filtername; filtername = filtername->next)
1166 if (NULL == get_filter(csp, filtername->str, filter_type))
1168 log_error(LOG_LEVEL_ERROR, "Missing %s '%s'",
1169 filter_type_to_string(filter_type), filtername->str);
1179 /*********************************************************************
1181 * Function : action_spec_is_valid
1183 * Description : Should eventually figure out if an action spec
1184 * is valid, but currently only checks that the
1185 * referenced filters are accounted for.
1188 * 1 : csp = Current client state (buffers, headers, etc...)
1189 * 2 : cur_action = The action spec to check.
1191 * Returns : 0 => No problems detected, everything else is an error.
1193 *********************************************************************/
1194 static int action_spec_is_valid(struct client_state *csp, const struct action_spec *cur_action)
1198 enum filter_type filter_type;
1200 {ACTION_MULTI_FILTER, FT_CONTENT_FILTER},
1201 {ACTION_MULTI_CLIENT_HEADER_FILTER, FT_CLIENT_HEADER_FILTER},
1202 {ACTION_MULTI_SERVER_HEADER_FILTER, FT_SERVER_HEADER_FILTER},
1203 {ACTION_MULTI_CLIENT_HEADER_TAGGER, FT_CLIENT_HEADER_TAGGER},
1204 {ACTION_MULTI_SERVER_HEADER_TAGGER, FT_SERVER_HEADER_TAGGER},
1205 {ACTION_MULTI_CLIENT_BODY_FILTER, FT_CLIENT_BODY_FILTER}
1210 for (i = 0; i < SZ(filter_map); i++)
1212 errors += referenced_filters_are_missing(csp, cur_action,
1213 filter_map[i].multi_index, filter_map[i].filter_type);
1221 /*********************************************************************
1223 * Function : load_one_actions_file
1225 * Description : Read and parse an action file and add to files
1229 * 1 : csp = Current client state (buffers, headers, etc...)
1230 * 2 : fileid = File index to load.
1232 * Returns : 0 => Ok, everything else is an error.
1234 *********************************************************************/
1238 int load_one_actions_file(struct client_state *csp, int fileid)
1243 * Note: Keep these in the order they occur in the file, they are
1244 * sometimes tested with <=
1247 MODE_START_OF_FILE = 1,
1249 MODE_DESCRIPTION = 3,
1255 struct url_actions *last_perm;
1256 struct url_actions *perm;
1258 struct file_list *fs;
1259 struct action_spec * cur_action = NULL;
1260 int cur_action_used = 0;
1261 struct action_alias * alias_list = NULL;
1262 unsigned long linenum = 0;
1263 mode = MODE_START_OF_FILE;
1265 if (!check_file_changed(current_actions_file[fileid], csp->config->actions_file[fileid], &fs))
1267 /* No need to load */
1268 csp->actions_list[fileid] = current_actions_file[fileid];
1273 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': %E. "
1274 "Note that beginning with Privoxy 3.0.7, actions files have to be specified "
1275 "with their complete file names.", csp->config->actions_file[fileid]);
1276 return 1; /* never get here */
1279 fs->f = last_perm = zalloc_or_die(sizeof(*last_perm));
1281 if ((fp = fopen(csp->config->actions_file[fileid], "r")) == NULL)
1283 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error opening file: %E",
1284 csp->config->actions_file[fileid]);
1285 return 1; /* never get here */
1288 log_error(LOG_LEVEL_INFO, "Loading actions file: %s", csp->config->actions_file[fileid]);
1290 while (read_config_line(fp, &linenum, &buf) != NULL)
1294 /* It's a header block */
1297 /* It's {{settings}} or {{alias}} */
1298 size_t len = strlen(buf);
1299 char * start = buf + 2;
1300 char * end = buf + len - 1;
1301 if ((len < (size_t)5) || (*end-- != '}') || (*end-- != '}'))
1305 log_error(LOG_LEVEL_FATAL,
1306 "can't load actions file '%s': invalid line (%lu): %s",
1307 csp->config->actions_file[fileid], linenum, buf);
1308 return 1; /* never get here */
1311 /* Trim leading and trailing whitespace. */
1319 log_error(LOG_LEVEL_FATAL,
1320 "can't load actions file '%s': invalid line (%lu): {{ }}",
1321 csp->config->actions_file[fileid], linenum);
1322 return 1; /* never get here */
1326 * An actionsfile can optionally contain the following blocks.
1327 * They *MUST* be in this order, to simplify processing:
1333 * ...free text, format TBD, but no line may start with a '{'...
1338 * The actual actions must be *after* these special blocks.
1339 * None of these special blocks may be repeated.
1342 if (0 == strcmpic(start, "settings"))
1344 /* it's a {{settings}} block */
1345 if (mode >= MODE_SETTINGS)
1347 /* {{settings}} must be first thing in file and must only
1351 log_error(LOG_LEVEL_FATAL,
1352 "can't load actions file '%s': line %lu: {{settings}} must only appear once, and it must be before anything else.",
1353 csp->config->actions_file[fileid], linenum);
1355 mode = MODE_SETTINGS;
1357 else if (0 == strcmpic(start, "description"))
1359 /* it's a {{description}} block */
1360 if (mode >= MODE_DESCRIPTION)
1362 /* {{description}} is a singleton and only {{settings}} may proceed it
1365 log_error(LOG_LEVEL_FATAL,
1366 "can't load actions file '%s': line %lu: {{description}} must only appear once, and only a {{settings}} block may be above it.",
1367 csp->config->actions_file[fileid], linenum);
1369 mode = MODE_DESCRIPTION;
1371 else if (0 == strcmpic(start, "alias"))
1373 /* it's an {{alias}} block */
1374 if (mode >= MODE_ALIAS)
1376 /* {{alias}} must be first thing in file, possibly after
1377 * {{settings}} and {{description}}
1379 * {{alias}} must only appear once.
1381 * Note that these are new restrictions introduced in
1382 * v2.9.10 in order to make actionsfile editing simpler.
1383 * (Otherwise, reordering actionsfile entries without
1384 * completely rewriting the file becomes non-trivial)
1387 log_error(LOG_LEVEL_FATAL,
1388 "can't load actions file '%s': line %lu: {{alias}} must only appear once, and it must be before all actions.",
1389 csp->config->actions_file[fileid], linenum);
1395 /* invalid {{something}} block */
1397 log_error(LOG_LEVEL_FATAL,
1398 "can't load actions file '%s': invalid line (%lu): {{%s}}",
1399 csp->config->actions_file[fileid], linenum, start);
1400 return 1; /* never get here */
1405 /* It's an actions block */
1411 mode = MODE_ACTIONS;
1413 /* free old action */
1416 if (!cur_action_used)
1418 free_action_spec(cur_action);
1422 cur_action_used = 0;
1423 cur_action = zalloc_or_die(sizeof(*cur_action));
1424 init_action(cur_action);
1427 * Copy the buffer before messing with it as we may need the
1428 * unmodified version in for the fatal error messages. Given
1429 * that this is not a common event, we could instead simply
1430 * read the line again.
1432 * buf + 1 to skip the leading '{'
1434 actions_buf = end = strdup_or_die(buf + 1);
1436 /* check we have a trailing } and then trim it */
1437 if (strlen(actions_buf))
1439 end += strlen(actions_buf) - 1;
1446 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1447 "Missing trailing '}' in action section starting at line (%lu): %s",
1448 csp->config->actions_file[fileid], linenum, buf);
1449 return 1; /* never get here */
1453 /* trim any whitespace immediately inside {} */
1456 if (get_actions(actions_buf, alias_list, cur_action))
1461 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1462 "can't completely parse the action section starting at line (%lu): %s",
1463 csp->config->actions_file[fileid], linenum, buf);
1464 return 1; /* never get here */
1467 if (action_spec_is_valid(csp, cur_action))
1469 log_error(LOG_LEVEL_ERROR, "Invalid action section in file '%s', "
1470 "starting at line %lu: %s",
1471 csp->config->actions_file[fileid], linenum, buf);
1477 else if (mode == MODE_SETTINGS)
1480 * Part of the {{settings}} block.
1481 * For now only serves to check if the file's minimum Privoxy
1482 * version requirement is met, but we may want to read & check
1483 * permissions when we go multi-user.
1485 if (!strncmp(buf, "for-privoxy-version=", 20))
1487 char *version_string, *fields[3];
1490 version_string = strdup_or_die(buf + 20);
1492 num_fields = ssplit(version_string, ".", fields, SZ(fields));
1494 if (num_fields < 1 || atoi(fields[0]) == 0)
1496 log_error(LOG_LEVEL_ERROR,
1497 "While loading actions file '%s': invalid line (%lu): %s",
1498 csp->config->actions_file[fileid], linenum, buf);
1500 else if ( (atoi(fields[0]) > VERSION_MAJOR)
1501 || ((num_fields > 1) && (atoi(fields[1]) > VERSION_MINOR))
1502 || ((num_fields > 2) && (atoi(fields[2]) > VERSION_POINT)))
1505 log_error(LOG_LEVEL_FATAL,
1506 "Actions file '%s', line %lu requires newer Privoxy version: %s",
1507 csp->config->actions_file[fileid], linenum, buf);
1508 return 1; /* never get here */
1510 free(version_string);
1513 else if (mode == MODE_DESCRIPTION)
1516 * Part of the {{description}} block.
1520 else if (mode == MODE_ALIAS)
1525 char actions_buf[BUFFER_SIZE];
1526 struct action_alias * new_alias;
1528 char * start = strchr(buf, '=');
1531 if ((start == NULL) || (start == buf))
1533 log_error(LOG_LEVEL_FATAL,
1534 "can't load actions file '%s': invalid alias line (%lu): %s",
1535 csp->config->actions_file[fileid], linenum, buf);
1536 return 1; /* never get here */
1539 new_alias = zalloc_or_die(sizeof(*new_alias));
1541 /* Eat any the whitespace before the '=' */
1543 while ((*end == ' ') || (*end == '\t'))
1546 * we already know we must have at least 1 non-ws char
1547 * at start of buf - no need to check
1553 /* Eat any the whitespace after the '=' */
1555 while ((*start == ' ') || (*start == '\t'))
1561 log_error(LOG_LEVEL_FATAL,
1562 "can't load actions file '%s': invalid alias line (%lu): %s",
1563 csp->config->actions_file[fileid], linenum, buf);
1564 return 1; /* never get here */
1567 new_alias->name = strdup_or_die(buf);
1569 strlcpy(actions_buf, start, sizeof(actions_buf));
1571 if (get_actions(actions_buf, alias_list, new_alias->action))
1575 log_error(LOG_LEVEL_FATAL,
1576 "can't load actions file '%s': invalid alias line (%lu): %s = %s",
1577 csp->config->actions_file[fileid], linenum, buf, start);
1578 return 1; /* never get here */
1582 new_alias->next = alias_list;
1583 alias_list = new_alias;
1585 else if (mode == MODE_ACTIONS)
1587 /* it's an URL pattern */
1589 /* allocate a new node */
1590 perm = zalloc_or_die(sizeof(*perm));
1592 perm->action = cur_action;
1593 cur_action_used = 1;
1595 /* Save the URL pattern */
1596 if (create_pattern_spec(perm->url, buf))
1599 log_error(LOG_LEVEL_FATAL,
1600 "can't load actions file '%s': line %lu: cannot create URL or TAG pattern from: %s",
1601 csp->config->actions_file[fileid], linenum, buf);
1602 return 1; /* never get here */
1605 /* add it to the list */
1606 last_perm->next = perm;
1609 else if (mode == MODE_START_OF_FILE)
1611 /* oops - please have a {} line as 1st line in file. */
1613 log_error(LOG_LEVEL_FATAL,
1614 "can't load actions file '%s': line %lu should begin with a '{': %s",
1615 csp->config->actions_file[fileid], linenum, buf);
1616 return 1; /* never get here */
1620 /* How did we get here? This is impossible! */
1622 log_error(LOG_LEVEL_FATAL,
1623 "can't load actions file '%s': INTERNAL ERROR - mode = %d",
1624 csp->config->actions_file[fileid], mode);
1625 return 1; /* never get here */
1632 if (!cur_action_used)
1634 free_action_spec(cur_action);
1636 free_alias_list(alias_list);
1638 /* the old one is now obsolete */
1639 if (current_actions_file[fileid])
1641 current_actions_file[fileid]->unloader = unload_actions_file;
1644 fs->next = files->next;
1646 current_actions_file[fileid] = fs;
1648 csp->actions_list[fileid] = fs;
1655 /*********************************************************************
1657 * Function : actions_to_text
1659 * Description : Converts an actionsfile entry from the internal
1660 * structure into a text line. The output is split
1661 * into one line for each action with line continuation.
1664 * 1 : action = The action to format.
1666 * Returns : A string. Caller must free it.
1667 * NULL on out-of-memory error.
1669 *********************************************************************/
1670 char * actions_to_text(const struct action_spec *action)
1672 unsigned long mask = action->mask;
1673 unsigned long add = action->add;
1674 char *result = strdup_or_die("");
1675 struct list_entry * lst;
1677 /* sanity - prevents "-feature +feature" */
1681 #define DEFINE_ACTION_BOOL(__name, __bit) \
1682 if (!(mask & __bit)) \
1684 string_append(&result, " -" __name " \\\n"); \
1686 else if (add & __bit) \
1688 string_append(&result, " +" __name " \\\n"); \
1691 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1692 if (!(mask & __bit)) \
1694 string_append(&result, " -" __name " \\\n"); \
1696 else if (add & __bit) \
1698 string_append(&result, " +" __name "{"); \
1699 string_append(&result, action->string[__index]); \
1700 string_append(&result, "} \\\n"); \
1703 #define DEFINE_ACTION_MULTI(__name, __index) \
1704 if (action->multi_remove_all[__index]) \
1706 string_append(&result, " -" __name " \\\n"); \
1710 lst = action->multi_remove[__index]->first; \
1713 string_append(&result, " -" __name "{"); \
1714 string_append(&result, lst->str); \
1715 string_append(&result, "} \\\n"); \
1719 lst = action->multi_add[__index]->first; \
1722 string_append(&result, " +" __name "{"); \
1723 string_append(&result, lst->str); \
1724 string_append(&result, "} \\\n"); \
1728 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1730 #include "actionlist.h"
1732 #undef DEFINE_ACTION_MULTI
1733 #undef DEFINE_ACTION_STRING
1734 #undef DEFINE_ACTION_BOOL
1735 #undef DEFINE_ACTION_ALIAS
1741 /*********************************************************************
1743 * Function : actions_to_html
1745 * Description : Converts an actionsfile entry from numeric form
1746 * ("mask" and "add") to a <br>-separated HTML string
1747 * in which each action is linked to its chapter in
1751 * 1 : csp = Client state (for config)
1752 * 2 : action = Action spec to be converted
1754 * Returns : A string. Caller must free it.
1755 * NULL on out-of-memory error.
1757 *********************************************************************/
1758 char * actions_to_html(const struct client_state *csp,
1759 const struct action_spec *action)
1761 unsigned long mask = action->mask;
1762 unsigned long add = action->add;
1763 char *result = strdup_or_die("");
1764 struct list_entry * lst;
1766 /* sanity - prevents "-feature +feature" */
1770 #define DEFINE_ACTION_BOOL(__name, __bit) \
1771 if (!(mask & __bit)) \
1773 string_append(&result, "\n<br>-"); \
1774 string_join(&result, add_help_link(__name, csp->config)); \
1776 else if (add & __bit) \
1778 string_append(&result, "\n<br>+"); \
1779 string_join(&result, add_help_link(__name, csp->config)); \
1782 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1783 if (!(mask & __bit)) \
1785 string_append(&result, "\n<br>-"); \
1786 string_join(&result, add_help_link(__name, csp->config)); \
1788 else if (add & __bit) \
1790 string_append(&result, "\n<br>+"); \
1791 string_join(&result, add_help_link(__name, csp->config)); \
1792 string_append(&result, "{"); \
1793 string_join(&result, html_encode(action->string[__index])); \
1794 string_append(&result, "}"); \
1797 #define DEFINE_ACTION_MULTI(__name, __index) \
1798 if (action->multi_remove_all[__index]) \
1800 string_append(&result, "\n<br>-"); \
1801 string_join(&result, add_help_link(__name, csp->config)); \
1805 lst = action->multi_remove[__index]->first; \
1808 string_append(&result, "\n<br>-"); \
1809 string_join(&result, add_help_link(__name, csp->config)); \
1810 string_append(&result, "{"); \
1811 string_join(&result, html_encode(lst->str)); \
1812 string_append(&result, "}"); \
1816 lst = action->multi_add[__index]->first; \
1819 string_append(&result, "\n<br>+"); \
1820 string_join(&result, add_help_link(__name, csp->config)); \
1821 string_append(&result, "{"); \
1822 string_join(&result, html_encode(lst->str)); \
1823 string_append(&result, "}"); \
1827 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1829 #include "actionlist.h"
1831 #undef DEFINE_ACTION_MULTI
1832 #undef DEFINE_ACTION_STRING
1833 #undef DEFINE_ACTION_BOOL
1834 #undef DEFINE_ACTION_ALIAS
1836 /* trim leading <br> */
1837 if (result && *result)
1840 result = strdup(result + 5);
1848 /*********************************************************************
1850 * Function : current_actions_to_html
1852 * Description : Converts a current action spec to a <br> separated HTML
1853 * text in which each action is linked to its chapter in
1857 * 1 : csp = Client state (for config)
1858 * 2 : action = Current action spec to be converted
1860 * Returns : A string. Caller must free it.
1861 * NULL on out-of-memory error.
1863 *********************************************************************/
1864 char *current_action_to_html(const struct client_state *csp,
1865 const struct current_action_spec *action)
1867 unsigned long flags = action->flags;
1868 struct list_entry * lst;
1869 char *result = strdup_or_die("");
1870 char *active = strdup_or_die("");
1871 char *inactive = strdup_or_die("");
1873 #define DEFINE_ACTION_BOOL(__name, __bit) \
1874 if (flags & __bit) \
1876 string_append(&active, "\n<br>+"); \
1877 string_join(&active, add_help_link(__name, csp->config)); \
1881 string_append(&inactive, "\n<br>-"); \
1882 string_join(&inactive, add_help_link(__name, csp->config)); \
1885 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1886 if (flags & __bit) \
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(action->string[__index])); \
1892 string_append(&active, "}"); \
1896 string_append(&inactive, "\n<br>-"); \
1897 string_join(&inactive, add_help_link(__name, csp->config)); \
1900 #define DEFINE_ACTION_MULTI(__name, __index) \
1901 lst = action->multi[__index]->first; \
1904 string_append(&inactive, "\n<br>-"); \
1905 string_join(&inactive, add_help_link(__name, csp->config)); \
1911 string_append(&active, "\n<br>+"); \
1912 string_join(&active, add_help_link(__name, csp->config)); \
1913 string_append(&active, "{"); \
1914 string_join(&active, html_encode(lst->str)); \
1915 string_append(&active, "}"); \
1920 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1922 #include "actionlist.h"
1924 #undef DEFINE_ACTION_MULTI
1925 #undef DEFINE_ACTION_STRING
1926 #undef DEFINE_ACTION_BOOL
1927 #undef DEFINE_ACTION_ALIAS
1931 string_append(&result, active);
1934 string_append(&result, "\n<br>");
1935 if (inactive != NULL)
1937 string_append(&result, inactive);
1944 /*********************************************************************
1946 * Function : action_to_line_of_text
1948 * Description : Converts an action spec to a single text line
1949 * listing the enabled actions.
1952 * 1 : action = Current action spec to be converted
1954 * Returns : A string. Caller must free it.
1955 * Out-of-memory errors are fatal.
1957 *********************************************************************/
1958 char *actions_to_line_of_text(const struct current_action_spec *action)
1961 struct list_entry *lst;
1963 const unsigned long flags = action->flags;
1965 active = strdup_or_die("");
1967 #define DEFINE_ACTION_BOOL(__name, __bit) \
1968 if (flags & __bit) \
1970 snprintf(buffer, sizeof(buffer), "+%s ", __name); \
1971 string_append(&active, buffer); \
1974 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1975 if (flags & __bit) \
1977 snprintf(buffer, sizeof(buffer), "+%s{%s} ", \
1978 __name, action->string[__index]); \
1979 string_append(&active, buffer); \
1982 #define DEFINE_ACTION_MULTI(__name, __index) \
1983 lst = action->multi[__index]->first; \
1984 while (lst != NULL) \
1986 snprintf(buffer, sizeof(buffer), "+%s{%s} ", \
1987 __name, lst->str); \
1988 string_append(&active, buffer); \
1992 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1994 #include "actionlist.h"
1996 #undef DEFINE_ACTION_MULTI
1997 #undef DEFINE_ACTION_STRING
1998 #undef DEFINE_ACTION_BOOL
1999 #undef DEFINE_ACTION_ALIAS
2003 log_error(LOG_LEVEL_FATAL, "Out of memory in action_to_line_of_text()");