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