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