Cleaning up error handling in CGI functions - they now send back
[privoxy.git] / cgi.h
1 #ifndef CGI_H_INCLUDED
2 #define CGI_H_INCLUDED
3 #define CGI_H_VERSION "$Id: cgi.h,v 1.16 2001/09/16 17:08:54 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  *                IJBSWA team.  http://ijbswa.sourceforge.net
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.16  2001/09/16 17:08:54  jongfoster
42  *    Moving simple CGI functions from cgi.c to new file cgisimple.c
43  *
44  *    Revision 1.15  2001/09/16 15:02:35  jongfoster
45  *    Adding i.j.b/robots.txt.
46  *    Inlining add_stats() since it's only ever called from one place.
47  *
48  *    Revision 1.14  2001/09/16 11:38:02  jongfoster
49  *    Splitting fill_template() into 2 functions:
50  *    template_load() loads the file
51  *    template_fill() performs the PCRS regexps.
52  *    This is because the CGI edit interface has a "table row"
53  *    template which is used many times in the page - this
54  *    change means it's only loaded from disk once.
55  *
56  *    Revision 1.13  2001/09/16 11:00:10  jongfoster
57  *    New function alloc_http_response, for symmetry with free_http_response
58  *
59  *    Revision 1.12  2001/09/13 23:31:25  jongfoster
60  *    Moving image data to cgi.c rather than cgi.h.
61  *
62  *    Revision 1.11  2001/08/05 16:06:20  jongfoster
63  *    Modifiying "struct map" so that there are now separate header and
64  *    "map_entry" structures.  This means that functions which modify a
65  *    map no longer need to return a pointer to the modified map.
66  *    Also, it no longer reverses the order of the entries (which may be
67  *    important with some advanced template substitutions).
68  *
69  *    Revision 1.10  2001/08/01 21:19:22  jongfoster
70  *    Moving file version information to a separate CGI page.
71  *
72  *    Revision 1.9  2001/08/01 00:17:54  jongfoster
73  *    Adding prototype for map_conditional
74  *
75  *    Revision 1.8  2001/07/30 22:08:36  jongfoster
76  *    Tidying up #defines:
77  *    - All feature #defines are now of the form FEATURE_xxx
78  *    - Permanently turned off WIN_GUI_EDIT
79  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
80  *
81  *    Revision 1.7  2001/07/29 18:43:08  jongfoster
82  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
83  *    ANSI C rules.
84  *
85  *    Revision 1.6  2001/06/29 21:45:41  oes
86  *    Indentation, CRLF->LF, Tab-> Space
87  *
88  *    Revision 1.5  2001/06/29 13:22:44  oes
89  *    - Cleaned up
90  *    - Added new functions: default_exports(), make_menu(),
91  *      error_response() etc, ranamed others and changed
92  *      param and return types.
93  *    - Removed HTTP/HTML snipplets
94  *    - Removed logentry from cancelled commit
95  *
96  *    Revision 1.4  2001/06/09 10:50:58  jongfoster
97  *    Changing "show URL info" handler to new style.
98  *    Adding "extern" to some function prototypes.
99  *
100  *    Revision 1.3  2001/06/03 19:12:16  oes
101  *    introduced new cgi handling
102  *
103  *    No revisions before 1.3
104  *
105  **********************************************************************/
106 \f
107
108 #include "project.h"
109
110 #ifdef __cplusplus
111 extern "C" {
112 #endif
113
114 /*
115  * Dispatch & parameter parsing functions
116  */
117 extern struct http_response *dispatch_cgi(struct client_state *csp);
118 extern struct map *parse_cgi_parameters(char *argstring);
119
120 /* Not exactly a CGI */
121 extern struct http_response * error_response(struct client_state *csp,
122                                              const char *templatename,
123                                              int err);
124
125 /*
126  * CGI support functions
127  */
128 extern struct http_response * alloc_http_response(void);
129 extern void free_http_response(struct http_response *rsp);
130
131 extern struct http_response *finish_http_response(struct http_response *rsp);
132
133 extern struct map * default_exports(const struct client_state *csp, const char *caller);
134
135 extern jb_err map_block_killer (struct map *exports, const char *name);
136 extern jb_err map_conditional  (struct map *exports, const char *name, int choose_first);
137
138 extern jb_err template_load(struct client_state *csp, char ** template_ptr, 
139                             const char *templatename);
140 extern jb_err template_fill(char ** template_ptr, const struct map *exports);
141 extern jb_err template_fill_for_cgi(struct client_state *csp,
142                                     const char *templatename,
143                                     struct map *exports,
144                                     struct http_response *rsp);
145
146 extern void cgi_init_error_messages(void);
147 extern struct http_response *cgi_error_memory(void);
148 extern jb_err cgi_error_no_template(struct client_state *csp,
149                                     struct http_response *rsp,
150                                     const char *template_name);
151 extern jb_err cgi_error_bad_param(struct client_state *csp,
152                                   struct http_response *rsp);
153
154 /*
155  * Text generators
156  */
157 extern void get_http_time(int time_offset, char * buf);
158 extern char *make_menu(const char *self);
159 extern char *dump_map(const struct map *map);
160
161 /*
162  * Some images.
163  */
164 extern const char image_junkbuster_gif_data[];
165 extern const int  image_junkbuster_gif_length;
166 extern const char image_blank_gif_data[];
167 extern const int  image_blank_gif_length;
168
169
170 /* Revision control strings from this header and associated .c file */
171 extern const char cgi_rcs[];
172 extern const char cgi_h_rcs[];
173
174 #ifdef __cplusplus
175 } /* extern "C" */
176 #endif
177
178 #endif /* ndef CGI_H_INCLUDED */
179
180 /*
181   Local Variables:
182   tab-width: 3
183   end:
184 */