cgi.h

   1 #ifndef CGI_H_INCLUDED
   2 #define CGI_H_INCLUDED
   3 #define CGI_H_VERSION "$Id: cgi.h,v 1.21 2002/03/07 03:48:38 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  *                Privoxy 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.21  2002/03/07 03:48:38  oes
  42  *     - Changed built-in images from GIF to PNG
  43  *       (with regard to Unisys patent issue)
  44  *     - Added a 4x4 pattern PNG which is less intrusive
  45  *       than the logo but also clearly marks the deleted banners
  46  *
  47  *    Revision 1.20  2002/03/04 17:53:22  oes
  48  *    Fixed compiled warning
  49  *
  50  *    Revision 1.19  2002/01/21 00:33:52  jongfoster
  51  *    Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
  52  *
  53  *    Revision 1.18  2001/11/16 00:46:31  jongfoster
  54  *    Fixing compiler warnings
  55  *
  56  *    Revision 1.17  2001/10/23 21:48:19  jongfoster
  57  *    Cleaning up error handling in CGI functions - they now send back
  58  *    a HTML error page and should never cause a FATAL error.  (Fixes one
  59  *    potential source of "denial of service" attacks).
  60  *
  61  *    CGI actions file editor that works and is actually useful.
  62  *
  63  *    Ability to toggle JunkBuster remotely using a CGI call.
  64  *
  65  *    You can turn off both the above features in the main configuration
  66  *    file, e.g. if you are running a multi-user proxy.
  67  *
  68  *    Revision 1.16  2001/09/16 17:08:54  jongfoster
  69  *    Moving simple CGI functions from cgi.c to new file cgisimple.c
  70  *
  71  *    Revision 1.15  2001/09/16 15:02:35  jongfoster
  72  *    Adding i.j.b/robots.txt.
  73  *    Inlining add_stats() since it's only ever called from one place.
  74  *
  75  *    Revision 1.14  2001/09/16 11:38:02  jongfoster
  76  *    Splitting fill_template() into 2 functions:
  77  *    template_load() loads the file
  78  *    template_fill() performs the PCRS regexps.
  79  *    This is because the CGI edit interface has a "table row"
  80  *    template which is used many times in the page - this
  81  *    change means it's only loaded from disk once.
  82  *
  83  *    Revision 1.13  2001/09/16 11:00:10  jongfoster
  84  *    New function alloc_http_response, for symmetry with free_http_response
  85  *
  86  *    Revision 1.12  2001/09/13 23:31:25  jongfoster
  87  *    Moving image data to cgi.c rather than cgi.h.
  88  *
  89  *    Revision 1.11  2001/08/05 16:06:20  jongfoster
  90  *    Modifiying "struct map" so that there are now separate header and
  91  *    "map_entry" structures.  This means that functions which modify a
  92  *    map no longer need to return a pointer to the modified map.
  93  *    Also, it no longer reverses the order of the entries (which may be
  94  *    important with some advanced template substitutions).
  95  *
  96  *    Revision 1.10  2001/08/01 21:19:22  jongfoster
  97  *    Moving file version information to a separate CGI page.
  98  *
  99  *    Revision 1.9  2001/08/01 00:17:54  jongfoster
 100  *    Adding prototype for map_conditional
 101  *
 102  *    Revision 1.8  2001/07/30 22:08:36  jongfoster
 103  *    Tidying up #defines:
 104  *    - All feature #defines are now of the form FEATURE_xxx
 105  *    - Permanently turned off WIN_GUI_EDIT
 106  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 107  *
 108  *    Revision 1.7  2001/07/29 18:43:08  jongfoster
 109  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 110  *    ANSI C rules.
 111  *
 112  *    Revision 1.6  2001/06/29 21:45:41  oes
 113  *    Indentation, CRLF->LF, Tab-> Space
 114  *
 115  *    Revision 1.5  2001/06/29 13:22:44  oes
 116  *    - Cleaned up
 117  *    - Added new functions: default_exports(), make_menu(),
 118  *      error_response() etc, ranamed others and changed
 119  *      param and return types.
 120  *    - Removed HTTP/HTML snipplets
 121  *    - Removed logentry from cancelled commit
 122  *
 123  *    Revision 1.4  2001/06/09 10:50:58  jongfoster
 124  *    Changing "show URL info" handler to new style.
 125  *    Adding "extern" to some function prototypes.
 126  *
 127  *    Revision 1.3  2001/06/03 19:12:16  oes
 128  *    introduced new cgi handling
 129  *
 130  *    No revisions before 1.3
 131  *
 132  **********************************************************************/
 133 \f
 134
 135 #include "project.h"
 136
 137 #ifdef __cplusplus
 138 extern "C" {
 139 #endif
 140
 141 /*
 142  * Main dispatch function
 143  */
 144 extern struct http_response *dispatch_cgi(struct client_state *csp);
 145
 146 /* Not exactly a CGI */
 147 extern struct http_response * error_response(struct client_state *csp,
 148                                              const char *templatename,
 149                                              int err);
 150
 151 /*
 152  * CGI support functions
 153  */
 154 extern struct http_response * alloc_http_response(void);
 155 extern void free_http_response(struct http_response *rsp);
 156
 157 extern struct http_response *finish_http_response(struct http_response *rsp);
 158
 159 extern struct map * default_exports(const struct client_state *csp, const char *caller);
 160
 161 extern jb_err map_block_killer (struct map *exports, const char *name);
 162 extern jb_err map_block_keep   (struct map *exports, const char *name);
 163 extern jb_err map_conditional  (struct map *exports, const char *name, int choose_first);
 164
 165 extern jb_err template_load(struct client_state *csp, char ** template_ptr,
 166                             const char *templatename);
 167 extern jb_err template_fill(char ** template_ptr, const struct map *exports);
 168 extern jb_err template_fill_for_cgi(struct client_state *csp,
 169                                     const char *templatename,
 170                                     struct map *exports,
 171                                     struct http_response *rsp);
 172
 173 extern void cgi_init_error_messages(void);
 174 extern struct http_response *cgi_error_memory(void);
 175 extern jb_err cgi_error_no_template(struct client_state *csp,
 176                                     struct http_response *rsp,
 177                                     const char *template_name);
 178 extern jb_err cgi_error_bad_param(struct client_state *csp,
 179                                   struct http_response *rsp);
 180
 181 /*
 182  * Text generators
 183  */
 184 extern void get_http_time(int time_offset, char * buf);
 185 extern char *make_menu(const char *self);
 186 extern char *dump_map(const struct map *the_map);
 187
 188 /*
 189  * Ad replacement images.
 190  */
 191 extern const char image_logo_data[];
 192 extern const size_t  image_logo_length;
 193 extern const char image_pattern_data[];
 194 extern const size_t  image_pattern_length;
 195 extern const char image_blank_data[];
 196 extern const size_t  image_blank_length;
 197
 198 /* Revision control strings from this header and associated .c file */
 199 extern const char cgi_rcs[];
 200 extern const char cgi_h_rcs[];
 201
 202 #ifdef __cplusplus
 203 } /* extern "C" */
 204 #endif
 205
 206 #endif /* ndef CGI_H_INCLUDED */
 207
 208 /*
 209   Local Variables:
 210   tab-width: 3
 211   end:
 212 */