-const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.65 2007/07/21 11:51:36 fabiankeil Exp $";
+const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.85 2009/01/22 12:06:26 fabiankeil Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/loadcfg.c,v $
* routine to load the configuration and the global
* variables it writes to.
*
- * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
*
* Revisions :
* $Log: loadcfg.c,v $
+ * Revision 1.85 2009/01/22 12:06:26 fabiankeil
+ * Don't keep connections alive when running single-threaded.
+ *
+ * Revision 1.84 2009/01/14 16:14:36 fabiankeil
+ * Due to the standard.action file removal, the other action
+ * files changed their position in config->actions_file[].
+ * Update mingw32 kludge accordingly.
+ *
+ * Revision 1.83 2008/12/20 14:53:55 fabiankeil
+ * Add config option socket-timeout to control the time
+ * Privoxy waits for data to arrive on a socket. Useful
+ * in case of stale ssh tunnels or when fuzz-testing.
+ *
+ * Revision 1.82 2008/11/16 12:43:49 fabiankeil
+ * Turn keep-alive support into a runtime feature
+ * that is disabled by setting keep-alive-timeout
+ * to a negative value.
+ *
+ * Revision 1.81 2008/11/13 09:08:42 fabiankeil
+ * Add new config option: keep-alive-timeout.
+ *
+ * Revision 1.80 2008/08/31 15:59:03 fabiankeil
+ * There's no reason to let remote toggling support depend
+ * on FEATURE_CGI_EDIT_ACTIONS, so make sure it doesn't.
+ *
+ * Revision 1.79 2008/08/30 12:03:07 fabiankeil
+ * Remove FEATURE_COOKIE_JAR.
+ *
+ * Revision 1.78 2008/08/02 08:23:22 fabiankeil
+ * If the enforce-blocks directive is used with FEATURE_FORCE_LOAD
+ * disabled, log a message that blocks will always be enforced
+ * instead of complaining about an unrecognized directive.
+ * Reported by Pietro Leone.
+ *
+ * Revision 1.77 2008/05/26 16:13:22 fabiankeil
+ * Reuse directive_hash and don't hash the same directive twice.
+ *
+ * Revision 1.76 2008/05/10 09:03:16 fabiankeil
+ * - Merge three string_append() calls.
+ * - Remove useless assertion.
+ *
+ * Revision 1.75 2008/03/30 14:52:05 fabiankeil
+ * Rename load_actions_file() and load_re_filterfile()
+ * as they load multiple files "now".
+ *
+ * Revision 1.74 2008/03/26 18:07:07 fabiankeil
+ * Add hostname directive. Closes PR#1918189.
+ *
+ * Revision 1.73 2008/02/16 16:54:51 fabiankeil
+ * Fix typo.
+ *
+ * Revision 1.72 2008/02/03 13:46:15 fabiankeil
+ * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
+ *
+ * Revision 1.71 2007/12/23 15:24:56 fabiankeil
+ * Reword "unrecognized directive" warning, use better
+ * mark up and add a <br>. Fixes parts of #1856559.
+ *
+ * Revision 1.70 2007/12/15 14:24:05 fabiankeil
+ * Plug memory leak if listen-address only specifies the port.
+ *
+ * Revision 1.69 2007/10/27 13:02:27 fabiankeil
+ * Relocate daemon-mode-related log messages to make sure
+ * they aren't shown again in case of configuration reloads.
+ *
+ * Revision 1.68 2007/10/19 16:32:34 fabiankeil
+ * Plug memory leak introduced with my last commit.
+ *
+ * Revision 1.67 2007/10/14 14:12:41 fabiankeil
+ * When in daemon mode, close stderr after the configuration file has been
+ * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
+ *
+ * Revision 1.66 2007/08/05 14:02:09 fabiankeil
+ * #1763173 from Stefan Huehner: declare unload_configfile() static.
+ *
* Revision 1.65 2007/07/21 11:51:36 fabiankeil
* As Hal noticed, checking dispatch_cgi() as the last cruncher
* looks like a bug if CGI requests are blocked unintentionally,
#include "encode.h"
#include "urlmatch.h"
#include "cgi.h"
+#include "gateway.h"
const char loadcfg_h_rcs[] = LOADCFG_H_VERSION;
#define hash_forward 2029845ul /* "forward" */
#define hash_forward_socks4 3963965521ul /* "forward-socks4" */
#define hash_forward_socks4a 2639958518ul /* "forward-socks4a" */
+#define hash_forward_socks5 3963965522ul /* "forward-socks5" */
#define hash_forwarded_connect_retries 101465292ul /* "forwarded-connect-retries" */
-#define hash_jarfile 2046641ul /* "jarfile" */
+#define hash_hostname 10308071ul /* "hostname" */
+#define hash_keep_alive_timeout 3878599515ul /* "keep-alive-timeout" */
#define hash_listen_address 1255650842ul /* "listen-address" */
#define hash_logdir 422889ul /* "logdir" */
#define hash_logfile 2114766ul /* "logfile" */
#define hash_permit_access 3587953268ul /* "permit-access" */
#define hash_proxy_info_url 3903079059ul /* "proxy-info-url" */
#define hash_single_threaded 4250084780ul /* "single-threaded" */
+#define hash_socket_timeout 1809001761ul /* "socket-timeout" */
#define hash_split_large_cgi_forms 671658948ul /* "split-large-cgi-forms" */
#define hash_suppress_blocklists 1948693308ul /* "suppress-blocklists" */
#define hash_templdir 11067889ul /* "templdir" */
}
config->forward = NULL;
-#ifdef FEATURE_COOKIE_JAR
- if ( NULL != config->jar )
- {
- fclose( config->jar );
- config->jar = NULL;
- }
-#endif /* def FEATURE_COOKIE_JAR */
-
freez(config->confdir);
freez(config->logdir);
freez(config->templdir);
+ freez(config->hostname);
freez(config->haddr);
freez(config->logfile);
freez(config->proxy_args);
freez(config->usermanual);
-#ifdef FEATURE_COOKIE_JAR
- freez(config->jarfile);
-#endif /* def FEATURE_COOKIE_JAR */
-
#ifdef FEATURE_TRUST
freez(config->trustfile);
list_remove_all(config->trust_info);
*
* Description : Load the config file and all parameters.
*
+ * XXX: more than thousand lines long
+ * and thus in serious need of refactoring.
+ *
* Parameters : None
*
* Returns : The configuration_spec, or NULL on error.
struct file_list *fs;
unsigned long linenum = 0;
int i;
+ char *logfile = NULL;
+#ifdef FEATURE_CONNECTION_KEEP_ALIVE
+ int keep_alive_timeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
+#endif
if ( !check_file_changed(current_configfile, configfile, &fs))
{
config->usermanual = strdup(USER_MANUAL_URL);
config->proxy_args = strdup("");
config->forwarded_connect_retries = 0;
+ config->socket_timeout = 180;
config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
config->feature_flags &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
config->feature_flags &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
struct forward_spec *cur_fwd;
int vec_count;
char *vec[3];
+ unsigned long directive_hash;
strlcpy(tmp, buf, sizeof(tmp));
/* Save the argument for show-proxy-args */
savearg(cmd, arg, config);
-
- switch( hash_string( cmd ) )
+ directive_hash = hash_string(cmd);
+ switch (directive_hash)
{
/* *************************************************************************
* actionsfile actions-file-name
/* *************************************************************************
* enable-remote-toggle 0|1
* *************************************************************************/
-#ifdef FEATURE_CGI_EDIT_ACTIONS
+#ifdef FEATURE_TOGGLE
case hash_enable_remote_toggle:
if ((*arg != '\0') && (0 != atoi(arg)))
{
config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
}
continue;
-#endif /* def FEATURE_CGI_EDIT_ACTIONS */
+#endif /* def FEATURE_TOGGLE */
/* *************************************************************************
* enable-remote-http-toggle 0|1
continue;
/* *************************************************************************
- * hash_enforce_blocks 0|1
+ * enforce-blocks 0|1
* *************************************************************************/
-#ifdef FEATURE_FORCE_LOAD
case hash_enforce_blocks:
+#ifdef FEATURE_FORCE_LOAD
if ((*arg != '\0') && (0 != atoi(arg)))
{
config->feature_flags |= RUNTIME_FEATURE_ENFORCE_BLOCKS;
{
config->feature_flags &= ~RUNTIME_FEATURE_ENFORCE_BLOCKS;
}
- continue;
+#else
+ log_error(LOG_LEVEL_ERROR, "Ignoring directive 'enforce-blocks'. "
+ "FEATURE_FORCE_LOAD is disabled, blocks will always be enforced.");
#endif /* def FEATURE_FORCE_LOAD */
+ continue;
/* *************************************************************************
* filterfile file-name
* forward-socks4a url-pattern socks-proxy[:port] (.|http-proxy[:port])
* *************************************************************************/
case hash_forward_socks4a:
+ case hash_forward_socks5:
vec_count = ssplit(arg, " \t", vec, SZ(vec), 1, 1);
if (vec_count != 3)
continue;
}
- cur_fwd->type = SOCKS_4A;
+ if (directive_hash == hash_forward_socks4a)
+ {
+ cur_fwd->type = SOCKS_4A;
+ }
+ else
+ {
+ cur_fwd->type = SOCKS_5;
+ }
/* Save the URL pattern */
if (create_url_spec(cur_fwd->url, vec[0]))
continue;
/* *************************************************************************
- * jarfile jar-file-name
- * In logdir by default
+ * hostname hostname-to-show-on-cgi-pages
+ * *************************************************************************/
+ case hash_hostname :
+ freez(config->hostname);
+ config->hostname = strdup(arg);
+ if (NULL == config->hostname)
+ {
+ log_error(LOG_LEVEL_FATAL, "Out of memory saving hostname.");
+ }
+ continue;
+
+/* *************************************************************************
+ * keep-alive-timeout timeout
* *************************************************************************/
-#ifdef FEATURE_COOKIE_JAR
- case hash_jarfile :
- freez(config->jarfile);
- config->jarfile = make_path(config->logdir, arg);
+#ifdef FEATURE_CONNECTION_KEEP_ALIVE
+ case hash_keep_alive_timeout :
+ if (*arg != '\0')
+ {
+ int timeout = atoi(arg);
+ if (0 <= timeout)
+ {
+ config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
+ keep_alive_timeout = timeout;
+ }
+ else
+ {
+ config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
+ }
+ }
continue;
-#endif /* def FEATURE_COOKIE_JAR */
+#endif
/* *************************************************************************
* listen-address [ip][:port]
* In logdir by default
* *************************************************************************/
case hash_logfile :
- freez(config->logfile);
- config->logfile = no_daemon ? NULL : make_path(config->logdir, arg);
+ if (!no_daemon)
+ {
+ logfile = make_path(config->logdir, arg);
+ if (NULL == logfile)
+ {
+ log_error(LOG_LEVEL_FATAL, "Out of memory while creating logfile path");
+ }
+ }
continue;
/* *************************************************************************
config->multi_threaded = 0;
continue;
+/* *************************************************************************
+ * socket-timeout numer_of_seconds
+ * *************************************************************************/
+ case hash_socket_timeout :
+ if (*arg != '\0')
+ {
+ int socket_timeout = atoi(arg);
+ if (0 < socket_timeout)
+ {
+ config->socket_timeout = socket_timeout;
+ }
+ else
+ {
+ log_error(LOG_LEVEL_FATAL,
+ "Invalid socket-timeout: '%s'", arg);
+ }
+ }
+ continue;
+
/* *************************************************************************
* split-large-cgi-forms
* *************************************************************************/
#endif /* ndef FEATURE_ACL */
#ifndef FEATURE_CGI_EDIT_ACTIONS
case hash_enable_edit_actions:
+#endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
+#ifndef FEATURE_TOGGLE
case hash_enable_remote_toggle:
-#endif /* def FEATURE_CGI_EDIT_ACTIONS */
-#ifndef FEATURE_COOKIE_JAR
- case hash_jarfile :
-#endif /* ndef FEATURE_COOKIE_JAR */
+#endif /* ndef FEATURE_TOGGLE */
#ifndef FEATURE_ACL
case hash_permit_access:
#endif /* ndef FEATURE_ACL */
* to LOG_LEVEL_FATAL.
*/
log_error(LOG_LEVEL_ERROR, "Ignoring unrecognized directive '%s' (%luul) in line %lu "
- "in configuration file (%s).", buf, hash_string(cmd), linenum, configfile);
+ "in configuration file (%s).", buf, directive_hash, linenum, configfile);
string_append(&config->proxy_args,
- " <b><font color=\"red\">WARNING: unrecognized directive, ignored</font></b>");
+ " <strong class='warning'>Warning: ignored unrecognized directive above.</strong><br>");
continue;
/* *************************************************************************/
fclose(configfp);
+ set_debug_level(config->debug);
+
+ freez(config->logfile);
+
+ if (!no_daemon)
+ {
+ if (NULL != logfile)
+ {
+ config->logfile = logfile;
+ init_error_log(Argv[0], config->logfile);
+ }
+ else
+ {
+ disable_logging();
+ }
+ }
+
+#ifdef FEATURE_CONNECTION_KEEP_ALIVE
+ if (config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
+ {
+ if (config->multi_threaded)
+ {
+ set_keep_alive_timeout(keep_alive_timeout);
+ }
+ else
+ {
+ /*
+ * While we could use keep-alive without multiple threads
+ * if we didn't bother with enforcing the connection timeout,
+ * that might make Tor users sad, even though they shouldn't
+ * enable the single-threaded option anyway.
+ */
+ config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
+ log_error(LOG_LEVEL_ERROR,
+ "Config option single-threaded disables connection keep-alive.");
+ }
+ }
+#endif
+
if (NULL == config->proxy_args)
{
log_error(LOG_LEVEL_FATAL, "Out of memory loading config - insufficient memory for config->proxy_args");
}
- init_error_log(Argv[0], config->logfile, config->debug);
-
if (config->actions_file[0])
{
- add_loader(load_actions_file, config);
+ add_loader(load_action_files, config);
}
- if (config->re_filterfile)
+ if (config->re_filterfile[0])
{
- add_loader(load_re_filterfile, config);
+ add_loader(load_re_filterfiles, config);
}
#ifdef FEATURE_TRUST
}
#endif /* def FEATURE_TRUST */
-#ifdef FEATURE_COOKIE_JAR
- if ( NULL != config->jarfile )
- {
- if ( NULL == (config->jar = fopen(config->jarfile, "a")) )
- {
- log_error(LOG_LEVEL_FATAL, "can't open jarfile '%s': %E", config->jarfile);
- /* Never get here - LOG_LEVEL_FATAL causes program exit */
- }
- setbuf(config->jar, NULL);
- }
-#endif /* def FEATURE_COOKIE_JAR */
-
if ( NULL == config->haddr )
{
config->haddr = strdup( HADDR_DEFAULT );
}
if (*config->haddr == '\0')
{
- config->haddr = NULL;
+ /*
+ * Only the port specified. We stored it in config->hport
+ * and don't need its text representation anymore.
+ */
+ freez(config->haddr);
}
}
/* FIXME: this is a kludge for win32 */
#if defined(_WIN32) && !defined (_WIN_CONSOLE)
- g_default_actions_file = config->actions_file[1]; /* FIXME Hope this is default.action */
+ g_default_actions_file = config->actions_file[1]; /* FIXME Hope this is default.action */
g_user_actions_file = config->actions_file[2]; /* FIXME Hope this is user.action */
g_re_filterfile = config->re_filterfile[0]; /* FIXME Hope this is default.filter */
char * s;
assert(command);
- assert(*command);
assert(argument);
/*
* Add config option name embedded in
- * link to it's section in the user-manual
+ * link to its section in the user-manual
*/
buf = strdup("\n<a href=\"");
if (!strncmpic(config->usermanual, "file://", 7) ||
}
else
{
- string_append(&buf, "http://");
- string_append(&buf, CGI_SITE_2_HOST);
- string_append(&buf, "/user-manual/");
+ string_append(&buf, "http://" CGI_SITE_2_HOST "/user-manual/");
}
string_append(&buf, CONFIG_HELP_PREFIX);
string_join (&buf, string_toupper(command));