actions.c

   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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
 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  *********************************************************************/
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  *********************************************************************/
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  *********************************************************************/
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 #ifdef FEATURE_EXTERNAL_FILTERS
1115    case FT_EXTERNAL_CONTENT_FILTER:
1116       return "external content filter";
1117 #endif
1118    case FT_INVALID_FILTER:
1119       return "invalid filter type";
1120    }
1121
1122    return "unknown filter type";
1123
1124 }
1125
1126 /*********************************************************************
1127  *
1128  * Function    :  referenced_filters_are_missing
1129  *
1130  * Description :  Checks if any filters of a certain type referenced
1131  *                in an action spec are missing.
1132  *
1133  * Parameters  :
1134  *          1  :  csp = Current client state (buffers, headers, etc...)
1135  *          2  :  cur_action = The action spec to check.
1136  *          3  :  multi_index = The index where to look for the filter.
1137  *          4  :  filter_type = The filter type the caller is interested in.
1138  *
1139  * Returns     :  0 => All referenced filters exist, everything else is an error.
1140  *
1141  *********************************************************************/
1142 static int referenced_filters_are_missing(const struct client_state *csp,
1143    const struct action_spec *cur_action, int multi_index, enum filter_type filter_type)
1144 {
1145    struct list_entry *filtername;
1146
1147    for (filtername = cur_action->multi_add[multi_index]->first;
1148         filtername; filtername = filtername->next)
1149    {
1150       if (NULL == get_filter(csp, filtername->str, filter_type))
1151       {
1152          log_error(LOG_LEVEL_ERROR, "Missing %s '%s'",
1153             filter_type_to_string(filter_type), filtername->str);
1154          return 1;
1155       }
1156    }
1157
1158    return 0;
1159
1160 }
1161
1162
1163 /*********************************************************************
1164  *
1165  * Function    :  action_spec_is_valid
1166  *
1167  * Description :  Should eventually figure out if an action spec
1168  *                is valid, but currently only checks that the
1169  *                referenced filters are accounted for.
1170  *
1171  * Parameters  :
1172  *          1  :  csp = Current client state (buffers, headers, etc...)
1173  *          2  :  cur_action = The action spec to check.
1174  *
1175  * Returns     :  0 => No problems detected, everything else is an error.
1176  *
1177  *********************************************************************/
1178 static int action_spec_is_valid(struct client_state *csp, const struct action_spec *cur_action)
1179 {
1180    struct {
1181       int multi_index;
1182       enum filter_type filter_type;
1183    } filter_map[] = {
1184       {ACTION_MULTI_FILTER, FT_CONTENT_FILTER},
1185       {ACTION_MULTI_CLIENT_HEADER_FILTER, FT_CLIENT_HEADER_FILTER},
1186       {ACTION_MULTI_SERVER_HEADER_FILTER, FT_SERVER_HEADER_FILTER},
1187       {ACTION_MULTI_CLIENT_HEADER_TAGGER, FT_CLIENT_HEADER_TAGGER},
1188       {ACTION_MULTI_SERVER_HEADER_TAGGER, FT_SERVER_HEADER_TAGGER}
1189    };
1190    int errors = 0;
1191    int i;
1192
1193    for (i = 0; i < SZ(filter_map); i++)
1194    {
1195       errors += referenced_filters_are_missing(csp, cur_action,
1196          filter_map[i].multi_index, filter_map[i].filter_type);
1197    }
1198
1199    return errors;
1200
1201 }
1202
1203
1204 /*********************************************************************
1205  *
1206  * Function    :  load_one_actions_file
1207  *
1208  * Description :  Read and parse a action file and add to files
1209  *                list.
1210  *
1211  * Parameters  :
1212  *          1  :  csp = Current client state (buffers, headers, etc...)
1213  *          2  :  fileid = File index to load.
1214  *
1215  * Returns     :  0 => Ok, everything else is an error.
1216  *
1217  *********************************************************************/
1218 #ifndef FUZZ
1219 static
1220 #endif
1221 int load_one_actions_file(struct client_state *csp, int fileid)
1222 {
1223
1224    /*
1225     * Parser mode.
1226     * Note: Keep these in the order they occur in the file, they are
1227     * sometimes tested with <=
1228     */
1229    enum {
1230       MODE_START_OF_FILE = 1,
1231       MODE_SETTINGS      = 2,
1232       MODE_DESCRIPTION   = 3,
1233       MODE_ALIAS         = 4,
1234       MODE_ACTIONS       = 5
1235    } mode;
1236
1237    FILE *fp;
1238    struct url_actions *last_perm;
1239    struct url_actions *perm;
1240    char  *buf;
1241    struct file_list *fs;
1242    struct action_spec * cur_action = NULL;
1243    int cur_action_used = 0;
1244    struct action_alias * alias_list = NULL;
1245    unsigned long linenum = 0;
1246    mode = MODE_START_OF_FILE;
1247
1248    if (!check_file_changed(current_actions_file[fileid], csp->config->actions_file[fileid], &fs))
1249    {
1250       /* No need to load */
1251       csp->actions_list[fileid] = current_actions_file[fileid];
1252       return 0;
1253    }
1254    if (!fs)
1255    {
1256       log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': %E. "
1257          "Note that beginning with Privoxy 3.0.7, actions files have to be specified "
1258          "with their complete file names.", csp->config->actions_file[fileid]);
1259       return 1; /* never get here */
1260    }
1261
1262    fs->f = last_perm = zalloc_or_die(sizeof(*last_perm));
1263
1264    if ((fp = fopen(csp->config->actions_file[fileid], "r")) == NULL)
1265    {
1266       log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error opening file: %E",
1267                 csp->config->actions_file[fileid]);
1268       return 1; /* never get here */
1269    }
1270
1271    log_error(LOG_LEVEL_INFO, "Loading actions file: %s", csp->config->actions_file[fileid]);
1272
1273    while (read_config_line(fp, &linenum, &buf) != NULL)
1274    {
1275       if (*buf == '{')
1276       {
1277          /* It's a header block */
1278          if (buf[1] == '{')
1279          {
1280             /* It's {{settings}} or {{alias}} */
1281             size_t len = strlen(buf);
1282             char * start = buf + 2;
1283             char * end = buf + len - 1;
1284             if ((len < (size_t)5) || (*end-- != '}') || (*end-- != '}'))
1285             {
1286                /* too short */
1287                fclose(fp);
1288                log_error(LOG_LEVEL_FATAL,
1289                   "can't load actions file '%s': invalid line (%lu): %s",
1290                   csp->config->actions_file[fileid], linenum, buf);
1291                return 1; /* never get here */
1292             }
1293
1294             /* Trim leading and trailing whitespace. */
1295             end[1] = '\0';
1296             chomp(start);
1297
1298             if (*start == '\0')
1299             {
1300                /* too short */
1301                fclose(fp);
1302                log_error(LOG_LEVEL_FATAL,
1303                   "can't load actions file '%s': invalid line (%lu): {{ }}",
1304                   csp->config->actions_file[fileid], linenum);
1305                return 1; /* never get here */
1306             }
1307
1308             /*
1309              * An actionsfile can optionally contain the following blocks.
1310              * They *MUST* be in this order, to simplify processing:
1311              *
1312              * {{settings}}
1313              * name=value...
1314              *
1315              * {{description}}
1316              * ...free text, format TBD, but no line may start with a '{'...
1317              *
1318              * {{alias}}
1319              * name=actions...
1320              *
1321              * The actual actions must be *after* these special blocks.
1322              * None of these special blocks may be repeated.
1323              *
1324              */
1325             if (0 == strcmpic(start, "settings"))
1326             {
1327                /* it's a {{settings}} block */
1328                if (mode >= MODE_SETTINGS)
1329                {
1330                   /* {{settings}} must be first thing in file and must only
1331                    * appear once.
1332                    */
1333                   fclose(fp);
1334                   log_error(LOG_LEVEL_FATAL,
1335                      "can't load actions file '%s': line %lu: {{settings}} must only appear once, and it must be before anything else.",
1336                      csp->config->actions_file[fileid], linenum);
1337                }
1338                mode = MODE_SETTINGS;
1339             }
1340             else if (0 == strcmpic(start, "description"))
1341             {
1342                /* it's a {{description}} block */
1343                if (mode >= MODE_DESCRIPTION)
1344                {
1345                   /* {{description}} is a singleton and only {{settings}} may proceed it
1346                    */
1347                   fclose(fp);
1348                   log_error(LOG_LEVEL_FATAL,
1349                      "can't load actions file '%s': line %lu: {{description}} must only appear once, and only a {{settings}} block may be above it.",
1350                      csp->config->actions_file[fileid], linenum);
1351                }
1352                mode = MODE_DESCRIPTION;
1353             }
1354             else if (0 == strcmpic(start, "alias"))
1355             {
1356                /* it's an {{alias}} block */
1357                if (mode >= MODE_ALIAS)
1358                {
1359                   /* {{alias}} must be first thing in file, possibly after
1360                    * {{settings}} and {{description}}
1361                    *
1362                    * {{alias}} must only appear once.
1363                    *
1364                    * Note that these are new restrictions introduced in
1365                    * v2.9.10 in order to make actionsfile editing simpler.
1366                    * (Otherwise, reordering actionsfile entries without
1367                    * completely rewriting the file becomes non-trivial)
1368                    */
1369                   fclose(fp);
1370                   log_error(LOG_LEVEL_FATAL,
1371                      "can't load actions file '%s': line %lu: {{alias}} must only appear once, and it must be before all actions.",
1372                      csp->config->actions_file[fileid], linenum);
1373                }
1374                mode = MODE_ALIAS;
1375             }
1376             else
1377             {
1378                /* invalid {{something}} block */
1379                fclose(fp);
1380                log_error(LOG_LEVEL_FATAL,
1381                   "can't load actions file '%s': invalid line (%lu): {{%s}}",
1382                   csp->config->actions_file[fileid], linenum, start);
1383                return 1; /* never get here */
1384             }
1385          }
1386          else
1387          {
1388             /* It's an actions block */
1389
1390             char *actions_buf;
1391             char * end;
1392
1393             /* set mode */
1394             mode = MODE_ACTIONS;
1395
1396             /* free old action */
1397             if (cur_action)
1398             {
1399                if (!cur_action_used)
1400                {
1401                   free_action_spec(cur_action);
1402                }
1403                cur_action = NULL;
1404             }
1405             cur_action_used = 0;
1406             cur_action = zalloc_or_die(sizeof(*cur_action));
1407             init_action(cur_action);
1408
1409             /*
1410              * Copy the buffer before messing with it as we may need the
1411              * unmodified version in for the fatal error messages. Given
1412              * that this is not a common event, we could instead simply
1413              * read the line again.
1414              *
1415              * buf + 1 to skip the leading '{'
1416              */
1417             actions_buf = end = strdup_or_die(buf + 1);
1418
1419             /* check we have a trailing } and then trim it */
1420             if (strlen(actions_buf))
1421             {
1422                end += strlen(actions_buf) - 1;
1423             }
1424             if (*end != '}')
1425             {
1426                /* No closing } */
1427                fclose(fp);
1428                freez(actions_buf);
1429                log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1430                   "Missing trailing '}' in action section starting at line (%lu): %s",
1431                   csp->config->actions_file[fileid], linenum, buf);
1432                return 1; /* never get here */
1433             }
1434             *end = '\0';
1435
1436             /* trim any whitespace immediately inside {} */
1437             chomp(actions_buf);
1438
1439             if (get_actions(actions_buf, alias_list, cur_action))
1440             {
1441                /* error */
1442                fclose(fp);
1443                freez(actions_buf);
1444                log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
1445                   "can't completely parse the action section starting at line (%lu): %s",
1446                   csp->config->actions_file[fileid], linenum, buf);
1447                return 1; /* never get here */
1448             }
1449
1450             if (action_spec_is_valid(csp, cur_action))
1451             {
1452                log_error(LOG_LEVEL_ERROR, "Invalid action section in file '%s', "
1453                   "starting at line %lu: %s",
1454                   csp->config->actions_file[fileid], linenum, buf);
1455             }
1456
1457             freez(actions_buf);
1458          }
1459       }
1460       else if (mode == MODE_SETTINGS)
1461       {
1462          /*
1463           * Part of the {{settings}} block.
1464           * For now only serves to check if the file's minimum Privoxy
1465           * version requirement is met, but we may want to read & check
1466           * permissions when we go multi-user.
1467           */
1468          if (!strncmp(buf, "for-privoxy-version=", 20))
1469          {
1470             char *version_string, *fields[3];
1471             int num_fields;
1472
1473             version_string = strdup_or_die(buf + 20);
1474
1475             num_fields = ssplit(version_string, ".", fields, SZ(fields));
1476
1477             if (num_fields < 1 || atoi(fields[0]) == 0)
1478             {
1479                log_error(LOG_LEVEL_ERROR,
1480                  "While loading actions file '%s': invalid line (%lu): %s",
1481                   csp->config->actions_file[fileid], linenum, buf);
1482             }
1483             else if (                  (atoi(fields[0]) > VERSION_MAJOR)
1484                || ((num_fields > 1) && (atoi(fields[1]) > VERSION_MINOR))
1485                || ((num_fields > 2) && (atoi(fields[2]) > VERSION_POINT)))
1486             {
1487                fclose(fp);
1488                log_error(LOG_LEVEL_FATAL,
1489                          "Actions file '%s', line %lu requires newer Privoxy version: %s",
1490                          csp->config->actions_file[fileid], linenum, buf);
1491                return 1; /* never get here */
1492             }
1493             free(version_string);
1494          }
1495       }
1496       else if (mode == MODE_DESCRIPTION)
1497       {
1498          /*
1499           * Part of the {{description}} block.
1500           * Ignore for now.
1501           */
1502       }
1503       else if (mode == MODE_ALIAS)
1504       {
1505          /*
1506           * define an alias
1507           */
1508          char  actions_buf[BUFFER_SIZE];
1509          struct action_alias * new_alias;
1510
1511          char * start = strchr(buf, '=');
1512          char * end = start;
1513
1514          if ((start == NULL) || (start == buf))
1515          {
1516             log_error(LOG_LEVEL_FATAL,
1517                "can't load actions file '%s': invalid alias line (%lu): %s",
1518                csp->config->actions_file[fileid], linenum, buf);
1519             return 1; /* never get here */
1520          }
1521
1522          new_alias = zalloc_or_die(sizeof(*new_alias));
1523
1524          /* Eat any the whitespace before the '=' */
1525          end--;
1526          while ((*end == ' ') || (*end == '\t'))
1527          {
1528             /*
1529              * we already know we must have at least 1 non-ws char
1530              * at start of buf - no need to check
1531              */
1532             end--;
1533          }
1534          end[1] = '\0';
1535
1536          /* Eat any the whitespace after the '=' */
1537          start++;
1538          while ((*start == ' ') || (*start == '\t'))
1539          {
1540             start++;
1541          }
1542          if (*start == '\0')
1543          {
1544             log_error(LOG_LEVEL_FATAL,
1545                "can't load actions file '%s': invalid alias line (%lu): %s",
1546                csp->config->actions_file[fileid], linenum, buf);
1547             return 1; /* never get here */
1548          }
1549
1550          new_alias->name = strdup_or_die(buf);
1551
1552          strlcpy(actions_buf, start, sizeof(actions_buf));
1553
1554          if (get_actions(actions_buf, alias_list, new_alias->action))
1555          {
1556             /* error */
1557             fclose(fp);
1558             log_error(LOG_LEVEL_FATAL,
1559                "can't load actions file '%s': invalid alias line (%lu): %s = %s",
1560                csp->config->actions_file[fileid], linenum, buf, start);
1561             return 1; /* never get here */
1562          }
1563
1564          /* add to list */
1565          new_alias->next = alias_list;
1566          alias_list = new_alias;
1567       }
1568       else if (mode == MODE_ACTIONS)
1569       {
1570          /* it's an URL pattern */
1571
1572          /* allocate a new node */
1573          perm = zalloc_or_die(sizeof(*perm));
1574
1575          perm->action = cur_action;
1576          cur_action_used = 1;
1577
1578          /* Save the URL pattern */
1579          if (create_pattern_spec(perm->url, buf))
1580          {
1581             fclose(fp);
1582             log_error(LOG_LEVEL_FATAL,
1583                "can't load actions file '%s': line %lu: cannot create URL or TAG pattern from: %s",
1584                csp->config->actions_file[fileid], linenum, buf);
1585             return 1; /* never get here */
1586          }
1587
1588          /* add it to the list */
1589          last_perm->next = perm;
1590          last_perm = perm;
1591       }
1592       else if (mode == MODE_START_OF_FILE)
1593       {
1594          /* oops - please have a {} line as 1st line in file. */
1595          fclose(fp);
1596          log_error(LOG_LEVEL_FATAL,
1597             "can't load actions file '%s': line %lu should begin with a '{': %s",
1598             csp->config->actions_file[fileid], linenum, buf);
1599          return 1; /* never get here */
1600       }
1601       else
1602       {
1603          /* How did we get here? This is impossible! */
1604          fclose(fp);
1605          log_error(LOG_LEVEL_FATAL,
1606             "can't load actions file '%s': INTERNAL ERROR - mode = %d",
1607             csp->config->actions_file[fileid], mode);
1608          return 1; /* never get here */
1609       }
1610       freez(buf);
1611    }
1612
1613    fclose(fp);
1614
1615    if (!cur_action_used)
1616    {
1617       free_action_spec(cur_action);
1618    }
1619    free_alias_list(alias_list);
1620
1621    /* the old one is now obsolete */
1622    if (current_actions_file[fileid])
1623    {
1624       current_actions_file[fileid]->unloader = unload_actions_file;
1625    }
1626
1627    fs->next    = files->next;
1628    files->next = fs;
1629    current_actions_file[fileid] = fs;
1630
1631    csp->actions_list[fileid] = fs;
1632
1633    return(0);
1634
1635 }
1636
1637
1638 /*********************************************************************
1639  *
1640  * Function    :  actions_to_text
1641  *
1642  * Description :  Converts a actionsfile entry from the internal
1643  *                structure into a text line.  The output is split
1644  *                into one line for each action with line continuation.
1645  *
1646  * Parameters  :
1647  *          1  :  action = The action to format.
1648  *
1649  * Returns     :  A string.  Caller must free it.
1650  *                NULL on out-of-memory error.
1651  *
1652  *********************************************************************/
1653 char * actions_to_text(const struct action_spec *action)
1654 {
1655    unsigned long mask = action->mask;
1656    unsigned long add  = action->add;
1657    char *result = strdup_or_die("");
1658    struct list_entry * lst;
1659
1660    /* sanity - prevents "-feature +feature" */
1661    mask |= add;
1662
1663
1664 #define DEFINE_ACTION_BOOL(__name, __bit)          \
1665    if (!(mask & __bit))                            \
1666    {                                               \
1667       string_append(&result, " -" __name " \\\n"); \
1668    }                                               \
1669    else if (add & __bit)                           \
1670    {                                               \
1671       string_append(&result, " +" __name " \\\n"); \
1672    }
1673
1674 #define DEFINE_ACTION_STRING(__name, __bit, __index)   \
1675    if (!(mask & __bit))                                \
1676    {                                                   \
1677       string_append(&result, " -" __name " \\\n");     \
1678    }                                                   \
1679    else if (add & __bit)                               \
1680    {                                                   \
1681       string_append(&result, " +" __name "{");         \
1682       string_append(&result, action->string[__index]); \
1683       string_append(&result, "} \\\n");                \
1684    }
1685
1686 #define DEFINE_ACTION_MULTI(__name, __index)         \
1687    if (action->multi_remove_all[__index])            \
1688    {                                                 \
1689       string_append(&result, " -" __name " \\\n");   \
1690    }                                                 \
1691    else                                              \
1692    {                                                 \
1693       lst = action->multi_remove[__index]->first;    \
1694       while (lst)                                    \
1695       {                                              \
1696          string_append(&result, " -" __name "{");    \
1697          string_append(&result, lst->str);           \
1698          string_append(&result, "} \\\n");           \
1699          lst = lst->next;                            \
1700       }                                              \
1701    }                                                 \
1702    lst = action->multi_add[__index]->first;          \
1703    while (lst)                                       \
1704    {                                                 \
1705       string_append(&result, " +" __name "{");       \
1706       string_append(&result, lst->str);              \
1707       string_append(&result, "} \\\n");              \
1708       lst = lst->next;                               \
1709    }
1710
1711 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1712
1713 #include "actionlist.h"
1714
1715 #undef DEFINE_ACTION_MULTI
1716 #undef DEFINE_ACTION_STRING
1717 #undef DEFINE_ACTION_BOOL
1718 #undef DEFINE_ACTION_ALIAS
1719
1720    return result;
1721 }
1722
1723
1724 /*********************************************************************
1725  *
1726  * Function    :  actions_to_html
1727  *
1728  * Description :  Converts a actionsfile entry from numeric form
1729  *                ("mask" and "add") to a <br>-separated HTML string
1730  *                in which each action is linked to its chapter in
1731  *                the user manual.
1732  *
1733  * Parameters  :
1734  *          1  :  csp    = Client state (for config)
1735  *          2  :  action = Action spec to be converted
1736  *
1737  * Returns     :  A string.  Caller must free it.
1738  *                NULL on out-of-memory error.
1739  *
1740  *********************************************************************/
1741 char * actions_to_html(const struct client_state *csp,
1742                        const struct action_spec *action)
1743 {
1744    unsigned long mask = action->mask;
1745    unsigned long add  = action->add;
1746    char *result = strdup_or_die("");
1747    struct list_entry * lst;
1748
1749    /* sanity - prevents "-feature +feature" */
1750    mask |= add;
1751
1752
1753 #define DEFINE_ACTION_BOOL(__name, __bit)       \
1754    if (!(mask & __bit))                         \
1755    {                                            \
1756       string_append(&result, "\n<br>-");        \
1757       string_join(&result, add_help_link(__name, csp->config)); \
1758    }                                            \
1759    else if (add & __bit)                        \
1760    {                                            \
1761       string_append(&result, "\n<br>+");        \
1762       string_join(&result, add_help_link(__name, csp->config)); \
1763    }
1764
1765 #define DEFINE_ACTION_STRING(__name, __bit, __index) \
1766    if (!(mask & __bit))                              \
1767    {                                                 \
1768       string_append(&result, "\n<br>-");             \
1769       string_join(&result, add_help_link(__name, csp->config)); \
1770    }                                                 \
1771    else if (add & __bit)                             \
1772    {                                                 \
1773       string_append(&result, "\n<br>+");             \
1774       string_join(&result, add_help_link(__name, csp->config)); \
1775       string_append(&result, "{");                   \
1776       string_join(&result, html_encode(action->string[__index])); \
1777       string_append(&result, "}");                   \
1778    }
1779
1780 #define DEFINE_ACTION_MULTI(__name, __index)          \
1781    if (action->multi_remove_all[__index])             \
1782    {                                                  \
1783       string_append(&result, "\n<br>-");              \
1784       string_join(&result, add_help_link(__name, csp->config)); \
1785    }                                                  \
1786    else                                               \
1787    {                                                  \
1788       lst = action->multi_remove[__index]->first;     \
1789       while (lst)                                     \
1790       {                                               \
1791          string_append(&result, "\n<br>-");           \
1792          string_join(&result, add_help_link(__name, csp->config)); \
1793          string_append(&result, "{");                 \
1794          string_join(&result, html_encode(lst->str)); \
1795          string_append(&result, "}");                 \
1796          lst = lst->next;                             \
1797       }                                               \
1798    }                                                  \
1799    lst = action->multi_add[__index]->first;           \
1800    while (lst)                                        \
1801    {                                                  \
1802       string_append(&result, "\n<br>+");              \
1803       string_join(&result, add_help_link(__name, csp->config)); \
1804       string_append(&result, "{");                    \
1805       string_join(&result, html_encode(lst->str));    \
1806       string_append(&result, "}");                    \
1807       lst = lst->next;                                \
1808    }
1809
1810 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1811
1812 #include "actionlist.h"
1813
1814 #undef DEFINE_ACTION_MULTI
1815 #undef DEFINE_ACTION_STRING
1816 #undef DEFINE_ACTION_BOOL
1817 #undef DEFINE_ACTION_ALIAS
1818
1819    /* trim leading <br> */
1820    if (result && *result)
1821    {
1822       char * s = result;
1823       result = strdup(result + 5);
1824       free(s);
1825    }
1826
1827    return result;
1828 }
1829
1830
1831 /*********************************************************************
1832  *
1833  * Function    :  current_actions_to_html
1834  *
1835  * Description :  Converts a current action spec to a <br> separated HTML
1836  *                text in which each action is linked to its chapter in
1837  *                the user manual.
1838  *
1839  * Parameters  :
1840  *          1  :  csp    = Client state (for config)
1841  *          2  :  action = Current action spec to be converted
1842  *
1843  * Returns     :  A string.  Caller must free it.
1844  *                NULL on out-of-memory error.
1845  *
1846  *********************************************************************/
1847 char *current_action_to_html(const struct client_state *csp,
1848                              const struct current_action_spec *action)
1849 {
1850    unsigned long flags  = action->flags;
1851    struct list_entry * lst;
1852    char *result   = strdup_or_die("");
1853    char *active   = strdup_or_die("");
1854    char *inactive = strdup_or_die("");
1855
1856 #define DEFINE_ACTION_BOOL(__name, __bit)  \
1857    if (flags & __bit)                      \
1858    {                                       \
1859       string_append(&active, "\n<br>+");   \
1860       string_join(&active, add_help_link(__name, csp->config)); \
1861    }                                       \
1862    else                                    \
1863    {                                       \
1864       string_append(&inactive, "\n<br>-"); \
1865       string_join(&inactive, add_help_link(__name, csp->config)); \
1866    }
1867
1868 #define DEFINE_ACTION_STRING(__name, __bit, __index)   \
1869    if (flags & __bit)                                  \
1870    {                                                   \
1871       string_append(&active, "\n<br>+");               \
1872       string_join(&active, add_help_link(__name, csp->config)); \
1873       string_append(&active, "{");                     \
1874       string_join(&active, html_encode(action->string[__index])); \
1875       string_append(&active, "}");                     \
1876    }                                                   \
1877    else                                                \
1878    {                                                   \
1879       string_append(&inactive, "\n<br>-");             \
1880       string_join(&inactive, add_help_link(__name, csp->config)); \
1881    }
1882
1883 #define DEFINE_ACTION_MULTI(__name, __index)           \
1884    lst = action->multi[__index]->first;                \
1885    if (lst == NULL)                                    \
1886    {                                                   \
1887       string_append(&inactive, "\n<br>-");             \
1888       string_join(&inactive, add_help_link(__name, csp->config)); \
1889    }                                                   \
1890    else                                                \
1891    {                                                   \
1892       while (lst)                                      \
1893       {                                                \
1894          string_append(&active, "\n<br>+");            \
1895          string_join(&active, add_help_link(__name, csp->config)); \
1896          string_append(&active, "{");                  \
1897          string_join(&active, html_encode(lst->str));  \
1898          string_append(&active, "}");                  \
1899          lst = lst->next;                              \
1900       }                                                \
1901    }
1902
1903 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1904
1905 #include "actionlist.h"
1906
1907 #undef DEFINE_ACTION_MULTI
1908 #undef DEFINE_ACTION_STRING
1909 #undef DEFINE_ACTION_BOOL
1910 #undef DEFINE_ACTION_ALIAS
1911
1912    if (active != NULL)
1913    {
1914       string_append(&result, active);
1915       freez(active);
1916    }
1917    string_append(&result, "\n<br>");
1918    if (inactive != NULL)
1919    {
1920       string_append(&result, inactive);
1921       freez(inactive);
1922    }
1923    return result;
1924 }
1925
1926
1927 /*********************************************************************
1928  *
1929  * Function    :  action_to_line_of_text
1930  *
1931  * Description :  Converts a action spec to a single text line
1932  *                listing the enabled actions.
1933  *
1934  * Parameters  :
1935  *          1  :  action = Current action spec to be converted
1936  *
1937  * Returns     :  A string. Caller must free it.
1938  *                Out-of-memory errors are fatal.
1939  *
1940  *********************************************************************/
1941 char *actions_to_line_of_text(const struct current_action_spec *action)
1942 {
1943    char buffer[200];
1944    struct list_entry *lst;
1945    char *active;
1946    const unsigned long flags = action->flags;
1947
1948    active = strdup_or_die("");
1949
1950 #define DEFINE_ACTION_BOOL(__name, __bit)               \
1951    if (flags & __bit)                                   \
1952    {                                                    \
1953       snprintf(buffer, sizeof(buffer), "+%s ", __name); \
1954       string_append(&active, buffer);                   \
1955    }                                                    \
1956
1957 #define DEFINE_ACTION_STRING(__name, __bit, __index)    \
1958    if (flags & __bit)                                   \
1959    {                                                    \
1960       snprintf(buffer, sizeof(buffer), "+%s{%s} ",      \
1961          __name, action->string[__index]);              \
1962       string_append(&active, buffer);                   \
1963    }                                                    \
1964
1965 #define DEFINE_ACTION_MULTI(__name, __index)            \
1966    lst = action->multi[__index]->first;                 \
1967    while (lst != NULL)                                  \
1968    {                                                    \
1969       snprintf(buffer, sizeof(buffer), "+%s{%s} ",      \
1970          __name, lst->str);                             \
1971       string_append(&active, buffer);                   \
1972       lst = lst->next;                                  \
1973    }                                                    \
1974
1975 #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
1976
1977 #include "actionlist.h"
1978
1979 #undef DEFINE_ACTION_MULTI
1980 #undef DEFINE_ACTION_STRING
1981 #undef DEFINE_ACTION_BOOL
1982 #undef DEFINE_ACTION_ALIAS
1983
1984    if (active == NULL)
1985    {
1986       log_error(LOG_LEVEL_FATAL, "Out of memory in action_to_line_of_text()");
1987    }
1988
1989    return active;
1990 }