cgi.h

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