1 #ifndef FILTERS_H_INCLUDED
2 #define FILTERS_H_INCLUDED
3 #define FILTERS_H_VERSION "$Id: filters.h,v 1.11 2001/07/13 14:00:18 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', `domaincmp', `dsplit',
12 * `filter_popups', `forward_url'
13 * `ij_untrusted_url', `intercept_url', `re_process_buffer',
14 * `show_proxy_args', and `trust_url'
16 * Copyright : Written by and Copyright (C) 2001 the SourceForge
17 * IJBSWA team. http://ijbswa.sourceforge.net
19 * Based on the Internet Junkbuster originally written
20 * by and Copyright (C) 1997 Anonymous Coders and
21 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
43 * Revision 1.11 2001/07/13 14:00:18 oes
44 * - Introduced gif_deanimate_response
45 * - Renamed re_process_buffer to pcrs_filter_response
46 * - Removed all #ifdef PCRS
48 * Revision 1.10 2001/06/29 13:29:01 oes
49 * Cleaned up and updated to reflect the changesin
52 * Revision 1.9 2001/06/07 23:10:53 jongfoster
53 * Replacing struct gateway with struct forward_spec
55 * Revision 1.8 2001/06/03 19:12:00 oes
56 * extracted-CGI relevant stuff
58 * Revision 1.7 2001/05/31 21:21:30 jongfoster
59 * Permissionsfile / actions file changes:
60 * - Changed "permission" to "action" throughout
61 * - changes to file format to allow string parameters
62 * - Moved helper functions to actions.c
64 * Revision 1.6 2001/05/29 09:50:24 jongfoster
65 * Unified blocklist/imagelist/permissionslist.
66 * File format is still under discussion, but the internal changes
69 * Also modified interceptor behaviour:
70 * - We now intercept all URLs beginning with one of the following
71 * prefixes (and *only* these prefixes):
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
87 * Revision 1.5 2001/05/27 22:17:04 oes
89 * - re_process_buffer no longer writes the modified buffer
90 * to the client, which was very ugly. It now returns the
91 * buffer, which it is then written by chat.
93 * - content_length now adjusts the Content-Length: header
94 * for modified documents rather than crunch()ing it.
95 * (Length info in csp->content_length, which is 0 for
96 * unmodified documents)
98 * - For this to work, sed() is called twice when filtering.
100 * Revision 1.4 2001/05/26 15:26:15 jongfoster
101 * ACL feature now provides more security by immediately dropping
102 * connections from untrusted hosts.
104 * Revision 1.3 2001/05/22 18:46:04 oes
106 * - Enabled filtering banners by size rather than URL
107 * by adding patterns that replace all standard banner
108 * sizes with the "Junkbuster" gif to the re_filterfile
110 * - Enabled filtering WebBugs by providing a pattern
111 * which kills all 1x1 images
113 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
114 * which is selected by the (nonstandard and therefore
115 * capital) letter 'U' in the option string.
116 * It causes the quantifiers to be ungreedy by default.
117 * Appending a ? turns back to greedy (!).
119 * - Added a new interceptor ijb-send-banner, which
120 * sends back the "Junkbuster" gif. Without imagelist or
121 * MSIE detection support, or if tinygif = 1, or the
122 * URL isn't recognized as an imageurl, a lame HTML
123 * explanation is sent instead.
125 * - Added new feature, which permits blocking remote
126 * script redirects and firing back a local redirect
128 * The feature is conditionally compiled, i.e. it
129 * can be disabled with --disable-fast-redirects,
130 * plus it must be activated by a "fast-redirects"
131 * line in the config file, has its own log level
132 * and of course wants to be displayed by show-proxy-args
133 * Note: Boy, all the #ifdefs in 1001 locations and
134 * all the fumbling with configure.in and acconfig.h
135 * were *way* more work than the feature itself :-(
137 * - Because a generic redirect template was needed for
138 * this, tinygif = 3 now uses the same.
140 * - Moved GIFs, and other static HTTP response templates
145 * - Removed some >400 CRs again (Jon, you really worked
148 * Revision 1.2 2001/05/20 01:21:20 jongfoster
149 * Version 2.9.4 checkin.
150 * - Merged popupfile and cookiefile, and added control over PCRS
151 * filtering, in new "permissionsfile".
152 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
153 * file error you now get a message box (in the Win32 GUI) rather
154 * than the program exiting with no explanation.
155 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
157 * - Removed tabs from "config"
158 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
159 * - Bumped up version number.
161 * Revision 1.1.1.1 2001/05/15 13:58:52 oes
162 * Initial import of version 2.9.3 source tree
165 *********************************************************************/
175 struct access_control_addr;
178 struct http_response;
179 struct current_action_spec;
188 extern int block_acl(struct access_control_addr *dst, struct client_state *csp);
189 extern int acl_addr(char *aspec, struct access_control_addr *aca);
190 #endif /* def ACL_FILES */
195 extern struct http_response *block_url(struct client_state *csp);
196 extern struct http_response *redirect_url(struct client_state *csp);
198 extern struct http_response *trust_url(struct client_state *csp);
199 #endif /* def TRUST_FILES */
205 extern int is_untrusted_url(struct client_state *csp);
206 #endif /* def TRUST_FILES */
207 #ifdef IMAGE_BLOCKING
208 extern int is_imageurl(struct client_state *csp);
209 #endif /* def IMAGE_BLOCKING */
212 * Determining applicable actions
214 extern void url_actions(struct http_request *http,
215 struct client_state *csp);
216 extern void apply_url_actions(struct current_action_spec *action,
217 struct http_request *http,
218 struct url_actions *b);
220 * Determining parent proxies
222 extern const struct forward_spec *forward_url(struct http_request *http, struct client_state *csp);
224 extern struct url_spec dsplit(char *domain);
225 extern int domaincmp(struct url_spec *pattern, struct url_spec *fqdn);
228 * Content modification
230 extern char *pcrs_filter_response(struct client_state *csp);
231 extern char *gif_deanimate_response(struct client_state *csp);
234 * Revision control strings from this header and associated .c file
236 extern const char filters_rcs[];
237 extern const char filters_h_rcs[];
243 #endif /* ndef FILTERS_H_INCLUDED */