cgi.h

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