Add support for external filters
[privoxy.git] / loadcfg.c
1 const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.139 2013/11/24 14:25:19 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/loadcfg.c,v $
5  *
6  * Purpose     :  Loads settings from the configuration file into
7  *                global variables.  This file contains both the
8  *                routine to load the configuration and the global
9  *                variables it writes to.
10  *
11  * Copyright   :  Written by and Copyright (C) 2001-2009 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 <sys/types.h>
43 #include <stdlib.h>
44 #include <string.h>
45 #include <signal.h>
46 #include <fcntl.h>
47 #include <errno.h>
48 #include <ctype.h>
49 #include <assert.h>
50
51 #ifdef _WIN32
52
53 # ifndef STRICT
54 #  define STRICT
55 # endif
56 # include <windows.h>
57
58 # include "win32.h"
59 # ifndef _WIN_CONSOLE
60 #  include "w32log.h"
61 # endif /* ndef _WIN_CONSOLE */
62
63 #else /* ifndef _WIN32 */
64
65 #ifndef __OS2__
66 # include <unistd.h>
67 # include <sys/wait.h>
68 #endif
69 # include <sys/time.h>
70 # include <sys/stat.h>
71 # include <signal.h>
72
73 #endif
74
75 #include "project.h"
76 #include "loadcfg.h"
77 #include "list.h"
78 #include "jcc.h"
79 #include "filters.h"
80 #include "loaders.h"
81 #include "miscutil.h"
82 #include "errlog.h"
83 #include "ssplit.h"
84 #include "encode.h"
85 #include "urlmatch.h"
86 #include "cgi.h"
87 #include "gateway.h"
88
89 const char loadcfg_h_rcs[] = LOADCFG_H_VERSION;
90
91 #ifdef FEATURE_TOGGLE
92 /* Privoxy is enabled by default. */
93 int global_toggle_state = 1;
94 #endif /* def FEATURE_TOGGLE */
95
96 /* The filename of the configfile */
97 const char *configfile  = NULL;
98
99 /*
100  * CGI functions will later need access to the invocation args,
101  * so we will make argc and argv global.
102  */
103 int Argc = 0;
104 char * const * Argv = NULL;
105
106 static struct file_list *current_configfile = NULL;
107
108
109 /*
110  * This takes the "cryptic" hash of each keyword and aliases them to
111  * something a little more readable.  This also makes changing the
112  * hash values easier if they should change or the hash algorthm changes.
113  * Use the included "hash" program to find out what the hash will be
114  * for any string supplied on the command line.  (Or just put it in the
115  * config file and read the number from the error message in the log).
116  *
117  * Please keep this list sorted alphabetically (but with the Windows
118  * console and GUI specific options last).
119  */
120
121 #define hash_actions_file                1196306641U /* "actionsfile" */
122 #define hash_accept_intercepted_requests 1513024973U /* "accept-intercepted-requests" */
123 #define hash_admin_address               4112573064U /* "admin-address" */
124 #define hash_allow_cgi_request_crunching  258915987U /* "allow-cgi-request-crunching" */
125 #define hash_buffer_limit                1881726070U /* "buffer-limit */
126 #define hash_client_header_order         2701453514U /* "client-header-order" */
127 #define hash_compression_level           2464423563U /* "compression-level" */
128 #define hash_confdir                        1978389U /* "confdir" */
129 #define hash_connection_sharing          1348841265U /* "connection-sharing" */
130 #define hash_debug                            78263U /* "debug" */
131 #define hash_default_server_timeout      2530089913U /* "default-server-timeout" */
132 #define hash_deny_access                 1227333715U /* "deny-access" */
133 #define hash_enable_edit_actions         2517097536U /* "enable-edit-actions" */
134 #define hash_enable_compression          3943696946U /* "enable-compression" */
135 #define hash_enable_proxy_authentication_forwarding 4040610791U /* enable-proxy-authentication-forwarding */
136 #define hash_enable_remote_toggle        2979744683U /* "enable-remote-toggle" */
137 #define hash_enable_remote_http_toggle    110543988U /* "enable-remote-http-toggle" */
138 #define hash_enforce_blocks              1862427469U /* "enforce-blocks" */
139 #define hash_filterfile                   250887266U /* "filterfile" */
140 #define hash_forward                        2029845U /* "forward" */
141 #define hash_forward_socks4              3963965521U /* "forward-socks4" */
142 #define hash_forward_socks4a             2639958518U /* "forward-socks4a" */
143 #define hash_forward_socks5              3963965522U /* "forward-socks5" */
144 #define hash_forward_socks5t             2639958542U /* "forward-socks5t" */
145 #define hash_forwarded_connect_retries    101465292U /* "forwarded-connect-retries" */
146 #define hash_handle_as_empty_returns_ok  1444873247U /* "handle-as-empty-doc-returns-ok" */
147 #define hash_hostname                      10308071U /* "hostname" */
148 #define hash_keep_alive_timeout          3878599515U /* "keep-alive-timeout" */
149 #define hash_listen_address              1255650842U /* "listen-address" */
150 #define hash_logdir                          422889U /* "logdir" */
151 #define hash_logfile                        2114766U /* "logfile" */
152 #define hash_max_client_connections      3595884446U /* "max-client-connections" */
153 #define hash_permit_access               3587953268U /* "permit-access" */
154 #define hash_proxy_info_url              3903079059U /* "proxy-info-url" */
155 #define hash_single_threaded             4250084780U /* "single-threaded" */
156 #define hash_socket_timeout              1809001761U /* "socket-timeout" */
157 #define hash_split_large_cgi_forms        671658948U /* "split-large-cgi-forms" */
158 #define hash_suppress_blocklists         1948693308U /* "suppress-blocklists" */
159 #define hash_templdir                      11067889U /* "templdir" */
160 #define hash_temporary_directory         1824125181U /* "temporary-directory" */
161 #define hash_tolerate_pipelining         1360286620U /* "tolerate-pipelining" */
162 #define hash_toggle                          447966U /* "toggle" */
163 #define hash_trust_info_url               430331967U /* "trust-info-url" */
164 #define hash_trustfile                     56494766U /* "trustfile" */
165 #define hash_usermanual                  1416668518U /* "user-manual" */
166 #define hash_activity_animation          1817904738U /* "activity-animation" */
167 #define hash_close_button_minimizes      3651284693U /* "close-button-minimizes" */
168 #define hash_hide_console                2048809870U /* "hide-console" */
169 #define hash_log_buffer_size             2918070425U /* "log-buffer-size" */
170 #define hash_log_font_name               2866730124U /* "log-font-name" */
171 #define hash_log_font_size               2866731014U /* "log-font-size" */
172 #define hash_log_highlight_messages      4032101240U /* "log-highlight-messages" */
173 #define hash_log_max_lines               2868344173U /* "log-max-lines" */
174 #define hash_log_messages                2291744899U /* "log-messages" */
175 #define hash_show_on_task_bar             215410365U /* "show-on-task-bar" */
176
177
178 static void savearg(char *command, char *argument, struct configuration_spec * config);
179
180 /*********************************************************************
181  *
182  * Function    :  unload_configfile
183  *
184  * Description :  Free the config structure and all components.
185  *
186  * Parameters  :
187  *          1  :  data: struct configuration_spec to unload
188  *
189  * Returns     :  N/A
190  *
191  *********************************************************************/
192 static void unload_configfile (void * data)
193 {
194    struct configuration_spec * config = (struct configuration_spec *)data;
195    struct forward_spec *cur_fwd = config->forward;
196    int i;
197
198 #ifdef FEATURE_ACL
199    struct access_control_list *cur_acl = config->acl;
200
201    while (cur_acl != NULL)
202    {
203       struct access_control_list * next_acl = cur_acl->next;
204       free(cur_acl);
205       cur_acl = next_acl;
206    }
207    config->acl = NULL;
208 #endif /* def FEATURE_ACL */
209
210    while (cur_fwd != NULL)
211    {
212       struct forward_spec * next_fwd = cur_fwd->next;
213       free_pattern_spec(cur_fwd->url);
214
215       freez(cur_fwd->gateway_host);
216       freez(cur_fwd->forward_host);
217       free(cur_fwd);
218       cur_fwd = next_fwd;
219    }
220    config->forward = NULL;
221
222    freez(config->confdir);
223    freez(config->logdir);
224    freez(config->templdir);
225    freez(config->hostname);
226 #ifdef FEATURE_EXTERNAL_FILTERS
227    freez(config->temporary_directory);
228 #endif
229
230    for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
231    {
232       freez(config->haddr[i]);
233    }
234    freez(config->logfile);
235
236    for (i = 0; i < MAX_AF_FILES; i++)
237    {
238       freez(config->actions_file_short[i]);
239       freez(config->actions_file[i]);
240       freez(config->re_filterfile_short[i]);
241       freez(config->re_filterfile[i]);
242    }
243
244    list_remove_all(config->ordered_client_headers);
245
246    freez(config->admin_address);
247    freez(config->proxy_info_url);
248    freez(config->proxy_args);
249    freez(config->usermanual);
250
251 #ifdef FEATURE_TRUST
252    freez(config->trustfile);
253    list_remove_all(config->trust_info);
254 #endif /* def FEATURE_TRUST */
255
256    freez(config);
257 }
258
259
260 #ifdef FEATURE_GRACEFUL_TERMINATION
261 /*********************************************************************
262  *
263  * Function    :  unload_current_config_file
264  *
265  * Description :  Unloads current config file - reset to state at
266  *                beginning of program.
267  *
268  * Parameters  :  None
269  *
270  * Returns     :  N/A
271  *
272  *********************************************************************/
273 void unload_current_config_file(void)
274 {
275    if (current_configfile)
276    {
277       current_configfile->unloader = unload_configfile;
278       current_configfile = NULL;
279    }
280 }
281 #endif
282
283
284 /*********************************************************************
285  *
286  * Function    :  parse_toggle_value
287  *
288  * Description :  Parse the value of a directive that can only be
289  *                enabled or disabled. Terminates with a fatal error
290  *                if the value is NULL or something other than 0 or 1.
291  *
292  * Parameters  :
293  *          1  :  name:  The name of the directive. Used for log messages.
294  *          2  :  value: The value to parse
295  *
296  *
297  * Returns     :  The numerical toggle state
298  *
299  *********************************************************************/
300 static int parse_toggle_state(const char *name, const char *value)
301 {
302    int toggle_state;
303    assert(name != NULL);
304    assert(value != NULL);
305
306    if ((value == NULL) || (*value == '\0'))
307    {
308       log_error(LOG_LEVEL_FATAL, "Directive %s used without argument", name);
309    }
310
311    toggle_state = atoi(value);
312
313    /*
314     * Also check the length as atoi() doesn't mind
315     * garbage after a valid integer, but we do.
316     */
317    if (((toggle_state != 0) && (toggle_state != 1)) || (strlen(value) != 1))
318    {
319       log_error(LOG_LEVEL_FATAL,
320          "Directive %s used with invalid argument '%s'. Use either '0' or '1'.",
321          name, value);
322    }
323
324    return toggle_state;
325
326 }
327
328
329 /*********************************************************************
330  *
331  * Function    :  parse_client_header_order
332  *
333  * Description :  Parse the value of the header-order directive
334  *
335  * Parameters  :
336  *          1  :  ordered_header_list:  List to insert the ordered
337  *                                      headers into.
338  *          2  :  ordered_headers:  The ordered header names separated
339  *                                  by spaces or tabs.
340  *
341  *
342  * Returns     :  N/A
343  *
344  *********************************************************************/
345 static void parse_client_header_order(struct list *ordered_header_list, const char *ordered_headers)
346 {
347    char *original_headers_copy;
348    char **vector;
349    size_t max_segments;
350    int number_of_headers;
351    int i;
352
353    assert(ordered_header_list != NULL);
354    assert(ordered_headers != NULL);
355
356    if (ordered_headers == NULL)
357    {
358       log_error(LOG_LEVEL_FATAL, "header-order used without argument");
359    }
360
361    /*
362     * XXX: This estimate is guaranteed to be high enough as we
363     *      let ssplit() ignore empty fields, but also a bit wasteful.
364     *      The same hack is used in get_last_url() so it looks like
365     *      a real solution is needed.
366     */
367    max_segments = strlen(ordered_headers) / 2;
368    if (max_segments == 0)
369    {
370       max_segments = 1;
371    }
372    vector = malloc_or_die(max_segments * sizeof(char *));
373
374    original_headers_copy = strdup_or_die(ordered_headers);
375
376    number_of_headers = ssplit(original_headers_copy, "\t ", vector, max_segments);
377    if (number_of_headers == -1)
378    {
379       log_error(LOG_LEVEL_FATAL, "Failed to split ordered headers");
380    }
381
382    for (i = 0; i < number_of_headers; i++)
383    {
384       if (JB_ERR_OK != enlist(ordered_header_list, vector[i]))
385       {
386          log_error(LOG_LEVEL_FATAL,
387             "Failed to enlist ordered header: %s", vector[i]);
388       }
389    }
390
391    freez(vector);
392    freez(original_headers_copy);
393
394    return;
395
396 }
397
398
399 /*********************************************************************
400  *
401  * Function    :  load_config
402  *
403  * Description :  Load the config file and all parameters.
404  *
405  *                XXX: more than thousand lines long
406  *                and thus in serious need of refactoring.
407  *
408  * Parameters  :  None
409  *
410  * Returns     :  The configuration_spec, or NULL on error.
411  *
412  *********************************************************************/
413 struct configuration_spec * load_config(void)
414 {
415    char *buf = NULL;
416    char *p, *q;
417    FILE *configfp = NULL;
418    struct configuration_spec * config = NULL;
419    struct client_state * fake_csp;
420    struct file_list *fs;
421    unsigned long linenum = 0;
422    int i;
423    char *logfile = NULL;
424
425    if (!check_file_changed(current_configfile, configfile, &fs))
426    {
427       /* No need to load */
428       return ((struct configuration_spec *)current_configfile->f);
429    }
430    if (NULL == fs)
431    {
432       log_error(LOG_LEVEL_FATAL,
433          "can't check configuration file '%s':  %E", configfile);
434       return NULL;
435    }
436
437    if (NULL != current_configfile)
438    {
439       log_error(LOG_LEVEL_INFO, "Reloading configuration file '%s'", configfile);
440    }
441
442 #ifdef FEATURE_TOGGLE
443    global_toggle_state = 1;
444 #endif /* def FEATURE_TOGGLE */
445
446    fs->f = config = (struct configuration_spec *)zalloc(sizeof(*config));
447
448    if (NULL == config)
449    {
450       freez(fs->filename);
451       freez(fs);
452       log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
453       return NULL;
454    }
455
456    /*
457     * This is backwards from how it's usually done.
458     * Following the usual pattern, "fs" would be stored in a member
459     * variable in "csp", and then we'd access "config" from "fs->f",
460     * using a cast.  However, "config" is used so often that a
461     * cast each time would be very ugly, and the extra indirection
462     * would waste CPU cycles.  Therefore we store "config" in
463     * "csp->config", and "fs" in "csp->config->config_file_list".
464     */
465    config->config_file_list = fs;
466
467    /*
468     * Set to defaults
469     */
470    config->multi_threaded            = 1;
471    config->buffer_limit              = 4096 * 1024;
472    config->usermanual                = strdup(USER_MANUAL_URL);
473    config->proxy_args                = strdup("");
474    config->forwarded_connect_retries = 0;
475    /*
476     * 128 client sockets ought to be enough for everybody who can't
477     * be bothered to read the documentation to figure out how to
478     * increase the limit.
479     */
480    config->max_client_connections    = 128;
481    config->socket_timeout            = 300; /* XXX: Should be a macro. */
482 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
483    config->default_server_timeout    = 0;
484    config->keep_alive_timeout        = DEFAULT_KEEP_ALIVE_TIMEOUT;
485    config->feature_flags            &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
486    config->feature_flags            &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
487 #endif
488    config->feature_flags            &= ~RUNTIME_FEATURE_CGI_TOGGLE;
489    config->feature_flags            &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
490    config->feature_flags            &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
491    config->feature_flags            &= ~RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
492    config->feature_flags            &= ~RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
493 #ifdef FEATURE_COMPRESSION
494    config->feature_flags            &= ~RUNTIME_FEATURE_COMPRESSION;
495    /*
496     * XXX: Run some benchmarks to see if there are better default values.
497     */
498    config->compression_level         = 1;
499 #endif
500    config->feature_flags            &= ~RUNTIME_FEATURE_TOLERATE_PIPELINING;
501
502    configfp = fopen(configfile, "r");
503    if (NULL == configfp)
504    {
505       log_error(LOG_LEVEL_FATAL,
506          "can't open configuration file '%s':  %E", configfile);
507       /* Never get here - LOG_LEVEL_FATAL causes program exit */
508    }
509
510    while (read_config_line(configfp, &linenum, &buf) != NULL)
511    {
512       char cmd[BUFFER_SIZE];
513       char arg[BUFFER_SIZE];
514       char tmp[BUFFER_SIZE];
515 #ifdef FEATURE_ACL
516       struct access_control_list *cur_acl;
517 #endif /* def FEATURE_ACL */
518       struct forward_spec *cur_fwd;
519       int vec_count;
520       char *vec[3];
521       unsigned int directive_hash;
522
523       strlcpy(tmp, buf, sizeof(tmp));
524
525       /* Copy command (i.e. up to space or tab) into cmd */
526       p = buf;
527       q = cmd;
528       while (*p && (*p != ' ') && (*p != '\t'))
529       {
530          *q++ = *p++;
531       }
532       *q = '\0';
533
534       /* Skip over the whitespace in buf */
535       while (*p && ((*p == ' ') || (*p == '\t')))
536       {
537          p++;
538       }
539
540       /* Copy the argument into arg */
541       if (strlcpy(arg, p, sizeof(arg)) >= sizeof(arg))
542       {
543          log_error(LOG_LEVEL_FATAL, "Config line too long: %s", buf);
544       }
545
546       /* Should never happen, but check this anyway */
547       if (*cmd == '\0')
548       {
549          freez(buf);
550          continue;
551       }
552
553       /* Make sure the command field is lower case */
554       for (p = cmd; *p; p++)
555       {
556          if (privoxy_isupper(*p))
557          {
558             *p = (char)privoxy_tolower(*p);
559          }
560       }
561
562       directive_hash = hash_string(cmd);
563       switch (directive_hash)
564       {
565 /* *************************************************************************
566  * actionsfile actions-file-name
567  * In confdir by default
568  * *************************************************************************/
569          case hash_actions_file :
570             i = 0;
571             while ((i < MAX_AF_FILES) && (NULL != config->actions_file[i]))
572             {
573                i++;
574             }
575
576             if (i >= MAX_AF_FILES)
577             {
578                log_error(LOG_LEVEL_FATAL, "Too many 'actionsfile' directives in config file - limit is %d.\n"
579                   "(You can increase this limit by changing MAX_AF_FILES in project.h and recompiling).",
580                   MAX_AF_FILES);
581             }
582             config->actions_file_short[i] = strdup(arg);
583             config->actions_file[i] = make_path(config->confdir, arg);
584
585             break;
586 /* *************************************************************************
587  * accept-intercepted-requests
588  * *************************************************************************/
589          case hash_accept_intercepted_requests:
590             if (parse_toggle_state(cmd, arg) == 1)
591             {
592                config->feature_flags |= RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
593             }
594             else
595             {
596                config->feature_flags &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
597             }
598             break;
599
600 /* *************************************************************************
601  * admin-address email-address
602  * *************************************************************************/
603          case hash_admin_address :
604             freez(config->admin_address);
605             config->admin_address = strdup(arg);
606             break;
607
608 /* *************************************************************************
609  * allow-cgi-request-crunching
610  * *************************************************************************/
611          case hash_allow_cgi_request_crunching:
612             if (parse_toggle_state(cmd, arg) == 1)
613             {
614                config->feature_flags |= RUNTIME_FEATURE_CGI_CRUNCHING;
615             }
616             else
617             {
618                config->feature_flags &= ~RUNTIME_FEATURE_CGI_CRUNCHING;
619             }
620             break;
621
622 /* *************************************************************************
623  * buffer-limit n
624  * *************************************************************************/
625          case hash_buffer_limit :
626             config->buffer_limit = (size_t)(1024 * atoi(arg));
627             break;
628
629 /* *************************************************************************
630  * client-header-order header-1 header-2 ... header-n
631  * *************************************************************************/
632          case hash_client_header_order:
633             list_remove_all(config->ordered_client_headers);
634             parse_client_header_order(config->ordered_client_headers, arg);
635             break;
636
637 /* *************************************************************************
638  * confdir directory-name
639  * *************************************************************************/
640          case hash_confdir :
641             freez(config->confdir);
642             config->confdir = make_path(NULL, arg);
643             break;
644
645 /* *************************************************************************
646  * compression-level 0-9
647  * *************************************************************************/
648 #ifdef FEATURE_COMPRESSION
649          case hash_compression_level :
650             if (*arg != '\0')
651             {
652                int compression_level = atoi(arg);
653                if (-1 <= compression_level && compression_level <= 9)
654                {
655                   config->compression_level = compression_level;;
656                }
657                else
658                {
659                   log_error(LOG_LEVEL_FATAL,
660                      "Invalid compression-level value: %s", arg);
661                }
662             }
663             else
664             {
665                log_error(LOG_LEVEL_FATAL,
666                   "Invalid compression-level directive. Compression value missing");
667             }
668             break;
669 #endif
670
671 /* *************************************************************************
672  * connection-sharing (0|1)
673  * *************************************************************************/
674 #ifdef FEATURE_CONNECTION_SHARING
675          case hash_connection_sharing :
676             if (parse_toggle_state(cmd, arg) == 1)
677             {
678                config->feature_flags |= RUNTIME_FEATURE_CONNECTION_SHARING;
679             }
680             else
681             {
682                config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
683             }
684             break;
685 #endif
686
687 /* *************************************************************************
688  * debug n
689  * Specifies debug level, multiple values are ORed together.
690  * *************************************************************************/
691          case hash_debug :
692             config->debug |= atoi(arg);
693             break;
694
695 /* *************************************************************************
696  * default-server-timeout timeout
697  * *************************************************************************/
698 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
699          case hash_default_server_timeout :
700             if (*arg != '\0')
701             {
702                int timeout = atoi(arg);
703                if (0 <= timeout)
704                {
705                   config->default_server_timeout = (unsigned int)timeout;
706                }
707                else
708                {
709                   log_error(LOG_LEVEL_FATAL,
710                      "Invalid default-server-timeout value: %s", arg);
711                }
712             }
713             break;
714 #endif
715
716 /* *************************************************************************
717  * deny-access source-ip[/significant-bits] [dest-ip[/significant-bits]]
718  * *************************************************************************/
719 #ifdef FEATURE_ACL
720          case hash_deny_access:
721             strlcpy(tmp, arg, sizeof(tmp));
722             vec_count = ssplit(tmp, " \t", vec, SZ(vec));
723
724             if ((vec_count != 1) && (vec_count != 2))
725             {
726                log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
727                      "deny-access directive in configuration file.");
728                string_append(&config->proxy_args,
729                   "<br>\nWARNING: Wrong number of parameters for "
730                   "deny-access directive in configuration file.<br><br>\n");
731                break;
732             }
733
734             /* allocate a new node */
735             cur_acl = (struct access_control_list *) zalloc(sizeof(*cur_acl));
736
737             if (cur_acl == NULL)
738             {
739                log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
740                /* Never get here - LOG_LEVEL_FATAL causes program exit */
741                break;
742             }
743             cur_acl->action = ACL_DENY;
744
745             if (acl_addr(vec[0], cur_acl->src) < 0)
746             {
747                log_error(LOG_LEVEL_ERROR, "Invalid source address, port or netmask "
748                   "for deny-access directive in configuration file: \"%s\"", vec[0]);
749                string_append(&config->proxy_args,
750                   "<br>\nWARNING: Invalid source address, port or netmask "
751                   "for deny-access directive in configuration file: \"");
752                string_append(&config->proxy_args,
753                   vec[0]);
754                string_append(&config->proxy_args,
755                   "\"<br><br>\n");
756                freez(cur_acl);
757                break;
758             }
759             if (vec_count == 2)
760             {
761                if (acl_addr(vec[1], cur_acl->dst) < 0)
762                {
763                   log_error(LOG_LEVEL_ERROR, "Invalid destination address, port or netmask "
764                      "for deny-access directive in configuration file: \"%s\"", vec[1]);
765                   string_append(&config->proxy_args,
766                      "<br>\nWARNING: Invalid destination address, port or netmask "
767                      "for deny-access directive in configuration file: \"");
768                   string_append(&config->proxy_args,
769                      vec[1]);
770                   string_append(&config->proxy_args,
771                      "\"<br><br>\n");
772                   freez(cur_acl);
773                   break;
774                }
775             }
776 #ifdef HAVE_RFC2553
777             else
778             {
779                cur_acl->wildcard_dst = 1;
780             }
781 #endif /* def HAVE_RFC2553 */
782
783             /*
784              * Add it to the list.  Note we reverse the list to get the
785              * behaviour the user expects.  With both the ACL and
786              * actions file, the last match wins.  However, the internal
787              * implementations are different:  The actions file is stored
788              * in the same order as the file, and scanned completely.
789              * With the ACL, we reverse the order as we load it, then
790              * when we scan it we stop as soon as we get a match.
791              */
792             cur_acl->next  = config->acl;
793             config->acl = cur_acl;
794
795             break;
796 #endif /* def FEATURE_ACL */
797
798 /* *************************************************************************
799  * enable-edit-actions 0|1
800  * *************************************************************************/
801 #ifdef FEATURE_CGI_EDIT_ACTIONS
802          case hash_enable_edit_actions:
803             if (parse_toggle_state(cmd, arg) == 1)
804             {
805                config->feature_flags |= RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
806             }
807             else
808             {
809                config->feature_flags &= ~RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
810             }
811             break;
812 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
813
814 /* *************************************************************************
815  * enable-compression 0|1
816  * *************************************************************************/
817 #ifdef FEATURE_COMPRESSION
818          case hash_enable_compression:
819             if (parse_toggle_state(cmd, arg) == 1)
820             {
821                config->feature_flags |= RUNTIME_FEATURE_COMPRESSION;
822             }
823             else
824             {
825                config->feature_flags &= ~RUNTIME_FEATURE_COMPRESSION;
826             }
827             break;
828 #endif /* def FEATURE_COMPRESSION */
829
830 /* *************************************************************************
831  * enable-proxy-authentication-forwarding 0|1
832  * *************************************************************************/
833          case hash_enable_proxy_authentication_forwarding:
834             if (parse_toggle_state(cmd, arg) == 1)
835             {
836                config->feature_flags |= RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
837             }
838             else
839             {
840                config->feature_flags &= ~RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
841             }
842             break;
843
844 /* *************************************************************************
845  * enable-remote-toggle 0|1
846  * *************************************************************************/
847 #ifdef FEATURE_TOGGLE
848          case hash_enable_remote_toggle:
849             if (parse_toggle_state(cmd, arg) == 1)
850             {
851                config->feature_flags |= RUNTIME_FEATURE_CGI_TOGGLE;
852             }
853             else
854             {
855                config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
856             }
857             break;
858 #endif /* def FEATURE_TOGGLE */
859
860 /* *************************************************************************
861  * enable-remote-http-toggle 0|1
862  * *************************************************************************/
863          case hash_enable_remote_http_toggle:
864             if (parse_toggle_state(cmd, arg) == 1)
865             {
866                config->feature_flags |= RUNTIME_FEATURE_HTTP_TOGGLE;
867             }
868             else
869             {
870                config->feature_flags &= ~RUNTIME_FEATURE_HTTP_TOGGLE;
871             }
872             break;
873
874 /* *************************************************************************
875  * enforce-blocks 0|1
876  * *************************************************************************/
877          case hash_enforce_blocks:
878 #ifdef FEATURE_FORCE_LOAD
879             if (parse_toggle_state(cmd, arg) == 1)
880             {
881                config->feature_flags |= RUNTIME_FEATURE_ENFORCE_BLOCKS;
882             }
883             else
884             {
885                config->feature_flags &= ~RUNTIME_FEATURE_ENFORCE_BLOCKS;
886             }
887 #else
888             log_error(LOG_LEVEL_ERROR, "Ignoring directive 'enforce-blocks'. "
889                "FEATURE_FORCE_LOAD is disabled, blocks will always be enforced.");
890 #endif /* def FEATURE_FORCE_LOAD */
891             break;
892
893 /* *************************************************************************
894  * filterfile file-name
895  * In confdir by default.
896  * *************************************************************************/
897          case hash_filterfile :
898             i = 0;
899             while ((i < MAX_AF_FILES) && (NULL != config->re_filterfile[i]))
900             {
901                i++;
902             }
903
904             if (i >= MAX_AF_FILES)
905             {
906                log_error(LOG_LEVEL_FATAL, "Too many 'filterfile' directives in config file - limit is %d.\n"
907                   "(You can increase this limit by changing MAX_AF_FILES in project.h and recompiling).",
908                   MAX_AF_FILES);
909             }
910             config->re_filterfile_short[i] = strdup(arg);
911             config->re_filterfile[i] = make_path(config->confdir, arg);
912
913             break;
914
915 /* *************************************************************************
916  * forward url-pattern (.|http-proxy-host[:port])
917  * *************************************************************************/
918          case hash_forward:
919             strlcpy(tmp, arg, sizeof(tmp));
920             vec_count = ssplit(tmp, " \t", vec, SZ(vec));
921
922             if (vec_count != 2)
923             {
924                log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for forward "
925                      "directive in configuration file.");
926                string_append(&config->proxy_args,
927                   "<br>\nWARNING: Wrong number of parameters for "
928                   "forward directive in configuration file.");
929                break;
930             }
931
932             /* allocate a new node */
933             cur_fwd = zalloc(sizeof(*cur_fwd));
934             if (cur_fwd == NULL)
935             {
936                log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
937                /* Never get here - LOG_LEVEL_FATAL causes program exit */
938                break;
939             }
940
941             cur_fwd->type = SOCKS_NONE;
942
943             /* Save the URL pattern */
944             if (create_pattern_spec(cur_fwd->url, vec[0]))
945             {
946                log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward "
947                      "directive in configuration file.");
948                string_append(&config->proxy_args,
949                   "<br>\nWARNING: Bad URL specifier for "
950                   "forward directive in configuration file.");
951                break;
952             }
953
954             /* Parse the parent HTTP proxy host:port */
955             p = vec[1];
956
957             if (strcmp(p, ".") != 0)
958             {
959                cur_fwd->forward_port = 8000;
960                parse_forwarder_address(p, &cur_fwd->forward_host,
961                   &cur_fwd->forward_port);
962             }
963
964             /* Add to list. */
965             cur_fwd->next = config->forward;
966             config->forward = cur_fwd;
967
968             break;
969
970 /* *************************************************************************
971  * forward-socks4 url-pattern socks-proxy[:port] (.|http-proxy[:port])
972  * *************************************************************************/
973          case hash_forward_socks4:
974             strlcpy(tmp, arg, sizeof(tmp));
975             vec_count = ssplit(tmp, " \t", vec, SZ(vec));
976
977             if (vec_count != 3)
978             {
979                log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
980                      "forward-socks4 directive in configuration file.");
981                string_append(&config->proxy_args,
982                   "<br>\nWARNING: Wrong number of parameters for "
983                   "forward-socks4 directive in configuration file.");
984                break;
985             }
986
987             /* allocate a new node */
988             cur_fwd = zalloc(sizeof(*cur_fwd));
989             if (cur_fwd == NULL)
990             {
991                log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
992                /* Never get here - LOG_LEVEL_FATAL causes program exit */
993                break;
994             }
995
996             cur_fwd->type = SOCKS_4;
997
998             /* Save the URL pattern */
999             if (create_pattern_spec(cur_fwd->url, vec[0]))
1000             {
1001                log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward-socks4 "
1002                      "directive in configuration file.");
1003                string_append(&config->proxy_args,
1004                   "<br>\nWARNING: Bad URL specifier for "
1005                   "forward-socks4 directive in configuration file.");
1006                break;
1007             }
1008
1009             /* Parse the SOCKS proxy host[:port] */
1010             p = vec[1];
1011
1012             /* XXX: This check looks like a bug. */
1013             if (strcmp(p, ".") != 0)
1014             {
1015                cur_fwd->gateway_port = 1080;
1016                parse_forwarder_address(p, &cur_fwd->gateway_host,
1017                   &cur_fwd->gateway_port);
1018             }
1019
1020             /* Parse the parent HTTP proxy host[:port] */
1021             p = vec[2];
1022
1023             if (strcmp(p, ".") != 0)
1024             {
1025                cur_fwd->forward_port = 8000;
1026                parse_forwarder_address(p, &cur_fwd->forward_host,
1027                   &cur_fwd->forward_port);
1028             }
1029
1030             /* Add to list. */
1031             cur_fwd->next = config->forward;
1032             config->forward = cur_fwd;
1033
1034             break;
1035
1036 /* *************************************************************************
1037  * forward-socks4a url-pattern socks-proxy[:port] (.|http-proxy[:port])
1038  * *************************************************************************/
1039          case hash_forward_socks4a:
1040          case hash_forward_socks5:
1041          case hash_forward_socks5t:
1042             strlcpy(tmp, arg, sizeof(tmp));
1043             vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1044
1045             if (vec_count != 3)
1046             {
1047                log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
1048                      "forward-socks4a directive in configuration file.");
1049                string_append(&config->proxy_args,
1050                   "<br>\nWARNING: Wrong number of parameters for "
1051                   "forward-socks4a directive in configuration file.");
1052                break;
1053             }
1054
1055             /* allocate a new node */
1056             cur_fwd = zalloc(sizeof(*cur_fwd));
1057             if (cur_fwd == NULL)
1058             {
1059                log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
1060                /* Never get here - LOG_LEVEL_FATAL causes program exit */
1061                break;
1062             }
1063
1064             if (directive_hash == hash_forward_socks4a)
1065             {
1066                cur_fwd->type = SOCKS_4A;
1067             }
1068             else if (directive_hash == hash_forward_socks5)
1069             {
1070                cur_fwd->type = SOCKS_5;
1071             }
1072             else
1073             {
1074                assert(directive_hash == hash_forward_socks5t);
1075                cur_fwd->type = SOCKS_5T;
1076             }
1077
1078             /* Save the URL pattern */
1079             if (create_pattern_spec(cur_fwd->url, vec[0]))
1080             {
1081                log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward-socks4a "
1082                      "directive in configuration file.");
1083                string_append(&config->proxy_args,
1084                   "<br>\nWARNING: Bad URL specifier for "
1085                   "forward-socks4a directive in configuration file.");
1086                break;
1087             }
1088
1089             /* Parse the SOCKS proxy host[:port] */
1090             p = vec[1];
1091
1092             cur_fwd->gateway_port = 1080;
1093             parse_forwarder_address(p, &cur_fwd->gateway_host,
1094                &cur_fwd->gateway_port);
1095
1096             /* Parse the parent HTTP proxy host[:port] */
1097             p = vec[2];
1098
1099             if (strcmp(p, ".") != 0)
1100             {
1101                cur_fwd->forward_port = 8000;
1102                parse_forwarder_address(p, &cur_fwd->forward_host,
1103                   &cur_fwd->forward_port);
1104             }
1105
1106             /* Add to list. */
1107             cur_fwd->next = config->forward;
1108             config->forward = cur_fwd;
1109
1110             break;
1111
1112 /* *************************************************************************
1113  * forwarded-connect-retries n
1114  * *************************************************************************/
1115          case hash_forwarded_connect_retries :
1116             config->forwarded_connect_retries = atoi(arg);
1117             break;
1118
1119 /* *************************************************************************
1120  * handle-as-empty-doc-returns-ok 0|1
1121  *
1122  * Workaround for firefox hanging on blocked javascript pages.
1123  *   Block with the "+handle-as-empty-document" flag and set the
1124  *   "handle-as-empty-doc-returns-ok" run-time config flag so that
1125  *   Privoxy returns a 200/OK status instead of a 403/Forbidden status
1126  *   to the browser for blocked pages.
1127  ***************************************************************************/
1128          case hash_handle_as_empty_returns_ok:
1129             if (parse_toggle_state(cmd, arg) == 1)
1130             {
1131                config->feature_flags |= RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
1132             }
1133             else
1134             {
1135                config->feature_flags &= ~RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
1136             }
1137             break;
1138
1139 /* *************************************************************************
1140  * hostname hostname-to-show-on-cgi-pages
1141  * *************************************************************************/
1142          case hash_hostname :
1143             freez(config->hostname);
1144             config->hostname = strdup(arg);
1145             if (NULL == config->hostname)
1146             {
1147                log_error(LOG_LEVEL_FATAL, "Out of memory saving hostname.");
1148             }
1149             break;
1150
1151 /* *************************************************************************
1152  * keep-alive-timeout timeout
1153  * *************************************************************************/
1154 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1155          case hash_keep_alive_timeout :
1156             if (*arg != '\0')
1157             {
1158                int timeout = atoi(arg);
1159                if (0 < timeout)
1160                {
1161                   config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
1162                   config->keep_alive_timeout = (unsigned int)timeout;
1163                }
1164                else
1165                {
1166                   config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
1167                }
1168             }
1169             break;
1170 #endif
1171
1172 /* *************************************************************************
1173  * listen-address [ip][:port]
1174  * *************************************************************************/
1175          case hash_listen_address :
1176             i = 0;
1177             while ((i < MAX_LISTENING_SOCKETS) && (NULL != config->haddr[i]))
1178             {
1179                i++;
1180             }
1181
1182             if (i >= MAX_LISTENING_SOCKETS)
1183             {
1184                log_error(LOG_LEVEL_FATAL, "Too many 'listen-address' directives in config file - limit is %d.\n"
1185                   "(You can increase this limit by changing MAX_LISTENING_SOCKETS in project.h and recompiling).",
1186                   MAX_LISTENING_SOCKETS);
1187             }
1188             config->haddr[i] = strdup(arg);
1189             if (NULL == config->haddr[i])
1190             {
1191                log_error(LOG_LEVEL_FATAL, "Out of memory while copying listening address");
1192             }
1193             break;
1194
1195 /* *************************************************************************
1196  * logdir directory-name
1197  * *************************************************************************/
1198          case hash_logdir :
1199             freez(config->logdir);
1200             config->logdir = make_path(NULL, arg);
1201             break;
1202
1203 /* *************************************************************************
1204  * logfile log-file-name
1205  * In logdir by default
1206  * *************************************************************************/
1207          case hash_logfile :
1208             if (daemon_mode)
1209             {
1210                logfile = make_path(config->logdir, arg);
1211                if (NULL == logfile)
1212                {
1213                   log_error(LOG_LEVEL_FATAL, "Out of memory while creating logfile path");
1214                }
1215             }
1216             break;
1217
1218 /* *************************************************************************
1219  * max-client-connections number
1220  * *************************************************************************/
1221          case hash_max_client_connections :
1222             if (*arg != '\0')
1223             {
1224                int max_client_connections = atoi(arg);
1225                if (0 <= max_client_connections)
1226                {
1227                   config->max_client_connections = max_client_connections;
1228                }
1229             }
1230             break;
1231
1232 /* *************************************************************************
1233  * permit-access source-ip[/significant-bits] [dest-ip[/significant-bits]]
1234  * *************************************************************************/
1235 #ifdef FEATURE_ACL
1236          case hash_permit_access:
1237             strlcpy(tmp, arg, sizeof(tmp));
1238             vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1239
1240             if ((vec_count != 1) && (vec_count != 2))
1241             {
1242                log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
1243                      "permit-access directive in configuration file.");
1244                string_append(&config->proxy_args,
1245                   "<br>\nWARNING: Wrong number of parameters for "
1246                   "permit-access directive in configuration file.<br><br>\n");
1247
1248                break;
1249             }
1250
1251             /* allocate a new node */
1252             cur_acl = (struct access_control_list *) zalloc(sizeof(*cur_acl));
1253
1254             if (cur_acl == NULL)
1255             {
1256                log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
1257                /* Never get here - LOG_LEVEL_FATAL causes program exit */
1258                break;
1259             }
1260             cur_acl->action = ACL_PERMIT;
1261
1262             if (acl_addr(vec[0], cur_acl->src) < 0)
1263             {
1264                log_error(LOG_LEVEL_ERROR, "Invalid source address, port or netmask "
1265                   "for permit-access directive in configuration file: \"%s\"", vec[0]);
1266                string_append(&config->proxy_args,
1267                   "<br>\nWARNING: Invalid source address, port or netmask for "
1268                   "permit-access directive in configuration file: \"");
1269                string_append(&config->proxy_args,
1270                   vec[0]);
1271                string_append(&config->proxy_args,
1272                   "\"<br><br>\n");
1273                freez(cur_acl);
1274                break;
1275             }
1276             if (vec_count == 2)
1277             {
1278                if (acl_addr(vec[1], cur_acl->dst) < 0)
1279                {
1280                   log_error(LOG_LEVEL_ERROR, "Invalid destination address, port or netmask "
1281                      "for permit-access directive in configuration file: \"%s\"", vec[1]);
1282                   string_append(&config->proxy_args,
1283                      "<br>\nWARNING: Invalid destination address, port or netmask for "
1284                      "permit-access directive in configuration file: \"");
1285                   string_append(&config->proxy_args,
1286                      vec[1]);
1287                   string_append(&config->proxy_args,
1288                      "\"<br><br>\n");
1289                   freez(cur_acl);
1290                   break;
1291                }
1292             }
1293 #ifdef HAVE_RFC2553
1294             else
1295             {
1296                cur_acl->wildcard_dst = 1;
1297             }
1298 #endif /* def HAVE_RFC2553 */
1299
1300             /*
1301              * Add it to the list.  Note we reverse the list to get the
1302              * behaviour the user expects.  With both the ACL and
1303              * actions file, the last match wins.  However, the internal
1304              * implementations are different:  The actions file is stored
1305              * in the same order as the file, and scanned completely.
1306              * With the ACL, we reverse the order as we load it, then
1307              * when we scan it we stop as soon as we get a match.
1308              */
1309             cur_acl->next  = config->acl;
1310             config->acl = cur_acl;
1311
1312             break;
1313 #endif /* def FEATURE_ACL */
1314
1315 /* *************************************************************************
1316  * proxy-info-url url
1317  * *************************************************************************/
1318          case hash_proxy_info_url :
1319             freez(config->proxy_info_url);
1320             config->proxy_info_url = strdup(arg);
1321             break;
1322
1323 /* *************************************************************************
1324  * single-threaded 0|1
1325  * *************************************************************************/
1326          case hash_single_threaded :
1327             config->multi_threaded =  0 == parse_toggle_state(cmd, arg);
1328             break;
1329
1330 /* *************************************************************************
1331  * socket-timeout numer_of_seconds
1332  * *************************************************************************/
1333          case hash_socket_timeout :
1334             if (*arg != '\0')
1335             {
1336                int socket_timeout = atoi(arg);
1337                if (0 <= socket_timeout)
1338                {
1339                   config->socket_timeout = socket_timeout;
1340                }
1341                else
1342                {
1343                   log_error(LOG_LEVEL_FATAL,
1344                      "Invalid socket-timeout: '%s'", arg);
1345                }
1346             }
1347             break;
1348
1349 /* *************************************************************************
1350  * split-large-cgi-forms
1351  * *************************************************************************/
1352          case hash_split_large_cgi_forms :
1353             if (parse_toggle_state(cmd, arg) == 1)
1354             {
1355                config->feature_flags |= RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
1356             }
1357             else
1358             {
1359                config->feature_flags &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
1360             }
1361             break;
1362
1363 /* *************************************************************************
1364  * templdir directory-name
1365  * *************************************************************************/
1366          case hash_templdir :
1367             freez(config->templdir);
1368             config->templdir = make_path(NULL, arg);
1369             break;
1370
1371 #ifdef FEATURE_EXTERNAL_FILTERS
1372 /* *************************************************************************
1373  * temporary-directory directory-name
1374  * *************************************************************************/
1375          case hash_temporary_directory :
1376             freez(config->temporary_directory);
1377             config->temporary_directory = make_path(NULL, arg);
1378             break;
1379 #endif
1380
1381 /* *************************************************************************
1382  * tolerate-pipelining (0|1)
1383  * *************************************************************************/
1384          case hash_tolerate_pipelining :
1385             if (parse_toggle_state(cmd, arg) == 1)
1386             {
1387                config->feature_flags |= RUNTIME_FEATURE_TOLERATE_PIPELINING;
1388             }
1389             else
1390             {
1391                config->feature_flags &= ~RUNTIME_FEATURE_TOLERATE_PIPELINING;
1392             }
1393             break;
1394
1395 /* *************************************************************************
1396  * toggle (0|1)
1397  * *************************************************************************/
1398 #ifdef FEATURE_TOGGLE
1399          case hash_toggle :
1400             global_toggle_state = parse_toggle_state(cmd, arg);
1401             break;
1402 #endif /* def FEATURE_TOGGLE */
1403
1404 /* *************************************************************************
1405  * trust-info-url url
1406  * *************************************************************************/
1407 #ifdef FEATURE_TRUST
1408          case hash_trust_info_url :
1409             enlist(config->trust_info, arg);
1410             break;
1411 #endif /* def FEATURE_TRUST */
1412
1413 /* *************************************************************************
1414  * trustfile filename
1415  * (In confdir by default.)
1416  * *************************************************************************/
1417 #ifdef FEATURE_TRUST
1418          case hash_trustfile :
1419             freez(config->trustfile);
1420             config->trustfile = make_path(config->confdir, arg);
1421             break;
1422 #endif /* def FEATURE_TRUST */
1423
1424 /* *************************************************************************
1425  * usermanual url
1426  * *************************************************************************/
1427          case hash_usermanual :
1428             /*
1429              * XXX: If this isn't the first config directive, the
1430              * show-status page links to the website documentation
1431              * for the directives that were already parsed. Lame.
1432              */
1433             freez(config->usermanual);
1434             config->usermanual = strdup(arg);
1435             break;
1436
1437 /* *************************************************************************
1438  * Win32 Console options:
1439  * *************************************************************************/
1440
1441 /* *************************************************************************
1442  * hide-console
1443  * *************************************************************************/
1444 #ifdef _WIN_CONSOLE
1445          case hash_hide_console :
1446             hideConsole = 1;
1447             break;
1448 #endif /*def _WIN_CONSOLE*/
1449
1450
1451 /* *************************************************************************
1452  * Win32 GUI options:
1453  * *************************************************************************/
1454
1455 #if defined(_WIN32) && ! defined(_WIN_CONSOLE)
1456 /* *************************************************************************
1457  * activity-animation (0|1)
1458  * *************************************************************************/
1459          case hash_activity_animation :
1460             g_bShowActivityAnimation = parse_toggle_state(cmd, arg);
1461             break;
1462
1463 /* *************************************************************************
1464  *  close-button-minimizes (0|1)
1465  * *************************************************************************/
1466          case hash_close_button_minimizes :
1467             g_bCloseHidesWindow = parse_toggle_state(cmd, arg);
1468             break;
1469
1470 /* *************************************************************************
1471  * log-buffer-size (0|1)
1472  * *************************************************************************/
1473          case hash_log_buffer_size :
1474             g_bLimitBufferSize = parse_toggle_state(cmd, arg);
1475             break;
1476
1477 /* *************************************************************************
1478  * log-font-name fontname
1479  * *************************************************************************/
1480          case hash_log_font_name :
1481             if (strlcpy(g_szFontFaceName, arg,
1482                    sizeof(g_szFontFaceName)) >= sizeof(g_szFontFaceName))
1483             {
1484                log_error(LOG_LEVEL_FATAL,
1485                   "log-font-name argument '%s' is longer than %u characters.",
1486                   arg, sizeof(g_szFontFaceName)-1);
1487             }
1488             break;
1489
1490 /* *************************************************************************
1491  * log-font-size n
1492  * *************************************************************************/
1493          case hash_log_font_size :
1494             g_nFontSize = atoi(arg);
1495             break;
1496
1497 /* *************************************************************************
1498  * log-highlight-messages (0|1)
1499  * *************************************************************************/
1500          case hash_log_highlight_messages :
1501             g_bHighlightMessages = parse_toggle_state(cmd, arg);
1502             break;
1503
1504 /* *************************************************************************
1505  * log-max-lines n
1506  * *************************************************************************/
1507          case hash_log_max_lines :
1508             g_nMaxBufferLines = atoi(arg);
1509             break;
1510
1511 /* *************************************************************************
1512  * log-messages (0|1)
1513  * *************************************************************************/
1514          case hash_log_messages :
1515             g_bLogMessages = parse_toggle_state(cmd, arg);
1516             break;
1517
1518 /* *************************************************************************
1519  * show-on-task-bar (0|1)
1520  * *************************************************************************/
1521          case hash_show_on_task_bar :
1522             g_bShowOnTaskBar = parse_toggle_state(cmd, arg);
1523             break;
1524
1525 #endif /* defined(_WIN32) && ! defined(_WIN_CONSOLE) */
1526
1527
1528 /* *************************************************************************
1529  * Warnings about unsupported features
1530  * *************************************************************************/
1531 #ifndef FEATURE_ACL
1532          case hash_deny_access:
1533 #endif /* ndef FEATURE_ACL */
1534 #ifndef FEATURE_CGI_EDIT_ACTIONS
1535          case hash_enable_edit_actions:
1536 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1537 #ifndef FEATURE_TOGGLE
1538          case hash_enable_remote_toggle:
1539 #endif /* ndef FEATURE_TOGGLE */
1540 #ifndef FEATURE_ACL
1541          case hash_permit_access:
1542 #endif /* ndef FEATURE_ACL */
1543 #ifndef FEATURE_TOGGLE
1544          case hash_toggle :
1545 #endif /* ndef FEATURE_TOGGLE */
1546 #ifndef FEATURE_TRUST
1547          case hash_trustfile :
1548          case hash_trust_info_url :
1549 #endif /* ndef FEATURE_TRUST */
1550
1551 #ifndef _WIN_CONSOLE
1552          case hash_hide_console :
1553 #endif /* ndef _WIN_CONSOLE */
1554
1555 #if defined(_WIN_CONSOLE) || ! defined(_WIN32)
1556          case hash_activity_animation :
1557          case hash_close_button_minimizes :
1558          case hash_log_buffer_size :
1559          case hash_log_font_name :
1560          case hash_log_font_size :
1561          case hash_log_highlight_messages :
1562          case hash_log_max_lines :
1563          case hash_log_messages :
1564          case hash_show_on_task_bar :
1565 #endif /* defined(_WIN_CONSOLE) || ! defined(_WIN32) */
1566             /* These warnings are annoying - so hide them. -- Jon */
1567             /* log_error(LOG_LEVEL_INFO, "Unsupported directive \"%s\" ignored.", cmd); */
1568             break;
1569
1570 /* *************************************************************************/
1571          default :
1572 /* *************************************************************************/
1573             /*
1574              * I decided that I liked this better as a warning than an
1575              * error.  To change back to an error, just change log level
1576              * to LOG_LEVEL_FATAL.
1577              */
1578             log_error(LOG_LEVEL_ERROR, "Ignoring unrecognized directive "
1579                "'%s' (%uU) in line %lu in configuration file (%s).",
1580                buf, directive_hash, linenum, configfile);
1581             string_append(&config->proxy_args,
1582                " <strong class='warning'>Warning: Ignoring unrecognized directive:</strong>");
1583             break;
1584
1585 /* *************************************************************************/
1586       } /* end switch(hash_string(cmd)) */
1587
1588       /* Save the argument for the show-status page. */
1589       savearg(cmd, arg, config);
1590       freez(buf);
1591    } /* end while (read_config_line(...)) */
1592
1593    fclose(configfp);
1594
1595    set_debug_level(config->debug);
1596
1597    freez(config->logfile);
1598
1599    if (daemon_mode)
1600    {
1601       if (NULL != logfile)
1602       {
1603          config->logfile = logfile;
1604          init_error_log(Argv[0], config->logfile);
1605       }
1606       else
1607       {
1608          disable_logging();
1609       }
1610    }
1611
1612 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1613    if (config->default_server_timeout > config->keep_alive_timeout)
1614    {
1615       log_error(LOG_LEVEL_ERROR,
1616          "Reducing the default-server-timeout from %d to the keep-alive-timeout %d.",
1617          config->default_server_timeout, config->keep_alive_timeout);
1618       config->default_server_timeout = config->keep_alive_timeout;
1619    }
1620 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1621
1622 #ifdef FEATURE_CONNECTION_SHARING
1623    if (config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1624    {
1625       if (config->multi_threaded)
1626       {
1627          set_keep_alive_timeout(config->keep_alive_timeout);
1628       }
1629       else
1630       {
1631          /*
1632           * While we could use keep-alive without multiple threads
1633           * if we didn't bother with enforcing the connection timeout,
1634           * that might make Tor users sad, even though they shouldn't
1635           * enable the single-threaded option anyway.
1636           *
1637           * XXX: We could still use Proxy-Connection: keep-alive.
1638           */
1639          config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
1640          log_error(LOG_LEVEL_ERROR,
1641             "Config option single-threaded disables connection keep-alive.");
1642       }
1643    }
1644    else if ((config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING))
1645    {
1646       log_error(LOG_LEVEL_ERROR, "Config option connection-sharing "
1647          "has no effect if keep-alive-timeout isn't set.");
1648       config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
1649    }
1650 #endif /* def FEATURE_CONNECTION_SHARING */
1651
1652    if (NULL == config->proxy_args)
1653    {
1654       log_error(LOG_LEVEL_FATAL, "Out of memory loading config - insufficient memory for config->proxy_args");
1655    }
1656
1657    if (config->re_filterfile[0])
1658    {
1659       add_loader(load_re_filterfiles, config);
1660    }
1661
1662    if (config->actions_file[0])
1663    {
1664       add_loader(load_action_files, config);
1665    }
1666
1667 #ifdef FEATURE_TRUST
1668    if (config->trustfile)
1669    {
1670       add_loader(load_trustfile, config);
1671    }
1672 #endif /* def FEATURE_TRUST */
1673
1674    if (NULL == config->haddr[0])
1675    {
1676       config->haddr[0] = strdup(HADDR_DEFAULT);
1677       if (NULL == config->haddr[0])
1678       {
1679          log_error(LOG_LEVEL_FATAL, "Out of memory while copying default listening address");
1680       }
1681    }
1682
1683    for (i = 0; i < MAX_LISTENING_SOCKETS && NULL != config->haddr[i]; i++)
1684    {
1685       if ((*config->haddr[i] == '[')
1686          && (NULL != (p = strchr(config->haddr[i], ']')))
1687          && (p[1] == ':')
1688          && (0 < (config->hport[i] = atoi(p + 2))))
1689       {
1690          *p = '\0';
1691          memmove((void *)config->haddr[i], config->haddr[i] + 1,
1692             (size_t)(p - config->haddr[i]));
1693       }
1694       else if (NULL != (p = strchr(config->haddr[i], ':'))
1695          && (0 < (config->hport[i] = atoi(p + 1))))
1696       {
1697          *p = '\0';
1698       }
1699       else
1700       {
1701          log_error(LOG_LEVEL_FATAL, "invalid bind port spec %s", config->haddr[i]);
1702          /* Never get here - LOG_LEVEL_FATAL causes program exit */
1703       }
1704       if (*config->haddr[i] == '\0')
1705       {
1706          /*
1707           * Only the port specified. We stored it in config->hport[i]
1708           * and don't need its text representation anymore.
1709           * Use config->hport[i] == 0 to iterate listening addresses since
1710           * now.
1711           */
1712          freez(config->haddr[i]);
1713       }
1714    }
1715
1716    /*
1717     * Want to run all the loaders once now.
1718     *
1719     * Need to set up a fake csp, so they can get to the config.
1720     */
1721    fake_csp = (struct client_state *) zalloc (sizeof(*fake_csp));
1722    fake_csp->config = config;
1723
1724    if (run_loader(fake_csp))
1725    {
1726       freez(fake_csp);
1727       log_error(LOG_LEVEL_FATAL, "A loader failed while loading config file. Exiting.");
1728       /* Never get here - LOG_LEVEL_FATAL causes program exit */
1729    }
1730    freez(fake_csp);
1731
1732 /* FIXME: this is a kludge for win32 */
1733 #if defined(_WIN32) && !defined (_WIN_CONSOLE)
1734
1735    g_default_actions_file = config->actions_file[1]; /* FIXME Hope this is default.action */
1736    g_user_actions_file  = config->actions_file[2];  /* FIXME Hope this is user.action */
1737    g_default_filterfile = config->re_filterfile[0]; /* FIXME Hope this is default.filter */
1738    g_user_filterfile    = config->re_filterfile[1]; /* FIXME Hope this is user.filter */
1739
1740 #ifdef FEATURE_TRUST
1741    g_trustfile        = config->trustfile;
1742 #endif /* def FEATURE_TRUST */
1743
1744
1745 #endif /* defined(_WIN32) && !defined (_WIN_CONSOLE) */
1746 /* FIXME: end kludge */
1747
1748
1749    config->need_bind = 1;
1750
1751    if (current_configfile)
1752    {
1753       struct configuration_spec * oldcfg = (struct configuration_spec *)
1754                                            current_configfile->f;
1755       /*
1756        * Check if config->haddr[i],hport[i] == oldcfg->haddr[i],hport[i]
1757        *
1758        * The following could be written more compactly as a single,
1759        * (unreadably long) if statement.
1760        */
1761       config->need_bind = 0;
1762
1763       for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
1764       {
1765          if (config->hport[i] != oldcfg->hport[i])
1766          {
1767             config->need_bind = 1;
1768          }
1769          else if (config->haddr[i] == NULL)
1770          {
1771             if (oldcfg->haddr[i] != NULL)
1772             {
1773                config->need_bind = 1;
1774             }
1775          }
1776          else if (oldcfg->haddr[i] == NULL)
1777          {
1778             config->need_bind = 1;
1779          }
1780          else if (0 != strcmp(config->haddr[i], oldcfg->haddr[i]))
1781          {
1782             config->need_bind = 1;
1783          }
1784       }
1785
1786       current_configfile->unloader = unload_configfile;
1787    }
1788
1789    fs->next = files->next;
1790    files->next = fs;
1791
1792    current_configfile = fs;
1793
1794    return (config);
1795 }
1796
1797
1798 /*********************************************************************
1799  *
1800  * Function    :  savearg
1801  *
1802  * Description :  Called from `load_config'.  It saves each non-empty
1803  *                and non-comment line from config into
1804  *                config->proxy_args.  This is used to create the
1805  *                show-proxy-args page.  On error, frees
1806  *                config->proxy_args and sets it to NULL
1807  *
1808  * Parameters  :
1809  *          1  :  command = config setting that was found
1810  *          2  :  argument = the setting's argument (if any)
1811  *          3  :  config = Configuration to save into.
1812  *
1813  * Returns     :  N/A
1814  *
1815  *********************************************************************/
1816 static void savearg(char *command, char *argument, struct configuration_spec * config)
1817 {
1818    char * buf;
1819    char * s;
1820
1821    assert(command);
1822    assert(argument);
1823
1824    /*
1825     * Add config option name embedded in
1826     * link to its section in the user-manual
1827     */
1828    buf = strdup("\n<a href=\"");
1829    if (!strncmpic(config->usermanual, "file://", 7) ||
1830        !strncmpic(config->usermanual, "http", 4))
1831    {
1832       string_append(&buf, config->usermanual);
1833    }
1834    else
1835    {
1836       string_append(&buf, "http://" CGI_SITE_2_HOST "/user-manual/");
1837    }
1838    string_append(&buf, CONFIG_HELP_PREFIX);
1839    string_join  (&buf, string_toupper(command));
1840    string_append(&buf, "\">");
1841    string_append(&buf, command);
1842    string_append(&buf, "</a> ");
1843
1844    if (NULL == buf)
1845    {
1846       freez(config->proxy_args);
1847       return;
1848    }
1849
1850    if ((NULL != argument) && ('\0' != *argument))
1851    {
1852       s = html_encode(argument);
1853       if (NULL == s)
1854       {
1855          freez(buf);
1856          freez(config->proxy_args);
1857          return;
1858       }
1859
1860       if (strncmpic(argument, "http://", 7) == 0)
1861       {
1862          string_append(&buf, "<a href=\"");
1863          string_append(&buf, s);
1864          string_append(&buf, "\">");
1865          string_join  (&buf, s);
1866          string_append(&buf, "</a>");
1867       }
1868       else
1869       {
1870          string_join  (&buf, s);
1871       }
1872    }
1873
1874    string_append(&buf, "<br>");
1875    string_join(&config->proxy_args, buf);
1876 }
1877
1878
1879 /*
1880   Local Variables:
1881   tab-width: 3
1882   end:
1883 */