name change related issues
[privoxy.git] / loaders.h
1 #ifndef LOADERS_H_INCLUDED
2 #define LOADERS_H_INCLUDED
3 #define LOADERS_H_VERSION "$Id: loaders.h,v 1.17 2002/03/16 23:54:06 jongfoster Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/loaders.h,v $
7  *
8  * Purpose     :  Functions to load and unload the various
9  *                configuration files.  Also contains code to manage
10  *                the list of active loaders, and to automatically 
11  *                unload files that are no longer in use.
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: loaders.h,v $
40  *    Revision 1.17  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.16  2002/03/07 03:46:17  oes
48  *    Fixed compiler warnings
49  *
50  *    Revision 1.15  2002/01/22 23:46:18  jongfoster
51  *    Moving edit_read_line() and simple_read_line() to loaders.c, and
52  *    extending them to support reading MS-DOS, Mac and UNIX style files
53  *    on all platforms.
54  *
55  *    Modifying read_config_line() (without changing it's prototype) to
56  *    be a trivial wrapper for edit_read_line().  This means that we have
57  *    one function to read a line and handle comments, which is common
58  *    between the initialization code and the edit interface.
59  *
60  *    Revision 1.14  2002/01/17 21:03:08  jongfoster
61  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
62  *
63  *    Renaming free_url to free_url_spec, since it frees a struct url_spec.
64  *
65  *    Revision 1.13  2001/12/30 14:07:32  steudten
66  *    - Add signal handling (unix)
67  *    - Add SIGHUP handler (unix)
68  *    - Add creation of pidfile (unix)
69  *    - Add action 'top' in rc file (RH)
70  *    - Add entry 'SIGNALS' to manpage
71  *    - Add exit message to logfile (unix)
72  *
73  *    Revision 1.12  2001/11/07 00:02:13  steudten
74  *    Add line number in error output for lineparsing for
75  *    actionsfile and configfile.
76  *    Special handling for CLF added.
77  *
78  *    Revision 1.11  2001/10/23 21:38:53  jongfoster
79  *    Adding error-checking to create_url_spec()
80  *
81  *    Revision 1.10  2001/09/22 16:36:59  jongfoster
82  *    Removing unused parameter fs from read_config_line()
83  *
84  *    Revision 1.9  2001/07/30 22:08:36  jongfoster
85  *    Tidying up #defines:
86  *    - All feature #defines are now of the form FEATURE_xxx
87  *    - Permanently turned off WIN_GUI_EDIT
88  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
89  *
90  *    Revision 1.8  2001/07/29 18:58:15  jongfoster
91  *    Removing nested #includes, adding forward declarations for needed
92  *    structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
93  *
94  *    Revision 1.7  2001/07/13 14:01:54  oes
95  *    Removed all #ifdef PCRS
96  *
97  *    Revision 1.6  2001/06/07 23:14:38  jongfoster
98  *    Removing ACL and forward file loaders - these files have
99  *    been merged into the config file.
100  *
101  *    Revision 1.5  2001/05/31 21:28:49  jongfoster
102  *    Removed all permissionsfile code - it's now called the actions
103  *    file, and (almost) all the code is in actions.c
104  *
105  *    Revision 1.4  2001/05/29 09:50:24  jongfoster
106  *    Unified blocklist/imagelist/permissionslist.
107  *    File format is still under discussion, but the internal changes
108  *    are (mostly) done.
109  *
110  *    Also modified interceptor behaviour:
111  *    - We now intercept all URLs beginning with one of the following
112  *      prefixes (and *only* these prefixes):
113  *        * http://i.j.b/
114  *        * http://ijbswa.sf.net/config/
115  *        * http://ijbswa.sourceforge.net/config/
116  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
117  *    - Internal changes so that intercepted and fast redirect pages
118  *      are not replaced with an image.
119  *    - Interceptors now have the option to send a binary page direct
120  *      to the client. (i.e. ijb-send-banner uses this)
121  *    - Implemented show-url-info interceptor.  (Which is why I needed
122  *      the above interceptors changes - a typical URL is
123  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
124  *      The previous mechanism would not have intercepted that, and
125  *      if it had been intercepted then it then it would have replaced
126  *      it with an image.)
127  *
128  *    Revision 1.3  2001/05/26 00:28:36  jongfoster
129  *    Automatic reloading of config file.
130  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
131  *    Most of the global variables have been moved to a new
132  *    struct configuration_spec, accessed through csp->config->globalname
133  *    Most of the globals remaining are used by the Win32 GUI.
134  *
135  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
136  *    Version 2.9.4 checkin.
137  *    - Merged popupfile and cookiefile, and added control over PCRS
138  *      filtering, in new "permissionsfile".
139  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
140  *      file error you now get a message box (in the Win32 GUI) rather
141  *      than the program exiting with no explanation.
142  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
143  *      skipping.
144  *    - Removed tabs from "config"
145  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
146  *    - Bumped up version number.
147  *
148  *    Revision 1.1.1.1  2001/05/15 13:59:00  oes
149  *    Initial import of version 2.9.3 source tree
150  *
151  *
152  *********************************************************************/
153 \f
154
155 #ifdef __cplusplus
156 extern "C" {
157 #endif
158
159 /* Structures taken from project.h */
160 struct client_state;
161 struct file_list;
162 struct configuration_spec;
163 struct url_spec;
164
165 extern void sweep(void);
166 extern char *read_config_line(char *buf, size_t buflen, FILE *fp, unsigned long *linenum);
167 extern int check_file_changed(const struct file_list * current,
168                               const char * filename,
169                               struct file_list ** newfl);
170
171 extern jb_err edit_read_line(FILE *fp,
172                              char **raw_out,
173                              char **prefix_out,
174                              char **data_out,
175                              int *newline,
176                              unsigned long *line_number);
177
178 extern jb_err simple_read_line(FILE *fp, char **dest, int *newline);
179
180 /*
181  * Various types of newlines that a file may contain.
182  */
183 #define NEWLINE_UNKNOWN 0  /* Newline convention in file is unknown */
184 #define NEWLINE_UNIX    1  /* Newline convention in file is '\n'   (ASCII 10) */
185 #define NEWLINE_DOS     2  /* Newline convention in file is '\r\n' (ASCII 13,10) */
186 #define NEWLINE_MAC     3  /* Newline convention in file is '\r'   (ASCII 13) */
187
188 /*
189  * Types of newlines that a file may contain, as strings.  If you have an
190  * extremely wierd compiler that does not have '\r' == CR == ASCII 13 and
191  * '\n' == LF == ASCII 10), then fix CHAR_CR and CHAR_LF in loaders.c as
192  * well as these definitions.
193  */
194 #define NEWLINE(style) ((style)==NEWLINE_DOS ? "\r\n" : \
195                         ((style)==NEWLINE_MAC ? "\r" : "\n"))
196
197
198 extern short int MustReload;
199 extern int load_actions_file(struct client_state *csp);
200 extern int load_re_filterfile(struct client_state *csp);
201
202 #ifdef FEATURE_TRUST
203 extern int load_trustfile(struct client_state *csp);
204 #endif /* def FEATURE_TRUST */
205
206 #ifdef FEATURE_GRACEFUL_TERMINATION
207 #ifdef FEATURE_TRUST
208 void unload_current_trust_file(void);
209 #endif
210 void unload_current_re_filterfile(void);
211 #endif /* FEATURE_GRACEFUL_TERMINATION */
212
213
214 extern void add_loader(int (*loader)(struct client_state *), 
215                        struct configuration_spec * config);
216 extern int run_loader(struct client_state *csp);
217
218 /* Revision control strings from this header and associated .c file */
219 extern const char loaders_rcs[];
220 extern const char loaders_h_rcs[];
221
222 #ifdef __cplusplus
223 } /* extern "C" */
224 #endif
225
226 #endif /* ndef LOADERS_H_INCLUDED */
227
228 /*
229   Local Variables:
230   tab-width: 3
231   end:
232 */