1 #ifndef FILTERS_H_INCLUDED
2 #define FILTERS_H_INCLUDED
3 #define FILTERS_H_VERSION "$Id: filters.h,v 1.18 2002/03/25 22:12:45 oes Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/filters.h,v $
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', `filter_popups', `forward_url'
12 * `ij_untrusted_url', `intercept_url', `re_process_buffer',
13 * `show_proxy_args', and `trust_url'
15 * Copyright : Written by and Copyright (C) 2001 the SourceForge
16 * Privoxy team. http://www.privoxy.org/
18 * Based on the Internet Junkbuster originally written
19 * by and Copyright (C) 1997 Anonymous Coders and
20 * Junkbusters Corporation. http://www.junkbusters.com
22 * This program is free software; you can redistribute it
23 * and/or modify it under the terms of the GNU General
24 * Public License as published by the Free Software
25 * Foundation; either version 2 of the License, or (at
26 * your option) any later version.
28 * This program is distributed in the hope that it will
29 * be useful, but WITHOUT ANY WARRANTY; without even the
30 * implied warranty of MERCHANTABILITY or FITNESS FOR A
31 * PARTICULAR PURPOSE. See the GNU General Public
32 * License for more details.
34 * The GNU General Public License should be included with
35 * this file. If not, you can view it at
36 * http://www.gnu.org/copyleft/gpl.html
37 * or write to the Free Software Foundation, Inc., 59
38 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
42 * Revision 1.18 2002/03/25 22:12:45 oes
43 * Added fix for undefined INADDR_NONE on Solaris by Bart Schelstraete
45 * Revision 1.17 2002/03/24 13:25:43 swa
46 * name change related issues
48 * Revision 1.16 2002/01/17 21:01:02 jongfoster
49 * Moving all our URL and URL pattern parsing code to urlmatch.c.
51 * Revision 1.15 2001/10/10 16:44:16 oes
52 * Added match_portlist function
54 * Revision 1.14 2001/10/07 15:41:40 oes
55 * Added prototype for remove_chunked_transfer_coding
57 * Revision 1.13 2001/07/30 22:08:36 jongfoster
58 * Tidying up #defines:
59 * - All feature #defines are now of the form FEATURE_xxx
60 * - Permanently turned off WIN_GUI_EDIT
61 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
63 * Revision 1.12 2001/07/29 19:01:11 jongfoster
64 * Changed _FILENAME_H to FILENAME_H_INCLUDED.
65 * Added forward declarations for needed structures.
67 * Revision 1.11 2001/07/13 14:00:18 oes
68 * - Introduced gif_deanimate_response
69 * - Renamed re_process_buffer to pcrs_filter_response
70 * - Removed all #ifdef PCRS
72 * Revision 1.10 2001/06/29 13:29:01 oes
73 * Cleaned up and updated to reflect the changesin
76 * Revision 1.9 2001/06/07 23:10:53 jongfoster
77 * Replacing struct gateway with struct forward_spec
79 * Revision 1.8 2001/06/03 19:12:00 oes
80 * extracted-CGI relevant stuff
82 * Revision 1.7 2001/05/31 21:21:30 jongfoster
83 * Permissionsfile / actions file changes:
84 * - Changed "permission" to "action" throughout
85 * - changes to file format to allow string parameters
86 * - Moved helper functions to actions.c
88 * Revision 1.6 2001/05/29 09:50:24 jongfoster
89 * Unified blocklist/imagelist/permissionslist.
90 * File format is still under discussion, but the internal changes
93 * Also modified interceptor behaviour:
94 * - We now intercept all URLs beginning with one of the following
95 * prefixes (and *only* these prefixes):
97 * * http://ijbswa.sf.net/config/
98 * * http://ijbswa.sourceforge.net/config/
99 * - New interceptors "home page" - go to http://i.j.b/ to see it.
100 * - Internal changes so that intercepted and fast redirect pages
101 * are not replaced with an image.
102 * - Interceptors now have the option to send a binary page direct
103 * to the client. (i.e. ijb-send-banner uses this)
104 * - Implemented show-url-info interceptor. (Which is why I needed
105 * the above interceptors changes - a typical URL is
106 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
107 * The previous mechanism would not have intercepted that, and
108 * if it had been intercepted then it then it would have replaced
111 * Revision 1.5 2001/05/27 22:17:04 oes
113 * - re_process_buffer no longer writes the modified buffer
114 * to the client, which was very ugly. It now returns the
115 * buffer, which it is then written by chat.
117 * - content_length now adjusts the Content-Length: header
118 * for modified documents rather than crunch()ing it.
119 * (Length info in csp->content_length, which is 0 for
120 * unmodified documents)
122 * - For this to work, sed() is called twice when filtering.
124 * Revision 1.4 2001/05/26 15:26:15 jongfoster
125 * ACL feature now provides more security by immediately dropping
126 * connections from untrusted hosts.
128 * Revision 1.3 2001/05/22 18:46:04 oes
130 * - Enabled filtering banners by size rather than URL
131 * by adding patterns that replace all standard banner
132 * sizes with the "Junkbuster" gif to the re_filterfile
134 * - Enabled filtering WebBugs by providing a pattern
135 * which kills all 1x1 images
137 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
138 * which is selected by the (nonstandard and therefore
139 * capital) letter 'U' in the option string.
140 * It causes the quantifiers to be ungreedy by default.
141 * Appending a ? turns back to greedy (!).
143 * - Added a new interceptor ijb-send-banner, which
144 * sends back the "Junkbuster" gif. Without imagelist or
145 * MSIE detection support, or if tinygif = 1, or the
146 * URL isn't recognized as an imageurl, a lame HTML
147 * explanation is sent instead.
149 * - Added new feature, which permits blocking remote
150 * script redirects and firing back a local redirect
152 * The feature is conditionally compiled, i.e. it
153 * can be disabled with --disable-fast-redirects,
154 * plus it must be activated by a "fast-redirects"
155 * line in the config file, has its own log level
156 * and of course wants to be displayed by show-proxy-args
157 * Note: Boy, all the #ifdefs in 1001 locations and
158 * all the fumbling with configure.in and acconfig.h
159 * were *way* more work than the feature itself :-(
161 * - Because a generic redirect template was needed for
162 * this, tinygif = 3 now uses the same.
164 * - Moved GIFs, and other static HTTP response templates
169 * - Removed some >400 CRs again (Jon, you really worked
172 * Revision 1.2 2001/05/20 01:21:20 jongfoster
173 * Version 2.9.4 checkin.
174 * - Merged popupfile and cookiefile, and added control over PCRS
175 * filtering, in new "permissionsfile".
176 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
177 * file error you now get a message box (in the Win32 GUI) rather
178 * than the program exiting with no explanation.
179 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
181 * - Removed tabs from "config"
182 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
183 * - Bumped up version number.
185 * Revision 1.1.1.1 2001/05/15 13:58:52 oes
186 * Initial import of version 2.9.3 source tree
189 *********************************************************************/
199 struct access_control_addr;
202 struct http_response;
203 struct current_action_spec;
212 extern int block_acl(struct access_control_addr *dst, struct client_state *csp);
213 extern int acl_addr(char *aspec, struct access_control_addr *aca);
214 #endif /* def FEATURE_ACL */
215 extern int match_portlist(const char *portlist, int port);
220 extern struct http_response *block_url(struct client_state *csp);
221 extern struct http_response *redirect_url(struct client_state *csp);
222 #ifdef FEATURE_COOKIE_JAR
223 extern struct http_response *trust_url(struct client_state *csp);
224 #endif /* def FEATURE_COOKIE_JAR */
229 #ifdef FEATURE_COOKIE_JAR
230 extern int is_untrusted_url(struct client_state *csp);
231 #endif /* def FEATURE_COOKIE_JAR */
232 #ifdef FEATURE_IMAGE_BLOCKING
233 extern int is_imageurl(struct client_state *csp);
234 #endif /* def FEATURE_IMAGE_BLOCKING */
237 * Determining applicable actions
239 extern void url_actions(struct http_request *http,
240 struct client_state *csp);
241 extern void apply_url_actions(struct current_action_spec *action,
242 struct http_request *http,
243 struct url_actions *b);
245 * Determining parent proxies
247 extern const struct forward_spec *forward_url(struct http_request *http, struct client_state *csp);
250 * Content modification
252 extern char *pcrs_filter_response(struct client_state *csp);
253 extern char *gif_deanimate_response(struct client_state *csp);
254 extern int remove_chunked_transfer_coding(char *buffer, const size_t size);
260 #define INADDR_NONE -1
264 * Revision control strings from this header and associated .c file
266 extern const char filters_rcs[];
267 extern const char filters_h_rcs[];
273 #endif /* ndef FILTERS_H_INCLUDED */