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