Moving all our URL and URL pattern parsing code to urlmatch.c.
[privoxy.git] / loaders.h
1 #ifndef LOADERS_H_INCLUDED
2 #define LOADERS_H_INCLUDED
3 #define LOADERS_H_VERSION "$Id: loaders.h,v 1.13 2001/12/30 14:07:32 steudten 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  *                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: loaders.h,v $
40  *    Revision 1.13  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.12  2001/11/07 00:02:13  steudten
49  *    Add line number in error output for lineparsing for
50  *    actionsfile and configfile.
51  *    Special handling for CLF added.
52  *
53  *    Revision 1.11  2001/10/23 21:38:53  jongfoster
54  *    Adding error-checking to create_url_spec()
55  *
56  *    Revision 1.10  2001/09/22 16:36:59  jongfoster
57  *    Removing unused parameter fs from read_config_line()
58  *
59  *    Revision 1.9  2001/07/30 22:08:36  jongfoster
60  *    Tidying up #defines:
61  *    - All feature #defines are now of the form FEATURE_xxx
62  *    - Permanently turned off WIN_GUI_EDIT
63  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
64  *
65  *    Revision 1.8  2001/07/29 18:58:15  jongfoster
66  *    Removing nested #includes, adding forward declarations for needed
67  *    structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
68  *
69  *    Revision 1.7  2001/07/13 14:01:54  oes
70  *    Removed all #ifdef PCRS
71  *
72  *    Revision 1.6  2001/06/07 23:14:38  jongfoster
73  *    Removing ACL and forward file loaders - these files have
74  *    been merged into the config file.
75  *
76  *    Revision 1.5  2001/05/31 21:28:49  jongfoster
77  *    Removed all permissionsfile code - it's now called the actions
78  *    file, and (almost) all the code is in actions.c
79  *
80  *    Revision 1.4  2001/05/29 09:50:24  jongfoster
81  *    Unified blocklist/imagelist/permissionslist.
82  *    File format is still under discussion, but the internal changes
83  *    are (mostly) done.
84  *
85  *    Also modified interceptor behaviour:
86  *    - We now intercept all URLs beginning with one of the following
87  *      prefixes (and *only* these prefixes):
88  *        * http://i.j.b/
89  *        * http://ijbswa.sf.net/config/
90  *        * http://ijbswa.sourceforge.net/config/
91  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
92  *    - Internal changes so that intercepted and fast redirect pages
93  *      are not replaced with an image.
94  *    - Interceptors now have the option to send a binary page direct
95  *      to the client. (i.e. ijb-send-banner uses this)
96  *    - Implemented show-url-info interceptor.  (Which is why I needed
97  *      the above interceptors changes - a typical URL is
98  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
99  *      The previous mechanism would not have intercepted that, and
100  *      if it had been intercepted then it then it would have replaced
101  *      it with an image.)
102  *
103  *    Revision 1.3  2001/05/26 00:28:36  jongfoster
104  *    Automatic reloading of config file.
105  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
106  *    Most of the global variables have been moved to a new
107  *    struct configuration_spec, accessed through csp->config->globalname
108  *    Most of the globals remaining are used by the Win32 GUI.
109  *
110  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
111  *    Version 2.9.4 checkin.
112  *    - Merged popupfile and cookiefile, and added control over PCRS
113  *      filtering, in new "permissionsfile".
114  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
115  *      file error you now get a message box (in the Win32 GUI) rather
116  *      than the program exiting with no explanation.
117  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
118  *      skipping.
119  *    - Removed tabs from "config"
120  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
121  *    - Bumped up version number.
122  *
123  *    Revision 1.1.1.1  2001/05/15 13:59:00  oes
124  *    Initial import of version 2.9.3 source tree
125  *
126  *
127  *********************************************************************/
128 \f
129
130 #ifdef __cplusplus
131 extern "C" {
132 #endif
133
134 /* Structures taken from project.h */
135 struct client_state;
136 struct file_list;
137 struct configuration_spec;
138 struct url_spec;
139
140 extern void sweep(void);
141 extern char *read_config_line(char *buf, int buflen, FILE *fp, unsigned long *linenum);
142 extern int check_file_changed(const struct file_list * current,
143                               const char * filename,
144                               struct file_list ** newfl);
145
146 extern short int MustReload;
147 extern int load_actions_file(struct client_state *csp);
148 extern int load_re_filterfile(struct client_state *csp);
149
150 #ifdef FEATURE_TRUST
151 extern int load_trustfile(struct client_state *csp);
152 #endif /* def FEATURE_TRUST */
153
154
155
156 extern void add_loader(int (*loader)(struct client_state *), 
157                        struct configuration_spec * config);
158 extern int run_loader(struct client_state *csp);
159
160 /* Revision control strings from this header and associated .c file */
161 extern const char loaders_rcs[];
162 extern const char loaders_h_rcs[];
163
164 #ifdef __cplusplus
165 } /* extern "C" */
166 #endif
167
168 #endif /* ndef LOADERS_H_INCLUDED */
169
170 /*
171   Local Variables:
172   tab-width: 3
173   end:
174 */