1 /*********************************************************************
2 *
3 * File : $Source: /cvsroot/ijbswa/current/actions.c,v $
4 *
5 * Purpose : Declares functions to work with actions files
6 *
7 * Copyright : Written by and Copyright (C) 2001-2016 the
8 * Privoxy team. https://www.privoxy.org/
9 *
10 * Based on the Internet Junkbuster originally written
11 * by and Copyright (C) 1997 Anonymous Coders and
12 * Junkbusters Corporation. http://www.junkbusters.com
13 *
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.
19 *
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.
25 *
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.
31 *
32 *********************************************************************/
33
34
35 #include "config.h"
36
37 #include <stdio.h>
38 #include <string.h>
39 #include <assert.h>
40 #include <stdlib.h>
41
42 #ifdef FEATURE_PTHREAD
43 #include <pthread.h>
44 #endif
45
46 #include "project.h"
47 #include "jcc.h"
48 #include "list.h"
49 #include "actions.h"
50 #include "miscutil.h"
51 #include "errlog.h"
52 #include "loaders.h"
53 #include "encode.h"
54 #include "urlmatch.h"
55 #include "cgi.h"
56 #include "ssplit.h"
57 #include "filters.h"
58
59 /*
60 * We need the main list of options.
61 *
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
67 * the values:
68 */
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 */
75 };
76
77 /*
78 * We need a structure to hold the name, flag changes,
79 * type, and string index.
80 */
81 struct action_name
82 {
83 const char * name;
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[] */
88 };
89
90 /*
91 * And with those building blocks in place, here's the array.
92 */
93 static const struct action_name action_names[] =
94 {
95 /*
96 * Well actually there's no data here - it's in actionlist.h
97 * This keeps it together to make it easy to change.
98 *
99 * Here's the macros used to format it:
100 */
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 */
111
112 #include "actionlist.h"
113
114 #undef DEFINE_ACTION_MULTI
115 #undef DEFINE_ACTION_STRING
116 #undef DEFINE_ACTION_BOOL
117 #undef DEFINE_ACTION_ALIAS
118
119 { NULL, 0, 0 } /* End marker */
120 };
121
122
123 #ifndef FUZZ
124 static
125 #endif
126 int load_one_actions_file(struct client_state *csp, int fileid);
127
128
129 /*********************************************************************
130 *
131 * Function : merge_actions
132 *
133 * Description : Merge two actions together.
134 * Similar to "dest += src".
135 *
136 * Parameters :
137 * 1 : dest = Actions to modify.
138 * 2 : src = Action to add.
139 *
140 * Returns : JB_ERR_OK or JB_ERR_MEMORY
141 *
142 *********************************************************************/
merge_actions(struct action_spec * dest,const struct action_spec * src)143 jb_err merge_actions (struct action_spec *dest,
144 const struct action_spec *src)
145 {
146 int i;
147 jb_err err;
148
149 dest->mask &= src->mask;
150 dest->add &= src->mask;
151 dest->add |= src->add;
152
153 for (i = 0; i < ACTION_STRING_COUNT; i++)
154 {
155 char * str = src->string[i];
156 if (str)
157 {
158 freez(dest->string[i]);
159 dest->string[i] = strdup_or_die(str);
160 }
161 }
162
163 for (i = 0; i < ACTION_MULTI_COUNT; i++)
164 {
165 if (src->multi_remove_all[i])
166 {
167 /* Remove everything from dest */
168 list_remove_all(dest->multi_remove[i]);
169 dest->multi_remove_all[i] = 1;
170
171 err = list_duplicate(dest->multi_add[i], src->multi_add[i]);
172 }
173 else if (dest->multi_remove_all[i])
174 {
175 /*
176 * dest already removes everything, so we only need to worry
177 * about what we add.
178 */
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]);
181 }
182 else
183 {
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]);
188 }
189
190 if (err)
191 {
192 return err;
193 }
194 }
195
196 return JB_ERR_OK;
197 }
198
199
200 /*********************************************************************
201 *
202 * Function : copy_action
203 *
204 * Description : Copy an action_specs.
205 * Similar to "dest = src".
206 *
207 * Parameters :
208 * 1 : dest = Destination of copy.
209 * 2 : src = Source for copy.
210 *
211 * Returns : JB_ERR_OK or JB_ERR_MEMORY
212 *
213 *********************************************************************/
copy_action(struct action_spec * dest,const struct action_spec * src)214 jb_err copy_action (struct action_spec *dest,
215 const struct action_spec *src)
216 {
217 int i;
218 jb_err err = JB_ERR_OK;
219
220 free_action(dest);
221 memset(dest, '\0', sizeof(*dest));
222
223 dest->mask = src->mask;
224 dest->add = src->add;
225
226 for (i = 0; i < ACTION_STRING_COUNT; i++)
227 {
228 char * str = src->string[i];
229 if (str)
230 {
231 str = strdup_or_die(str);
232 dest->string[i] = str;
233 }
234 }
235
236 for (i = 0; i < ACTION_MULTI_COUNT; i++)
237 {
238 dest->multi_remove_all[i] = src->multi_remove_all[i];
239 err = list_duplicate(dest->multi_remove[i], src->multi_remove[i]);
240 if (err)
241 {
242 return err;
243 }
244 err = list_duplicate(dest->multi_add[i], src->multi_add[i]);
245 if (err)
246 {
247 return err;
248 }
249 }
250 return err;
251 }
252
253 /*********************************************************************
254 *
255 * Function : free_action_spec
256 *
257 * Description : Frees an action_spec and the memory used by it.
258 *
259 * Parameters :
260 * 1 : src = Source to free.
261 *
262 * Returns : N/A
263 *
264 *********************************************************************/
free_action_spec(struct action_spec * src)265 void free_action_spec(struct action_spec *src)
266 {
267 free_action(src);
268 freez(src);
269 }
270
271
272 /*********************************************************************
273 *
274 * Function : free_action
275 *
276 * Description : Destroy an action_spec. Frees memory used by it,
277 * except for the memory used by the struct action_spec
278 * itself.
279 *
280 * Parameters :
281 * 1 : src = Source to free.
282 *
283 * Returns : N/A
284 *
285 *********************************************************************/
free_action(struct action_spec * src)286 void free_action (struct action_spec *src)
287 {
288 int i;
289
290 if (src == NULL)
291 {
292 return;
293 }
294
295 for (i = 0; i < ACTION_STRING_COUNT; i++)
296 {
297 freez(src->string[i]);
298 }
299
300 for (i = 0; i < ACTION_MULTI_COUNT; i++)
301 {
302 destroy_list(src->multi_remove[i]);
303 destroy_list(src->multi_add[i]);
304 }
305
306 memset(src, '\0', sizeof(*src));
307 }
308
309
310 /*********************************************************************
311 *
312 * Function : get_action_token
313 *
314 * Description : Parses a line for the first action.
315 * Modifies its input array, doesn't allocate memory.
316 * e.g. given:
317 * *line=" +abc{def} -ghi "
318 * Returns:
319 * *line=" -ghi "
320 * *name="+abc"
321 * *value="def"
322 *
323 * Parameters :
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.
332 *
333 * Returns : JB_ERR_OK => Ok
334 * JB_ERR_PARSE => Mismatched {} (line was trashed anyway)
335 *
336 *********************************************************************/
get_action_token(char ** line,char ** name,char ** value)337 jb_err get_action_token(char **line, char **name, char **value)
338 {
339 char * str = *line;
340 char ch;
341
342 /* set default returns */
343 *line = NULL;
344 *name = NULL;
345 *value = NULL;
346
347 /* Eat any leading whitespace */
348 while ((*str == ' ') || (*str == '\t'))
349 {
350 str++;
351 }
352
353 if (*str == '\0')
354 {
355 return 0;
356 }
357
358 if (*str == '{')
359 {
360 /* null name, just value is prohibited */
361 return JB_ERR_PARSE;
362 }
363
364 *name = str;
365
366 /* parse option */
367 while (((ch = *str) != '\0') &&
368 (ch != ' ') && (ch != '\t') && (ch != '{'))
369 {
370 if (ch == '}')
371 {
372 /* error, '}' without '{' */
373 return JB_ERR_PARSE;
374 }
375 str++;
376 }
377 *str = '\0';
378
379 if (ch != '{')
380 {
381 /* no value */
382 if (ch == '\0')
383 {
384 /* EOL - be careful not to run off buffer */
385 *line = str;
386 }
387 else
388 {
389 /* More to parse next time. */
390 *line = str + 1;
391 }
392 return JB_ERR_OK;
393 }
394
395 str++;
396 *value = str;
397
398 /* The value ends with the first non-escaped closing curly brace */
399 while ((str = strchr(str, '}')) != NULL)
400 {
401 if (str[-1] == '\\')
402 {
403 /* Overwrite the '\' so the action doesn't see it. */
404 string_move(str-1, str);
405 continue;
406 }
407 break;
408 }
409 if (str == NULL)
410 {
411 /* error */
412 *value = NULL;
413 return JB_ERR_PARSE;
414 }
415
416 /* got value */
417 *str = '\0';
418 *line = str + 1;
419
420 chomp(*value);
421
422 return JB_ERR_OK;
423 }
424
425 /*********************************************************************
426 *
427 * Function : action_used_to_be_valid
428 *
429 * Description : Checks if unrecognized actions were valid in earlier
430 * releases.
431 *
432 * Parameters :
433 * 1 : action = The string containing the action to check.
434 *
435 * Returns : True if yes, otherwise false.
436 *
437 *********************************************************************/
action_used_to_be_valid(const char * action)438 static int action_used_to_be_valid(const char *action)
439 {
440 static const char * const formerly_valid_actions[] = {
441 "inspect-jpegs",
442 "kill-popups",
443 "send-vanilla-wafer",
444 "send-wafer",
445 "treat-forbidden-connects-like-blocks",
446 "vanilla-wafer",
447 "wafer"
448 };
449 unsigned int i;
450
451 for (i = 0; i < SZ(formerly_valid_actions); i++)
452 {
453 if (0 == strcmpic(action, formerly_valid_actions[i]))
454 {
455 return TRUE;
456 }
457 }
458
459 return FALSE;
460 }
461
462 /*********************************************************************
463 *
464 * Function : get_actions
465 *
466 * Description : Parses a list of actions.
467 *
468 * Parameters :
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
473 * allocates memory.
474 *
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)
478 *
479 *********************************************************************/
get_actions(char * line,struct action_alias * alias_list,struct action_spec * cur_action)480 jb_err get_actions(char *line,
481 struct action_alias * alias_list,
482 struct action_spec *cur_action)
483 {
484 jb_err err;
485 init_action(cur_action);
486 cur_action->mask = ACTION_MASK_ALL;
487
488 while (line)
489 {
490 char * option = NULL;
491 char * value = NULL;
492
493 err = get_action_token(&line, &option, &value);
494 if (err)
495 {
496 return err;
497 }
498
499 if (option)
500 {
501 /* handle option in 'option' */
502
503 /* Check for standard action name */
504 const struct action_name * action = action_names;
505
506 while ((action->name != NULL) && (0 != strcmpic(action->name, option)))
507 {
508 action++;
509 }
510 if (action->name != NULL)
511 {
512 /* Found it */
513 cur_action->mask &= action->mask;
514 cur_action->add &= action->mask;
515 cur_action->add |= action->add;
516
517 switch (action->value_type)
518 {
519 case AV_NONE:
520 if (value != NULL)
521 {
522 log_error(LOG_LEVEL_ERROR,
523 "Action %s does not take parameters but %s was given.",
524 action->name, value);
525 return JB_ERR_PARSE;
526 }
527 break;
528 case AV_ADD_STRING:
529 {
530 /* add single string. */
531
532 if ((value == NULL) || (*value == '\0'))
533 {
534 if (0 == strcmpic(action->name, "+block"))
535 {
536 /*
537 * XXX: Temporary backwards compatibility hack.
538 * XXX: should include line number.
539 */
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.");
544 }
545 else
546 {
547 return JB_ERR_PARSE;
548 }
549 }
550 #ifdef FEATURE_EXTENDED_STATISTICS
551 if (0 == strcmpic(action->name, "+block"))
552 {
553 register_block_reason_for_statistics(value);
554 }
555 #endif
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])
560 {
561 return JB_ERR_MEMORY;
562 }
563 break;
564 }
565 case AV_REM_STRING:
566 {
567 /* remove single string. */
568
569 freez (cur_action->string[action->index]);
570 break;
571 }
572 case AV_ADD_MULTI:
573 {
574 /* append multi string. */
575
576 struct list * remove_p = cur_action->multi_remove[action->index];
577 struct list * add_p = cur_action->multi_add[action->index];
578
579 if ((value == NULL) || (*value == '\0'))
580 {
581 return JB_ERR_PARSE;
582 }
583
584 list_remove_item(remove_p, value);
585 err = enlist_unique(add_p, value, 0);
586 if (err)
587 {
588 return err;
589 }
590 break;
591 }
592 case AV_REM_MULTI:
593 {
594 /* remove multi string. */
595
596 struct list * remove_p = cur_action->multi_remove[action->index];
597 struct list * add_p = cur_action->multi_add[action->index];
598
599 if ((value == NULL) || (*value == '\0')
600 || ((*value == '*') && (value[1] == '\0')))
601 {
602 /*
603 * no option, or option == "*".
604 *
605 * Remove *ALL*.
606 */
607 list_remove_all(remove_p);
608 list_remove_all(add_p);
609 cur_action->multi_remove_all[action->index] = 1;
610 }
611 else
612 {
613 /* Valid option - remove only 1 option */
614
615 if (!cur_action->multi_remove_all[action->index])
616 {
617 /* there isn't a catch-all in the remove list already */
618 err = enlist_unique(remove_p, value, 0);
619 if (err)
620 {
621 return err;
622 }
623 }
624 list_remove_item(add_p, value);
625 }
626 break;
627 }
628 default:
629 /* Shouldn't get here unless there's memory corruption. */
630 assert(0);
631 return JB_ERR_PARSE;
632 }
633 }
634 else
635 {
636 /* try user aliases. */
637 const struct action_alias * alias = alias_list;
638
639 while ((alias != NULL) && (0 != strcmpic(alias->name, option)))
640 {
641 alias = alias->next;
642 }
643 if (alias != NULL)
644 {
645 /* Found it */
646 merge_actions(cur_action, alias->action);
647 }
648 else if (((size_t)2 < strlen(option)) && action_used_to_be_valid(option+1))
649 {
650 log_error(LOG_LEVEL_ERROR, "Action '%s' is no longer valid "
651 "in this Privoxy release. Ignored.", option+1);
652 }
653 else if (((size_t)2 < strlen(option)) && 0 == strcmpic(option+1, "hide-forwarded-for-headers"))
654 {
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.");
658 }
659 else
660 {
661 /* Bad action name */
662 /*
663 * XXX: This is a fatal error and Privoxy will later on exit
664 * in load_one_actions_file() because of an "invalid line".
665 *
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
669 * same reason.
670 */
671 log_error(LOG_LEVEL_ERROR, "Unknown action or alias: %s", option);
672 return JB_ERR_PARSE;
673 }
674 }
675 }
676 }
677
678 return JB_ERR_OK;
679 }
680
681
682 /*********************************************************************
683 *
684 * Function : init_current_action
685 *
686 * Description : Zero out an action.
687 *
688 * Parameters :
689 * 1 : dest = An uninitialized current_action_spec.
690 *
691 * Returns : N/A
692 *
693 *********************************************************************/
init_current_action(struct current_action_spec * dest)694 void init_current_action (struct current_action_spec *dest)
695 {
696 memset(dest, '\0', sizeof(*dest));
697
698 dest->flags = ACTION_MOST_COMPATIBLE;
699 }
700
701
702 /*********************************************************************
703 *
704 * Function : init_action
705 *
706 * Description : Zero out an action.
707 *
708 * Parameters :
709 * 1 : dest = An uninitialized action_spec.
710 *
711 * Returns : N/A
712 *
713 *********************************************************************/
init_action(struct action_spec * dest)714 void init_action (struct action_spec *dest)
715 {
716 memset(dest, '\0', sizeof(*dest));
717 }
718
719
720 /*********************************************************************
721 *
722 * Function : merge_current_action
723 *
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)
733 *
734 * Parameters :
735 * 1 : dest = Current actions, to modify.
736 * 2 : src = Action to add.
737 *
738 * Returns 0 : no error
739 * !=0 : error, probably JB_ERR_MEMORY.
740 *
741 *********************************************************************/
merge_current_action(struct current_action_spec * dest,const struct action_spec * src)742 jb_err merge_current_action (struct current_action_spec *dest,
743 const struct action_spec *src)
744 {
745 int i;
746 jb_err err = JB_ERR_OK;
747
748 dest->flags &= src->mask;
749 dest->flags |= src->add;
750
751 for (i = 0; i < ACTION_STRING_COUNT; i++)
752 {
753 char * str = src->string[i];
754 if (str)
755 {
756 str = strdup_or_die(str);
757 freez(dest->string[i]);
758 dest->string[i] = str;
759 }
760 }
761
762 for (i = 0; i < ACTION_MULTI_COUNT; i++)
763 {
764 if (src->multi_remove_all[i])
765 {
766 /* Remove everything from dest, then add src->multi_add */
767 err = list_duplicate(dest->multi[i], src->multi_add[i]);
768 if (err)
769 {
770 return err;
771 }
772 }
773 else
774 {
775 list_remove_list(dest->multi[i], src->multi_remove[i]);
776 err = list_append_list_unique(dest->multi[i], src->multi_add[i]);
777 if (err)
778 {
779 return err;
780 }
781 }
782 }
783 return err;
784 }
785
786
787 /*********************************************************************
788 *
789 * Function : update_action_bits_for_tag
790 *
791 * Description : Updates the action bits based on the action sections
792 * whose tag patterns match a provided tag.
793 *
794 * Parameters :
795 * 1 : csp = Current client state (buffers, headers, etc...)
796 * 2 : tag = The tag on which the update should be based on
797 *
798 * Returns : 0 if no tag matched, or
799 * 1 otherwise
800 *
801 *********************************************************************/
update_action_bits_for_tag(struct client_state * csp,const char * tag)802 int update_action_bits_for_tag(struct client_state *csp, const char *tag)
803 {
804 struct file_list *fl;
805 struct url_actions *b;
806
807 int updated = 0;
808 int i;
809
810 assert(tag);
811 assert(list_contains_item(csp->tags, tag));
812
813 /* Run through all action files, */
814 for (i = 0; i < MAX_AF_FILES; i++)
815 {
816 if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
817 {
818 /* Skip empty files */
819 continue;
820 }
821
822 /* and through all the action patterns, */
823 for (b = b->next; NULL != b; b = b->next)
824 {
825 /* skip everything but TAG patterns, */
826 if (!(b->url->flags & PATTERN_SPEC_TAG_PATTERN))
827 {
828 continue;
829 }
830
831 /* and check if one of the tag patterns matches the tag, */
832 if (0 == regexec(b->url->pattern.tag_regex, tag, 0, NULL, 0))
833 {
834 /* if it does, update the action bit map, */
835 if (merge_current_action(csp->action, b->action))
836 {
837 log_error(LOG_LEVEL_ERROR,
838 "Out of memory while changing action bits");
839 }
840 /* and signal the change. */
841 updated = 1;
842 }
843 }
844 }
845
846 return updated;
847 }
848
849
850 /*********************************************************************
851 *
852 * Function : check_negative_tag_patterns
853 *
854 * Description : Updates the action bits based on NO-*-TAG patterns.
855 *
856 * Parameters :
857 * 1 : csp = Current client state (buffers, headers, etc...)
858 * 2 : flag = The tag pattern type
859 *
860 * Returns : JB_ERR_OK in case off success, or
861 * JB_ERR_MEMORY on out-of-memory error.
862 *
863 *********************************************************************/
check_negative_tag_patterns(struct client_state * csp,unsigned int flag)864 jb_err check_negative_tag_patterns(struct client_state *csp, unsigned int flag)
865 {
866 struct list_entry *tag;
867 struct file_list *fl;
868 struct url_actions *b = NULL;
869 int i;
870
871 for (i = 0; i < MAX_AF_FILES; i++)
872 {
873 fl = csp->actions_list[i];
874 if ((fl == NULL) || ((b = fl->f) == NULL))
875 {
876 continue;
877 }
878 for (b = b->next; NULL != b; b = b->next)
879 {
880 int tag_found = 0;
881 if (0 == (b->url->flags & flag))
882 {
883 continue;
884 }
885 for (tag = csp->tags->first; NULL != tag; tag = tag->next)
886 {
887 if (0 == regexec(b->url->pattern.tag_regex, tag->str, 0, NULL, 0))
888 {
889 /*
890 * The pattern matches at least one tag, thus the action
891 * section doesn't apply and we don't need to look at the
892 * other tags.
893 */
894 tag_found = 1;
895 break;
896 }
897 }
898 if (!tag_found)
899 {
900 /*
901 * The pattern doesn't match any tags,
902 * thus the action section applies.
903 */
904 if (merge_current_action(csp->action, b->action))
905 {
906 log_error(LOG_LEVEL_ERROR,
907 "Out of memory while changing action bits");
908 return JB_ERR_MEMORY;
909 }
910 log_error(LOG_LEVEL_HEADER, "Updated action bits based on: %s",
911 b->url->spec);
912 }
913 }
914 }
915
916 return JB_ERR_OK;
917 }
918
919
920 /*********************************************************************
921 *
922 * Function : free_current_action
923 *
924 * Description : Free memory used by a current_action_spec.
925 * Does not free the current_action_spec itself.
926 *
927 * Parameters :
928 * 1 : src = Source to free.
929 *
930 * Returns : N/A
931 *
932 *********************************************************************/
free_current_action(struct current_action_spec * src)933 void free_current_action(struct current_action_spec *src)
934 {
935 int i;
936
937 for (i = 0; i < ACTION_STRING_COUNT; i++)
938 {
939 freez(src->string[i]);
940 }
941
942 for (i = 0; i < ACTION_MULTI_COUNT; i++)
943 {
944 destroy_list(src->multi[i]);
945 }
946
947 memset(src, '\0', sizeof(*src));
948 }
949
950
951 static struct file_list *current_actions_file[MAX_AF_FILES] = {
952 NULL, NULL, NULL, NULL, NULL,
953 NULL, NULL, NULL, NULL, NULL
954 };
955
956
957 #ifdef FEATURE_GRACEFUL_TERMINATION
958 /*********************************************************************
959 *
960 * Function : unload_current_actions_file
961 *
962 * Description : Unloads current actions file - reset to state at
963 * beginning of program.
964 *
965 * Parameters : None
966 *
967 * Returns : N/A
968 *
969 *********************************************************************/
unload_current_actions_file(void)970 void unload_current_actions_file(void)
971 {
972 int i;
973
974 for (i = 0; i < MAX_AF_FILES; i++)
975 {
976 if (current_actions_file[i])
977 {
978 current_actions_file[i]->unloader = unload_actions_file;
979 current_actions_file[i] = NULL;
980 }
981 }
982 }
983 #endif /* FEATURE_GRACEFUL_TERMINATION */
984
985
986 /*********************************************************************
987 *
988 * Function : unload_actions_file
989 *
990 * Description : Unloads an actions module.
991 *
992 * Parameters :
993 * 1 : file_data = the data structure associated with the
994 * actions file.
995 *
996 * Returns : N/A
997 *
998 *********************************************************************/
unload_actions_file(void * file_data)999 void unload_actions_file(void *file_data)
1000 {
1001 struct url_actions * next;
1002 struct url_actions * cur = (struct url_actions *)file_data;
1003 while (cur != NULL)
1004 {
1005 next = cur->next;
1006 free_pattern_spec(cur->url);
1007 if ((next == NULL) || (next->action != cur->action))
1008 {
1009 /*
1010 * As the action settings might be shared,
1011 * we can only free them if the current
1012 * url pattern is the last one, or if the
1013 * next one is using different settings.
1014 */
1015 free_action_spec(cur->action);
1016 }
1017 freez(cur);
1018 cur = next;
1019 }
1020 }
1021
1022
1023 /*********************************************************************
1024 *
1025 * Function : free_alias_list
1026 *
1027 * Description : Free memory used by a list of aliases.
1028 *
1029 * Parameters :
1030 * 1 : alias_list = Linked list to free.
1031 *
1032 * Returns : N/A
1033 *
1034 *********************************************************************/
free_alias_list(struct action_alias * alias_list)1035 void free_alias_list(struct action_alias *alias_list)
1036 {
1037 while (alias_list != NULL)
1038 {
1039 struct action_alias * next = alias_list->next;
1040 alias_list->next = NULL;
1041 freez(alias_list->name);
1042 free_action(alias_list->action);
1043 free(alias_list);
1044 alias_list = next;
1045 }
1046 }
1047
1048
1049 /*********************************************************************
1050 *
1051 * Function : load_action_files
1052 *
1053 * Description : Read and parse all the action files and add to files
1054 * list.
1055 *
1056 * Parameters :
1057 * 1 : csp = Current client state (buffers, headers, etc...)
1058 *
1059 * Returns : 0 => Ok, everything else is an error.
1060 *
1061 *********************************************************************/
load_action_files(struct client_state * csp)1062 int load_action_files(struct client_state *csp)
1063 {
1064 int i;
1065 int result;
1066
1067 for (i = 0; i < MAX_AF_FILES; i++)
1068 {
1069 if (csp->config->actions_file[i])
1070 {
1071 result = load_one_actions_file(csp, i);
1072 if (result)
1073 {
1074 return result;
1075 }
1076 }
1077 else if (current_actions_file[i])
1078 {
1079 current_actions_file[i]->unloader = unload_actions_file;
1080 current_actions_file[i] = NULL;
1081 }
1082 }
1083
1084 return 0;
1085 }
1086
1087
1088 /*********************************************************************
1089 *
1090 * Function : filter_type_to_string
1091 *
1092 * Description : Converts a filter type enum into a string.
1093 *
1094 * Parameters :
1095 * 1 : filter_type = filter_type as enum
1096 *
1097 * Returns : Pointer to static string.
1098 *
1099 *********************************************************************/
filter_type_to_string(enum filter_type filter_type)1100 static const char *filter_type_to_string(enum filter_type filter_type)
1101 {
1102 switch (filter_type)
1103 {
1104 case FT_CONTENT_FILTER:
1105 return "content filter";
1106 case FT_CLIENT_HEADER_FILTER:
1107 return "client-header filter";
1108 case FT_SERVER_HEADER_FILTER:
1109 return "server-header filter";
1110 case FT_CLIENT_HEADER_TAGGER:
1111 return "client-header tagger";
1112 case FT_SERVER_HEADER_TAGGER:
1113 return "server-header tagger";
1114 case FT_SUPPRESS_TAG:
1115 return "suppress tag filter";
1116 case FT_CLIENT_BODY_FILTER:
1117 return "client body filter";
1118 case FT_ADD_HEADER:
1119 return "add-header action";
1120 #ifdef FEATURE_EXTERNAL_FILTERS
1121 case FT_EXTERNAL_CONTENT_FILTER:
1122 return "external content filter";
1123 #endif
1124 case FT_INVALID_FILTER:
1125 return "invalid filter type";
1126 }
1127
1128 return "unknown filter type";
1129
1130 }
1131
1132 /*********************************************************************
1133 *
1134 * Function : referenced_filters_are_missing
1135 *
1136 * Description : Checks if any filters of a certain type referenced
1137 * in an action spec are missing.
1138 *
1139 * Parameters :
1140 * 1 : csp = Current client state (buffers, headers, etc...)
1141 * 2 : cur_action = The action spec to check.
1142 * 3 : multi_index = The index where to look for the filter.
1143 * 4 : filter_type = The filter type the caller is interested in.
1144 *
1145 * Returns : 0 => All referenced filters exist, everything else is an error.
1146 *
1147 *********************************************************************/
referenced_filters_are_missing(const struct client_state * csp,const struct action_spec * cur_action,int multi_index,enum filter_type filter_type)1148 static int referenced_filters_are_missing(const struct client_state *csp,
1149 const struct action_spec *cur_action, int multi_index, enum filter_type filter_type)
1150 {
1151 struct list_entry *filtername;
1152
1153 for (filtername = cur_action->multi_add[multi_index]->first;
1154 filtername; filtername = filtername->next)
1155 {
1156 if (NULL == get_filter(csp, filtername->str, filter_type))
1157 {
1158 log_error(LOG_LEVEL_ERROR, "Missing %s '%s'",
1159 filter_type_to_string(filter_type), filtername->str);
1160 return 1;
1161 }
1162 }
1163
1164 return 0;
1165
1166 }
1167
1168
1169 /*********************************************************************
1170 *
1171 * Function : action_spec_is_valid
1172 *
1173 * Description : Should eventually figure out if an action spec
1174 * is valid, but currently only checks that the
1175 * referenced filters are accounted for.
1176 *
1177 * Parameters :
1178 * 1 : csp = Current client state (buffers, headers, etc...)
1179 * 2 : cur_action = The action spec to check.
1180 *
1181 * Returns : 0 => No problems detected, everything else is an error.
1182 *
1183 *********************************************************************/
action_spec_is_valid(struct client_state * csp,const struct action_spec * cur_action)1184 static int action_spec_is_valid(struct client_state *csp, const struct action_spec *cur_action)
1185 {
1186 struct {
1187 int multi_index;
1188 enum filter_type filter_type;
1189 } filter_map[] = {
1190 {ACTION_MULTI_FILTER, FT_CONTENT_FILTER},
1191 {ACTION_MULTI_CLIENT_HEADER_FILTER, FT_CLIENT_HEADER_FILTER},
1192 {ACTION_MULTI_SERVER_HEADER_FILTER, FT_SERVER_HEADER_FILTER},
1193 {ACTION_MULTI_CLIENT_HEADER_TAGGER, FT_CLIENT_HEADER_TAGGER},
1194 {ACTION_MULTI_SERVER_HEADER_TAGGER, FT_SERVER_HEADER_TAGGER},
1195 {ACTION_MULTI_CLIENT_BODY_FILTER, FT_CLIENT_BODY_FILTER}
1196 };
1197 int errors = 0;
1198 int i;
1199
1200 for (i = 0; i < SZ(filter_map); i++)
1201 {
1202 errors += referenced_filters_are_missing(csp, cur_action,
1203 filter_map[i].multi_index, filter_map[i].filter_type);
1204 }
1205
1206 return errors;
1207
1208 }
1209
1210
1211 /*********************************************************************
1212 *
1213 * Function : load_one_actions_file
1214 *
1215 * Description : Read and parse an action file and add to files
1216 * list.
1217 *
1218 * Parameters :
1219 * 1 : csp = Current client state (buffers, headers, etc...)
1220 * 2 : fileid = File index to load.
1221 *
1222 * Returns : 0 => Ok, everything else is an error.
1223 *
1224 *********************************************************************/
1225 #ifndef FUZZ
1226 static
1227 #endif
load_one_actions_file(struct client_state * csp,int fileid)1228 int load_one_actions_file(struct client_state *csp, int fileid)
1229 {
1230
1231 /*
1232 * Parser mode.
1233 * Note: Keep these in the order they occur in the file, they are
1234 * sometimes tested with <=
1235 */
1236 enum {
1237 MODE_START_OF_FILE = 1,
1238 MODE_SETTINGS = 2,
1239 MODE_DESCRIPTION = 3,
1240 MODE_ALIAS = 4,
1241 MODE_ACTIONS = 5
1242 } mode;
1243
1244 FILE *fp;
1245 struct url_actions *last_perm;
1246 struct url_actions *perm;
1247 char *buf;
1248 struct file_list *fs;
1249 struct action_spec * cur_action = NULL;
1250 int cur_action_used = 0;
1251 struct action_alias * alias_list = NULL;
1252 unsigned long linenum = 0;
1253 mode = MODE_START_OF_FILE;
1254
1255 if (!check_file_changed(current_actions_file[fileid], csp->config->actions_file[fileid], &fs))
1256 {
1257 /* No need to load */
1258 csp->actions_list[fileid] = current_actions_file[fileid];
1259 return 0;
1260 }
1261 if (!fs)
1262 {
1263 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': %E. "
1264 "Note that beginning with Privoxy 3.0.7, actions files have to be specified "
1265 "with their complete file names.", csp->config->actions_file[fileid]);
1266 return 1; /* never get here */
1267 }
1268
1269 fs->f = last_perm = zalloc_or_die(sizeof(*last_perm));
1270
1271 if ((fp = fopen(csp->config->actions_file[fileid], "r")) == NULL)
1272 {
1273 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error opening file: %E",
1274 csp->config->actions_file[fileid]);
1275 return 1; /* never get here */
1276 }
1277
1278 log_error(LOG_LEVEL_INFO, "Loading actions file: %s", csp->config->actions_file[fileid]);
1279
1280 while (read_config_line(fp, &linenum, &buf) != NULL)
1281 {
1282 if (*buf == '{')
1283 {
1284 /* It's a header block */
1285 if (buf[1] == '{')
1286 {
1287 /* It's {{settings}} or {{alias}} */
1288 size_t len = strlen(buf);
1289 char * start = buf + 2;
1290 char * end = buf + len - 1;
1291 if ((len < (size_t)5) || (*end-- != '}') || (*end-- != '}'))
1292 {
1293 /* too short */
1294 fclose(fp);
1295 log_error(LOG_LEVEL_FATAL,
1296 "can't load actions file '%s': invalid line (%lu): %s",
1297 csp->config->actions_file[fileid], linenum, buf);
1298 return 1; /* never get here */
1299 }
1300
1301 /* Trim leading and trailing whitespace. */
1302 end[1] = '\0';
1303 chomp(start);
1304
1305 if (*start == '\0')
1306 {
1307 /* too short */
1308 fclose(fp);
1309 log_error(LOG_LEVEL_FATAL,
1310 "can't load actions file '%s': invalid line (%lu): {{ }}",
1311 csp->config->actions_file[fileid], linenum);
1312 return 1; /* never get here */
1313 }
1314
1315 /*
1316 * An actionsfile can optionally contain the following blocks.
1317 * They *MUST* be in this order, to simplify processing:
1318 *
1319 * {{settings}}
1320 * name=value...
1321 *
1322 * {{description}}
1323 * ...free text, format TBD, but no line may start with a '{'...
1324 *
1325 * {{alias}}
1326 * name=actions...
1327 *
1328 * The actual actions must be *after* these special blocks.
1329 * None of these special blocks may be repeated.
1330 *
1331 */
1332 if (0 == strcmpic(start, "settings"))
1333 {
1334 /* it's a {{settings}} block */
1335 if (mode >= MODE_SETTINGS)
1336 {
1337 /* {{settings}} must be first thing in file and must only
1338 * appear once.
1339 */
1340 fclose(fp);
1341 log_error(LOG_LEVEL_FATAL,
1342 "can't load actions file '%s': line %lu: {{settings}} must only appear once, and it must be before anything else.",
1343 csp->config->actions_file[fileid], linenum);
1344 }
1345 mode = MODE_SETTINGS;
1346 }
1347 else if (0 == strcmpic(start, "description"))
1348 {
1349 /* it's a {{description}} block */
1350 if (mode >= MODE_DESCRIPTION)
1351 {
1352 /* {{description}} is a singleton and only {{settings}} may proceed it
1353 */
1354 fclose(fp);
1355 log_error(LOG_LEVEL_FATAL,
1356 "can't load actions file '%s': line %lu: {{description}} must only appear once, and only a {{settings}} block may be above it.",
1357 csp->config->actions_file[fileid], linenum);
1358 }
1359 mode = MODE_DESCRIPTION;
1360 }
1361 else if (0 == strcmpic(start, "alias"))
1362 {
1363 /* it's an {{alias}} block */
1364 if (mode >= MODE_ALIAS)
1365 {
1366 /* {{alias}} must be first thing in file, possibly after
1367 * {{settings}} and {{description}}
1368 *
1369 * {{alias}} must only appear once.
1370 *
1371 * Note that these are new restrictions introduced in
1372 * v2.9.10 in order to make actionsfile editing simpler.
1373 * (Otherwise, reordering actionsfile entries without
1374 * completely rewriting the file becomes non-trivial)
1375 */
1376 fclose(fp);
1377 log_error(LOG_LEVEL_FATAL,
1378 "can't load actions file '%s': line %lu: {{alias}} must only appear once, and it must be before all actions.",
1379 csp->config->actions_file[fileid], linenum);
1380 }
1381 mode = MODE_ALIAS;
1382 }
1383 else
1384 {
1385 /* invalid {{something}} block */
1386 fclose(fp);
1387 log_error(LOG_LEVEL_FATAL,
1388 "can't load actions file '%s': invalid line (%lu): {{%s}}",
1389 csp->config->actions_file[fileid], linenum, start);
1390 return 1; /* never get here */
1391 }
1392 }
1393 else
1394 {
1395 /* It's an actions block */
1396
1397 char *actions_buf;
1398 char * end;
1399
1400 /* set mode */
1401 mode = MODE_ACTIONS;
1402
1403 /* free old action */
1404 if (cur_action)
1405 {
1406 if (!cur_action_used)
1407 {
1408 free_action_spec(cur_action);
1409 }
1410 cur_action = NULL;
1411 }
1412 cur_action_used = 0;
1413 cur_action = zalloc_or_die(sizeof(*cur_action));
1414 init_action(cur_action);
1415
1416 /*
1417 * Copy the buffer before messing with it as we may need the
1418 * unmodified version in for the fatal error messages. Given
1419 * that this is not a common event, we could instead simply
1420 * read the line again.
1421 *
1422 * buf + 1 to skip the leading '{'
1423 */
1424 actions_buf = end = strdup_or_die(buf + 1);
1425
1426 /* check we have a trailing } and then trim it */
1427 if (strlen(actions_buf))
1428 {
1429 end += strlen(actions_buf) - 1;
1430 }
1431 if (*end != '}')
1432 {
1433 /* No closing } */
1434 fclose(fp);
1435 freez(actions_buf);
1436 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1437 "Missing trailing '}' in action section starting at line (%lu): %s",
1438 csp->config->actions_file[fileid], linenum, buf);
1439 return 1; /* never get here */
1440 }
1441 *end = '\0';
1442
1443 /* trim any whitespace immediately inside {} */
1444 chomp(actions_buf);
1445
1446 if (get_actions(actions_buf, alias_list, cur_action))
1447 {
1448 /* error */
1449 fclose(fp);
1450 freez(actions_buf);
1451 log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1452 "can't completely parse the action section starting at line (%lu): %s",
1453 csp->config->actions_file[fileid], linenum, buf);
1454 return 1; /* never get here */
1455 }
1456
1457 if (action_spec_is_valid(csp, cur_action))
1458 {
1459 log_error(LOG_LEVEL_ERROR, "Invalid action section in file '%s', "
1460 "starting at line %lu: %s",
1461 csp->config->actions_file[fileid], linenum, buf);
1462 }
1463
1464 freez(actions_buf);
1465 }
1466 }
1467 else if (mode == MODE_SETTINGS)
1468 {
1469 /*
1470 * Part of the {{settings}} block.
1471 * For now only serves to check if the file's minimum Privoxy
1472 * version requirement is met, but we may want to read & check
1473 * permissions when we go multi-user.
1474 */
1475 if (!strncmp(buf, "for-privoxy-version=", 20))
1476 {
1477 char *version_string, *fields[3];
1478 int num_fields;
1479
1480 version_string = strdup_or_die(buf + 20);
1481
1482 num_fields = ssplit(version_string, ".", fields, SZ(fields));
1483
1484 if (num_fields < 1 || atoi(fields[0]) == 0)
1485 {
1486 log_error(LOG_LEVEL_ERROR,
1487 "While loading actions file '%s': invalid line (%lu): %s",
1488 csp->config->actions_file[fileid], linenum, buf);
1489 }
1490 else if ( (atoi(fields[0]) > VERSION_MAJOR)
1491 || ((num_fields > 1) && (atoi(fields[1]) > VERSION_MINOR))
1492 || ((num_fields > 2) && (atoi(fields[2]) > VERSION_POINT)))
1493 {
1494 fclose(fp);
1495 log_error(LOG_LEVEL_FATAL,
1496 "Actions file '%s', line %lu requires newer Privoxy version: %s",
1497 csp->config->actions_file[fileid], linenum, buf);
1498 return 1; /* never get here */
1499 }
1500 free(version_string);
1501 }
1502 }
1503 else if (mode == MODE_DESCRIPTION)
1504 {
1505 /*
1506 * Part of the {{description}} block.
1507 * Ignore for now.
1508 */
1509 }
1510 else if (mode == MODE_ALIAS)
1511 {
1512 /*
1513 * define an alias
1514 */
1515 char actions_buf[BUFFER_SIZE];
1516 struct action_alias * new_alias;
1517
1518 char * start = strchr(buf, '=');
1519 char * end = start;
1520
1521 if ((start == NULL) || (start == buf))
1522 {
1523 log_error(LOG_LEVEL_FATAL,
1524 "can't load actions file '%s': invalid alias line (%lu): %s",
1525 csp->config->actions_file[fileid], linenum, buf);
1526 return 1; /* never get here */
1527 }
1528
1529 new_alias = zalloc_or_die(sizeof(*new_alias));
1530
1531 /* Eat any the whitespace before the '=' */
1532 end--;
1533 while ((*end == ' ') || (*end == '\t'))
1534 {
1535 /*
1536 * we already know we must have at least 1 non-ws char
1537 * at start of buf - no need to check
1538 */
1539 end--;
1540 }
1541 end[1] = '\0';
1542
1543 /* Eat any the whitespace after the '=' */
1544 start++;
1545 while ((*start == ' ') || (*start == '\t'))
1546 {
1547 start++;
1548 }
1549 if (*start == '\0')
1550 {
1551 log_error(LOG_LEVEL_FATAL,
1552 "can't load actions file '%s': invalid alias line (%lu): %s",
1553 csp->config->actions_file[fileid], linenum, buf);
1554 return 1; /* never get here */
1555 }
1556
1557 new_alias->name = strdup_or_die(buf);
1558
1559 strlcpy(actions_buf, start, sizeof(actions_buf));
1560
1561 if (get_actions(actions_buf, alias_list, new_alias->action))
1562 {
1563 /* error */
1564 fclose(fp);
1565 log_error(LOG_LEVEL_FATAL,
1566 "can't load actions file '%s': invalid alias line (%lu): %s = %s",
1567 csp->config->actions_file[fileid], linenum, buf, start);
1568 return 1; /* never get here */
1569 }
1570
1571 /* add to list */
1572 new_alias->next = alias_list;
1573 alias_list = new_alias;
1574 }
1575 else if (mode == MODE_ACTIONS)
1576 {
1577 /* it's an URL pattern */
1578
1579 /* allocate a new node */
1580 perm = zalloc_or_die(sizeof(*perm));
1581
1582 perm->action = cur_action;
1583 cur_action_used = 1;
1584
1585 /* Save the URL pattern */
1586 if (create_pattern_spec(perm->url, buf))
1587 {
1588 fclose(fp);
1589 log_error(LOG_LEVEL_FATAL,
1590 "can't load actions file '%s': line %lu: cannot create URL or TAG pattern from: %s",
1591 csp->config->actions_file[fileid], linenum, buf);
1592 return 1; /* never get here */
1593 }
1594
1595 /* add it to the list */
1596 last_perm->next = perm;
1597 last_perm = perm;
1598 }
1599 else if (mode == MODE_START_OF_FILE)
1600 {
1601 /* oops - please have a {} line as 1st line in file. */
1602 fclose(fp);
1603 log_error(LOG_LEVEL_FATAL,
1604 "can't load actions file '%s': line %lu should begin with a '{': %s",
1605 csp->config->actions_file[fileid], linenum, buf);
1606 return 1; /* never get here */
1607 }
1608 else
1609 {
1610 /* How did we get here? This is impossible! */
1611 fclose(fp);
1612 log_error(LOG_LEVEL_FATAL,
1613 "can't load actions file '%s': INTERNAL ERROR - mode = %d",
1614 csp->config->actions_file[fileid], mode);
1615 return 1; /* never get here */
1616 }
1617 freez(buf);
1618 }
1619
1620 fclose(fp);
1621
1622 if (!cur_action_used)
1623 {
1624 free_action_spec(cur_action);
1625 }
1626 free_alias_list(alias_list);
1627
1628 /* the old one is now obsolete */
1629 if (current_actions_file[fileid])
1630 {
1631 current_actions_file[fileid]->unloader = unload_actions_file;
1632 }
1633
1634 fs->next = files->next;
1635 files->next = fs;
1636 current_actions_file[fileid] = fs;
1637
1638 csp->actions_list[fileid] = fs;
1639
1640 return(0);
1641
1642 }
1643
1644
1645 /*********************************************************************
1646 *
1647 * Function : actions_to_text
1648 *
1649 * Description : Converts an actionsfile entry from the internal
1650 * structure into a text line. The output is split
1651 * into one line for each action with line continuation.
1652 *
1653 * Parameters :
1654 * 1 : action = The action to format.
1655 *
1656 * Returns : A string. Caller must free it.
1657 * NULL on out-of-memory error.
1658 *
1659 *********************************************************************/
actions_to_text(const struct action_spec * action)1660 char * actions_to_text(const struct action_spec *action)
1661 {
1662 unsigned long mask = action->mask;
1663 unsigned long add = action->add;
1664 char *result = strdup_or_die("");
1665 struct list_entry * lst;
1666
1667 /* sanity - prevents "-feature +feature" */
1668 mask |= add;
1669
1670
1671 #define DEFINE_ACTION_BOOL(__name, __bit) \
1672 if (!(mask & __bit)) \
1673 { \
1674 string_append(&result, " -" __name " \\\n"); \
1675 } \
1676 else if (add & __bit) \
1677 { \
1678 string_append(&result, " +" __name " \\\n"); \
1679 }
1680
1681 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1682 if (!(mask & __bit)) \
1683 { \
1684 string_append(&result, " -" __name " \\\n"); \
1685 } \
1686 else if (add & __bit) \
1687 { \
1688 string_append(&result, " +" __name "{"); \
1689 string_append(&result, action->string[__index]); \
1690 string_append(&result, "} \\\n"); \
1691 }
1692
1693 #define DEFINE_ACTION_MULTI(__name, __index) \
1694 if (action->multi_remove_all[__index]) \
1695 { \
1696 string_append(&result, " -" __name " \\\n"); \
1697 } \
1698 else \
1699 { \
1700 lst = action->multi_remove[__index]->first; \
1701 while (lst) \
1702 { \
1703 string_append(&result, " -" __name "{"); \
1704 string_append(&result, lst->str); \
1705 string_append(&result, "} \\\n"); \
1706 lst = lst->next; \
1707 } \
1708 } \
1709 lst = action->multi_add[__index]->first; \
1710 while (lst) \
1711 { \
1712 string_append(&result, " +" __name "{"); \
1713 string_append(&result, lst->str); \
1714 string_append(&result, "} \\\n"); \
1715 lst = lst->next; \
1716 }
1717
1718 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1719
1720 #include "actionlist.h"
1721
1722 #undef DEFINE_ACTION_MULTI
1723 #undef DEFINE_ACTION_STRING
1724 #undef DEFINE_ACTION_BOOL
1725 #undef DEFINE_ACTION_ALIAS
1726
1727 return result;
1728 }
1729
1730
1731 /*********************************************************************
1732 *
1733 * Function : actions_to_html
1734 *
1735 * Description : Converts an actionsfile entry from numeric form
1736 * ("mask" and "add") to a <br>-separated HTML string
1737 * in which each action is linked to its chapter in
1738 * the user manual.
1739 *
1740 * Parameters :
1741 * 1 : csp = Client state (for config)
1742 * 2 : action = Action spec to be converted
1743 *
1744 * Returns : A string. Caller must free it.
1745 * NULL on out-of-memory error.
1746 *
1747 *********************************************************************/
actions_to_html(const struct client_state * csp,const struct action_spec * action)1748 char * actions_to_html(const struct client_state *csp,
1749 const struct action_spec *action)
1750 {
1751 unsigned long mask = action->mask;
1752 unsigned long add = action->add;
1753 char *result = strdup_or_die("");
1754 struct list_entry * lst;
1755
1756 /* sanity - prevents "-feature +feature" */
1757 mask |= add;
1758
1759
1760 #define DEFINE_ACTION_BOOL(__name, __bit) \
1761 if (!(mask & __bit)) \
1762 { \
1763 string_append(&result, "\n<br>-"); \
1764 string_join(&result, add_help_link(__name, csp->config)); \
1765 } \
1766 else if (add & __bit) \
1767 { \
1768 string_append(&result, "\n<br>+"); \
1769 string_join(&result, add_help_link(__name, csp->config)); \
1770 }
1771
1772 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1773 if (!(mask & __bit)) \
1774 { \
1775 string_append(&result, "\n<br>-"); \
1776 string_join(&result, add_help_link(__name, csp->config)); \
1777 } \
1778 else if (add & __bit) \
1779 { \
1780 string_append(&result, "\n<br>+"); \
1781 string_join(&result, add_help_link(__name, csp->config)); \
1782 string_append(&result, "{"); \
1783 string_join(&result, html_encode(action->string[__index])); \
1784 string_append(&result, "}"); \
1785 }
1786
1787 #define DEFINE_ACTION_MULTI(__name, __index) \
1788 if (action->multi_remove_all[__index]) \
1789 { \
1790 string_append(&result, "\n<br>-"); \
1791 string_join(&result, add_help_link(__name, csp->config)); \
1792 } \
1793 else \
1794 { \
1795 lst = action->multi_remove[__index]->first; \
1796 while (lst) \
1797 { \
1798 string_append(&result, "\n<br>-"); \
1799 string_join(&result, add_help_link(__name, csp->config)); \
1800 string_append(&result, "{"); \
1801 string_join(&result, html_encode(lst->str)); \
1802 string_append(&result, "}"); \
1803 lst = lst->next; \
1804 } \
1805 } \
1806 lst = action->multi_add[__index]->first; \
1807 while (lst) \
1808 { \
1809 string_append(&result, "\n<br>+"); \
1810 string_join(&result, add_help_link(__name, csp->config)); \
1811 string_append(&result, "{"); \
1812 string_join(&result, html_encode(lst->str)); \
1813 string_append(&result, "}"); \
1814 lst = lst->next; \
1815 }
1816
1817 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1818
1819 #include "actionlist.h"
1820
1821 #undef DEFINE_ACTION_MULTI
1822 #undef DEFINE_ACTION_STRING
1823 #undef DEFINE_ACTION_BOOL
1824 #undef DEFINE_ACTION_ALIAS
1825
1826 /* trim leading <br> */
1827 if (result && *result)
1828 {
1829 char * s = result;
1830 result = strdup(result + 5);
1831 free(s);
1832 }
1833
1834 return result;
1835 }
1836
1837
1838 /*********************************************************************
1839 *
1840 * Function : current_actions_to_html
1841 *
1842 * Description : Converts a current action spec to a <br> separated HTML
1843 * text in which each action is linked to its chapter in
1844 * the user manual.
1845 *
1846 * Parameters :
1847 * 1 : csp = Client state (for config)
1848 * 2 : action = Current action spec to be converted
1849 *
1850 * Returns : A string. Caller must free it.
1851 * NULL on out-of-memory error.
1852 *
1853 *********************************************************************/
current_action_to_html(const struct client_state * csp,const struct current_action_spec * action)1854 char *current_action_to_html(const struct client_state *csp,
1855 const struct current_action_spec *action)
1856 {
1857 unsigned long flags = action->flags;
1858 struct list_entry * lst;
1859 char *result = strdup_or_die("");
1860 char *active = strdup_or_die("");
1861 char *inactive = strdup_or_die("");
1862
1863 #define DEFINE_ACTION_BOOL(__name, __bit) \
1864 if (flags & __bit) \
1865 { \
1866 string_append(&active, "\n<br>+"); \
1867 string_join(&active, add_help_link(__name, csp->config)); \
1868 } \
1869 else \
1870 { \
1871 string_append(&inactive, "\n<br>-"); \
1872 string_join(&inactive, add_help_link(__name, csp->config)); \
1873 }
1874
1875 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1876 if (flags & __bit) \
1877 { \
1878 string_append(&active, "\n<br>+"); \
1879 string_join(&active, add_help_link(__name, csp->config)); \
1880 string_append(&active, "{"); \
1881 string_join(&active, html_encode(action->string[__index])); \
1882 string_append(&active, "}"); \
1883 } \
1884 else \
1885 { \
1886 string_append(&inactive, "\n<br>-"); \
1887 string_join(&inactive, add_help_link(__name, csp->config)); \
1888 }
1889
1890 #define DEFINE_ACTION_MULTI(__name, __index) \
1891 lst = action->multi[__index]->first; \
1892 if (lst == NULL) \
1893 { \
1894 string_append(&inactive, "\n<br>-"); \
1895 string_join(&inactive, add_help_link(__name, csp->config)); \
1896 } \
1897 else \
1898 { \
1899 while (lst) \
1900 { \
1901 string_append(&active, "\n<br>+"); \
1902 string_join(&active, add_help_link(__name, csp->config)); \
1903 string_append(&active, "{"); \
1904 string_join(&active, html_encode(lst->str)); \
1905 string_append(&active, "}"); \
1906 lst = lst->next; \
1907 } \
1908 }
1909
1910 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1911
1912 #include "actionlist.h"
1913
1914 #undef DEFINE_ACTION_MULTI
1915 #undef DEFINE_ACTION_STRING
1916 #undef DEFINE_ACTION_BOOL
1917 #undef DEFINE_ACTION_ALIAS
1918
1919 if (active != NULL)
1920 {
1921 string_append(&result, active);
1922 freez(active);
1923 }
1924 string_append(&result, "\n<br>");
1925 if (inactive != NULL)
1926 {
1927 string_append(&result, inactive);
1928 freez(inactive);
1929 }
1930 return result;
1931 }
1932
1933
1934 /*********************************************************************
1935 *
1936 * Function : action_to_line_of_text
1937 *
1938 * Description : Converts an action spec to a single text line
1939 * listing the enabled actions.
1940 *
1941 * Parameters :
1942 * 1 : action = Current action spec to be converted
1943 *
1944 * Returns : A string. Caller must free it.
1945 * Out-of-memory errors are fatal.
1946 *
1947 *********************************************************************/
actions_to_line_of_text(const struct current_action_spec * action)1948 char *actions_to_line_of_text(const struct current_action_spec *action)
1949 {
1950 char buffer[200];
1951 struct list_entry *lst;
1952 char *active;
1953 const unsigned long flags = action->flags;
1954
1955 active = strdup_or_die("");
1956
1957 #define DEFINE_ACTION_BOOL(__name, __bit) \
1958 if (flags & __bit) \
1959 { \
1960 snprintf(buffer, sizeof(buffer), "+%s ", __name); \
1961 string_append(&active, buffer); \
1962 } \
1963
1964 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1965 if (flags & __bit) \
1966 { \
1967 snprintf(buffer, sizeof(buffer), "+%s{%s} ", \
1968 __name, action->string[__index]); \
1969 string_append(&active, buffer); \
1970 } \
1971
1972 #define DEFINE_ACTION_MULTI(__name, __index) \
1973 lst = action->multi[__index]->first; \
1974 while (lst != NULL) \
1975 { \
1976 snprintf(buffer, sizeof(buffer), "+%s{%s} ", \
1977 __name, lst->str); \
1978 string_append(&active, buffer); \
1979 lst = lst->next; \
1980 } \
1981
1982 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1983
1984 #include "actionlist.h"
1985
1986 #undef DEFINE_ACTION_MULTI
1987 #undef DEFINE_ACTION_STRING
1988 #undef DEFINE_ACTION_BOOL
1989 #undef DEFINE_ACTION_ALIAS
1990
1991 if (active == NULL)
1992 {
1993 log_error(LOG_LEVEL_FATAL, "Out of memory in action_to_line_of_text()");
1994 }
1995
1996 return active;
1997 }
1998