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