3 #define CGI_H_VERSION "$Id: cgi.h,v 1.28 2002/04/26 12:54:03 oes Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/cgi.h,v $
8 * Purpose : Declares functions to intercept request, generate
9 * html or gif answers, and to compose HTTP resonses.
11 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001 the SourceForge
15 * Privoxy team. http://www.privoxy.org/
17 * Based on the Internet Junkbuster originally written
18 * by and Copyright (C) 1997 Anonymous Coders and
19 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
41 * Revision 1.28 2002/04/26 12:54:03 oes
42 * New function add_help_link
44 * Revision 1.27 2002/04/24 02:16:51 oes
45 * Moved get_char_param, get_string_param and get_number_param here from cgiedit.c
47 * Revision 1.26 2002/04/10 13:38:35 oes
48 * load_template signature changed
50 * Revision 1.25 2002/04/08 20:50:25 swa
53 * Revision 1.24 2002/03/26 22:29:54 swa
54 * we have a new homepage!
56 * Revision 1.23 2002/03/24 16:18:15 jongfoster
59 * Revision 1.22 2002/03/24 13:25:43 swa
60 * name change related issues
62 * Revision 1.21 2002/03/07 03:48:38 oes
63 * - Changed built-in images from GIF to PNG
64 * (with regard to Unisys patent issue)
65 * - Added a 4x4 pattern PNG which is less intrusive
66 * than the logo but also clearly marks the deleted banners
68 * Revision 1.20 2002/03/04 17:53:22 oes
69 * Fixed compiled warning
71 * Revision 1.19 2002/01/21 00:33:52 jongfoster
72 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
74 * Revision 1.18 2001/11/16 00:46:31 jongfoster
75 * Fixing compiler warnings
77 * Revision 1.17 2001/10/23 21:48:19 jongfoster
78 * Cleaning up error handling in CGI functions - they now send back
79 * a HTML error page and should never cause a FATAL error. (Fixes one
80 * potential source of "denial of service" attacks).
82 * CGI actions file editor that works and is actually useful.
84 * Ability to toggle Junkbuster remotely using a CGI call.
86 * You can turn off both the above features in the main configuration
87 * file, e.g. if you are running a multi-user proxy.
89 * Revision 1.16 2001/09/16 17:08:54 jongfoster
90 * Moving simple CGI functions from cgi.c to new file cgisimple.c
92 * Revision 1.15 2001/09/16 15:02:35 jongfoster
93 * Adding i.j.b/robots.txt.
94 * Inlining add_stats() since it's only ever called from one place.
96 * Revision 1.14 2001/09/16 11:38:02 jongfoster
97 * Splitting fill_template() into 2 functions:
98 * template_load() loads the file
99 * template_fill() performs the PCRS regexps.
100 * This is because the CGI edit interface has a "table row"
101 * template which is used many times in the page - this
102 * change means it's only loaded from disk once.
104 * Revision 1.13 2001/09/16 11:00:10 jongfoster
105 * New function alloc_http_response, for symmetry with free_http_response
107 * Revision 1.12 2001/09/13 23:31:25 jongfoster
108 * Moving image data to cgi.c rather than cgi.h.
110 * Revision 1.11 2001/08/05 16:06:20 jongfoster
111 * Modifiying "struct map" so that there are now separate header and
112 * "map_entry" structures. This means that functions which modify a
113 * map no longer need to return a pointer to the modified map.
114 * Also, it no longer reverses the order of the entries (which may be
115 * important with some advanced template substitutions).
117 * Revision 1.10 2001/08/01 21:19:22 jongfoster
118 * Moving file version information to a separate CGI page.
120 * Revision 1.9 2001/08/01 00:17:54 jongfoster
121 * Adding prototype for map_conditional
123 * Revision 1.8 2001/07/30 22:08:36 jongfoster
124 * Tidying up #defines:
125 * - All feature #defines are now of the form FEATURE_xxx
126 * - Permanently turned off WIN_GUI_EDIT
127 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
129 * Revision 1.7 2001/07/29 18:43:08 jongfoster
130 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
133 * Revision 1.6 2001/06/29 21:45:41 oes
134 * Indentation, CRLF->LF, Tab-> Space
136 * Revision 1.5 2001/06/29 13:22:44 oes
138 * - Added new functions: default_exports(), make_menu(),
139 * error_response() etc, ranamed others and changed
140 * param and return types.
141 * - Removed HTTP/HTML snipplets
142 * - Removed logentry from cancelled commit
144 * Revision 1.4 2001/06/09 10:50:58 jongfoster
145 * Changing "show URL info" handler to new style.
146 * Adding "extern" to some function prototypes.
148 * Revision 1.3 2001/06/03 19:12:16 oes
149 * introduced new cgi handling
151 * No revisions before 1.3
153 **********************************************************************/
163 * Main dispatch function
165 extern struct http_response *dispatch_cgi(struct client_state *csp);
167 /* Not exactly a CGI */
168 extern struct http_response * error_response(struct client_state *csp,
169 const char *templatename,
173 * CGI support functions
175 extern struct http_response * alloc_http_response(void);
176 extern void free_http_response(struct http_response *rsp);
178 extern struct http_response *finish_http_response(struct http_response *rsp);
180 extern struct map * default_exports(const struct client_state *csp, const char *caller);
182 extern jb_err map_block_killer (struct map *exports, const char *name);
183 extern jb_err map_block_keep (struct map *exports, const char *name);
184 extern jb_err map_conditional (struct map *exports, const char *name, int choose_first);
186 extern jb_err template_load(struct client_state *csp, char ** template_ptr,
187 const char *templatename, int recursive);
188 extern jb_err template_fill(char ** template_ptr, const struct map *exports);
189 extern jb_err template_fill_for_cgi(struct client_state *csp,
190 const char *templatename,
192 struct http_response *rsp);
194 extern void cgi_init_error_messages(void);
195 extern struct http_response *cgi_error_memory(void);
196 extern jb_err cgi_error_no_template(struct client_state *csp,
197 struct http_response *rsp,
198 const char *template_name);
199 extern jb_err cgi_error_bad_param(struct client_state *csp,
200 struct http_response *rsp);
201 jb_err cgi_error_unknown(struct client_state *csp,
202 struct http_response *rsp,
203 jb_err error_to_report);
205 extern jb_err get_number_param(struct client_state *csp,
206 const struct map *parameters,
209 extern jb_err get_string_param(const struct map *parameters,
210 const char *param_name,
211 const char **pparam);
212 extern char get_char_param(const struct map *parameters,
213 const char *param_name);
218 extern void get_http_time(int time_offset, char * buf);
219 extern char *add_help_link(const char *item, struct configuration_spec *config);
220 extern char *make_menu(const char *self);
221 extern char *dump_map(const struct map *the_map);
224 * Ad replacement images
226 extern const char image_pattern_data[];
227 extern const size_t image_pattern_length;
228 extern const char image_blank_data[];
229 extern const size_t image_blank_length;
231 /* Revision control strings from this header and associated .c file */
232 extern const char cgi_rcs[];
233 extern const char cgi_h_rcs[];
239 #endif /* ndef CGI_H_INCLUDED */