Fix various spelling errors in the comments.
[privoxy.git] / loaders.c
1 const char loaders_rcs[] = "$Id: loaders.c,v 1.81 2011/03/03 14:38:36 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
959    if (csp)
960    {
961       csp->tlist = fs;
962    }
963    return(0);
964
965 load_trustfile_error:
966    log_error(LOG_LEVEL_FATAL, "can't load trustfile '%s': %E",
967       csp->config->trustfile);
968    freez(buf);
969    return(-1);
970
971 }
972 #endif /* def FEATURE_TRUST */
973
974
975 /*********************************************************************
976  *
977  * Function    :  unload_re_filterfile
978  *
979  * Description :  Unload the re_filter list by freeing all chained
980  *                re_filterfile specs and their data.
981  *
982  * Parameters  :
983  *          1  :  f = the data structure associated with the filterfile.
984  *
985  * Returns     :  N/A
986  *
987  *********************************************************************/
988 static void unload_re_filterfile(void *f)
989 {
990    struct re_filterfile_spec *a, *b = (struct re_filterfile_spec *)f;
991
992    while (b != NULL)
993    {
994       a = b->next;
995
996       destroy_list(b->patterns);
997       pcrs_free_joblist(b->joblist);
998       freez(b->name);
999       freez(b->description);
1000       freez(b);
1001
1002       b = a;
1003    }
1004
1005    return;
1006 }
1007
1008 /*********************************************************************
1009  *
1010  * Function    :  unload_forward_spec
1011  *
1012  * Description :  Unload the forward spec settings by freeing all 
1013  *                memory referenced by members and the memory for
1014  *                the spec itself.
1015  *
1016  * Parameters  :
1017  *          1  :  fwd = the forward spec.
1018  *
1019  * Returns     :  N/A
1020  *
1021  *********************************************************************/
1022 void unload_forward_spec(struct forward_spec *fwd)
1023 {
1024    free_url_spec(fwd->url);
1025    freez(fwd->gateway_host);
1026    freez(fwd->forward_host);
1027    free(fwd);
1028
1029    return;
1030 }
1031
1032
1033 #ifdef FEATURE_GRACEFUL_TERMINATION
1034 /*********************************************************************
1035  *
1036  * Function    :  unload_current_re_filterfile
1037  *
1038  * Description :  Unloads current re_filter file - reset to state at
1039  *                beginning of program.
1040  *
1041  * Parameters  :  None
1042  *
1043  * Returns     :  N/A
1044  *
1045  *********************************************************************/
1046 void unload_current_re_filterfile(void)
1047 {
1048    int i;
1049
1050    for (i = 0; i < MAX_AF_FILES; i++)
1051    {
1052       if (current_re_filterfile[i])
1053       {
1054          current_re_filterfile[i]->unloader = unload_re_filterfile;
1055          current_re_filterfile[i] = NULL;
1056       }
1057    }
1058 }
1059 #endif
1060
1061
1062 /*********************************************************************
1063  *
1064  * Function    :  load_re_filterfiles
1065  *
1066  * Description :  Loads all the filterfiles. 
1067  *                Generate a chained list of re_filterfile_spec's from
1068  *                the "FILTER: " blocks, compiling all their substitutions
1069  *                into chained lists of pcrs_job structs.
1070  *
1071  * Parameters  :
1072  *          1  :  csp = Current client state (buffers, headers, etc...)
1073  *
1074  * Returns     :  0 => Ok, everything else is an error.
1075  *
1076  *********************************************************************/
1077 int load_re_filterfiles(struct client_state *csp)
1078 {
1079    int i;
1080    int result;
1081
1082    for (i = 0; i < MAX_AF_FILES; i++)
1083    {
1084       if (csp->config->re_filterfile[i])
1085       {
1086          result = load_one_re_filterfile(csp, i);
1087          if (result)
1088          {
1089             return result;
1090          }
1091       }
1092       else if (current_re_filterfile[i])
1093       {
1094          current_re_filterfile[i]->unloader = unload_re_filterfile;
1095          current_re_filterfile[i] = NULL;
1096       }
1097    }
1098
1099    return 0;
1100 }
1101
1102
1103 /*********************************************************************
1104  *
1105  * Function    :  load_one_re_filterfile
1106  *
1107  * Description :  Load a re_filterfile. 
1108  *                Generate a chained list of re_filterfile_spec's from
1109  *                the "FILTER: " blocks, compiling all their substitutions
1110  *                into chained lists of pcrs_job structs.
1111  *
1112  * Parameters  :
1113  *          1  :  csp = Current client state (buffers, headers, etc...)
1114  *
1115  * Returns     :  0 => Ok, everything else is an error.
1116  *
1117  *********************************************************************/
1118 int load_one_re_filterfile(struct client_state *csp, int fileid)
1119 {
1120    FILE *fp;
1121
1122    struct re_filterfile_spec *new_bl, *bl = NULL;
1123    struct file_list *fs;
1124
1125    char *buf = NULL;
1126    int error;
1127    unsigned long linenum = 0;
1128    pcrs_job *dummy, *lastjob = NULL;
1129
1130    /*
1131     * No need to reload if unchanged
1132     */
1133    if (!check_file_changed(current_re_filterfile[fileid], csp->config->re_filterfile[fileid], &fs))
1134    {
1135       if (csp)
1136       {
1137          csp->rlist[fileid] = current_re_filterfile[fileid];
1138       }
1139       return(0);
1140    }
1141    if (!fs)
1142    {
1143       goto load_re_filterfile_error;
1144    }
1145
1146    /* 
1147     * Open the file or fail
1148     */
1149    if ((fp = fopen(csp->config->re_filterfile[fileid], "r")) == NULL)
1150    {
1151       goto load_re_filterfile_error;
1152    }
1153
1154    log_error(LOG_LEVEL_INFO, "Loading filter file: %s", csp->config->re_filterfile[fileid]);
1155
1156    /* 
1157     * Read line by line
1158     */
1159    while (read_config_line(fp, &linenum, &buf) != NULL)
1160    {
1161       int new_filter = NO_NEW_FILTER;
1162
1163       if (strncmp(buf, "FILTER:", 7) == 0)
1164       {
1165          new_filter = FT_CONTENT_FILTER;
1166       }
1167       else if (strncmp(buf, "SERVER-HEADER-FILTER:", 21) == 0)
1168       {
1169          new_filter = FT_SERVER_HEADER_FILTER;
1170       }
1171       else if (strncmp(buf, "CLIENT-HEADER-FILTER:", 21) == 0)
1172       {
1173          new_filter = FT_CLIENT_HEADER_FILTER;
1174       }
1175       else if (strncmp(buf, "CLIENT-HEADER-TAGGER:", 21) == 0)
1176       {
1177          new_filter = FT_CLIENT_HEADER_TAGGER;
1178       }
1179       else if (strncmp(buf, "SERVER-HEADER-TAGGER:", 21) == 0)
1180       {
1181          new_filter = FT_SERVER_HEADER_TAGGER;
1182       }
1183
1184       /*
1185        * If this is the head of a new filter block, make it a
1186        * re_filterfile spec of its own and chain it to the list:
1187        */
1188       if (new_filter != NO_NEW_FILTER)
1189       {
1190          new_bl = (struct re_filterfile_spec  *)zalloc(sizeof(*bl));
1191          if (new_bl == NULL)
1192          {
1193             goto load_re_filterfile_error;
1194          }
1195          if (new_filter == FT_CONTENT_FILTER)
1196          {
1197             new_bl->name = chomp(buf + 7);
1198          }
1199          else
1200          {
1201             new_bl->name = chomp(buf + 21);
1202          }
1203          new_bl->type = new_filter;
1204
1205          /*
1206           * If a filter description is available,
1207           * encode it to HTML and save it.
1208           */
1209          if (NULL != (new_bl->description = strpbrk(new_bl->name, " \t")))
1210          {
1211             *new_bl->description++ = '\0';
1212             new_bl->description = html_encode(chomp(new_bl->description));
1213             if (NULL == new_bl->description)
1214             {
1215                new_bl->description = strdup("Out of memory while encoding this filter's description to HTML");
1216             }
1217          }
1218          else
1219          {
1220             new_bl->description = strdup("No description available for this filter");
1221          }
1222
1223          new_bl->name = strdup(chomp(new_bl->name));
1224          
1225          /*
1226           * If this is the first filter block, chain it
1227           * to the file_list rather than its (nonexistant)
1228           * predecessor
1229           */
1230          if (fs->f == NULL)
1231          {
1232             fs->f = new_bl;
1233          }
1234          else
1235          {
1236             assert(NULL != bl);
1237             bl->next = new_bl;
1238          }
1239          bl = new_bl;
1240
1241          log_error(LOG_LEVEL_RE_FILTER, "Reading in filter \"%s\" (\"%s\")", bl->name, bl->description);
1242
1243          freez(buf);
1244          continue;
1245       }
1246
1247       /* 
1248        * Else, save the expression, make it a pcrs_job
1249        * and chain it into the current filter's joblist 
1250        */
1251       if (bl != NULL)
1252       {
1253          error = enlist(bl->patterns, buf);
1254          if (JB_ERR_MEMORY == error)
1255          {
1256             log_error(LOG_LEVEL_FATAL,
1257                "Out of memory while enlisting re_filter job \'%s\' for filter %s.", buf, bl->name);
1258          }
1259          assert(JB_ERR_OK == error);
1260
1261          if (pcrs_job_is_dynamic(buf))
1262          {
1263             /*
1264              * Dynamic pattern that might contain variables
1265              * and has to be recompiled for every request
1266              */
1267             if (bl->joblist != NULL)
1268             {
1269                 pcrs_free_joblist(bl->joblist);
1270                 bl->joblist = NULL;
1271             }
1272             bl->dynamic = 1;
1273             log_error(LOG_LEVEL_RE_FILTER,
1274                "Adding dynamic re_filter job \'%s\' to filter %s succeeded.", buf, bl->name);
1275             freez(buf);
1276             continue;             
1277          }
1278          else if (bl->dynamic)
1279          {
1280             /*
1281              * A previous job was dynamic and as we
1282              * recompile the whole filter anyway, it
1283              * makes no sense to compile this job now.
1284              */
1285             log_error(LOG_LEVEL_RE_FILTER,
1286                "Adding static re_filter job \'%s\' to dynamic filter %s succeeded.", buf, bl->name);
1287             freez(buf);
1288             continue;
1289          }
1290
1291          if ((dummy = pcrs_compile_command(buf, &error)) == NULL)
1292          {
1293             log_error(LOG_LEVEL_ERROR,
1294                "Adding re_filter job \'%s\' to filter %s failed with error %d.", buf, bl->name, error);
1295             freez(buf);
1296             continue;
1297          }
1298          else
1299          {
1300             if (bl->joblist == NULL)
1301             {
1302                bl->joblist = dummy;
1303             }
1304             else if (NULL != lastjob)
1305             {
1306                lastjob->next = dummy;
1307             }
1308             lastjob = dummy;
1309             log_error(LOG_LEVEL_RE_FILTER, "Adding re_filter job \'%s\' to filter %s succeeded.", buf, bl->name);
1310          }
1311       }
1312       else
1313       {
1314          log_error(LOG_LEVEL_ERROR, "Ignoring job %s outside filter block in %s, line %d",
1315             buf, csp->config->re_filterfile[fileid], linenum);
1316       }
1317       freez(buf);
1318    }
1319
1320    fclose(fp);
1321
1322    /* 
1323     * Schedule the now-obsolete old data for unloading
1324     */
1325    if ( NULL != current_re_filterfile[fileid] )
1326    {
1327       current_re_filterfile[fileid]->unloader = unload_re_filterfile;
1328    }
1329
1330    /*
1331     * Chain this file into the global list of loaded files
1332     */
1333    fs->next    = files->next;
1334    files->next = fs;
1335    current_re_filterfile[fileid] = fs;
1336
1337    if (csp)
1338    {
1339       csp->rlist[fileid] = fs;
1340    }
1341
1342    return( 0 );
1343
1344 load_re_filterfile_error:
1345    log_error(LOG_LEVEL_FATAL, "can't load re_filterfile '%s': %E",
1346              csp->config->re_filterfile[fileid]);
1347    return(-1);
1348
1349 }
1350
1351
1352 /*********************************************************************
1353  *
1354  * Function    :  add_loader
1355  *
1356  * Description :  Called from `load_config'.  Called once for each input
1357  *                file found in config.
1358  *
1359  * Parameters  :
1360  *          1  :  loader = pointer to a function that can parse and load
1361  *                the appropriate config file.
1362  *          2  :  config = The configuration_spec to add the loader to.
1363  *
1364  * Returns     :  N/A
1365  *
1366  *********************************************************************/
1367 void add_loader(int (*loader)(struct client_state *),
1368                 struct configuration_spec * config)
1369 {
1370    int i;
1371
1372    for (i=0; i < NLOADERS; i++)
1373    {
1374       if (config->loaders[i] == NULL)
1375       {
1376          config->loaders[i] = loader;
1377          break;
1378       }
1379    }
1380
1381 }
1382
1383
1384 /*********************************************************************
1385  *
1386  * Function    :  run_loader
1387  *
1388  * Description :  Called from `load_config' and `listen_loop'.  This
1389  *                function keeps the "csp" current with any file mods
1390  *                since the last loop.  If a file is unchanged, the
1391  *                loader functions do NOT reload the file.
1392  *
1393  * Parameters  :
1394  *          1  :  csp = Current client state (buffers, headers, etc...)
1395  *                      Must be non-null.  Reads: "csp->config"
1396  *                      Writes: various data members.
1397  *
1398  * Returns     :  0 => Ok, everything else is an error.
1399  *
1400  *********************************************************************/
1401 int run_loader(struct client_state *csp)
1402 {
1403    int ret = 0;
1404    int i;
1405
1406    for (i=0; i < NLOADERS; i++)
1407    {
1408       if (csp->config->loaders[i] == NULL)
1409       {
1410          break;
1411       }
1412       ret |= (csp->config->loaders[i])(csp);
1413    }
1414    return(ret);
1415
1416 }
1417
1418 /*********************************************************************
1419  *
1420  * Function    :  file_has_been_modified
1421  *
1422  * Description :  Helper function to check if a file has been changed
1423  *
1424  * Parameters  :
1425  *          1  : filename = The name of the file to check
1426  *          2  : last_known_modification = The time of the last known
1427  *                                         modification
1428  *
1429  * Returns     :  TRUE if the file has been changed,
1430  *                FALSE otherwise.
1431  *
1432  *********************************************************************/
1433 static int file_has_been_modified(const char *filename, time_t last_know_modification)
1434 {
1435    struct stat statbuf[1];
1436
1437    if (stat(filename, statbuf) < 0)
1438    {
1439       /* Error, probably file not found which counts as change. */
1440       return 1;
1441    }
1442
1443    return (last_know_modification != statbuf->st_mtime);
1444 }
1445
1446
1447 /*********************************************************************
1448  *
1449  * Function    :  any_loaded_file_changed
1450  *
1451  * Description :  Helper function to check if any loaded file has been
1452  *                changed since the time it has been loaded.
1453  *
1454  *                XXX: Should we cache the return value for x seconds?
1455  *
1456  * Parameters  :
1457  *          1  : files_to_check = List of files to check
1458  *
1459  * Returns     : TRUE if any file has been changed,
1460  *               FALSE otherwise.
1461  *
1462  *********************************************************************/
1463 int any_loaded_file_changed(const struct file_list *files_to_check)
1464 {
1465    const struct file_list *file_to_check = files_to_check;
1466
1467    while (file_to_check != NULL)
1468    {
1469       if (file_has_been_modified(file_to_check->filename, file_to_check->lastmodified))
1470       {
1471          log_error(LOG_LEVEL_INFO,
1472             "File modification detected: %s", file_to_check->filename);
1473          return TRUE;
1474       }
1475       file_to_check = file_to_check->next;
1476    }
1477    return FALSE;
1478 }
1479
1480
1481 /*
1482   Local Variables:
1483   tab-width: 3
1484   end:
1485 */