cgi.h

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