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