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