Better memory management - current_action->strings[] now
[privoxy.git] / filters.h
1 #ifndef _FILTERS_H
2 #define _FILTERS_H
3 #define FILTERS_H_VERSION "$Id: filters.h,v 1.6 2001/05/29 09:50:24 jongfoster 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.6  2001/05/29 09:50:24  jongfoster
44  *    Unified blocklist/imagelist/permissionslist.
45  *    File format is still under discussion, but the internal changes
46  *    are (mostly) done.
47  *
48  *    Also modified interceptor behaviour:
49  *    - We now intercept all URLs beginning with one of the following
50  *      prefixes (and *only* these prefixes):
51  *        * http://i.j.b/
52  *        * http://ijbswa.sf.net/config/
53  *        * http://ijbswa.sourceforge.net/config/
54  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
55  *    - Internal changes so that intercepted and fast redirect pages
56  *      are not replaced with an image.
57  *    - Interceptors now have the option to send a binary page direct
58  *      to the client. (i.e. ijb-send-banner uses this)
59  *    - Implemented show-url-info interceptor.  (Which is why I needed
60  *      the above interceptors changes - a typical URL is
61  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
62  *      The previous mechanism would not have intercepted that, and
63  *      if it had been intercepted then it then it would have replaced
64  *      it with an image.)
65  *
66  *    Revision 1.5  2001/05/27 22:17:04  oes
67  *
68  *    - re_process_buffer no longer writes the modified buffer
69  *      to the client, which was very ugly. It now returns the
70  *      buffer, which it is then written by chat.
71  *
72  *    - content_length now adjusts the Content-Length: header
73  *      for modified documents rather than crunch()ing it.
74  *      (Length info in csp->content_length, which is 0 for
75  *      unmodified documents)
76  *
77  *    - For this to work, sed() is called twice when filtering.
78  *
79  *    Revision 1.4  2001/05/26 15:26:15  jongfoster
80  *    ACL feature now provides more security by immediately dropping
81  *    connections from untrusted hosts.
82  *
83  *    Revision 1.3  2001/05/22 18:46:04  oes
84  *
85  *    - Enabled filtering banners by size rather than URL
86  *      by adding patterns that replace all standard banner
87  *      sizes with the "Junkbuster" gif to the re_filterfile
88  *
89  *    - Enabled filtering WebBugs by providing a pattern
90  *      which kills all 1x1 images
91  *
92  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
93  *      which is selected by the (nonstandard and therefore
94  *      capital) letter 'U' in the option string.
95  *      It causes the quantifiers to be ungreedy by default.
96  *      Appending a ? turns back to greedy (!).
97  *
98  *    - Added a new interceptor ijb-send-banner, which
99  *      sends back the "Junkbuster" gif. Without imagelist or
100  *      MSIE detection support, or if tinygif = 1, or the
101  *      URL isn't recognized as an imageurl, a lame HTML
102  *      explanation is sent instead.
103  *
104  *    - Added new feature, which permits blocking remote
105  *      script redirects and firing back a local redirect
106  *      to the browser.
107  *      The feature is conditionally compiled, i.e. it
108  *      can be disabled with --disable-fast-redirects,
109  *      plus it must be activated by a "fast-redirects"
110  *      line in the config file, has its own log level
111  *      and of course wants to be displayed by show-proxy-args
112  *      Note: Boy, all the #ifdefs in 1001 locations and
113  *      all the fumbling with configure.in and acconfig.h
114  *      were *way* more work than the feature itself :-(
115  *
116  *    - Because a generic redirect template was needed for
117  *      this, tinygif = 3 now uses the same.
118  *
119  *    - Moved GIFs, and other static HTTP response templates
120  *      to project.h
121  *
122  *    - Some minor fixes
123  *
124  *    - Removed some >400 CRs again (Jon, you really worked
125  *      a lot! ;-)
126  *
127  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
128  *    Version 2.9.4 checkin.
129  *    - Merged popupfile and cookiefile, and added control over PCRS
130  *      filtering, in new "permissionsfile".
131  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
132  *      file error you now get a message box (in the Win32 GUI) rather
133  *      than the program exiting with no explanation.
134  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
135  *      skipping.
136  *    - Removed tabs from "config"
137  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
138  *    - Bumped up version number.
139  *
140  *    Revision 1.1.1.1  2001/05/15 13:58:52  oes
141  *    Initial import of version 2.9.3 source tree
142  *
143  *
144  *********************************************************************/
145 \f
146
147 #include "project.h"
148
149 #ifdef __cplusplus
150 extern "C" {
151 #endif
152
153 #ifdef ACL_FILES
154 extern int block_acl(struct access_control_addr *dst, struct client_state *csp);
155 extern int acl_addr(char *aspec, struct access_control_addr *aca);
156 #endif /* def ACL_FILES */
157
158 extern char *block_url(struct http_request *http, struct client_state *csp);
159 #ifdef TRUST_FILES
160 extern char *trust_url(struct http_request *http, struct client_state *csp);
161 #endif /* def TRUST_FILES */
162 extern int intercept_url(struct http_request *http, struct client_state *csp);
163 extern char *redirect_url(struct http_request *http, struct client_state *csp);
164
165 #ifdef IMAGE_BLOCKING
166 extern int block_imageurl(struct http_request *http, struct client_state *csp);
167 #endif /* def IMAGE_BLOCKING */
168
169 extern void url_actions(struct http_request *http, 
170                         struct client_state *csp);
171 extern void apply_url_actions(struct current_action_spec *action, 
172                               struct http_request *http, 
173                               struct url_actions *b);
174
175 extern const struct gateway *forward_url(struct http_request *http, struct client_state *csp);
176
177 extern struct url_spec dsplit(char *domain);
178 extern int domaincmp(struct url_spec *pattern, struct url_spec *fqdn);
179
180 extern char *show_proxy_args(struct http_request *http, struct client_state *csp);
181 extern char *ijb_send_banner(struct http_request *http, struct client_state *csp);
182
183 #ifdef TRUST_FILES
184 extern char *ij_untrusted_url(struct http_request *http, struct client_state *csp);
185 #endif /* def TRUST_FILES */
186
187 char *ijb_show_url_info(struct http_request *http, struct client_state *csp);
188
189 #ifdef STATISTICS
190 extern char *add_stats(char *s);
191 #endif /* def STATISTICS */
192
193 #ifdef PCRS
194 extern char *re_process_buffer(struct client_state *csp);
195 #endif /* def PCRS */
196
197 /* Revision control strings from this header and associated .c file */
198 extern const char filters_rcs[];
199 extern const char filters_h_rcs[];
200
201 #ifdef __cplusplus
202 } /* extern "C" */
203 #endif
204
205 #endif /* ndef _FILTERS_H */
206
207 /*
208   Local Variables:
209   tab-width: 3
210   end:
211 */