X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.h;h=c73ca20148390e33cc969680c69e7ca308fc522c;hp=9008744cde3f750c3b2ee5c8ce63c022e89fd66a;hb=bad55634165b116a64244e1ecd91bcdda5a2d2b2;hpb=cf9045e1db210200fc227ea0e3206d211aa9eda8 diff --git a/cgi.h b/cgi.h index 9008744c..c73ca201 100644 --- a/cgi.h +++ b/cgi.h @@ -1,6 +1,6 @@ #ifndef CGI_H_INCLUDED #define CGI_H_INCLUDED -#define CGI_H_VERSION "$Id: cgi.h,v 1.8 2001/07/30 22:08:36 jongfoster Exp $" +#define CGI_H_VERSION "$Id: cgi.h,v 1.33 2007/01/28 13:41:17 fabiankeil Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.h,v $ @@ -11,8 +11,8 @@ * Functions declared include: * * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -38,6 +38,120 @@ * * Revisions : * $Log: cgi.h,v $ + * Revision 1.33 2007/01/28 13:41:17 fabiankeil + * - Add HEAD support to finish_http_response. + * - Add error favicon to internal HTML error messages. + * + * Revision 1.32 2006/12/17 17:53:39 fabiankeil + * Suppress the toggle link if remote toggling is disabled. + * + * Revision 1.31 2006/07/18 14:48:45 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.29.2.2 2004/02/17 13:30:23 oes + * Moved cgi_error_disabled() from cgiedit.c to + * cgi.c to re-enable build with --disable-editor. + * Fixes Bug #892744. Thanks to Matthew Fischer + * for spotting. + * + * Revision 1.29.2.1 2003/12/17 16:33:28 oes + * Added prototype of new function cgi_redirect + * + * Revision 1.29 2002/05/19 11:33:21 jongfoster + * If a CGI error was not handled, and propogated back to + * dispatch_known_cgi(), then it was assumed to be "out of memory". + * This gave a very misleading error message. + * + * Now other errors will cause a simple message giving the error + * number and asking the user to report a bug. + * + * Bug report: + * http://sourceforge.net/tracker/index.php?func=detail + * &aid=557905&group_id=11118&atid=111118 + * + * Revision 1.28 2002/04/26 12:54:03 oes + * New function add_help_link + * + * Revision 1.27 2002/04/24 02:16:51 oes + * Moved get_char_param, get_string_param and get_number_param here from cgiedit.c + * + * Revision 1.26 2002/04/10 13:38:35 oes + * load_template signature changed + * + * Revision 1.25 2002/04/08 20:50:25 swa + * fixed JB spelling + * + * Revision 1.24 2002/03/26 22:29:54 swa + * we have a new homepage! + * + * Revision 1.23 2002/03/24 16:18:15 jongfoster + * Removing old logo + * + * Revision 1.22 2002/03/24 13:25:43 swa + * name change related issues + * + * Revision 1.21 2002/03/07 03:48:38 oes + * - Changed built-in images from GIF to PNG + * (with regard to Unisys patent issue) + * - Added a 4x4 pattern PNG which is less intrusive + * than the logo but also clearly marks the deleted banners + * + * Revision 1.20 2002/03/04 17:53:22 oes + * Fixed compiled warning + * + * Revision 1.19 2002/01/21 00:33:52 jongfoster + * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML. + * + * Revision 1.18 2001/11/16 00:46:31 jongfoster + * Fixing compiler warnings + * + * Revision 1.17 2001/10/23 21:48:19 jongfoster + * Cleaning up error handling in CGI functions - they now send back + * a HTML error page and should never cause a FATAL error. (Fixes one + * potential source of "denial of service" attacks). + * + * CGI actions file editor that works and is actually useful. + * + * Ability to toggle Junkbuster remotely using a CGI call. + * + * You can turn off both the above features in the main configuration + * file, e.g. if you are running a multi-user proxy. + * + * Revision 1.16 2001/09/16 17:08:54 jongfoster + * Moving simple CGI functions from cgi.c to new file cgisimple.c + * + * Revision 1.15 2001/09/16 15:02:35 jongfoster + * Adding i.j.b/robots.txt. + * Inlining add_stats() since it's only ever called from one place. + * + * Revision 1.14 2001/09/16 11:38:02 jongfoster + * Splitting fill_template() into 2 functions: + * template_load() loads the file + * template_fill() performs the PCRS regexps. + * This is because the CGI edit interface has a "table row" + * template which is used many times in the page - this + * change means it's only loaded from disk once. + * + * Revision 1.13 2001/09/16 11:00:10 jongfoster + * New function alloc_http_response, for symmetry with free_http_response + * + * Revision 1.12 2001/09/13 23:31:25 jongfoster + * Moving image data to cgi.c rather than cgi.h. + * + * Revision 1.11 2001/08/05 16:06:20 jongfoster + * Modifiying "struct map" so that there are now separate header and + * "map_entry" structures. This means that functions which modify a + * map no longer need to return a pointer to the modified map. + * Also, it no longer reverses the order of the entries (which may be + * important with some advanced template substitutions). + * + * Revision 1.10 2001/08/01 21:19:22 jongfoster + * Moving file version information to a separate CGI page. + * + * Revision 1.9 2001/08/01 00:17:54 jongfoster + * Adding prototype for map_conditional + * * Revision 1.8 2001/07/30 22:08:36 jongfoster * Tidying up #defines: * - All feature #defines are now of the form FEATURE_xxx @@ -78,69 +192,78 @@ extern "C" { #endif /* - * Dispatch & parameter parsing functions + * Main dispatch function */ extern struct http_response *dispatch_cgi(struct client_state *csp); -extern struct map *parse_cgi_parameters(char *argstring); - -/* - * CGI functions - */ -extern int cgi_default(struct client_state *csp, struct http_response *rsp, - struct map *parameters); -extern int cgi_show_status(struct client_state *csp, struct http_response *rsp, - struct map *parameters); -extern int cgi_show_url_info(struct client_state *csp, struct http_response *rsp, - struct map *parameters); -extern int cgi_send_banner(struct client_state *csp, struct http_response *rsp, - struct map *parameters); /* Not exactly a CGI */ -extern struct http_response *error_response(struct client_state *csp, const char *template, int err); +extern struct http_response * error_response(struct client_state *csp, + const char *templatename, + int err); /* * CGI support functions */ -extern struct http_response *finish_http_response(struct http_response *rsp); +extern struct http_response * alloc_http_response(void); extern void free_http_response(struct http_response *rsp); -extern struct map *default_exports(struct client_state *csp, char *caller); -extern struct map *map_block_killer(struct map *map, char *name); -extern struct map *map_conditional(struct map *exports, char *name, int choose_first); -extern char *fill_template(struct client_state *csp, const char *template, struct map *exports); +extern struct http_response *finish_http_response(const struct client_state *csp, + struct http_response *rsp); +extern struct map * default_exports(const struct client_state *csp, const char *caller); -/* - * Text generators - */ -extern char *make_menu(const char *self); -extern char *dump_map(struct map *map); +extern jb_err map_block_killer (struct map *exports, const char *name); +extern jb_err map_block_keep (struct map *exports, const char *name); +extern jb_err map_conditional (struct map *exports, const char *name, int choose_first); + +extern jb_err template_load(struct client_state *csp, char ** template_ptr, + const char *templatename, int recursive); +extern jb_err template_fill(char ** template_ptr, const struct map *exports); +extern jb_err template_fill_for_cgi(struct client_state *csp, + const char *templatename, + struct map *exports, + struct http_response *rsp); -#ifdef FEATURE_STATISTICS -extern struct map *add_stats(struct map *exports); -#endif /* def FEATURE_STATISTICS */ +extern void cgi_init_error_messages(void); +extern struct http_response *cgi_error_memory(void); +extern jb_err cgi_redirect (struct http_response * rsp, const char *target); +extern jb_err cgi_error_no_template(struct client_state *csp, + struct http_response *rsp, + const char *template_name); +extern jb_err cgi_error_bad_param(struct client_state *csp, + struct http_response *rsp); +extern jb_err cgi_error_disabled(struct client_state *csp, + struct http_response *rsp); +extern jb_err cgi_error_unknown(struct client_state *csp, + struct http_response *rsp, + jb_err error_to_report); + +extern jb_err get_number_param(struct client_state *csp, + const struct map *parameters, + char *name, + unsigned *pvalue); +extern jb_err get_string_param(const struct map *parameters, + const char *param_name, + const char **pparam); +extern char get_char_param(const struct map *parameters, + const char *param_name); /* - * Hint: You can encode your own GIFs like that: - * perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }' + * Text generators */ +extern void get_http_time(int time_offset, char *buf, size_t buffer_size); +extern char *add_help_link(const char *item, struct configuration_spec *config); +extern char *make_menu(const char *self, const unsigned feature_flags); +extern char *dump_map(const struct map *the_map); -static const char JBGIF[] = - "GIF89aD\000\013\000\360\000\000\000\000\000\377\377\377!" - "\371\004\001\000\000\001\000,\000\000\000\000D\000\013\000" - "\000\002a\214\217\251\313\355\277\000\200G&K\025\316hC\037" - "\200\234\230Y\2309\235S\230\266\206\372J\253<\3131\253\271" - "\270\215\342\254\013\203\371\202\264\334P\207\332\020o\266" - "N\215I\332=\211\312\3513\266:\026AK)\364\370\365aobr\305" - "\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276" - "\037Q\000\000;"; - -static const char BLANKGIF[] = - "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000" - "\000!\371\004\001\000\000\000\000,\000\000\000\000\001" - "\000\001\000\000\002\002D\001\000;"; - +/* + * Ad replacement images + */ +extern const char image_pattern_data[]; +extern const size_t image_pattern_length; +extern const char image_blank_data[]; +extern const size_t image_blank_length; /* Revision control strings from this header and associated .c file */ extern const char cgi_rcs[];