Fixed minor memory leak.
[privoxy.git] / filters.h
1 #ifndef _FILTERS_H
2 #define _FILTERS_H
3 #define FILTERS_H_VERSION "$Id: filters.h,v 1.8 2001/06/03 11:03:48 oes Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/filters.h,v $
7  *
8  * Purpose     :  Declares functions to parse/crunch headers and pages.
9  *                Functions declared include:
10  *                   `acl_addr', `add_stats', `block_acl', `block_imageurl',
11  *                   `block_url', `url_actions', `domaincmp', `dsplit',
12  *                   `filter_popups', `forward_url'
13  *                   `ij_untrusted_url', `intercept_url', `re_process_buffer',
14  *                   `show_proxy_args', and `trust_url'
15  *
16  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
17  *                IJBSWA team.  http://ijbswa.sourceforge.net
18  *
19  *                Based on the Internet Junkbuster originally written
20  *                by and Copyright (C) 1997 Anonymous Coders and 
21  *                Junkbusters Corporation.  http://www.junkbusters.com
22  *
23  *                This program is free software; you can redistribute it 
24  *                and/or modify it under the terms of the GNU General
25  *                Public License as published by the Free Software
26  *                Foundation; either version 2 of the License, or (at
27  *                your option) any later version.
28  *
29  *                This program is distributed in the hope that it will
30  *                be useful, but WITHOUT ANY WARRANTY; without even the
31  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
32  *                PARTICULAR PURPOSE.  See the GNU General Public
33  *                License for more details.
34  *
35  *                The GNU General Public License should be included with
36  *                this file.  If not, you can view it at
37  *                http://www.gnu.org/copyleft/gpl.html
38  *                or write to the Free Software Foundation, Inc., 59
39  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
40  *
41  * Revisions   :
42  *    $Log: filters.h,v $
43  *    Revision 1.8  2001/06/03 11:03:48  oes
44  *    Makefile/in
45  *
46  *    introduced cgi.c
47  *
48  *    actions.c:
49  *
50  *    adapted to new enlist_unique arg format
51  *
52  *    conf loadcfg.c
53  *
54  *    introduced confdir option
55  *
56  *    filters.c filtrers.h
57  *
58  *     extracted-CGI relevant stuff
59  *
60  *    jbsockets.c
61  *
62  *     filled comment
63  *
64  *    jcc.c
65  *
66  *     support for new cgi mechansim
67  *
68  *    list.c list.h
69  *
70  *    functions for new list type: "map"
71  *    extended enlist_unique
72  *
73  *    miscutil.c .h
74  *    introduced bindup()
75  *
76  *    parsers.c parsers.h
77  *
78  *    deleted const struct interceptors
79  *
80  *    pcrs.c
81  *    added FIXME
82  *
83  *    project.h
84  *
85  *    added struct map
86  *    added struct http_response
87  *    changes struct interceptors to struct cgi_dispatcher
88  *    moved HTML stuff to cgi.h
89  *
90  *    re_filterfile:
91  *
92  *    changed
93  *
94  *    showargs.c
95  *    NO TIME LEFT
96  *
97  *    Revision 1.7  2001/05/31 21:21:30  jongfoster
98  *    Permissionsfile / actions file changes:
99  *    - Changed "permission" to "action" throughout
100  *    - changes to file format to allow string parameters
101  *    - Moved helper functions to actions.c
102  *
103  *    Revision 1.6  2001/05/29 09:50:24  jongfoster
104  *    Unified blocklist/imagelist/permissionslist.
105  *    File format is still under discussion, but the internal changes
106  *    are (mostly) done.
107  *
108  *    Also modified interceptor behaviour:
109  *    - We now intercept all URLs beginning with one of the following
110  *      prefixes (and *only* these prefixes):
111  *        * http://i.j.b/
112  *        * http://ijbswa.sf.net/config/
113  *        * http://ijbswa.sourceforge.net/config/
114  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
115  *    - Internal changes so that intercepted and fast redirect pages
116  *      are not replaced with an image.
117  *    - Interceptors now have the option to send a binary page direct
118  *      to the client. (i.e. ijb-send-banner uses this)
119  *    - Implemented show-url-info interceptor.  (Which is why I needed
120  *      the above interceptors changes - a typical URL is
121  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
122  *      The previous mechanism would not have intercepted that, and
123  *      if it had been intercepted then it then it would have replaced
124  *      it with an image.)
125  *
126  *    Revision 1.5  2001/05/27 22:17:04  oes
127  *
128  *    - re_process_buffer no longer writes the modified buffer
129  *      to the client, which was very ugly. It now returns the
130  *      buffer, which it is then written by chat.
131  *
132  *    - content_length now adjusts the Content-Length: header
133  *      for modified documents rather than crunch()ing it.
134  *      (Length info in csp->content_length, which is 0 for
135  *      unmodified documents)
136  *
137  *    - For this to work, sed() is called twice when filtering.
138  *
139  *    Revision 1.4  2001/05/26 15:26:15  jongfoster
140  *    ACL feature now provides more security by immediately dropping
141  *    connections from untrusted hosts.
142  *
143  *    Revision 1.3  2001/05/22 18:46:04  oes
144  *
145  *    - Enabled filtering banners by size rather than URL
146  *      by adding patterns that replace all standard banner
147  *      sizes with the "Junkbuster" gif to the re_filterfile
148  *
149  *    - Enabled filtering WebBugs by providing a pattern
150  *      which kills all 1x1 images
151  *
152  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
153  *      which is selected by the (nonstandard and therefore
154  *      capital) letter 'U' in the option string.
155  *      It causes the quantifiers to be ungreedy by default.
156  *      Appending a ? turns back to greedy (!).
157  *
158  *    - Added a new interceptor ijb-send-banner, which
159  *      sends back the "Junkbuster" gif. Without imagelist or
160  *      MSIE detection support, or if tinygif = 1, or the
161  *      URL isn't recognized as an imageurl, a lame HTML
162  *      explanation is sent instead.
163  *
164  *    - Added new feature, which permits blocking remote
165  *      script redirects and firing back a local redirect
166  *      to the browser.
167  *      The feature is conditionally compiled, i.e. it
168  *      can be disabled with --disable-fast-redirects,
169  *      plus it must be activated by a "fast-redirects"
170  *      line in the config file, has its own log level
171  *      and of course wants to be displayed by show-proxy-args
172  *      Note: Boy, all the #ifdefs in 1001 locations and
173  *      all the fumbling with configure.in and acconfig.h
174  *      were *way* more work than the feature itself :-(
175  *
176  *    - Because a generic redirect template was needed for
177  *      this, tinygif = 3 now uses the same.
178  *
179  *    - Moved GIFs, and other static HTTP response templates
180  *      to project.h
181  *
182  *    - Some minor fixes
183  *
184  *    - Removed some >400 CRs again (Jon, you really worked
185  *      a lot! ;-)
186  *
187  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
188  *    Version 2.9.4 checkin.
189  *    - Merged popupfile and cookiefile, and added control over PCRS
190  *      filtering, in new "permissionsfile".
191  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
192  *      file error you now get a message box (in the Win32 GUI) rather
193  *      than the program exiting with no explanation.
194  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
195  *      skipping.
196  *    - Removed tabs from "config"
197  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
198  *    - Bumped up version number.
199  *
200  *    Revision 1.1.1.1  2001/05/15 13:58:52  oes
201  *    Initial import of version 2.9.3 source tree
202  *
203  *
204  *********************************************************************/
205 \f
206
207 #include "project.h"
208
209 #ifdef __cplusplus
210 extern "C" {
211 #endif
212
213 #ifdef ACL_FILES
214 extern int block_acl(struct access_control_addr *dst, struct client_state *csp);
215 extern int acl_addr(char *aspec, struct access_control_addr *aca);
216 #endif /* def ACL_FILES */
217
218 extern char *block_url(struct http_request *http, struct client_state *csp);
219 #ifdef TRUST_FILES
220 extern char *trust_url(struct http_request *http, struct client_state *csp);
221 #endif /* def TRUST_FILES */
222 #ifdef IMAGE_BLOCKING
223 extern int block_imageurl(struct http_request *http, struct client_state *csp);
224 #endif /* def IMAGE_BLOCKING */
225
226 extern void url_actions(struct http_request *http, 
227                         struct client_state *csp);
228 extern void apply_url_actions(struct current_action_spec *action, 
229                               struct http_request *http, 
230                               struct url_actions *b);
231
232 extern const struct gateway *forward_url(struct http_request *http, struct client_state *csp);
233
234 extern struct url_spec dsplit(char *domain);
235 extern int domaincmp(struct url_spec *pattern, struct url_spec *fqdn);
236
237 #ifdef PCRS
238 extern char *re_process_buffer(struct client_state *csp);
239 #endif /* def PCRS */
240
241 /* Revision control strings from this header and associated .c file */
242 extern const char filters_rcs[];
243 extern const char filters_h_rcs[];
244
245 #ifdef __cplusplus
246 } /* extern "C" */
247 #endif
248
249 #endif /* ndef _FILTERS_H */
250
251 /*
252   Local Variables:
253   tab-width: 3
254   end:
255 */