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