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