813d1e8e6982c9bcf82c2c7243ceaeecedd6e4f2
[privoxy.git] / src / cgi.h
1 #ifndef CGI_H_INCLUDED
2 #define CGI_H_INCLUDED
3 #define CGI_H_VERSION "$Id: cgi.h,v 1.29 2002/05/19 11:33:21 jongfoster Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/cgi.h,v $
7  *
8  * Purpose     :  Declares functions to intercept request, generate
9  *                html or gif answers, and to compose HTTP resonses.
10  *                
11  *                Functions declared include:
12  * 
13  *
14  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
15  *                Privoxy team. http://www.privoxy.org/
16  *
17  *                Based on the Internet Junkbuster originally written
18  *                by and Copyright (C) 1997 Anonymous Coders and 
19  *                Junkbusters Corporation.  http://www.junkbusters.com
20  *
21  *                This program is free software; you can redistribute it 
22  *                and/or modify it under the terms of the GNU General
23  *                Public License as published by the Free Software
24  *                Foundation; either version 2 of the License, or (at
25  *                your option) any later version.
26  *
27  *                This program is distributed in the hope that it will
28  *                be useful, but WITHOUT ANY WARRANTY; without even the
29  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
30  *                PARTICULAR PURPOSE.  See the GNU General Public
31  *                License for more details.
32  *
33  *                The GNU General Public License should be included with
34  *                this file.  If not, you can view it at
35  *                http://www.gnu.org/copyleft/gpl.html
36  *                or write to the Free Software Foundation, Inc., 59
37  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
38  *
39  * Revisions   :
40  *    $Log: cgi.h,v $
41  *    Revision 1.29  2002/05/19 11:33:21  jongfoster
42  *    If a CGI error was not handled, and propogated back to
43  *    dispatch_known_cgi(), then it was assumed to be "out of memory".
44  *    This gave a very misleading error message.
45  *
46  *    Now other errors will cause a simple message giving the error
47  *    number and asking the user to report a bug.
48  *
49  *    Bug report:
50  *    http://sourceforge.net/tracker/index.php?func=detail
51  *    &aid=557905&group_id=11118&atid=111118
52  *
53  *    Revision 1.28  2002/04/26 12:54:03  oes
54  *    New function add_help_link
55  *
56  *    Revision 1.27  2002/04/24 02:16:51  oes
57  *    Moved get_char_param, get_string_param and get_number_param here from cgiedit.c
58  *
59  *    Revision 1.26  2002/04/10 13:38:35  oes
60  *    load_template signature changed
61  *
62  *    Revision 1.25  2002/04/08 20:50:25  swa
63  *    fixed JB spelling
64  *
65  *    Revision 1.24  2002/03/26 22:29:54  swa
66  *    we have a new homepage!
67  *
68  *    Revision 1.23  2002/03/24 16:18:15  jongfoster
69  *    Removing old logo
70  *
71  *    Revision 1.22  2002/03/24 13:25:43  swa
72  *    name change related issues
73  *
74  *    Revision 1.21  2002/03/07 03:48:38  oes
75  *     - Changed built-in images from GIF to PNG
76  *       (with regard to Unisys patent issue)
77  *     - Added a 4x4 pattern PNG which is less intrusive
78  *       than the logo but also clearly marks the deleted banners
79  *
80  *    Revision 1.20  2002/03/04 17:53:22  oes
81  *    Fixed compiled warning
82  *
83  *    Revision 1.19  2002/01/21 00:33:52  jongfoster
84  *    Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
85  *
86  *    Revision 1.18  2001/11/16 00:46:31  jongfoster
87  *    Fixing compiler warnings
88  *
89  *    Revision 1.17  2001/10/23 21:48:19  jongfoster
90  *    Cleaning up error handling in CGI functions - they now send back
91  *    a HTML error page and should never cause a FATAL error.  (Fixes one
92  *    potential source of "denial of service" attacks).
93  *
94  *    CGI actions file editor that works and is actually useful.
95  *
96  *    Ability to toggle Junkbuster remotely using a CGI call.
97  *
98  *    You can turn off both the above features in the main configuration
99  *    file, e.g. if you are running a multi-user proxy.
100  *
101  *    Revision 1.16  2001/09/16 17:08:54  jongfoster
102  *    Moving simple CGI functions from cgi.c to new file cgisimple.c
103  *
104  *    Revision 1.15  2001/09/16 15:02:35  jongfoster
105  *    Adding i.j.b/robots.txt.
106  *    Inlining add_stats() since it's only ever called from one place.
107  *
108  *    Revision 1.14  2001/09/16 11:38:02  jongfoster
109  *    Splitting fill_template() into 2 functions:
110  *    template_load() loads the file
111  *    template_fill() performs the PCRS regexps.
112  *    This is because the CGI edit interface has a "table row"
113  *    template which is used many times in the page - this
114  *    change means it's only loaded from disk once.
115  *
116  *    Revision 1.13  2001/09/16 11:00:10  jongfoster
117  *    New function alloc_http_response, for symmetry with free_http_response
118  *
119  *    Revision 1.12  2001/09/13 23:31:25  jongfoster
120  *    Moving image data to cgi.c rather than cgi.h.
121  *
122  *    Revision 1.11  2001/08/05 16:06:20  jongfoster
123  *    Modifiying "struct map" so that there are now separate header and
124  *    "map_entry" structures.  This means that functions which modify a
125  *    map no longer need to return a pointer to the modified map.
126  *    Also, it no longer reverses the order of the entries (which may be
127  *    important with some advanced template substitutions).
128  *
129  *    Revision 1.10  2001/08/01 21:19:22  jongfoster
130  *    Moving file version information to a separate CGI page.
131  *
132  *    Revision 1.9  2001/08/01 00:17:54  jongfoster
133  *    Adding prototype for map_conditional
134  *
135  *    Revision 1.8  2001/07/30 22:08:36  jongfoster
136  *    Tidying up #defines:
137  *    - All feature #defines are now of the form FEATURE_xxx
138  *    - Permanently turned off WIN_GUI_EDIT
139  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
140  *
141  *    Revision 1.7  2001/07/29 18:43:08  jongfoster
142  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
143  *    ANSI C rules.
144  *
145  *    Revision 1.6  2001/06/29 21:45:41  oes
146  *    Indentation, CRLF->LF, Tab-> Space
147  *
148  *    Revision 1.5  2001/06/29 13:22:44  oes
149  *    - Cleaned up
150  *    - Added new functions: default_exports(), make_menu(),
151  *      error_response() etc, ranamed others and changed
152  *      param and return types.
153  *    - Removed HTTP/HTML snipplets
154  *    - Removed logentry from cancelled commit
155  *
156  *    Revision 1.4  2001/06/09 10:50:58  jongfoster
157  *    Changing "show URL info" handler to new style.
158  *    Adding "extern" to some function prototypes.
159  *
160  *    Revision 1.3  2001/06/03 19:12:16  oes
161  *    introduced new cgi handling
162  *
163  *    No revisions before 1.3
164  *
165  **********************************************************************/
166 \f
167
168 #include "project.h"
169
170 #ifdef __cplusplus
171 extern "C" {
172 #endif
173
174 /*
175  * Main dispatch function
176  */
177 extern struct http_response *dispatch_cgi(struct client_state *csp);
178
179 /* Not exactly a CGI */
180 extern struct http_response * error_response(struct client_state *csp,
181                                              const char *templatename,
182                                              int err);
183
184 /*
185  * CGI support functions
186  */
187 extern struct http_response * alloc_http_response(void);
188 extern void free_http_response(struct http_response *rsp);
189
190 extern struct http_response *finish_http_response(struct http_response *rsp);
191
192 extern struct map * default_exports(const struct client_state *csp, const char *caller);
193
194 extern jb_err map_block_killer (struct map *exports, const char *name);
195 extern jb_err map_block_keep   (struct map *exports, const char *name);
196 extern jb_err map_conditional  (struct map *exports, const char *name, int choose_first);
197
198 extern jb_err template_load(struct client_state *csp, char ** template_ptr, 
199                             const char *templatename, int recursive);
200 extern jb_err template_fill(char ** template_ptr, const struct map *exports);
201 extern jb_err template_fill_for_cgi(struct client_state *csp,
202                                     const char *templatename,
203                                     struct map *exports,
204                                     struct http_response *rsp);
205
206 extern void cgi_init_error_messages(void);
207 extern struct http_response *cgi_error_memory(void);
208 extern jb_err cgi_error_no_template(struct client_state *csp,
209                                     struct http_response *rsp,
210                                     const char *template_name);
211 extern jb_err cgi_error_bad_param(struct client_state *csp,
212                                   struct http_response *rsp);
213 jb_err cgi_error_unknown(struct client_state *csp,
214                          struct http_response *rsp,
215                          jb_err error_to_report);
216
217 extern jb_err get_number_param(struct client_state *csp,
218                                const struct map *parameters,
219                                char *name,
220                                unsigned *pvalue);
221 extern jb_err get_string_param(const struct map *parameters,
222                                const char *param_name,
223                                const char **pparam);
224 extern char   get_char_param(const struct map *parameters,
225                              const char *param_name);
226
227 /*
228  * Text generators
229  */
230 extern void get_http_time(int time_offset, char * buf);
231 extern char *add_help_link(const char *item, struct configuration_spec *config);
232 extern char *make_menu(const char *self);
233 extern char *dump_map(const struct map *the_map);
234
235 /*
236  * Ad replacement images
237  */
238 extern const char image_pattern_data[];
239 extern const size_t  image_pattern_length;
240 extern const char image_blank_data[];
241 extern const size_t  image_blank_length;
242
243 /* Revision control strings from this header and associated .c file */
244 extern const char cgi_rcs[];
245 extern const char cgi_h_rcs[];
246
247 #ifdef __cplusplus
248 } /* extern "C" */
249 #endif
250
251 #endif /* ndef CGI_H_INCLUDED */
252
253 /*
254   Local Variables:
255   tab-width: 3
256   end:
257 */