3 #define CGI_H_VERSION "$Id: cgi.h,v 1.23 2002/03/24 16:18:15 jongfoster 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.23 2002/03/24 16:18:15 jongfoster
44 * Revision 1.22 2002/03/24 13:25:43 swa
45 * name change related issues
47 * Revision 1.21 2002/03/07 03:48:38 oes
48 * - Changed built-in images from GIF to PNG
49 * (with regard to Unisys patent issue)
50 * - Added a 4x4 pattern PNG which is less intrusive
51 * than the logo but also clearly marks the deleted banners
53 * Revision 1.20 2002/03/04 17:53:22 oes
54 * Fixed compiled warning
56 * Revision 1.19 2002/01/21 00:33:52 jongfoster
57 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
59 * Revision 1.18 2001/11/16 00:46:31 jongfoster
60 * Fixing compiler warnings
62 * Revision 1.17 2001/10/23 21:48:19 jongfoster
63 * Cleaning up error handling in CGI functions - they now send back
64 * a HTML error page and should never cause a FATAL error. (Fixes one
65 * potential source of "denial of service" attacks).
67 * CGI actions file editor that works and is actually useful.
69 * Ability to toggle JunkBuster remotely using a CGI call.
71 * You can turn off both the above features in the main configuration
72 * file, e.g. if you are running a multi-user proxy.
74 * Revision 1.16 2001/09/16 17:08:54 jongfoster
75 * Moving simple CGI functions from cgi.c to new file cgisimple.c
77 * Revision 1.15 2001/09/16 15:02:35 jongfoster
78 * Adding i.j.b/robots.txt.
79 * Inlining add_stats() since it's only ever called from one place.
81 * Revision 1.14 2001/09/16 11:38:02 jongfoster
82 * Splitting fill_template() into 2 functions:
83 * template_load() loads the file
84 * template_fill() performs the PCRS regexps.
85 * This is because the CGI edit interface has a "table row"
86 * template which is used many times in the page - this
87 * change means it's only loaded from disk once.
89 * Revision 1.13 2001/09/16 11:00:10 jongfoster
90 * New function alloc_http_response, for symmetry with free_http_response
92 * Revision 1.12 2001/09/13 23:31:25 jongfoster
93 * Moving image data to cgi.c rather than cgi.h.
95 * Revision 1.11 2001/08/05 16:06:20 jongfoster
96 * Modifiying "struct map" so that there are now separate header and
97 * "map_entry" structures. This means that functions which modify a
98 * map no longer need to return a pointer to the modified map.
99 * Also, it no longer reverses the order of the entries (which may be
100 * important with some advanced template substitutions).
102 * Revision 1.10 2001/08/01 21:19:22 jongfoster
103 * Moving file version information to a separate CGI page.
105 * Revision 1.9 2001/08/01 00:17:54 jongfoster
106 * Adding prototype for map_conditional
108 * Revision 1.8 2001/07/30 22:08:36 jongfoster
109 * Tidying up #defines:
110 * - All feature #defines are now of the form FEATURE_xxx
111 * - Permanently turned off WIN_GUI_EDIT
112 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
114 * Revision 1.7 2001/07/29 18:43:08 jongfoster
115 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
118 * Revision 1.6 2001/06/29 21:45:41 oes
119 * Indentation, CRLF->LF, Tab-> Space
121 * Revision 1.5 2001/06/29 13:22:44 oes
123 * - Added new functions: default_exports(), make_menu(),
124 * error_response() etc, ranamed others and changed
125 * param and return types.
126 * - Removed HTTP/HTML snipplets
127 * - Removed logentry from cancelled commit
129 * Revision 1.4 2001/06/09 10:50:58 jongfoster
130 * Changing "show URL info" handler to new style.
131 * Adding "extern" to some function prototypes.
133 * Revision 1.3 2001/06/03 19:12:16 oes
134 * introduced new cgi handling
136 * No revisions before 1.3
138 **********************************************************************/
148 * Main dispatch function
150 extern struct http_response *dispatch_cgi(struct client_state *csp);
152 /* Not exactly a CGI */
153 extern struct http_response * error_response(struct client_state *csp,
154 const char *templatename,
158 * CGI support functions
160 extern struct http_response * alloc_http_response(void);
161 extern void free_http_response(struct http_response *rsp);
163 extern struct http_response *finish_http_response(struct http_response *rsp);
165 extern struct map * default_exports(const struct client_state *csp, const char *caller);
167 extern jb_err map_block_killer (struct map *exports, const char *name);
168 extern jb_err map_block_keep (struct map *exports, const char *name);
169 extern jb_err map_conditional (struct map *exports, const char *name, int choose_first);
171 extern jb_err template_load(struct client_state *csp, char ** template_ptr,
172 const char *templatename);
173 extern jb_err template_fill(char ** template_ptr, const struct map *exports);
174 extern jb_err template_fill_for_cgi(struct client_state *csp,
175 const char *templatename,
177 struct http_response *rsp);
179 extern void cgi_init_error_messages(void);
180 extern struct http_response *cgi_error_memory(void);
181 extern jb_err cgi_error_no_template(struct client_state *csp,
182 struct http_response *rsp,
183 const char *template_name);
184 extern jb_err cgi_error_bad_param(struct client_state *csp,
185 struct http_response *rsp);
190 extern void get_http_time(int time_offset, char * buf);
191 extern char *make_menu(const char *self);
192 extern char *dump_map(const struct map *the_map);
195 * Ad replacement images.
197 extern const char image_pattern_data[];
198 extern const size_t image_pattern_length;
199 extern const char image_blank_data[];
200 extern const size_t image_blank_length;
202 /* Revision control strings from this header and associated .c file */
203 extern const char cgi_rcs[];
204 extern const char cgi_h_rcs[];
210 #endif /* ndef CGI_H_INCLUDED */