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