Don't pass the whole csp structure to flush_socket()
[privoxy.git] / parsers.h
1 #ifndef PARSERS_H_INCLUDED
2 #define PARSERS_H_INCLUDED
3 #define PARSERS_H_VERSION "$Id: parsers.h,v 1.40 2007/08/11 14:47:26 fabiankeil Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/parsers.h,v $
7  *
8  * Purpose     :  Declares functions to parse/crunch headers and pages.
9  *                Functions declared include:
10  *                   `add_to_iob', `client_cookie_adder', `client_from',
11  *                   `client_referrer', `client_send_cookie', `client_ua',
12  *                   `client_uagent', `client_x_forwarded',
13  *                   `client_x_forwarded_adder', `client_xtra_adder',
14  *                   `content_type', `crumble', `destroy_list', `enlist',
15  *                   `flush_socket', `free_http_request', `get_header',
16  *                   `list_to_text', `parse_http_request', `sed',
17  *                   and `server_set_cookie'.
18  *
19  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
20  *                Privoxy team. http://www.privoxy.org/
21  *
22  *                Based on the Internet Junkbuster originally written
23  *                by and Copyright (C) 1997 Anonymous Coders and 
24  *                Junkbusters Corporation.  http://www.junkbusters.com
25  *
26  *                This program is free software; you can redistribute it 
27  *                and/or modify it under the terms of the GNU General
28  *                Public License as published by the Free Software
29  *                Foundation; either version 2 of the License, or (at
30  *                your option) any later version.
31  *
32  *                This program is distributed in the hope that it will
33  *                be useful, but WITHOUT ANY WARRANTY; without even the
34  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
35  *                PARTICULAR PURPOSE.  See the GNU General Public
36  *                License for more details.
37  *
38  *                The GNU General Public License should be included with
39  *                this file.  If not, you can view it at
40  *                http://www.gnu.org/copyleft/gpl.html
41  *                or write to the Free Software Foundation, Inc., 59
42  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
43  *
44  * Revisions   :
45  *    $Log: parsers.h,v $
46  *    Revision 1.40  2007/08/11 14:47:26  fabiankeil
47  *    Remove the prototypes for functions that are only
48  *    used in parsers.c and thus should be static.
49  *
50  *    Revision 1.39  2007/06/01 16:31:55  fabiankeil
51  *    Change sed() to return a jb_err in preparation for forward-override{}.
52  *
53  *    Revision 1.38  2007/03/25 14:27:11  fabiankeil
54  *    Let parse_header_time() return a jb_err code
55  *    instead of a pointer that can only be used to
56  *    check for NULL anyway.
57  *
58  *    Revision 1.37  2007/03/20 15:22:17  fabiankeil
59  *    - Remove filter_client_header() and filter_client_header(),
60  *      filter_header() now checks the shiny new
61  *      CSP_FLAG_CLIENT_HEADER_PARSING_DONE flag instead.
62  *
63  *    Revision 1.36  2007/03/05 13:25:32  fabiankeil
64  *    - Cosmetical changes for LOG_LEVEL_RE_FILTER messages.
65  *    - Handle "Cookie:" and "Connection:" headers a bit smarter
66  *      (don't crunch them just to recreate them later on).
67  *    - Add another non-standard time format for the cookie
68  *      expiration date detection.
69  *    - Fix a valgrind warning.
70  *
71  *    Revision 1.35  2007/01/01 19:36:37  fabiankeil
72  *    Integrate a modified version of Wil Mahan's
73  *    zlib patch (PR #895531).
74  *
75  *    Revision 1.34  2006/12/29 19:08:22  fabiankeil
76  *    Reverted parts of my last commit
77  *    to keep error handling working.
78  *
79  *    Revision 1.33  2006/12/29 18:04:40  fabiankeil
80  *    Fixed gcc43 conversion warnings.
81  *
82  *    Revision 1.32  2006/12/06 19:14:23  fabiankeil
83  *    Added prototype for get_destination_from_headers().
84  *
85  *    Revision 1.31  2006/08/17 17:15:10  fabiankeil
86  *    - Back to timegm() using GnuPG's replacement if necessary.
87  *      Using mktime() and localtime() could add a on hour offset if
88  *      the randomize factor was big enough to lead to a summer/wintertime
89  *      switch.
90  *
91  *    - Removed now-useless Privoxy 3.0.3 compatibility glue.
92  *
93  *    - Moved randomization code into pick_from_range().
94  *
95  *    - Changed parse_header_time definition.
96  *      time_t isn't guaranteed to be signed and
97  *      if it isn't, -1 isn't available as error code.
98  *      Changed some variable types in client_if_modified_since()
99  *      because of the same reason.
100  *
101  *    Revision 1.30  2006/08/14 08:25:19  fabiankeil
102  *    Split filter-headers{} into filter-client-headers{}
103  *    and filter-server-headers{}.
104  *    Added parse_header_time() to share some code.
105  *    Replaced timegm() with mktime().
106  *
107  *    Revision 1.29  2006/08/03 02:46:41  david__schmidt
108  *    Incorporate Fabian Keil's patch work:\rhttp://www.fabiankeil.de/sourcecode/privoxy/
109  *
110  *    Revision 1.28  2006/07/18 14:48:47  david__schmidt
111  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
112  *    with what was really the latest development (the v_3_0_branch branch)
113  *
114  *    Revision 1.26.2.1  2002/09/25 14:52:46  oes
115  *    Added basic support for OPTIONS and TRACE HTTP methods:
116  *     - New parser function client_max_forwards which decrements
117  *       the Max-Forwards HTTP header field of OPTIONS and TRACE
118  *       requests by one before forwarding
119  *     - New parser function client_host which extracts the host
120  *       and port information from the HTTP header field if the
121  *       request URI was not absolute
122  *     - Don't crumble and re-add the Host: header, but only generate
123  *       and append if missing
124  *
125  *    Revision 1.26  2002/05/08 15:59:53  oes
126  *    Changed add_to_iob signature (now returns jb_err)
127  *
128  *    Revision 1.25  2002/03/26 22:29:55  swa
129  *    we have a new homepage!
130  *
131  *    Revision 1.24  2002/03/24 13:25:43  swa
132  *    name change related issues
133  *
134  *    Revision 1.23  2002/03/13 00:27:05  jongfoster
135  *    Killing warnings
136  *
137  *    Revision 1.22  2002/03/09 20:03:52  jongfoster
138  *    - Making various functions return int rather than size_t.
139  *      (Undoing a recent change).  Since size_t is unsigned on
140  *      Windows, functions like read_socket that return -1 on
141  *      error cannot return a size_t.
142  *
143  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
144  *      crashes, and also frequently caused JB to jump to 100%
145  *      CPU and stay there.  (Because it thought it had just
146  *      read ((unsigned)-1) == 4Gb of data...)
147  *
148  *    - The signature of write_socket has changed, it now simply
149  *      returns success=0/failure=nonzero.
150  *
151  *    - Trying to get rid of a few warnings --with-debug on
152  *      Windows, I've introduced a new type "jb_socket".  This is
153  *      used for the socket file descriptors.  On Windows, this
154  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
155  *      an int.  The error value can't be -1 any more, so it's
156  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
157  *      Windows it maps to the #define INVALID_SOCKET.)
158  *
159  *    - The signature of bind_port has changed.
160  *
161  *    Revision 1.21  2002/03/07 03:46:17  oes
162  *    Fixed compiler warnings
163  *
164  *    Revision 1.20  2002/02/20 23:15:13  jongfoster
165  *    Parsing functions now handle out-of-memory gracefully by returning
166  *    an error code.
167  *
168  *    Revision 1.19  2002/01/17 21:03:47  jongfoster
169  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
170  *
171  *    Revision 1.18  2001/10/26 17:40:23  oes
172  *    Introduced get_header_value()
173  *    Removed client_accept()
174  *
175  *    Revision 1.17  2001/10/13 12:47:32  joergs
176  *    Removed client_host, added client_host_adder
177  *
178  *    Revision 1.16  2001/10/07 18:50:16  oes
179  *    Added server_content_encoding, renamed server_transfer_encoding
180  *
181  *    Revision 1.15  2001/10/07 18:01:55  oes
182  *    Changed server_http11 to server_http
183  *
184  *    Revision 1.14  2001/10/07 15:45:48  oes
185  *    added client_accept_encoding, client_te, client_accept_encoding_adder
186  *
187  *    renamed content_type and content_length
188  *
189  *    fixed client_host and strclean prototypes
190  *
191  *    Revision 1.13  2001/09/29 12:56:03  joergs
192  *    IJB now changes HTTP/1.1 to HTTP/1.0 in requests and answers.
193  *
194  *    Revision 1.12  2001/09/13 23:05:50  jongfoster
195  *    Changing the string paramater to the header parsers a "const".
196  *
197  *    Revision 1.11  2001/07/31 14:46:53  oes
198  *    Added prototype for connection_close_adder
199  *
200  *    Revision 1.10  2001/07/30 22:08:36  jongfoster
201  *    Tidying up #defines:
202  *    - All feature #defines are now of the form FEATURE_xxx
203  *    - Permanently turned off WIN_GUI_EDIT
204  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
205  *
206  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
207  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
208  *    ANSI C rules.
209  *
210  *    Revision 1.8  2001/07/13 14:01:54  oes
211  *    Removed all #ifdef PCRS
212  *
213  *    Revision 1.7  2001/06/29 13:32:14  oes
214  *    Removed logentry from cancelled commit
215  *
216  *    Revision 1.6  2001/06/03 19:12:38  oes
217  *    deleted const struct interceptors
218  *
219  *    Revision 1.5  2001/05/31 21:30:33  jongfoster
220  *    Removed list code - it's now in list.[ch]
221  *    Renamed "permission" to "action", and changed many features
222  *    to use the actions file rather than the global config.
223  *
224  *    Revision 1.4  2001/05/27 13:19:06  oes
225  *    Patched Joergs solution for the content-length in.
226  *
227  *    Revision 1.3  2001/05/26 13:39:32  jongfoster
228  *    Only crunches Content-Length header if applying RE filtering.
229  *    Without this fix, Microsoft Windows Update wouldn't work.
230  *
231  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
232  *    Version 2.9.4 checkin.
233  *    - Merged popupfile and cookiefile, and added control over PCRS
234  *      filtering, in new "permissionsfile".
235  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
236  *      file error you now get a message box (in the Win32 GUI) rather
237  *      than the program exiting with no explanation.
238  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
239  *      skipping.
240  *    - Removed tabs from "config"
241  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
242  *    - Bumped up version number.
243  *
244  *    Revision 1.1.1.1  2001/05/15 13:59:01  oes
245  *    Initial import of version 2.9.3 source tree
246  *
247  *
248  *********************************************************************/
249 \f
250
251 #include "project.h"
252
253 #ifdef __cplusplus
254 extern "C" {
255 #endif
256
257 extern const struct parsers client_patterns[];
258 extern const struct parsers server_patterns[];
259 extern const struct parsers server_patterns_light[];
260
261 extern const add_header_func_ptr add_client_headers[];
262 extern const add_header_func_ptr add_server_headers[];
263
264 extern int flush_socket(jb_socket fd, struct iob *iob);
265 extern jb_err add_to_iob(struct client_state *csp, char *buf, int n);
266 extern jb_err decompress_iob(struct client_state *csp);
267 extern char *get_header(struct client_state *csp);
268 extern char *get_header_value(const struct list *header_list, const char *header_name);
269 extern jb_err sed(const struct parsers pats[], const add_header_func_ptr more_headers[], struct client_state *csp);
270 extern void get_http_time(int time_offset, char *buf);
271 extern jb_err get_destination_from_headers(const struct list *headers, struct http_request *http);
272
273 #ifdef FEATURE_FORCE_LOAD
274 extern int strclean(const char *string, const char *substring);
275 #endif /* def FEATURE_FORCE_LOAD */
276
277 /* Revision control strings from this header and associated .c file */
278 extern const char parsers_rcs[];
279 extern const char parsers_h_rcs[];
280
281 extern int debug;
282
283 #ifdef __cplusplus
284 } /* extern "C" */
285 #endif
286
287 #endif /* ndef PARSERS_H_INCLUDED */
288
289 /*
290   Local Variables:
291   tab-width: 3
292   end:
293 */