3 #define CGI_H_VERSION "$Id: cgi.h,v 1.14 2001/09/16 11:38:02 jongfoster Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/cgi.h,v $
8 * Purpose : Declares functions to intercept request, generate
9 * html or gif answers, and to compose HTTP resonses.
11 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001 the SourceForge
15 * IJBSWA team. http://ijbswa.sourceforge.net
17 * Based on the Internet Junkbuster originally written
18 * by and Copyright (C) 1997 Anonymous Coders and
19 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
41 * Revision 1.14 2001/09/16 11:38:02 jongfoster
42 * Splitting fill_template() into 2 functions:
43 * template_load() loads the file
44 * template_fill() performs the PCRS regexps.
45 * This is because the CGI edit interface has a "table row"
46 * template which is used many times in the page - this
47 * change means it's only loaded from disk once.
49 * Revision 1.13 2001/09/16 11:00:10 jongfoster
50 * New function alloc_http_response, for symmetry with free_http_response
52 * Revision 1.12 2001/09/13 23:31:25 jongfoster
53 * Moving image data to cgi.c rather than cgi.h.
55 * Revision 1.11 2001/08/05 16:06:20 jongfoster
56 * Modifiying "struct map" so that there are now separate header and
57 * "map_entry" structures. This means that functions which modify a
58 * map no longer need to return a pointer to the modified map.
59 * Also, it no longer reverses the order of the entries (which may be
60 * important with some advanced template substitutions).
62 * Revision 1.10 2001/08/01 21:19:22 jongfoster
63 * Moving file version information to a separate CGI page.
65 * Revision 1.9 2001/08/01 00:17:54 jongfoster
66 * Adding prototype for map_conditional
68 * Revision 1.8 2001/07/30 22:08:36 jongfoster
69 * Tidying up #defines:
70 * - All feature #defines are now of the form FEATURE_xxx
71 * - Permanently turned off WIN_GUI_EDIT
72 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
74 * Revision 1.7 2001/07/29 18:43:08 jongfoster
75 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
78 * Revision 1.6 2001/06/29 21:45:41 oes
79 * Indentation, CRLF->LF, Tab-> Space
81 * Revision 1.5 2001/06/29 13:22:44 oes
83 * - Added new functions: default_exports(), make_menu(),
84 * error_response() etc, ranamed others and changed
85 * param and return types.
86 * - Removed HTTP/HTML snipplets
87 * - Removed logentry from cancelled commit
89 * Revision 1.4 2001/06/09 10:50:58 jongfoster
90 * Changing "show URL info" handler to new style.
91 * Adding "extern" to some function prototypes.
93 * Revision 1.3 2001/06/03 19:12:16 oes
94 * introduced new cgi handling
96 * No revisions before 1.3
98 **********************************************************************/
108 * Dispatch & parameter parsing functions
110 extern struct http_response *dispatch_cgi(struct client_state *csp);
111 extern struct map *parse_cgi_parameters(char *argstring);
116 extern int cgi_default (struct client_state *csp,
117 struct http_response *rsp,
118 struct map *parameters);
119 extern int cgi_robots_txt (struct client_state *csp,
120 struct http_response *rsp,
121 struct map *parameters);
122 extern int cgi_send_banner (struct client_state *csp,
123 struct http_response *rsp,
124 struct map *parameters);
125 extern int cgi_show_status (struct client_state *csp,
126 struct http_response *rsp,
127 struct map *parameters);
128 extern int cgi_show_url_info (struct client_state *csp,
129 struct http_response *rsp,
130 struct map *parameters);
131 extern int cgi_show_version (struct client_state *csp,
132 struct http_response *rsp,
133 struct map *parameters);
135 /* Not exactly a CGI */
136 extern struct http_response * error_response(struct client_state *csp,
137 const char *templatename,
141 * CGI support functions
143 extern struct http_response * alloc_http_response(void);
144 extern void free_http_response(struct http_response *rsp);
146 extern struct http_response *finish_http_response(struct http_response *rsp);
148 extern struct map * default_exports(const struct client_state *csp, const char *caller);
149 extern void map_block_killer(struct map *map, const char *name);
150 extern void map_conditional(struct map *exports, const char *name, int choose_first);
152 extern char *template_load(struct client_state *csp, const char *templatename);
153 extern void template_fill(char ** template_ptr, struct map *exports);
159 extern char *make_menu(const char *self);
160 extern char *dump_map(const struct map *map);
165 extern const char image_junkbuster_gif_data[];
166 extern const int image_junkbuster_gif_length;
167 extern const char image_blank_gif_data[];
168 extern const int image_blank_gif_length;
171 /* Revision control strings from this header and associated .c file */
172 extern const char cgi_rcs[];
173 extern const char cgi_h_rcs[];
179 #endif /* ndef CGI_H_INCLUDED */