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