X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.h;h=cbb2fb9be5809621c2b6ac5218c22c4b14c3b172;hp=cda223fd308c7a5f5b91976dfe3a269542e5937f;hb=bc7c06997f61b24d72a1f6f08e41ce0038cfd256;hpb=800fc5d0c1f6729fa6f48510860064caa811030e diff --git a/cgi.h b/cgi.h index cda223fd..cbb2fb9b 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.17 2001/10/23 21:48:19 jongfoster Exp $" +#define CGI_H_VERSION "$Id: cgi.h,v 1.34 2008/04/17 14:40:48 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,78 @@ * * Revisions : * $Log: cgi.h,v $ + * Revision 1.34 2008/04/17 14:40:48 fabiankeil + * Provide get_http_time() with the buffer size so it doesn't + * have to blindly assume that the buffer is big enough. + * + * 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 @@ -45,7 +117,7 @@ * * CGI actions file editor that works and is actually useful. * - * Ability to toggle JunkBuster remotely using a CGI call. + * 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. @@ -139,44 +211,63 @@ extern struct http_response * error_response(struct client_state *csp, extern struct http_response * alloc_http_response(void); extern void free_http_response(struct http_response *rsp); -extern struct http_response *finish_http_response(struct http_response *rsp); +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); 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); +extern jb_err template_load(const 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, +extern jb_err template_fill_for_cgi(const struct client_state *csp, const char *templatename, struct map *exports, struct http_response *rsp); extern void cgi_init_error_messages(void); extern struct http_response *cgi_error_memory(void); -extern jb_err cgi_error_no_template(struct client_state *csp, +extern jb_err cgi_redirect (struct http_response * rsp, const char *target); + +extern jb_err cgi_error_no_template(const struct client_state *csp, struct http_response *rsp, const char *template_name); -extern jb_err cgi_error_bad_param(struct client_state *csp, +extern jb_err cgi_error_bad_param(const struct client_state *csp, struct http_response *rsp); +extern jb_err cgi_error_disabled(const struct client_state *csp, + struct http_response *rsp); +extern jb_err cgi_error_unknown(const 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); /* * Text generators */ -extern void get_http_time(int time_offset, char * buf); -extern char *make_menu(const char *self); -extern char *dump_map(const struct map *map); +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); /* - * Some images. + * Ad replacement images */ -extern const char image_junkbuster_gif_data[]; -extern const int image_junkbuster_gif_length; -extern const char image_blank_gif_data[]; -extern const int image_blank_gif_length; - +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[];