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