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