Moving file version information to a separate CGI page.
[privoxy.git] / cgi.h
1 #ifndef CGI_H_INCLUDED
2 #define CGI_H_INCLUDED
3 #define CGI_H_VERSION "$Id: cgi.h,v 1.9 2001/08/01 00:17: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.9  2001/08/01 00:17:54  jongfoster
42  *    Adding prototype for map_conditional
43  *
44  *    Revision 1.8  2001/07/30 22:08:36  jongfoster
45  *    Tidying up #defines:
46  *    - All feature #defines are now of the form FEATURE_xxx
47  *    - Permanently turned off WIN_GUI_EDIT
48  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
49  *
50  *    Revision 1.7  2001/07/29 18:43:08  jongfoster
51  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
52  *    ANSI C rules.
53  *
54  *    Revision 1.6  2001/06/29 21:45:41  oes
55  *    Indentation, CRLF->LF, Tab-> Space
56  *
57  *    Revision 1.5  2001/06/29 13:22:44  oes
58  *    - Cleaned up
59  *    - Added new functions: default_exports(), make_menu(),
60  *      error_response() etc, ranamed others and changed
61  *      param and return types.
62  *    - Removed HTTP/HTML snipplets
63  *    - Removed logentry from cancelled commit
64  *
65  *    Revision 1.4  2001/06/09 10:50:58  jongfoster
66  *    Changing "show URL info" handler to new style.
67  *    Adding "extern" to some function prototypes.
68  *
69  *    Revision 1.3  2001/06/03 19:12:16  oes
70  *    introduced new cgi handling
71  *
72  *    No revisions before 1.3
73  *
74  **********************************************************************/
75 \f
76
77 #include "project.h"
78
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82
83 /*
84  * Dispatch & parameter parsing functions
85  */
86 extern struct http_response *dispatch_cgi(struct client_state *csp);
87 extern struct map *parse_cgi_parameters(char *argstring);
88
89 /*
90  * CGI functions
91  */
92 extern int cgi_show_version(struct client_state *csp, struct http_response *rsp,
93                             struct map *parameters);
94 extern int cgi_default(struct client_state *csp, struct http_response *rsp,
95                        struct map *parameters);
96 extern int cgi_show_status(struct client_state *csp, struct http_response *rsp,
97                            struct map *parameters);
98 extern int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
99                              struct map *parameters);
100 extern int cgi_send_banner(struct client_state *csp, struct http_response *rsp,
101                                   struct map *parameters);
102
103 /* Not exactly a CGI */
104 extern struct http_response *error_response(struct client_state *csp, const char *template, int err);
105
106 /*
107  * CGI support functions
108  */
109 extern struct http_response *finish_http_response(struct http_response *rsp);
110 extern void free_http_response(struct http_response *rsp);
111
112 extern struct map *default_exports(struct client_state *csp, char *caller);
113 extern struct map *map_block_killer(struct map *map, char *name);
114 extern struct map *map_conditional(struct map *exports, char *name, int choose_first);
115 extern char *fill_template(struct client_state *csp, const char *template, struct map *exports);
116
117
118 /*
119  * Text generators
120  */
121 extern char *make_menu(const char *self);
122 extern char *dump_map(struct map *map);
123
124 #ifdef FEATURE_STATISTICS
125 extern struct map *add_stats(struct map *exports);
126 #endif /* def FEATURE_STATISTICS */
127
128
129 /*
130  * Hint: You can encode your own GIFs like that:
131  * perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }'
132  */
133
134 static const char JBGIF[] =
135    "GIF89aD\000\013\000\360\000\000\000\000\000\377\377\377!"
136    "\371\004\001\000\000\001\000,\000\000\000\000D\000\013\000"
137    "\000\002a\214\217\251\313\355\277\000\200G&K\025\316hC\037"
138    "\200\234\230Y\2309\235S\230\266\206\372J\253<\3131\253\271"
139    "\270\215\342\254\013\203\371\202\264\334P\207\332\020o\266"
140    "N\215I\332=\211\312\3513\266:\026AK)\364\370\365aobr\305"
141    "\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276"
142    "\037Q\000\000;";
143
144 static const char BLANKGIF[] =
145    "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
146    "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
147    "\000\001\000\000\002\002D\001\000;";
148
149
150 /* Revision control strings from this header and associated .c file */
151 extern const char cgi_rcs[];
152 extern const char cgi_h_rcs[];
153
154 #ifdef __cplusplus
155 } /* extern "C" */
156 #endif
157
158 #endif /* ndef CGI_H_INCLUDED */
159
160 /*
161   Local Variables:
162   tab-width: 3
163   end:
164 */