loaders.c

   1 const char loaders_rcs[] = "$Id: loaders.c,v 1.85 2011/07/30 15:13:32 fabiankeil Exp $";
   2 /*********************************************************************
   3  *
   4  * File        :  $Source: /cvsroot/ijbswa/current/loaders.c,v $
   5  *
   6  * Purpose     :  Functions to load and unload the various
   7  *                configuration files.  Also contains code to manage
   8  *                the list of active loaders, and to automatically
   9  *                unload files that are no longer in use.
  10  *
  11  * Copyright   :  Written by and Copyright (C) 2001-2010 the
  12  *                Privoxy team. http://www.privoxy.org/
  13  *
  14  *                Based on the Internet Junkbuster originally written
  15  *                by and Copyright (C) 1997 Anonymous Coders and
  16  *                Junkbusters Corporation.  http://www.junkbusters.com
  17  *
  18  *                This program is free software; you can redistribute it
  19  *                and/or modify it under the terms of the GNU General
  20  *                Public License as published by the Free Software
  21  *                Foundation; either version 2 of the License, or (at
  22  *                your option) any later version.
  23  *
  24  *                This program is distributed in the hope that it will
  25  *                be useful, but WITHOUT ANY WARRANTY; without even the
  26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  27  *                PARTICULAR PURPOSE.  See the GNU General Public
  28  *                License for more details.
  29  *
  30  *                The GNU General Public License should be included with
  31  *                this file.  If not, you can view it at
  32  *                http://www.gnu.org/copyleft/gpl.html
  33  *                or write to the Free Software Foundation, Inc., 59
  34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  35  *
  36  *********************************************************************/
  37
  38
  39 #include "config.h"
  40
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <sys/types.h>
  44 #include <string.h>
  45 #include <errno.h>
  46 #include <sys/stat.h>
  47 #include <ctype.h>
  48 #include <assert.h>
  49
  50 #if !defined(_WIN32) && !defined(__OS2__)
  51 #include <unistd.h>
  52 #endif
  53
  54 #include "project.h"
  55 #include "list.h"
  56 #include "loaders.h"
  57 #include "filters.h"
  58 #include "parsers.h"
  59 #include "jcc.h"
  60 #include "miscutil.h"
  61 #include "errlog.h"
  62 #include "actions.h"
  63 #include "urlmatch.h"
  64 #include "encode.h"
  65
  66 const char loaders_h_rcs[] = LOADERS_H_VERSION;
  67
  68 /*
  69  * Currently active files.
  70  * These are also entered in the main linked list of files.
  71  */
  72
  73 #ifdef FEATURE_TRUST
  74 static struct file_list *current_trustfile      = NULL;
  75 #endif /* def FEATURE_TRUST */
  76
  77 static int load_one_re_filterfile(struct client_state *csp, int fileid);
  78
  79 static struct file_list *current_re_filterfile[MAX_AF_FILES]  = {
  80    NULL, NULL, NULL, NULL, NULL,
  81    NULL, NULL, NULL, NULL, NULL
  82 };
  83
  84 /*
  85  * Pseudo filter type for load_one_re_filterfile
  86  */
  87 #define NO_NEW_FILTER -1
  88
  89
  90 /*********************************************************************
  91  *
  92  * Function    :  sweep
  93  *
  94  * Description :  Basically a mark and sweep garbage collector, it is run
  95  *                (by the parent thread) every once in a while to reclaim memory.
  96  *
  97  * It uses a mark and sweep strategy:
  98  *   1) mark all files as inactive
  99  *
 100  *   2) check with each client:
 101  *       if it is active,   mark its files as active
 102  *       if it is inactive, free its resources
 103  *
 104  *   3) free the resources of all of the files that
 105  *      are still marked as inactive (and are obsolete).
 106  *
 107  *   N.B. files that are not obsolete don't have an unloader defined.
 108  *
 109  * Parameters  :  None
 110  *
 111  * Returns     :  The number of threads that are still active.
 112  *
 113  *********************************************************************/
 114 unsigned int sweep(void)
 115 {
 116    struct file_list *fl, *nfl;
 117    struct client_state *csp;
 118    struct client_states *last_active, *client_list;
 119    int i;
 120    unsigned int active_threads = 0;
 121
 122    /* clear all of the file's active flags */
 123    for ( fl = files->next; NULL != fl; fl = fl->next )
 124    {
 125       fl->active = 0;
 126    }
 127
 128    last_active = clients;
 129    client_list = clients->next;
 130
 131    while (NULL != client_list)
 132    {
 133       csp = &client_list->csp;
 134       if (csp->flags & CSP_FLAG_ACTIVE)
 135       {
 136          /* Mark this client's files as active */
 137
 138          /*
 139           * Always have a configuration file.
 140           * (Also note the slightly non-standard extra
 141           * indirection here.)
 142           */
 143          csp->config->config_file_list->active = 1;
 144
 145          /*
 146           * Actions files
 147           */
 148          for (i = 0; i < MAX_AF_FILES; i++)
 149          {
 150             if (csp->actions_list[i])
 151             {
 152                csp->actions_list[i]->active = 1;
 153             }
 154          }
 155
 156          /*
 157           * Filter files
 158           */
 159          for (i = 0; i < MAX_AF_FILES; i++)
 160          {
 161             if (csp->rlist[i])
 162             {
 163                csp->rlist[i]->active = 1;
 164             }
 165          }
 166
 167          /*
 168           * Trust file
 169           */
 170 #ifdef FEATURE_TRUST
 171          if (csp->tlist)
 172          {
 173             csp->tlist->active = 1;
 174          }
 175 #endif /* def FEATURE_TRUST */
 176
 177          active_threads++;
 178
 179          last_active = client_list;
 180          client_list = client_list->next;
 181       }
 182       else
 183       /*
 184        * This client is not active. Free its resources.
 185        */
 186       {
 187          last_active->next = client_list->next;
 188
 189          freez(csp->ip_addr_str);
 190          freez(csp->iob->buf);
 191          freez(csp->error_message);
 192
 193          if (csp->action->flags & ACTION_FORWARD_OVERRIDE &&
 194              NULL != csp->fwd)
 195          {
 196             unload_forward_spec(csp->fwd);
 197          }
 198          free_http_request(csp->http);
 199
 200          destroy_list(csp->headers);
 201          destroy_list(csp->tags);
 202
 203          free_current_action(csp->action);
 204
 205 #ifdef FEATURE_STATISTICS
 206          urls_read++;
 207          if (csp->flags & CSP_FLAG_REJECTED)
 208          {
 209             urls_rejected++;
 210          }
 211 #endif /* def FEATURE_STATISTICS */
 212
 213          freez(client_list);
 214
 215          client_list = last_active->next;
 216       }
 217    }
 218
 219    nfl = files;
 220    fl = files->next;
 221
 222    while (fl != NULL)
 223    {
 224       if ( ( 0 == fl->active ) && ( NULL != fl->unloader ) )
 225       {
 226          nfl->next = fl->next;
 227
 228          (fl->unloader)(fl->f);
 229
 230          freez(fl->filename);
 231          freez(fl);
 232
 233          fl = nfl->next;
 234       }
 235       else
 236       {
 237          nfl = fl;
 238          fl = fl->next;
 239       }
 240    }
 241
 242    return active_threads;
 243
 244 }
 245
 246
 247 /*********************************************************************
 248  *
 249  * Function    :  check_file_changed
 250  *
 251  * Description :  Helper function to check if a file needs reloading.
 252  *                If "current" is still current, return it.  Otherwise
 253  *                allocates a new (zeroed) "struct file_list", fills
 254  *                in the disk file name and timestamp, and returns it.
 255  *
 256  * Parameters  :
 257  *          1  :  current = The file_list currently being used - will
 258  *                          be checked to see if it is out of date.
 259  *                          May be NULL (which is treated as out of
 260  *                          date).
 261  *          2  :  filename = Name of file to check.
 262  *          3  :  newfl    = New file list. [Output only]
 263  *                           This will be set to NULL, OR a struct
 264  *                           file_list newly allocated on the
 265  *                           heap, with the filename and lastmodified
 266  *                           fields filled, and all others zeroed.
 267  *
 268  * Returns     :  If file unchanged: 0 (and sets newfl == NULL)
 269  *                If file changed: 1 and sets newfl != NULL
 270  *                On error: 1 and sets newfl == NULL
 271  *
 272  *********************************************************************/
 273 int check_file_changed(const struct file_list * current,
 274                        const char * filename,
 275                        struct file_list ** newfl)
 276 {
 277    struct file_list *fs;
 278    struct stat statbuf[1];
 279
 280    *newfl = NULL;
 281
 282    if (stat(filename, statbuf) < 0)
 283    {
 284       /* Error, probably file not found. */
 285       return 1;
 286    }
 287
 288    if (current
 289        && (current->lastmodified == statbuf->st_mtime)
 290        && (0 == strcmp(current->filename, filename)))
 291    {
 292       return 0;
 293    }
 294
 295    fs = (struct file_list *)zalloc(sizeof(struct file_list));
 296    if (fs == NULL)
 297    {
 298       /* Out of memory error */
 299       return 1;
 300    }
 301
 302
 303    fs->filename = strdup(filename);
 304    fs->lastmodified = statbuf->st_mtime;
 305
 306    if (fs->filename == NULL)
 307    {
 308       /* Out of memory error */
 309       freez (fs);
 310       return 1;
 311    }
 312    *newfl = fs;
 313    return 1;
 314 }
 315
 316
 317 /*********************************************************************
 318  *
 319  * Function    :  simple_read_line
 320  *
 321  * Description :  Read a single line from a file and return it.
 322  *                This is basically a version of fgets() that malloc()s
 323  *                it's own line buffer.  Note that the buffer will
 324  *                always be a multiple of BUFFER_SIZE bytes long.
 325  *                Therefore if you are going to keep the string for
 326  *                an extended period of time, you should probably
 327  *                strdup() it and free() the original, to save memory.
 328  *
 329  *
 330  * Parameters  :
 331  *          1  :  dest = destination for newly malloc'd pointer to
 332  *                line data.  Will be set to NULL on error.
 333  *          2  :  fp = File to read from
 334  *          3  :  newline = Standard for newlines in the file.
 335  *                Will be unchanged if it's value on input is not
 336  *                NEWLINE_UNKNOWN.
 337  *                On output, may be changed from NEWLINE_UNKNOWN to
 338  *                actual convention in file.
 339  *
 340  * Returns     :  JB_ERR_OK     on success
 341  *                JB_ERR_MEMORY on out-of-memory
 342  *                JB_ERR_FILE   on EOF.
 343  *
 344  *********************************************************************/
 345 jb_err simple_read_line(FILE *fp, char **dest, int *newline)
 346 {
 347    size_t len = 0;
 348    size_t buflen = BUFFER_SIZE;
 349    char * buf;
 350    char * p;
 351    int ch;
 352    int realnewline = NEWLINE_UNKNOWN;
 353
 354    if (NULL == (buf = malloc(buflen)))
 355    {
 356       return JB_ERR_MEMORY;
 357    }
 358
 359    p = buf;
 360
 361 /*
 362  * Character codes.  If you have a weird compiler and the following are
 363  * incorrect, you also need to fix NEWLINE() in loaders.h
 364  */
 365 #define CHAR_CR '\r' /* ASCII 13 */
 366 #define CHAR_LF '\n' /* ASCII 10 */
 367
 368    for (;;)
 369    {
 370       ch = getc(fp);
 371       if (ch == EOF)
 372       {
 373          if (len > 0)
 374          {
 375             *p = '\0';
 376             *dest = buf;
 377             return JB_ERR_OK;
 378          }
 379          else
 380          {
 381             free(buf);
 382             *dest = NULL;
 383             return JB_ERR_FILE;
 384          }
 385       }
 386       else if (ch == CHAR_CR)
 387       {
 388          ch = getc(fp);
 389          if (ch == CHAR_LF)
 390          {
 391             if (*newline == NEWLINE_UNKNOWN)
 392             {
 393                *newline = NEWLINE_DOS;
 394             }
 395          }
 396          else
 397          {
 398             if (ch != EOF)
 399             {
 400                ungetc(ch, fp);
 401             }
 402             if (*newline == NEWLINE_UNKNOWN)
 403             {
 404                *newline = NEWLINE_MAC;
 405             }
 406          }
 407          *p = '\0';
 408          *dest = buf;
 409          if (*newline == NEWLINE_UNKNOWN)
 410          {
 411             *newline = realnewline;
 412          }
 413          return JB_ERR_OK;
 414       }
 415       else if (ch == CHAR_LF)
 416       {
 417          *p = '\0';
 418          *dest = buf;
 419          if (*newline == NEWLINE_UNKNOWN)
 420          {
 421             *newline = NEWLINE_UNIX;
 422          }
 423          return JB_ERR_OK;
 424       }
 425       else if (ch == 0)
 426       {
 427          *p = '\0';
 428          *dest = buf;
 429          return JB_ERR_OK;
 430       }
 431
 432       *p++ = (char)ch;
 433
 434       if (++len >= buflen)
 435       {
 436          buflen += BUFFER_SIZE;
 437          if (NULL == (p = realloc(buf, buflen)))
 438          {
 439             free(buf);
 440             return JB_ERR_MEMORY;
 441          }
 442          buf = p;
 443          p = buf + len;
 444       }
 445    }
 446 }
 447
 448
 449 /*********************************************************************
 450  *
 451  * Function    :  edit_read_line
 452  *
 453  * Description :  Read a single non-empty line from a file and return
 454  *                it.  Trims comments, leading and trailing whitespace
 455  *                and respects escaping of newline and comment char.
 456  *                Provides the line in 2 alternative forms: raw and
 457  *                preprocessed.
 458  *                - raw is the raw data read from the file.  If the
 459  *                  line is not modified, then this should be written
 460  *                  to the new file.
 461  *                - prefix is any comments and blank lines that were
 462  *                  read from the file.  If the line is modified, then
 463  *                  this should be written out to the file followed
 464  *                  by the modified data.  (If this string is non-empty
 465  *                  then it will have a newline at the end).
 466  *                - data is the actual data that will be parsed
 467  *                  further by appropriate routines.
 468  *                On EOF, the 3 strings will all be set to NULL and
 469  *                0 will be returned.
 470  *
 471  * Parameters  :
 472  *          1  :  fp = File to read from
 473  *          2  :  raw_out = destination for newly malloc'd pointer to
 474  *                raw line data.  May be NULL if you don't want it.
 475  *          3  :  prefix_out = destination for newly malloc'd pointer to
 476  *                comments.  May be NULL if you don't want it.
 477  *          4  :  data_out = destination for newly malloc'd pointer to
 478  *                line data with comments and leading/trailing spaces
 479  *                removed, and line continuation performed.  May be
 480  *                NULL if you don't want it.
 481  *          5  :  newline = Standard for newlines in the file.
 482  *                On input, set to value to use or NEWLINE_UNKNOWN.
 483  *                On output, may be changed from NEWLINE_UNKNOWN to
 484  *                actual convention in file.  May be NULL if you
 485  *                don't want it.
 486  *          6  :  line_number = Line number in file.  In "lines" as
 487  *                reported by a text editor, not lines containing data.
 488  *
 489  * Returns     :  JB_ERR_OK     on success
 490  *                JB_ERR_MEMORY on out-of-memory
 491  *                JB_ERR_FILE   on EOF.
 492  *
 493  *********************************************************************/
 494 jb_err edit_read_line(FILE *fp,
 495                       char **raw_out,
 496                       char **prefix_out,
 497                       char **data_out,
 498                       int *newline,
 499                       unsigned long *line_number)
 500 {
 501    char *p;          /* Temporary pointer   */
 502    char *linebuf;    /* Line read from file */
 503    char *linestart;  /* Start of linebuf, usually first non-whitespace char */
 504    int contflag = 0; /* Nonzero for line continuation - i.e. line ends '\' */
 505    int is_empty = 1; /* Flag if not got any data yet */
 506    char *raw    = NULL; /* String to be stored in raw_out    */
 507    char *prefix = NULL; /* String to be stored in prefix_out */
 508    char *data   = NULL; /* String to be stored in data_out   */
 509    int scrapnewline;    /* Used for (*newline) if newline==NULL */
 510    jb_err rval = JB_ERR_OK;
 511
 512    assert(fp);
 513    assert(raw_out || data_out);
 514    assert(newline == NULL
 515        || *newline == NEWLINE_UNKNOWN
 516        || *newline == NEWLINE_UNIX
 517        || *newline == NEWLINE_DOS
 518        || *newline == NEWLINE_MAC);
 519
 520    if (newline == NULL)
 521    {
 522       scrapnewline = NEWLINE_UNKNOWN;
 523       newline = &scrapnewline;
 524    }
 525
 526    /* Set output parameters to NULL */
 527    if (raw_out)
 528    {
 529       *raw_out    = NULL;
 530    }
 531    if (prefix_out)
 532    {
 533       *prefix_out = NULL;
 534    }
 535    if (data_out)
 536    {
 537       *data_out   = NULL;
 538    }
 539
 540    /* Set string variables to new, empty strings. */
 541
 542    if (raw_out)
 543    {
 544       raw = strdup("");
 545       if (NULL == raw)
 546       {
 547          return JB_ERR_MEMORY;
 548       }
 549    }
 550    if (prefix_out)
 551    {
 552       prefix = strdup("");
 553       if (NULL == prefix)
 554       {
 555          freez(raw);
 556          return JB_ERR_MEMORY;
 557       }
 558    }
 559    if (data_out)
 560    {
 561       data = strdup("");
 562       if (NULL == data)
 563       {
 564          freez(raw);
 565          freez(prefix);
 566          return JB_ERR_MEMORY;
 567       }
 568    }
 569
 570    /* Main loop.  Loop while we need more data & it's not EOF. */
 571
 572    while ( (contflag || is_empty)
 573         && (JB_ERR_OK == (rval = simple_read_line(fp, &linebuf, newline))))
 574    {
 575       if (line_number)
 576       {
 577          (*line_number)++;
 578       }
 579       if (raw)
 580       {
 581          string_append(&raw,linebuf);
 582          if (string_append(&raw,NEWLINE(*newline)))
 583          {
 584             freez(prefix);
 585             freez(data);
 586             free(linebuf);
 587             return JB_ERR_MEMORY;
 588          }
 589       }
 590
 591       /* Line continuation? Trim escape and set flag. */
 592       p = linebuf + strlen(linebuf) - 1;
 593       contflag = ((*linebuf != '\0') && (*p == '\\'));
 594       if (contflag)
 595       {
 596          *p = '\0';
 597       }
 598
 599       /* Trim leading spaces if we're at the start of the line */
 600       linestart = linebuf;
 601       assert(NULL != data);
 602       if (*data == '\0')
 603       {
 604          /* Trim leading spaces */
 605          while (*linestart && isspace((int)(unsigned char)*linestart))
 606          {
 607             linestart++;
 608          }
 609       }
 610
 611       /* Handle comment characters. */
 612       p = linestart;
 613       while ((p = strchr(p, '#')) != NULL)
 614       {
 615          /* Found a comment char.. */
 616          if ((p != linebuf) && (*(p-1) == '\\'))
 617          {
 618             /* ..and it's escaped, left-shift the line over the escape. */
 619             char *q = p - 1;
 620             while ((*q = *(q + 1)) != '\0')
 621             {
 622                q++;
 623             }
 624             /* Now scan from just after the "#". */
 625          }
 626          else
 627          {
 628             /* Real comment.  Save it... */
 629             if (p == linestart)
 630             {
 631                /* Special case:  Line only contains a comment, so all the
 632                 * previous whitespace is considered part of the comment.
 633                 * Undo the whitespace skipping, if any.
 634                 */
 635                linestart = linebuf;
 636                p = linestart;
 637             }
 638             if (prefix)
 639             {
 640                string_append(&prefix,p);
 641                if (string_append(&prefix, NEWLINE(*newline)))
 642                {
 643                   freez(raw);
 644                   freez(data);
 645                   free(linebuf);
 646                   return JB_ERR_MEMORY;
 647                }
 648             }
 649
 650             /* ... and chop off the rest of the line */
 651             *p = '\0';
 652          }
 653       } /* END while (there's a # character) */
 654
 655       /* Write to the buffer */
 656       if (*linestart)
 657       {
 658          is_empty = 0;
 659          if (data)
 660          {
 661             if (string_append(&data, linestart))
 662             {
 663                freez(raw);
 664                freez(prefix);
 665                free(linebuf);
 666                return JB_ERR_MEMORY;
 667             }
 668          }
 669       }
 670
 671       free(linebuf);
 672    } /* END while(we need more data) */
 673
 674    /* Handle simple_read_line() errors - ignore EOF */
 675    if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE))
 676    {
 677       freez(raw);
 678       freez(prefix);
 679       freez(data);
 680       return rval;
 681    }
 682
 683    if (raw ? (*raw == '\0') : is_empty)
 684    {
 685       /* EOF and no data there.  (Definition of "data" depends on whether
 686        * the caller cares about "raw" or just "data").
 687        */
 688
 689       freez(raw);
 690       freez(prefix);
 691       freez(data);
 692
 693       return JB_ERR_FILE;
 694    }
 695    else
 696    {
 697       /* Got at least some data */
 698
 699       /* Remove trailing whitespace */
 700       chomp(data);
 701
 702       if (raw_out)
 703       {
 704          *raw_out    = raw;
 705       }
 706       else
 707       {
 708          freez(raw);
 709       }
 710       if (prefix_out)
 711       {
 712          *prefix_out = prefix;
 713       }
 714       else
 715       {
 716          freez(prefix);
 717       }
 718       if (data_out)
 719       {
 720          *data_out   = data;
 721       }
 722       else
 723       {
 724          freez(data);
 725       }
 726       return JB_ERR_OK;
 727    }
 728 }
 729
 730
 731 /*********************************************************************
 732  *
 733  * Function    :  read_config_line
 734  *
 735  * Description :  Read a single non-empty line from a file and return
 736  *                it.  Trims comments, leading and trailing whitespace
 737  *                and respects escaping of newline and comment char.
 738  *
 739  * Parameters  :
 740  *          1  :  fp = File to read from
 741  *          2  :  linenum = linenumber in file
 742  *          3  :  buf = Pointer to a pointer to set to the data buffer.
 743  *
 744  * Returns     :  NULL on EOF or error
 745  *                Otherwise, returns buf.
 746  *
 747  *********************************************************************/
 748 char *read_config_line(FILE *fp, unsigned long *linenum, char **buf)
 749 {
 750    jb_err err;
 751    err = edit_read_line(fp, NULL, NULL, buf, NULL, linenum);
 752    if (err)
 753    {
 754       if (err == JB_ERR_MEMORY)
 755       {
 756          log_error(LOG_LEVEL_FATAL, "Out of memory loading a config file");
 757       }
 758       *buf = NULL;
 759    }
 760    return *buf;
 761 }
 762
 763
 764 #ifdef FEATURE_TRUST
 765 /*********************************************************************
 766  *
 767  * Function    :  unload_trustfile
 768  *
 769  * Description :  Unloads a trustfile.
 770  *
 771  * Parameters  :
 772  *          1  :  f = the data structure associated with the trustfile.
 773  *
 774  * Returns     :  N/A
 775  *
 776  *********************************************************************/
 777 static void unload_trustfile(void *f)
 778 {
 779    struct block_spec *cur = (struct block_spec *)f;
 780    struct block_spec *next;
 781
 782    while (cur != NULL)
 783    {
 784       next = cur->next;
 785
 786       free_url_spec(cur->url);
 787       free(cur);
 788
 789       cur = next;
 790    }
 791
 792 }
 793
 794
 795 #ifdef FEATURE_GRACEFUL_TERMINATION
 796 /*********************************************************************
 797  *
 798  * Function    :  unload_current_trust_file
 799  *
 800  * Description :  Unloads current trust file - reset to state at
 801  *                beginning of program.
 802  *
 803  * Parameters  :  None
 804  *
 805  * Returns     :  N/A
 806  *
 807  *********************************************************************/
 808 void unload_current_trust_file(void)
 809 {
 810    if (current_trustfile)
 811    {
 812       current_trustfile->unloader = unload_trustfile;
 813       current_trustfile = NULL;
 814    }
 815 }
 816 #endif /* FEATURE_GRACEFUL_TERMINATION */
 817
 818
 819 /*********************************************************************
 820  *
 821  * Function    :  load_trustfile
 822  *
 823  * Description :  Read and parse a trustfile and add to files list.
 824  *
 825  * Parameters  :
 826  *          1  :  csp = Current client state (buffers, headers, etc...)
 827  *
 828  * Returns     :  0 => Ok, everything else is an error.
 829  *
 830  *********************************************************************/
 831 int load_trustfile(struct client_state *csp)
 832 {
 833    FILE *fp;
 834
 835    struct block_spec *b, *bl;
 836    struct url_spec **tl;
 837
 838    char *buf = NULL;
 839    int reject, trusted;
 840    struct file_list *fs;
 841    unsigned long linenum = 0;
 842    int trusted_referrers = 0;
 843
 844    if (!check_file_changed(current_trustfile, csp->config->trustfile, &fs))
 845    {
 846       /* No need to load */
 847       csp->tlist = current_trustfile;
 848       return(0);
 849    }
 850    if (!fs)
 851    {
 852       goto load_trustfile_error;
 853    }
 854
 855    fs->f = bl = (struct block_spec *)zalloc(sizeof(*bl));
 856    if (bl == NULL)
 857    {
 858       goto load_trustfile_error;
 859    }
 860
 861    if ((fp = fopen(csp->config->trustfile, "r")) == NULL)
 862    {
 863       goto load_trustfile_error;
 864    }
 865    log_error(LOG_LEVEL_INFO, "Loading trust file: %s", csp->config->trustfile);
 866
 867    tl = csp->config->trust_list;
 868
 869    while (read_config_line(fp, &linenum, &buf) != NULL)
 870    {
 871       trusted = 0;
 872       reject  = 1;
 873
 874       if (*buf == '+')
 875       {
 876          trusted = 1;
 877          *buf = '~';
 878       }
 879
 880       if (*buf == '~')
 881       {
 882          char *p;
 883          char *q;
 884
 885          reject = 0;
 886          p = buf;
 887          q = p+1;
 888          while ((*p++ = *q++) != '\0')
 889          {
 890             /* nop */
 891          }
 892       }
 893
 894       /* skip blank lines */
 895       if (*buf == '\0')
 896       {
 897          freez(buf);
 898          continue;
 899       }
 900
 901       /* allocate a new node */
 902       if ((b = zalloc(sizeof(*b))) == NULL)
 903       {
 904          fclose(fp);
 905          goto load_trustfile_error;
 906       }
 907
 908       /* add it to the list */
 909       b->next  = bl->next;
 910       bl->next = b;
 911
 912       b->reject = reject;
 913
 914       /* Save the URL pattern */
 915       if (create_url_spec(b->url, buf))
 916       {
 917          fclose(fp);
 918          goto load_trustfile_error;
 919       }
 920
 921       /*
 922        * save a pointer to URL's spec in the list of trusted URL's, too
 923        */
 924       if (trusted)
 925       {
 926          if(++trusted_referrers < MAX_TRUSTED_REFERRERS)
 927          {
 928             *tl++ = b->url;
 929          }
 930       }
 931       freez(buf);
 932    }
 933
 934    if(trusted_referrers >= MAX_TRUSTED_REFERRERS)
 935    {
 936       /*
 937        * FIXME: ... after Privoxy 3.0.4 is out.
 938        */
 939        log_error(LOG_LEVEL_ERROR, "Too many trusted referrers. Current limit is %d, you are using %d.\n"
 940           "  Additional trusted referrers are treated like ordinary trusted URLs.\n"
 941           "  (You can increase this limit by changing MAX_TRUSTED_REFERRERS in project.h and recompiling).",
 942           MAX_TRUSTED_REFERRERS, trusted_referrers);
 943    }
 944
 945    *tl = NULL;
 946
 947    fclose(fp);
 948
 949    /* the old one is now obsolete */
 950    if (current_trustfile)
 951    {
 952       current_trustfile->unloader = unload_trustfile;
 953    }
 954
 955    fs->next    = files->next;
 956    files->next = fs;
 957    current_trustfile = fs;
 958    csp->tlist = fs;
 959
 960    return(0);
 961
 962 load_trustfile_error:
 963    log_error(LOG_LEVEL_FATAL, "can't load trustfile '%s': %E",
 964       csp->config->trustfile);
 965    freez(buf);
 966    return(-1);
 967
 968 }
 969 #endif /* def FEATURE_TRUST */
 970
 971
 972 /*********************************************************************
 973  *
 974  * Function    :  unload_re_filterfile
 975  *
 976  * Description :  Unload the re_filter list by freeing all chained
 977  *                re_filterfile specs and their data.
 978  *
 979  * Parameters  :
 980  *          1  :  f = the data structure associated with the filterfile.
 981  *
 982  * Returns     :  N/A
 983  *
 984  *********************************************************************/
 985 static void unload_re_filterfile(void *f)
 986 {
 987    struct re_filterfile_spec *a, *b = (struct re_filterfile_spec *)f;
 988
 989    while (b != NULL)
 990    {
 991       a = b->next;
 992
 993       destroy_list(b->patterns);
 994       pcrs_free_joblist(b->joblist);
 995       freez(b->name);
 996       freez(b->description);
 997       freez(b);
 998
 999       b = a;
1000    }
1001
1002    return;
1003 }
1004
1005 /*********************************************************************
1006  *
1007  * Function    :  unload_forward_spec
1008  *
1009  * Description :  Unload the forward spec settings by freeing all
1010  *                memory referenced by members and the memory for
1011  *                the spec itself.
1012  *
1013  * Parameters  :
1014  *          1  :  fwd = the forward spec.
1015  *
1016  * Returns     :  N/A
1017  *
1018  *********************************************************************/
1019 void unload_forward_spec(struct forward_spec *fwd)
1020 {
1021    free_url_spec(fwd->url);
1022    freez(fwd->gateway_host);
1023    freez(fwd->forward_host);
1024    free(fwd);
1025
1026    return;
1027 }
1028
1029
1030 #ifdef FEATURE_GRACEFUL_TERMINATION
1031 /*********************************************************************
1032  *
1033  * Function    :  unload_current_re_filterfile
1034  *
1035  * Description :  Unloads current re_filter file - reset to state at
1036  *                beginning of program.
1037  *
1038  * Parameters  :  None
1039  *
1040  * Returns     :  N/A
1041  *
1042  *********************************************************************/
1043 void unload_current_re_filterfile(void)
1044 {
1045    int i;
1046
1047    for (i = 0; i < MAX_AF_FILES; i++)
1048    {
1049       if (current_re_filterfile[i])
1050       {
1051          current_re_filterfile[i]->unloader = unload_re_filterfile;
1052          current_re_filterfile[i] = NULL;
1053       }
1054    }
1055 }
1056 #endif
1057
1058
1059 /*********************************************************************
1060  *
1061  * Function    :  load_re_filterfiles
1062  *
1063  * Description :  Loads all the filterfiles.
1064  *                Generate a chained list of re_filterfile_spec's from
1065  *                the "FILTER: " blocks, compiling all their substitutions
1066  *                into chained lists of pcrs_job structs.
1067  *
1068  * Parameters  :
1069  *          1  :  csp = Current client state (buffers, headers, etc...)
1070  *
1071  * Returns     :  0 => Ok, everything else is an error.
1072  *
1073  *********************************************************************/
1074 int load_re_filterfiles(struct client_state *csp)
1075 {
1076    int i;
1077    int result;
1078
1079    for (i = 0; i < MAX_AF_FILES; i++)
1080    {
1081       if (csp->config->re_filterfile[i])
1082       {
1083          result = load_one_re_filterfile(csp, i);
1084          if (result)
1085          {
1086             return result;
1087          }
1088       }
1089       else if (current_re_filterfile[i])
1090       {
1091          current_re_filterfile[i]->unloader = unload_re_filterfile;
1092          current_re_filterfile[i] = NULL;
1093       }
1094    }
1095
1096    return 0;
1097 }
1098
1099
1100 /*********************************************************************
1101  *
1102  * Function    :  load_one_re_filterfile
1103  *
1104  * Description :  Load a re_filterfile.
1105  *                Generate a chained list of re_filterfile_spec's from
1106  *                the "FILTER: " blocks, compiling all their substitutions
1107  *                into chained lists of pcrs_job structs.
1108  *
1109  * Parameters  :
1110  *          1  :  csp = Current client state (buffers, headers, etc...)
1111  *
1112  * Returns     :  0 => Ok, everything else is an error.
1113  *
1114  *********************************************************************/
1115 int load_one_re_filterfile(struct client_state *csp, int fileid)
1116 {
1117    FILE *fp;
1118
1119    struct re_filterfile_spec *new_bl, *bl = NULL;
1120    struct file_list *fs;
1121
1122    char *buf = NULL;
1123    int error;
1124    unsigned long linenum = 0;
1125    pcrs_job *dummy, *lastjob = NULL;
1126
1127    /*
1128     * No need to reload if unchanged
1129     */
1130    if (!check_file_changed(current_re_filterfile[fileid], csp->config->re_filterfile[fileid], &fs))
1131    {
1132       csp->rlist[fileid] = current_re_filterfile[fileid];
1133       return(0);
1134    }
1135    if (!fs)
1136    {
1137       goto load_re_filterfile_error;
1138    }
1139
1140    /*
1141     * Open the file or fail
1142     */
1143    if ((fp = fopen(csp->config->re_filterfile[fileid], "r")) == NULL)
1144    {
1145       goto load_re_filterfile_error;
1146    }
1147
1148    log_error(LOG_LEVEL_INFO, "Loading filter file: %s", csp->config->re_filterfile[fileid]);
1149
1150    /*
1151     * Read line by line
1152     */
1153    while (read_config_line(fp, &linenum, &buf) != NULL)
1154    {
1155       int new_filter = NO_NEW_FILTER;
1156
1157       if (strncmp(buf, "FILTER:", 7) == 0)
1158       {
1159          new_filter = FT_CONTENT_FILTER;
1160       }
1161       else if (strncmp(buf, "SERVER-HEADER-FILTER:", 21) == 0)
1162       {
1163          new_filter = FT_SERVER_HEADER_FILTER;
1164       }
1165       else if (strncmp(buf, "CLIENT-HEADER-FILTER:", 21) == 0)
1166       {
1167          new_filter = FT_CLIENT_HEADER_FILTER;
1168       }
1169       else if (strncmp(buf, "CLIENT-HEADER-TAGGER:", 21) == 0)
1170       {
1171          new_filter = FT_CLIENT_HEADER_TAGGER;
1172       }
1173       else if (strncmp(buf, "SERVER-HEADER-TAGGER:", 21) == 0)
1174       {
1175          new_filter = FT_SERVER_HEADER_TAGGER;
1176       }
1177
1178       /*
1179        * If this is the head of a new filter block, make it a
1180        * re_filterfile spec of its own and chain it to the list:
1181        */
1182       if (new_filter != NO_NEW_FILTER)
1183       {
1184          new_bl = (struct re_filterfile_spec  *)zalloc(sizeof(*bl));
1185          if (new_bl == NULL)
1186          {
1187             goto load_re_filterfile_error;
1188          }
1189          if (new_filter == FT_CONTENT_FILTER)
1190          {
1191             new_bl->name = chomp(buf + 7);
1192          }
1193          else
1194          {
1195             new_bl->name = chomp(buf + 21);
1196          }
1197          new_bl->type = new_filter;
1198
1199          /*
1200           * If a filter description is available,
1201           * encode it to HTML and save it.
1202           */
1203          if (NULL != (new_bl->description = strpbrk(new_bl->name, " \t")))
1204          {
1205             *new_bl->description++ = '\0';
1206             new_bl->description = html_encode(chomp(new_bl->description));
1207             if (NULL == new_bl->description)
1208             {
1209                new_bl->description = strdup("Out of memory while encoding this filter's description to HTML");
1210             }
1211          }
1212          else
1213          {
1214             new_bl->description = strdup("No description available for this filter");
1215          }
1216
1217          new_bl->name = strdup(chomp(new_bl->name));
1218
1219          /*
1220           * If this is the first filter block, chain it
1221           * to the file_list rather than its (nonexistant)
1222           * predecessor
1223           */
1224          if (fs->f == NULL)
1225          {
1226             fs->f = new_bl;
1227          }
1228          else
1229          {
1230             assert(NULL != bl);
1231             bl->next = new_bl;
1232          }
1233          bl = new_bl;
1234
1235          log_error(LOG_LEVEL_RE_FILTER, "Reading in filter \"%s\" (\"%s\")", bl->name, bl->description);
1236
1237          freez(buf);
1238          continue;
1239       }
1240
1241       /*
1242        * Else, save the expression, make it a pcrs_job
1243        * and chain it into the current filter's joblist
1244        */
1245       if (bl != NULL)
1246       {
1247          error = enlist(bl->patterns, buf);
1248          if (JB_ERR_MEMORY == error)
1249          {
1250             log_error(LOG_LEVEL_FATAL,
1251                "Out of memory while enlisting re_filter job \'%s\' for filter %s.", buf, bl->name);
1252          }
1253          assert(JB_ERR_OK == error);
1254
1255          if (pcrs_job_is_dynamic(buf))
1256          {
1257             /*
1258              * Dynamic pattern that might contain variables
1259              * and has to be recompiled for every request
1260              */
1261             if (bl->joblist != NULL)
1262             {
1263                 pcrs_free_joblist(bl->joblist);
1264                 bl->joblist = NULL;
1265             }
1266             bl->dynamic = 1;
1267             log_error(LOG_LEVEL_RE_FILTER,
1268                "Adding dynamic re_filter job \'%s\' to filter %s succeeded.", buf, bl->name);
1269             freez(buf);
1270             continue;
1271          }
1272          else if (bl->dynamic)
1273          {
1274             /*
1275              * A previous job was dynamic and as we
1276              * recompile the whole filter anyway, it
1277              * makes no sense to compile this job now.
1278              */
1279             log_error(LOG_LEVEL_RE_FILTER,
1280                "Adding static re_filter job \'%s\' to dynamic filter %s succeeded.", buf, bl->name);
1281             freez(buf);
1282             continue;
1283          }
1284
1285          if ((dummy = pcrs_compile_command(buf, &error)) == NULL)
1286          {
1287             log_error(LOG_LEVEL_ERROR,
1288                "Adding re_filter job \'%s\' to filter %s failed with error %d.", buf, bl->name, error);
1289             freez(buf);
1290             continue;
1291          }
1292          else
1293          {
1294             if (bl->joblist == NULL)
1295             {
1296                bl->joblist = dummy;
1297             }
1298             else if (NULL != lastjob)
1299             {
1300                lastjob->next = dummy;
1301             }
1302             lastjob = dummy;
1303             log_error(LOG_LEVEL_RE_FILTER, "Adding re_filter job \'%s\' to filter %s succeeded.", buf, bl->name);
1304          }
1305       }
1306       else
1307       {
1308          log_error(LOG_LEVEL_ERROR, "Ignoring job %s outside filter block in %s, line %d",
1309             buf, csp->config->re_filterfile[fileid], linenum);
1310       }
1311       freez(buf);
1312    }
1313
1314    fclose(fp);
1315
1316    /*
1317     * Schedule the now-obsolete old data for unloading
1318     */
1319    if ( NULL != current_re_filterfile[fileid] )
1320    {
1321       current_re_filterfile[fileid]->unloader = unload_re_filterfile;
1322    }
1323
1324    /*
1325     * Chain this file into the global list of loaded files
1326     */
1327    fs->next    = files->next;
1328    files->next = fs;
1329    current_re_filterfile[fileid] = fs;
1330    csp->rlist[fileid] = fs;
1331
1332    return( 0 );
1333
1334 load_re_filterfile_error:
1335    log_error(LOG_LEVEL_FATAL, "can't load re_filterfile '%s': %E",
1336              csp->config->re_filterfile[fileid]);
1337    return(-1);
1338
1339 }
1340
1341
1342 /*********************************************************************
1343  *
1344  * Function    :  add_loader
1345  *
1346  * Description :  Called from `load_config'.  Called once for each input
1347  *                file found in config.
1348  *
1349  * Parameters  :
1350  *          1  :  loader = pointer to a function that can parse and load
1351  *                the appropriate config file.
1352  *          2  :  config = The configuration_spec to add the loader to.
1353  *
1354  * Returns     :  N/A
1355  *
1356  *********************************************************************/
1357 void add_loader(int (*loader)(struct client_state *),
1358                 struct configuration_spec * config)
1359 {
1360    int i;
1361
1362    for (i = 0; i < NLOADERS; i++)
1363    {
1364       if (config->loaders[i] == NULL)
1365       {
1366          config->loaders[i] = loader;
1367          break;
1368       }
1369    }
1370
1371 }
1372
1373
1374 /*********************************************************************
1375  *
1376  * Function    :  run_loader
1377  *
1378  * Description :  Called from `load_config' and `listen_loop'.  This
1379  *                function keeps the "csp" current with any file mods
1380  *                since the last loop.  If a file is unchanged, the
1381  *                loader functions do NOT reload the file.
1382  *
1383  * Parameters  :
1384  *          1  :  csp = Current client state (buffers, headers, etc...)
1385  *                      Must be non-null.  Reads: "csp->config"
1386  *                      Writes: various data members.
1387  *
1388  * Returns     :  0 => Ok, everything else is an error.
1389  *
1390  *********************************************************************/
1391 int run_loader(struct client_state *csp)
1392 {
1393    int ret = 0;
1394    int i;
1395
1396    for (i = 0; i < NLOADERS; i++)
1397    {
1398       if (csp->config->loaders[i] == NULL)
1399       {
1400          break;
1401       }
1402       ret |= (csp->config->loaders[i])(csp);
1403    }
1404    return(ret);
1405
1406 }
1407
1408 /*********************************************************************
1409  *
1410  * Function    :  file_has_been_modified
1411  *
1412  * Description :  Helper function to check if a file has been changed
1413  *
1414  * Parameters  :
1415  *          1  : filename = The name of the file to check
1416  *          2  : last_known_modification = The time of the last known
1417  *                                         modification
1418  *
1419  * Returns     :  TRUE if the file has been changed,
1420  *                FALSE otherwise.
1421  *
1422  *********************************************************************/
1423 static int file_has_been_modified(const char *filename, time_t last_know_modification)
1424 {
1425    struct stat statbuf[1];
1426
1427    if (stat(filename, statbuf) < 0)
1428    {
1429       /* Error, probably file not found which counts as change. */
1430       return 1;
1431    }
1432
1433    return (last_know_modification != statbuf->st_mtime);
1434 }
1435
1436
1437 /*********************************************************************
1438  *
1439  * Function    :  any_loaded_file_changed
1440  *
1441  * Description :  Helper function to check if any loaded file has been
1442  *                changed since the time it has been loaded.
1443  *
1444  *                XXX: Should we cache the return value for x seconds?
1445  *
1446  * Parameters  :
1447  *          1  : files_to_check = List of files to check
1448  *
1449  * Returns     : TRUE if any file has been changed,
1450  *               FALSE otherwise.
1451  *
1452  *********************************************************************/
1453 int any_loaded_file_changed(const struct file_list *files_to_check)
1454 {
1455    const struct file_list *file_to_check = files_to_check;
1456
1457    while (file_to_check != NULL)
1458    {
1459       if (file_has_been_modified(file_to_check->filename, file_to_check->lastmodified))
1460       {
1461          log_error(LOG_LEVEL_INFO,
1462             "File modification detected: %s", file_to_check->filename);
1463          return TRUE;
1464       }
1465       file_to_check = file_to_check->next;
1466    }
1467    return FALSE;
1468 }
1469
1470
1471 /*
1472   Local Variables:
1473   tab-width: 3
1474   end:
1475 */