cgi.h

   1 #ifndef CGI_H_INCLUDED
   2 #define CGI_H_INCLUDED
   3 #define CGI_H_VERSION "$Id: cgi.h,v 1.34 2008/04/17 14:40:48 fabiankeil 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-2007 the SourceForge
  15  *                Privoxy team. http://www.privoxy.org/
  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.34  2008/04/17 14:40:48  fabiankeil
  42  *    Provide get_http_time() with the buffer size so it doesn't
  43  *    have to blindly assume that the buffer is big enough.
  44  *
  45  *    Revision 1.33  2007/01/28 13:41:17  fabiankeil
  46  *    - Add HEAD support to finish_http_response.
  47  *    - Add error favicon to internal HTML error messages.
  48  *
  49  *    Revision 1.32  2006/12/17 17:53:39  fabiankeil
  50  *    Suppress the toggle link if remote toggling is disabled.
  51  *
  52  *    Revision 1.31  2006/07/18 14:48:45  david__schmidt
  53  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  54  *    with what was really the latest development (the v_3_0_branch branch)
  55  *
  56  *    Revision 1.29.2.2  2004/02/17 13:30:23  oes
  57  *    Moved cgi_error_disabled() from cgiedit.c to
  58  *    cgi.c to re-enable build with --disable-editor.
  59  *    Fixes Bug #892744. Thanks to Matthew Fischer
  60  *    for spotting.
  61  *
  62  *    Revision 1.29.2.1  2003/12/17 16:33:28  oes
  63  *    Added prototype of new function cgi_redirect
  64  *
  65  *    Revision 1.29  2002/05/19 11:33:21  jongfoster
  66  *    If a CGI error was not handled, and propogated back to
  67  *    dispatch_known_cgi(), then it was assumed to be "out of memory".
  68  *    This gave a very misleading error message.
  69  *
  70  *    Now other errors will cause a simple message giving the error
  71  *    number and asking the user to report a bug.
  72  *
  73  *    Bug report:
  74  *    http://sourceforge.net/tracker/index.php?func=detail
  75  *    &aid=557905&group_id=11118&atid=111118
  76  *
  77  *    Revision 1.28  2002/04/26 12:54:03  oes
  78  *    New function add_help_link
  79  *
  80  *    Revision 1.27  2002/04/24 02:16:51  oes
  81  *    Moved get_char_param, get_string_param and get_number_param here from cgiedit.c
  82  *
  83  *    Revision 1.26  2002/04/10 13:38:35  oes
  84  *    load_template signature changed
  85  *
  86  *    Revision 1.25  2002/04/08 20:50:25  swa
  87  *    fixed JB spelling
  88  *
  89  *    Revision 1.24  2002/03/26 22:29:54  swa
  90  *    we have a new homepage!
  91  *
  92  *    Revision 1.23  2002/03/24 16:18:15  jongfoster
  93  *    Removing old logo
  94  *
  95  *    Revision 1.22  2002/03/24 13:25:43  swa
  96  *    name change related issues
  97  *
  98  *    Revision 1.21  2002/03/07 03:48:38  oes
  99  *     - Changed built-in images from GIF to PNG
 100  *       (with regard to Unisys patent issue)
 101  *     - Added a 4x4 pattern PNG which is less intrusive
 102  *       than the logo but also clearly marks the deleted banners
 103  *
 104  *    Revision 1.20  2002/03/04 17:53:22  oes
 105  *    Fixed compiled warning
 106  *
 107  *    Revision 1.19  2002/01/21 00:33:52  jongfoster
 108  *    Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
 109  *
 110  *    Revision 1.18  2001/11/16 00:46:31  jongfoster
 111  *    Fixing compiler warnings
 112  *
 113  *    Revision 1.17  2001/10/23 21:48:19  jongfoster
 114  *    Cleaning up error handling in CGI functions - they now send back
 115  *    a HTML error page and should never cause a FATAL error.  (Fixes one
 116  *    potential source of "denial of service" attacks).
 117  *
 118  *    CGI actions file editor that works and is actually useful.
 119  *
 120  *    Ability to toggle Junkbuster remotely using a CGI call.
 121  *
 122  *    You can turn off both the above features in the main configuration
 123  *    file, e.g. if you are running a multi-user proxy.
 124  *
 125  *    Revision 1.16  2001/09/16 17:08:54  jongfoster
 126  *    Moving simple CGI functions from cgi.c to new file cgisimple.c
 127  *
 128  *    Revision 1.15  2001/09/16 15:02:35  jongfoster
 129  *    Adding i.j.b/robots.txt.
 130  *    Inlining add_stats() since it's only ever called from one place.
 131  *
 132  *    Revision 1.14  2001/09/16 11:38:02  jongfoster
 133  *    Splitting fill_template() into 2 functions:
 134  *    template_load() loads the file
 135  *    template_fill() performs the PCRS regexps.
 136  *    This is because the CGI edit interface has a "table row"
 137  *    template which is used many times in the page - this
 138  *    change means it's only loaded from disk once.
 139  *
 140  *    Revision 1.13  2001/09/16 11:00:10  jongfoster
 141  *    New function alloc_http_response, for symmetry with free_http_response
 142  *
 143  *    Revision 1.12  2001/09/13 23:31:25  jongfoster
 144  *    Moving image data to cgi.c rather than cgi.h.
 145  *
 146  *    Revision 1.11  2001/08/05 16:06:20  jongfoster
 147  *    Modifiying "struct map" so that there are now separate header and
 148  *    "map_entry" structures.  This means that functions which modify a
 149  *    map no longer need to return a pointer to the modified map.
 150  *    Also, it no longer reverses the order of the entries (which may be
 151  *    important with some advanced template substitutions).
 152  *
 153  *    Revision 1.10  2001/08/01 21:19:22  jongfoster
 154  *    Moving file version information to a separate CGI page.
 155  *
 156  *    Revision 1.9  2001/08/01 00:17:54  jongfoster
 157  *    Adding prototype for map_conditional
 158  *
 159  *    Revision 1.8  2001/07/30 22:08:36  jongfoster
 160  *    Tidying up #defines:
 161  *    - All feature #defines are now of the form FEATURE_xxx
 162  *    - Permanently turned off WIN_GUI_EDIT
 163  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 164  *
 165  *    Revision 1.7  2001/07/29 18:43:08  jongfoster
 166  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 167  *    ANSI C rules.
 168  *
 169  *    Revision 1.6  2001/06/29 21:45:41  oes
 170  *    Indentation, CRLF->LF, Tab-> Space
 171  *
 172  *    Revision 1.5  2001/06/29 13:22:44  oes
 173  *    - Cleaned up
 174  *    - Added new functions: default_exports(), make_menu(),
 175  *      error_response() etc, ranamed others and changed
 176  *      param and return types.
 177  *    - Removed HTTP/HTML snipplets
 178  *    - Removed logentry from cancelled commit
 179  *
 180  *    Revision 1.4  2001/06/09 10:50:58  jongfoster
 181  *    Changing "show URL info" handler to new style.
 182  *    Adding "extern" to some function prototypes.
 183  *
 184  *    Revision 1.3  2001/06/03 19:12:16  oes
 185  *    introduced new cgi handling
 186  *
 187  *    No revisions before 1.3
 188  *
 189  **********************************************************************/
 190 \f
 191
 192 #include "project.h"
 193
 194 #ifdef __cplusplus
 195 extern "C" {
 196 #endif
 197
 198 /*
 199  * Main dispatch function
 200  */
 201 extern struct http_response *dispatch_cgi(struct client_state *csp);
 202
 203 /* Not exactly a CGI */
 204 extern struct http_response * error_response(struct client_state *csp,
 205                                              const char *templatename,
 206                                              int err);
 207
 208 /*
 209  * CGI support functions
 210  */
 211 extern struct http_response * alloc_http_response(void);
 212 extern void free_http_response(struct http_response *rsp);
 213
 214 extern struct http_response *finish_http_response(const struct client_state *csp,
 215                                                   struct http_response *rsp);
 216
 217 extern struct map * default_exports(const struct client_state *csp, const char *caller);
 218
 219 extern jb_err map_block_killer (struct map *exports, const char *name);
 220 extern jb_err map_block_keep   (struct map *exports, const char *name);
 221 extern jb_err map_conditional  (struct map *exports, const char *name, int choose_first);
 222
 223 extern jb_err template_load(const struct client_state *csp, char ** template_ptr,
 224                             const char *templatename, int recursive);
 225 extern jb_err template_fill(char ** template_ptr, const struct map *exports);
 226 extern jb_err template_fill_for_cgi(const struct client_state *csp,
 227                                     const char *templatename,
 228                                     struct map *exports,
 229                                     struct http_response *rsp);
 230
 231 extern void cgi_init_error_messages(void);
 232 extern struct http_response *cgi_error_memory(void);
 233 extern jb_err cgi_redirect (struct http_response * rsp, const char *target);
 234
 235 extern jb_err cgi_error_no_template(const struct client_state *csp,
 236                                     struct http_response *rsp,
 237                                     const char *template_name);
 238 extern jb_err cgi_error_bad_param(const struct client_state *csp,
 239                                   struct http_response *rsp);
 240 extern jb_err cgi_error_disabled(const struct client_state *csp,
 241                                  struct http_response *rsp);
 242 extern jb_err cgi_error_unknown(const struct client_state *csp,
 243                          struct http_response *rsp,
 244                          jb_err error_to_report);
 245
 246 extern jb_err get_number_param(struct client_state *csp,
 247                                const struct map *parameters,
 248                                char *name,
 249                                unsigned *pvalue);
 250 extern jb_err get_string_param(const struct map *parameters,
 251                                const char *param_name,
 252                                const char **pparam);
 253 extern char   get_char_param(const struct map *parameters,
 254                              const char *param_name);
 255
 256 /*
 257  * Text generators
 258  */
 259 extern void get_http_time(int time_offset, char *buf, size_t buffer_size);
 260 extern char *add_help_link(const char *item, struct configuration_spec *config);
 261 extern char *make_menu(const char *self, const unsigned feature_flags);
 262 extern char *dump_map(const struct map *the_map);
 263
 264 /*
 265  * Ad replacement images
 266  */
 267 extern const char image_pattern_data[];
 268 extern const size_t  image_pattern_length;
 269 extern const char image_blank_data[];
 270 extern const size_t  image_blank_length;
 271
 272 /* Revision control strings from this header and associated .c file */
 273 extern const char cgi_rcs[];
 274 extern const char cgi_h_rcs[];
 275
 276 #ifdef __cplusplus
 277 } /* extern "C" */
 278 #endif
 279
 280 #endif /* ndef CGI_H_INCLUDED */
 281
 282 /*
 283   Local Variables:
 284   tab-width: 3
 285   end:
 286 */