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