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