loadcfg.h

   1 #ifndef LOADCFG_H_INCLUDED
   2 #define LOADCFG_H_INCLUDED
   3 #define LOADCFG_H_VERSION "$Id: loadcfg.h,v 1.9 2002/03/16 23:54:06 jongfoster Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/loadcfg.h,v $
   7  *
   8  * Purpose     :  Loads settings from the configuration file into
   9  *                global variables.  This file contains both the
  10  *                routine to load the configuration and the global
  11  *                variables it writes to.
  12  *
  13  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  14  *                Privoxy team.  http://ijbswa.sourceforge.net
  15  *
  16  *                Based on the Internet Junkbuster originally written
  17  *                by and Copyright (C) 1997 Anonymous Coders and
  18  *                Junkbusters Corporation.  http://www.junkbusters.com
  19  *
  20  *                This program is free software; you can redistribute it
  21  *                and/or modify it under the terms of the GNU General
  22  *                Public License as published by the Free Software
  23  *                Foundation; either version 2 of the License, or (at
  24  *                your option) any later version.
  25  *
  26  *                This program is distributed in the hope that it will
  27  *                be useful, but WITHOUT ANY WARRANTY; without even the
  28  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  29  *                PARTICULAR PURPOSE.  See the GNU General Public
  30  *                License for more details.
  31  *
  32  *                The GNU General Public License should be included with
  33  *                this file.  If not, you can view it at
  34  *                http://www.gnu.org/copyleft/gpl.html
  35  *                or write to the Free Software Foundation, Inc., 59
  36  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  37  *
  38  * Revisions   :
  39  *    $Log: loadcfg.h,v $
  40  *    Revision 1.9  2002/03/16 23:54:06  jongfoster
  41  *    Adding graceful termination feature, to help look for memory leaks.
  42  *    If you enable this (which, by design, has to be done by hand
  43  *    editing config.h) and then go to http://i.j.b/die, then the program
  44  *    will exit cleanly after the *next* request.  It should free all the
  45  *    memory that was used.
  46  *
  47  *    Revision 1.8  2001/12/30 14:07:32  steudten
  48  *    - Add signal handling (unix)
  49  *    - Add SIGHUP handler (unix)
  50  *    - Add creation of pidfile (unix)
  51  *    - Add action 'top' in rc file (RH)
  52  *    - Add entry 'SIGNALS' to manpage
  53  *    - Add exit message to logfile (unix)
  54  *
  55  *    Revision 1.7  2001/07/30 22:08:36  jongfoster
  56  *    Tidying up #defines:
  57  *    - All feature #defines are now of the form FEATURE_xxx
  58  *    - Permanently turned off WIN_GUI_EDIT
  59  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
  60  *
  61  *    Revision 1.6  2001/07/29 18:58:15  jongfoster
  62  *    Removing nested #includes, adding forward declarations for needed
  63  *    structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
  64  *
  65  *    Revision 1.5  2001/05/26 00:28:36  jongfoster
  66  *    Automatic reloading of config file.
  67  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
  68  *    Most of the global variables have been moved to a new
  69  *    struct configuration_spec, accessed through csp->config->globalname
  70  *    Most of the globals remaining are used by the Win32 GUI.
  71  *
  72  *    Revision 1.4  2001/05/22 18:46:04  oes
  73  *
  74  *    - Enabled filtering banners by size rather than URL
  75  *      by adding patterns that replace all standard banner
  76  *      sizes with the "Junkbuster" gif to the re_filterfile
  77  *
  78  *    - Enabled filtering WebBugs by providing a pattern
  79  *      which kills all 1x1 images
  80  *
  81  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
  82  *      which is selected by the (nonstandard and therefore
  83  *      capital) letter 'U' in the option string.
  84  *      It causes the quantifiers to be ungreedy by default.
  85  *      Appending a ? turns back to greedy (!).
  86  *
  87  *    - Added a new interceptor ijb-send-banner, which
  88  *      sends back the "Junkbuster" gif. Without imagelist or
  89  *      MSIE detection support, or if tinygif = 1, or the
  90  *      URL isn't recognized as an imageurl, a lame HTML
  91  *      explanation is sent instead.
  92  *
  93  *    - Added new feature, which permits blocking remote
  94  *      script redirects and firing back a local redirect
  95  *      to the browser.
  96  *      The feature is conditionally compiled, i.e. it
  97  *      can be disabled with --disable-fast-redirects,
  98  *      plus it must be activated by a "fast-redirects"
  99  *      line in the config file, has its own log level
 100  *      and of course wants to be displayed by show-proxy-args
 101  *      Note: Boy, all the #ifdefs in 1001 locations and
 102  *      all the fumbling with configure.in and acconfig.h
 103  *      were *way* more work than the feature itself :-(
 104  *
 105  *    - Because a generic redirect template was needed for
 106  *      this, tinygif = 3 now uses the same.
 107  *
 108  *    - Moved GIFs, and other static HTTP response templates
 109  *      to project.h
 110  *
 111  *    - Some minor fixes
 112  *
 113  *    - Removed some >400 CRs again (Jon, you really worked
 114  *      a lot! ;-)
 115  *
 116  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
 117  *    Version 2.9.4 checkin.
 118  *    - Merged popupfile and cookiefile, and added control over PCRS
 119  *      filtering, in new "permissionsfile".
 120  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 121  *      file error you now get a message box (in the Win32 GUI) rather
 122  *      than the program exiting with no explanation.
 123  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 124  *      skipping.
 125  *    - Removed tabs from "config"
 126  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 127  *    - Bumped up version number.
 128  *
 129  *    Revision 1.2  2001/05/17 23:01:01  oes
 130  *     - Cleaned CRLF's from the sources and related files
 131  *
 132  *    Revision 1.1.1.1  2001/05/15 13:58:58  oes
 133  *    Initial import of version 2.9.3 source tree
 134  *
 135  *
 136  *********************************************************************/
 137 \f
 138
 139 #ifdef __cplusplus
 140 extern "C" {
 141 #endif
 142
 143 /* Don't need project.h, only this: */
 144 struct configuration_spec;
 145
 146 /* Global variables */
 147
 148 #ifdef FEATURE_TOGGLE
 149 /* indicates if ijb is enabled */
 150 extern int g_bToggleIJB;
 151 #endif /* def FEATURE_TOGGLE */
 152
 153 extern const char *configfile;
 154
 155
 156 /* The load_config function is now going to call:
 157  * init_proxy_args, so it will need argc and argv.
 158  * Since load_config will also be a signal handler,
 159  * we need to have these globally available.
 160  */
 161 extern int Argc;
 162 extern const char **Argv;
 163 extern short int MustReload;
 164
 165
 166 extern struct configuration_spec * load_config(void);
 167
 168 #ifdef FEATURE_GRACEFUL_TERMINATION
 169 void unload_current_config_file(void);
 170 #endif
 171
 172 /* Revision control strings from this header and associated .c file */
 173 extern const char loadcfg_rcs[];
 174 extern const char loadcfg_h_rcs[];
 175
 176 #ifdef __cplusplus
 177 } /* extern "C" */
 178 #endif
 179
 180 #endif /* ndef LOADCFG_H_INCLUDED */
 181
 182 /*
 183   Local Variables:
 184   tab-width: 3
 185   end:
 186 */