Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
[privoxy.git] / parsers.h
1 #ifndef PARSERS_H_INCLUDED
2 #define PARSERS_H_INCLUDED
3 #define PARSERS_H_VERSION "$Id: parsers.h,v 1.26.2.1 2002/09/25 14:52:46 oes Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/Attic/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.26.2.1  2002/09/25 14:52:46  oes
47  *    Added basic support for OPTIONS and TRACE HTTP methods:
48  *     - New parser function client_max_forwards which decrements
49  *       the Max-Forwards HTTP header field of OPTIONS and TRACE
50  *       requests by one before forwarding
51  *     - New parser function client_host which extracts the host
52  *       and port information from the HTTP header field if the
53  *       request URI was not absolute
54  *     - Don't crumble and re-add the Host: header, but only generate
55  *       and append if missing
56  *
57  *    Revision 1.26  2002/05/08 15:59:53  oes
58  *    Changed add_to_iob signature (now returns jb_err)
59  *
60  *    Revision 1.25  2002/03/26 22:29:55  swa
61  *    we have a new homepage!
62  *
63  *    Revision 1.24  2002/03/24 13:25:43  swa
64  *    name change related issues
65  *
66  *    Revision 1.23  2002/03/13 00:27:05  jongfoster
67  *    Killing warnings
68  *
69  *    Revision 1.22  2002/03/09 20:03:52  jongfoster
70  *    - Making various functions return int rather than size_t.
71  *      (Undoing a recent change).  Since size_t is unsigned on
72  *      Windows, functions like read_socket that return -1 on
73  *      error cannot return a size_t.
74  *
75  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
76  *      crashes, and also frequently caused JB to jump to 100%
77  *      CPU and stay there.  (Because it thought it had just
78  *      read ((unsigned)-1) == 4Gb of data...)
79  *
80  *    - The signature of write_socket has changed, it now simply
81  *      returns success=0/failure=nonzero.
82  *
83  *    - Trying to get rid of a few warnings --with-debug on
84  *      Windows, I've introduced a new type "jb_socket".  This is
85  *      used for the socket file descriptors.  On Windows, this
86  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
87  *      an int.  The error value can't be -1 any more, so it's
88  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
89  *      Windows it maps to the #define INVALID_SOCKET.)
90  *
91  *    - The signature of bind_port has changed.
92  *
93  *    Revision 1.21  2002/03/07 03:46:17  oes
94  *    Fixed compiler warnings
95  *
96  *    Revision 1.20  2002/02/20 23:15:13  jongfoster
97  *    Parsing functions now handle out-of-memory gracefully by returning
98  *    an error code.
99  *
100  *    Revision 1.19  2002/01/17 21:03:47  jongfoster
101  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
102  *
103  *    Revision 1.18  2001/10/26 17:40:23  oes
104  *    Introduced get_header_value()
105  *    Removed client_accept()
106  *
107  *    Revision 1.17  2001/10/13 12:47:32  joergs
108  *    Removed client_host, added client_host_adder
109  *
110  *    Revision 1.16  2001/10/07 18:50:16  oes
111  *    Added server_content_encoding, renamed server_transfer_encoding
112  *
113  *    Revision 1.15  2001/10/07 18:01:55  oes
114  *    Changed server_http11 to server_http
115  *
116  *    Revision 1.14  2001/10/07 15:45:48  oes
117  *    added client_accept_encoding, client_te, client_accept_encoding_adder
118  *
119  *    renamed content_type and content_length
120  *
121  *    fixed client_host and strclean prototypes
122  *
123  *    Revision 1.13  2001/09/29 12:56:03  joergs
124  *    IJB now changes HTTP/1.1 to HTTP/1.0 in requests and answers.
125  *
126  *    Revision 1.12  2001/09/13 23:05:50  jongfoster
127  *    Changing the string paramater to the header parsers a "const".
128  *
129  *    Revision 1.11  2001/07/31 14:46:53  oes
130  *    Added prototype for connection_close_adder
131  *
132  *    Revision 1.10  2001/07/30 22:08:36  jongfoster
133  *    Tidying up #defines:
134  *    - All feature #defines are now of the form FEATURE_xxx
135  *    - Permanently turned off WIN_GUI_EDIT
136  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
137  *
138  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
139  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
140  *    ANSI C rules.
141  *
142  *    Revision 1.8  2001/07/13 14:01:54  oes
143  *    Removed all #ifdef PCRS
144  *
145  *    Revision 1.7  2001/06/29 13:32:14  oes
146  *    Removed logentry from cancelled commit
147  *
148  *    Revision 1.6  2001/06/03 19:12:38  oes
149  *    deleted const struct interceptors
150  *
151  *    Revision 1.5  2001/05/31 21:30:33  jongfoster
152  *    Removed list code - it's now in list.[ch]
153  *    Renamed "permission" to "action", and changed many features
154  *    to use the actions file rather than the global config.
155  *
156  *    Revision 1.4  2001/05/27 13:19:06  oes
157  *    Patched Joergs solution for the content-length in.
158  *
159  *    Revision 1.3  2001/05/26 13:39:32  jongfoster
160  *    Only crunches Content-Length header if applying RE filtering.
161  *    Without this fix, Microsoft Windows Update wouldn't work.
162  *
163  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
164  *    Version 2.9.4 checkin.
165  *    - Merged popupfile and cookiefile, and added control over PCRS
166  *      filtering, in new "permissionsfile".
167  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
168  *      file error you now get a message box (in the Win32 GUI) rather
169  *      than the program exiting with no explanation.
170  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
171  *      skipping.
172  *    - Removed tabs from "config"
173  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
174  *    - Bumped up version number.
175  *
176  *    Revision 1.1.1.1  2001/05/15 13:59:01  oes
177  *    Initial import of version 2.9.3 source tree
178  *
179  *
180  *********************************************************************/
181 \f
182
183 #include "project.h"
184
185 #ifdef __cplusplus
186 extern "C" {
187 #endif
188
189 extern const struct parsers client_patterns[];
190 extern const struct parsers server_patterns[];
191
192 extern const add_header_func_ptr add_client_headers[];
193 extern const add_header_func_ptr add_server_headers[];
194
195 extern int flush_socket(jb_socket fd, struct client_state *csp);
196 extern jb_err add_to_iob(struct client_state *csp, char *buf, int n);
197 extern char *get_header(struct client_state *csp);
198 extern char *get_header_value(const struct list *header_list, const char *header_name);
199 extern char *sed(const struct parsers pats[], const add_header_func_ptr more_headers[], struct client_state *csp);
200
201 extern jb_err crumble                (struct client_state *csp, char **header);
202 extern jb_err client_referrer        (struct client_state *csp, char **header);
203 extern jb_err client_uagent          (struct client_state *csp, char **header);
204 extern jb_err client_ua              (struct client_state *csp, char **header);
205 extern jb_err client_from            (struct client_state *csp, char **header);
206 extern jb_err client_send_cookie     (struct client_state *csp, char **header);
207 extern jb_err client_x_forwarded     (struct client_state *csp, char **header);
208 extern jb_err client_accept_encoding (struct client_state *csp, char **header);
209 extern jb_err client_te              (struct client_state *csp, char **header);
210 extern jb_err client_max_forwards    (struct client_state *csp, char **header);
211 extern jb_err client_host(struct client_state *csp, char **header);
212
213
214 extern jb_err client_host_adder           (struct client_state *csp);
215 extern jb_err client_cookie_adder         (struct client_state *csp);
216 extern jb_err client_xtra_adder           (struct client_state *csp);
217 extern jb_err client_accept_encoding_adder(struct client_state *csp);
218 extern jb_err client_x_forwarded_adder    (struct client_state *csp);
219
220 extern jb_err connection_close_adder      (struct client_state *csp); 
221
222 extern jb_err server_set_cookie      (struct client_state *csp, char **header);
223 extern jb_err server_content_type    (struct client_state *csp, char **header);
224 extern jb_err server_content_length  (struct client_state *csp, char **header);
225 extern jb_err server_content_md5     (struct client_state *csp, char **header);
226 extern jb_err server_content_encoding(struct client_state *csp, char **header);
227 extern jb_err server_transfer_coding (struct client_state *csp, char **header);
228 extern jb_err server_http            (struct client_state *csp, char **header);
229
230 #ifdef FEATURE_FORCE_LOAD
231 extern int strclean(const char *string, const char *substring);
232 #endif /* def FEATURE_FORCE_LOAD */
233
234 /* Revision control strings from this header and associated .c file */
235 extern const char parsers_rcs[];
236 extern const char parsers_h_rcs[];
237
238 #ifdef __cplusplus
239 } /* extern "C" */
240 #endif
241
242 #endif /* ndef PARSERS_H_INCLUDED */
243
244 /*
245   Local Variables:
246   tab-width: 3
247   end:
248 */