- Cleaned up
[privoxy.git] / cgi.h
1 #ifndef _CGI_H
2 #define _CGI_H
3 #define CGI_H_VERSION "$Id: cgi.h,v 1.4 2001/06/09 10:50:58 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.4  2001/06/09 10:50:58  jongfoster
42  *    Changing "show URL info" handler to new style.
43  *    Adding "extern" to some function prototypes.
44  *
45  *    Revision 1.3  2001/06/03 19:12:16  oes
46  *    introduced new cgi handling
47  *
48  *    No revisions before 1.3
49  *
50  **********************************************************************/
51 \f
52
53 #include "project.h"
54
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58
59 /*
60  * Dispatch & parameter parsing functions
61  */
62 extern struct http_response *dispatch_cgi(struct client_state *csp);
63 extern struct map *parse_cgi_parameters(char *argstring);
64
65 /*
66  * CGI functions
67  */
68 extern int cgi_default(struct client_state *csp, struct http_response *rsp,
69                        struct map *parameters);
70 extern int cgi_show_status(struct client_state *csp, struct http_response *rsp,
71                            struct map *parameters);
72 extern int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,\r
73                              struct map *parameters);
74 extern int cgi_send_banner(struct client_state *csp, struct http_response *rsp,
75                                           struct map *parameters);
76
77 /* Not exactly a CGI */
78 extern struct http_response *error_response(struct client_state *csp, const char *template, int err);
79
80 /*
81  * CGI support functions
82  */
83 extern struct http_response *finish_http_response(struct http_response *rsp);
84 extern void free_http_response(struct http_response *rsp);
85
86 extern struct map *default_exports(struct client_state *csp, char *caller);
87 extern struct map *map_block_killer(struct map *map, char *name);
88 extern char *fill_template(struct client_state *csp, const char *template, struct map *exports);
89
90
91 /*
92  * Text generators
93  */
94 extern char *make_menu(const char *self);
95 extern char *dump_map(struct map *map);
96
97 #ifdef STATISTICS
98 extern struct map *add_stats(struct map *exports);
99 #endif /* def STATISTICS */
100
101
102 /*
103  * Hint: You can encode your own GIFs like that:
104  * perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }'
105  */
106
107 static const char JBGIF[] =
108    "GIF89aD\000\013\000\360\000\000\000\000\000\377\377\377!"
109    "\371\004\001\000\000\001\000,\000\000\000\000D\000\013\000"
110    "\000\002a\214\217\251\313\355\277\000\200G&K\025\316hC\037"
111    "\200\234\230Y\2309\235S\230\266\206\372J\253<\3131\253\271"
112    "\270\215\342\254\013\203\371\202\264\334P\207\332\020o\266"
113    "N\215I\332=\211\312\3513\266:\026AK)\364\370\365aobr\305"
114    "\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276"
115    "\037Q\000\000;";
116
117 static const char BLANKGIF[] =
118    "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
119    "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
120    "\000\001\000\000\002\002D\001\000;";
121
122
123 /* Revision control strings from this header and associated .c file */
124 extern const char cgi_rcs[];
125 extern const char cgi_h_rcs[];
126
127 #ifdef __cplusplus
128 } /* extern "C" */
129 #endif
130
131 #endif /* ndef _CGI_H */
132
133 /*
134   Local Variables:
135   tab-width: 3
136   end:
137 */