Add small section on general packaging guidelines (e.g. actions files must
[privoxy.git] / loadcfg.c
index 9881465..1d6a10e 100644 (file)
--- a/loadcfg.c
+++ b/loadcfg.c
@@ -1,4 +1,4 @@
-const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.35 2002/03/07 03:52:44 oes Exp $";
+const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.47 2002/05/12 21:36:29 jongfoster Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/loadcfg.c,v $
@@ -9,7 +9,7 @@ const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.35 2002/03/07 03:52:44 oes Exp $"
  *                variables it writes to.
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
- *                IJBSWA team.  http://ijbswa.sourceforge.net
+ *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and
@@ -35,6 +35,48 @@ const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.35 2002/03/07 03:52:44 oes Exp $"
  *
  * Revisions   :
  *    $Log: loadcfg.c,v $
+ *    Revision 1.47  2002/05/12 21:36:29  jongfoster
+ *    Correcting function comments
+ *
+ *    Revision 1.46  2002/04/26 12:55:14  oes
+ *     - New option "user-manual", defaults to our site
+ *       via project.h #define
+ *     - savearg now embeds option names in help links
+ *
+ *    Revision 1.45  2002/04/24 02:11:54  oes
+ *    Jon's multiple AF patch: Allow up to MAX_ACTION_FILES actionsfile options
+ *
+ *    Revision 1.44  2002/04/08 20:37:13  swa
+ *    fixed JB spelling
+ *
+ *    Revision 1.43  2002/04/08 20:36:50  swa
+ *    fixed JB spelling
+ *
+ *    Revision 1.42  2002/04/05 15:50:15  oes
+ *    fix for invalid HTML proxy_args
+ *
+ *    Revision 1.41  2002/03/31 17:19:00  jongfoster
+ *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
+ *
+ *    Revision 1.40  2002/03/26 22:29:55  swa
+ *    we have a new homepage!
+ *
+ *    Revision 1.39  2002/03/24 13:25:43  swa
+ *    name change related issues
+ *
+ *    Revision 1.38  2002/03/24 13:05:48  jongfoster
+ *    Renaming re_filterfile to filterfile
+ *
+ *    Revision 1.37  2002/03/16 23:54:06  jongfoster
+ *    Adding graceful termination feature, to help look for memory leaks.
+ *    If you enable this (which, by design, has to be done by hand
+ *    editing config.h) and then go to http://i.j.b/die, then the program
+ *    will exit cleanly after the *next* request.  It should free all the
+ *    memory that was used.
+ *
+ *    Revision 1.36  2002/03/13 00:27:05  jongfoster
+ *    Killing warnings
+ *
  *    Revision 1.35  2002/03/07 03:52:44  oes
  *    Set logging to tty for --no-daemon mode
  *
@@ -273,6 +315,9 @@ const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.35 2002/03/07 03:52:44 oes Exp $"
 
 #ifdef _WIN32
 
+# ifndef STRICT
+#  define STRICT
+# endif
 # include <windows.h>
 
 # include "win32.h"
@@ -305,6 +350,7 @@ const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.35 2002/03/07 03:52:44 oes Exp $"
 #include "ssplit.h"
 #include "encode.h"
 #include "urlmatch.h"
+#include "cgi.h"
 
 const char loadcfg_h_rcs[] = LOADCFG_H_VERSION;
 
@@ -321,7 +367,7 @@ const char loadcfg_h_rcs[] = LOADCFG_H_VERSION;
 
 #ifdef FEATURE_TOGGLE
 /* by haroon - indicates if ijb is enabled */
-int g_bToggleIJB        = 1;   /* JunkBusters is enabled by default. */
+int g_bToggleIJB        = 1;   /* Privoxy is enabled by default. */
 #endif /* def FEATURE_TOGGLE */
 
 /* The filename of the configfile */
@@ -357,6 +403,7 @@ static struct file_list *current_configfile = NULL;
 #define hash_deny_access               1227333715ul /* "deny-access" */
 #define hash_enable_edit_actions       2517097536ul /* "enable-edit-actions" */
 #define hash_enable_remote_toggle      2979744683ul /* "enable-remote-toggle" */
+#define hash_filterfile                 250887266ul /* "filterfile" */
 #define hash_forward                      2029845ul /* "forward" */
 #define hash_forward_socks4            3963965521ul /* "forward-socks4" */
 #define hash_forward_socks4a           2639958518ul /* "forward-socks4a" */
@@ -366,13 +413,12 @@ static struct file_list *current_configfile = NULL;
 #define hash_logfile                      2114766ul /* "logfile" */
 #define hash_permit_access             3587953268ul /* "permit-access" */
 #define hash_proxy_info_url            3903079059ul /* "proxy-info-url" */
-#define hash_re_filterfile             3877522444ul /* "re_filterfile" */
 #define hash_single_threaded           4250084780ul /* "single-threaded" */
 #define hash_suppress_blocklists       1948693308ul /* "suppress-blocklists" */
 #define hash_toggle                        447966ul /* "toggle" */
 #define hash_trust_info_url             430331967ul /* "trust-info-url" */
 #define hash_trustfile                   56494766ul /* "trustfile" */
-
+#define hash_usermanual                1416668518ul /* "user-manual" */
 #define hash_activity_animation        1817904738ul /* "activity-animation" */
 #define hash_close_button_minimizes    3651284693ul /* "close-button-minimizes" */
 #define hash_hide_console              2048809870ul /* "hide-console" */
@@ -405,6 +451,7 @@ void unload_configfile (void * data)
    struct forward_spec *cur_fwd = config->forward;
 #ifdef FEATURE_ACL
    struct access_control_list *cur_acl = config->acl;
+   int i;
 
    while (cur_acl != NULL)
    {
@@ -441,10 +488,16 @@ void unload_configfile (void * data)
    freez(config->haddr);
    freez(config->logfile);
 
-   freez(config->actions_file);
+   for (i = 0; i < MAX_ACTION_FILES; i++)
+   {
+      freez(config->actions_file_short[i]);
+      freez(config->actions_file[i]);
+   }
+
    freez(config->admin_address);
    freez(config->proxy_info_url);
    freez(config->proxy_args);
+   freez(config->usermanual);
 
 #ifdef FEATURE_COOKIE_JAR
    freez(config->jarfile);
@@ -455,17 +508,39 @@ void unload_configfile (void * data)
 }
 
 
+#ifdef FEATURE_GRACEFUL_TERMINATION
+/*********************************************************************
+ *
+ * Function    :  unload_current_config_file
+ *
+ * Description :  Unloads current config file - reset to state at
+ *                beginning of program.
+ *
+ * Parameters  :  None
+ *
+ * Returns     :  N/A
+ *
+ *********************************************************************/
+void unload_current_config_file(void)
+{
+   if (current_configfile)
+   {
+      current_configfile->unloader = unload_configfile;
+      current_configfile = NULL;
+   }
+}
+#endif
+
+
 /*********************************************************************
  *
  * Function    :  load_config
  *
  * Description :  Load the config file and all parameters.
  *
- * Parameters  :
- *          1  :  csp = Client state (the config member will be
- *                filled in by this function).
+ * Parameters  :  None
  *
- * Returns     :  0 => Ok, everything else is an error.
+ * Returns     :  The configuration_spec, or NULL on error.
  *
  *********************************************************************/
 struct configuration_spec * load_config(void)
@@ -477,6 +552,7 @@ struct configuration_spec * load_config(void)
    struct client_state * fake_csp;
    struct file_list *fs;
    unsigned long linenum = 0;
+   int i;
 
    if ( !check_file_changed(current_configfile, configfile, &fs))
    {
@@ -519,10 +595,10 @@ struct configuration_spec * load_config(void)
    /*
     * Set to defaults
     */
-
    config->multi_threaded    = 1;
    config->hport             = HADDR_PORT;
    config->buffer_limit      = 4096 * 1024;
+   config->usermanual        = strdup(USER_MANUAL_URL);
    config->proxy_args        = strdup("");
 
    if ((configfp = fopen(configfile, "r")) == NULL)
@@ -590,8 +666,28 @@ struct configuration_spec * load_config(void)
  * In confdir by default
  * *************************************************************************/
          case hash_actions_file :
-            freez(config->actions_file);
-            config->actions_file = make_path(config->confdir, arg);
+            i = 0;
+            while ((i < MAX_ACTION_FILES) && (NULL != config->actions_file[i]))
+            {
+               i++;
+            }
+
+            if (i >= MAX_ACTION_FILES)
+            {
+               log_error(LOG_LEVEL_FATAL, "Too many 'actionsfile' directives in config file - limit is %d.\n"
+                  "(You can increase this limit by changing MAX_ACTION_FILES in project.h and recompiling).",
+                  MAX_ACTION_FILES);
+            }
+            config->actions_file_short[i] = strdup(arg);
+            p = malloc(strlen(arg) + sizeof(".action"));
+            if (p == NULL)
+            {
+               log_error(LOG_LEVEL_FATAL, "Out of memory");
+            }
+            strcpy(p, arg);
+            strcat(p, ".action");
+            config->actions_file[i] = make_path(config->confdir, p);
+            free(p);
             continue;
 
 /* *************************************************************************
@@ -1079,7 +1175,7 @@ struct configuration_spec * load_config(void)
  * re_filterfile file-name
  * In confdir by default.
  * *************************************************************************/
-         case hash_re_filterfile :
+         case hash_filterfile :
             freez(config->re_filterfile);
             config->re_filterfile = make_path(config->confdir, arg);
             continue;
@@ -1120,6 +1216,13 @@ struct configuration_spec * load_config(void)
             continue;
 #endif /* def FEATURE_TRUST */
 
+/* *************************************************************************
+ * usermanual url
+ * *************************************************************************/
+         case hash_usermanual :
+            freez(config->usermanual);
+            config->usermanual = strdup(arg);
+            continue;
 
 /* *************************************************************************
  * Win32 Console options:
@@ -1277,7 +1380,7 @@ struct configuration_spec * load_config(void)
 
    init_error_log(Argv[0], config->logfile, config->debug);
 
-   if (config->actions_file)
+   if (config->actions_file[0])
    {
       add_loader(load_actions_file, config);
    }
@@ -1353,7 +1456,7 @@ struct configuration_spec * load_config(void)
 /* FIXME: this is a kludge for win32 */
 #if defined(_WIN32) && !defined (_WIN_CONSOLE)
 
-   g_actions_file     = config->actions_file;
+   g_actions_file     = config->actions_file[0]; /* FIXME only works for first action file */
    g_re_filterfile    = config->re_filterfile;
 
 #ifdef FEATURE_TRUST
@@ -1423,6 +1526,7 @@ struct configuration_spec * load_config(void)
  * Parameters  :
  *          1  :  command = config setting that was found
  *          2  :  argument = the setting's argument (if any)
+ *          3  :  config = Configuration to save into.
  *
  * Returns     :  N/A
  *
@@ -1436,20 +1540,23 @@ static void savearg(char *command, char *argument, struct configuration_spec * c
    assert(*command);
    assert(argument);
 
-   buf = strdup("");
+   /*
+    * Add config option name embedded in
+    * link to it's section in the user-manual
+    */
+   buf = strdup("<a href=\"");
+   string_append(&buf, config->usermanual);
+   string_append(&buf, CONFIG_HELP_PREFIX);
+   string_join  (&buf, string_toupper(command));
+   string_append(&buf, "\">");
+   string_append(&buf, command);
+   string_append(&buf, "</a> ");
 
-   s = html_encode(command);
-   if (NULL == s)
+   if (NULL == buf)
    {
-      freez(buf);
       freez(config->proxy_args);
       return;
    }
-   string_append(&buf, "<a href=\"" REDIRECT_URL "option#");
-   string_append(&buf, s);
-   string_append(&buf, "\">");
-   string_join  (&buf, s);
-   string_append(&buf, "</a> ");
 
    if ( (NULL != argument) && ('\0' != *argument) )
    {