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