Moved get_char_param, get_string_param and get_number_param here from cgiedit.c
[privoxy.git] / cgi.h
1 #ifndef CGI_H_INCLUDED
2 #define CGI_H_INCLUDED
3 #define CGI_H_VERSION "$Id: cgi.h,v 1.26 2002/04/10 13:38:35 oes 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.26  2002/04/10 13:38:35  oes
42  *    load_template signature changed
43  *
44  *    Revision 1.25  2002/04/08 20:50:25  swa
45  *    fixed JB spelling
46  *
47  *    Revision 1.24  2002/03/26 22:29:54  swa
48  *    we have a new homepage!
49  *
50  *    Revision 1.23  2002/03/24 16:18:15  jongfoster
51  *    Removing old logo
52  *
53  *    Revision 1.22  2002/03/24 13:25:43  swa
54  *    name change related issues
55  *
56  *    Revision 1.21  2002/03/07 03:48:38  oes
57  *     - Changed built-in images from GIF to PNG
58  *       (with regard to Unisys patent issue)
59  *     - Added a 4x4 pattern PNG which is less intrusive
60  *       than the logo but also clearly marks the deleted banners
61  *
62  *    Revision 1.20  2002/03/04 17:53:22  oes
63  *    Fixed compiled warning
64  *
65  *    Revision 1.19  2002/01/21 00:33:52  jongfoster
66  *    Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
67  *
68  *    Revision 1.18  2001/11/16 00:46:31  jongfoster
69  *    Fixing compiler warnings
70  *
71  *    Revision 1.17  2001/10/23 21:48:19  jongfoster
72  *    Cleaning up error handling in CGI functions - they now send back
73  *    a HTML error page and should never cause a FATAL error.  (Fixes one
74  *    potential source of "denial of service" attacks).
75  *
76  *    CGI actions file editor that works and is actually useful.
77  *
78  *    Ability to toggle Junkbuster remotely using a CGI call.
79  *
80  *    You can turn off both the above features in the main configuration
81  *    file, e.g. if you are running a multi-user proxy.
82  *
83  *    Revision 1.16  2001/09/16 17:08:54  jongfoster
84  *    Moving simple CGI functions from cgi.c to new file cgisimple.c
85  *
86  *    Revision 1.15  2001/09/16 15:02:35  jongfoster
87  *    Adding i.j.b/robots.txt.
88  *    Inlining add_stats() since it's only ever called from one place.
89  *
90  *    Revision 1.14  2001/09/16 11:38:02  jongfoster
91  *    Splitting fill_template() into 2 functions:
92  *    template_load() loads the file
93  *    template_fill() performs the PCRS regexps.
94  *    This is because the CGI edit interface has a "table row"
95  *    template which is used many times in the page - this
96  *    change means it's only loaded from disk once.
97  *
98  *    Revision 1.13  2001/09/16 11:00:10  jongfoster
99  *    New function alloc_http_response, for symmetry with free_http_response
100  *
101  *    Revision 1.12  2001/09/13 23:31:25  jongfoster
102  *    Moving image data to cgi.c rather than cgi.h.
103  *
104  *    Revision 1.11  2001/08/05 16:06:20  jongfoster
105  *    Modifiying "struct map" so that there are now separate header and
106  *    "map_entry" structures.  This means that functions which modify a
107  *    map no longer need to return a pointer to the modified map.
108  *    Also, it no longer reverses the order of the entries (which may be
109  *    important with some advanced template substitutions).
110  *
111  *    Revision 1.10  2001/08/01 21:19:22  jongfoster
112  *    Moving file version information to a separate CGI page.
113  *
114  *    Revision 1.9  2001/08/01 00:17:54  jongfoster
115  *    Adding prototype for map_conditional
116  *
117  *    Revision 1.8  2001/07/30 22:08:36  jongfoster
118  *    Tidying up #defines:
119  *    - All feature #defines are now of the form FEATURE_xxx
120  *    - Permanently turned off WIN_GUI_EDIT
121  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
122  *
123  *    Revision 1.7  2001/07/29 18:43:08  jongfoster
124  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
125  *    ANSI C rules.
126  *
127  *    Revision 1.6  2001/06/29 21:45:41  oes
128  *    Indentation, CRLF->LF, Tab-> Space
129  *
130  *    Revision 1.5  2001/06/29 13:22:44  oes
131  *    - Cleaned up
132  *    - Added new functions: default_exports(), make_menu(),
133  *      error_response() etc, ranamed others and changed
134  *      param and return types.
135  *    - Removed HTTP/HTML snipplets
136  *    - Removed logentry from cancelled commit
137  *
138  *    Revision 1.4  2001/06/09 10:50:58  jongfoster
139  *    Changing "show URL info" handler to new style.
140  *    Adding "extern" to some function prototypes.
141  *
142  *    Revision 1.3  2001/06/03 19:12:16  oes
143  *    introduced new cgi handling
144  *
145  *    No revisions before 1.3
146  *
147  **********************************************************************/
148 \f
149
150 #include "project.h"
151
152 #ifdef __cplusplus
153 extern "C" {
154 #endif
155
156 /*
157  * Main dispatch function
158  */
159 extern struct http_response *dispatch_cgi(struct client_state *csp);
160
161 /* Not exactly a CGI */
162 extern struct http_response * error_response(struct client_state *csp,
163                                              const char *templatename,
164                                              int err);
165
166 /*
167  * CGI support functions
168  */
169 extern struct http_response * alloc_http_response(void);
170 extern void free_http_response(struct http_response *rsp);
171
172 extern struct http_response *finish_http_response(struct http_response *rsp);
173
174 extern struct map * default_exports(const struct client_state *csp, const char *caller);
175
176 extern jb_err map_block_killer (struct map *exports, const char *name);
177 extern jb_err map_block_keep   (struct map *exports, const char *name);
178 extern jb_err map_conditional  (struct map *exports, const char *name, int choose_first);
179
180 extern jb_err template_load(struct client_state *csp, char ** template_ptr, 
181                             const char *templatename, int recursive);
182 extern jb_err template_fill(char ** template_ptr, const struct map *exports);
183 extern jb_err template_fill_for_cgi(struct client_state *csp,
184                                     const char *templatename,
185                                     struct map *exports,
186                                     struct http_response *rsp);
187
188 extern void cgi_init_error_messages(void);
189 extern struct http_response *cgi_error_memory(void);
190 extern jb_err cgi_error_no_template(struct client_state *csp,
191                                     struct http_response *rsp,
192                                     const char *template_name);
193 extern jb_err cgi_error_bad_param(struct client_state *csp,
194                                   struct http_response *rsp);
195
196 extern jb_err get_number_param(struct client_state *csp,
197                                const struct map *parameters,
198                                char *name,
199                                unsigned *pvalue);
200 extern jb_err get_string_param(const struct map *parameters,
201                                const char *param_name,
202                                const char **pparam);
203 extern char   get_char_param(const struct map *parameters,
204                              const char *param_name);
205
206 /*
207  * Text generators
208  */
209 extern void get_http_time(int time_offset, char * buf);
210 extern char *make_menu(const char *self);
211 extern char *dump_map(const struct map *the_map);
212
213 /*
214  * Ad replacement images
215  */
216 extern const char image_pattern_data[];
217 extern const size_t  image_pattern_length;
218 extern const char image_blank_data[];
219 extern const size_t  image_blank_length;
220
221 /* Revision control strings from this header and associated .c file */
222 extern const char cgi_rcs[];
223 extern const char cgi_h_rcs[];
224
225 #ifdef __cplusplus
226 } /* extern "C" */
227 #endif
228
229 #endif /* ndef CGI_H_INCLUDED */
230
231 /*
232   Local Variables:
233   tab-width: 3
234   end:
235 */