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