X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.h;h=be1dbf7b08beb84c7a0400df0217a96126d71fd5;hp=dfdfa459d9cbe5606c78e12af3ac185d90c23beb;hb=bbd036550253068aa71a1a9c651f298ad6bcd549;hpb=3e5aa1e1d1a0e1c28619c2388be8c1a0ae4fbeb9 diff --git a/cgi.h b/cgi.h index dfdfa459..be1dbf7b 100644 --- a/cgi.h +++ b/cgi.h @@ -1,24 +1,24 @@ #ifndef CGI_H_INCLUDED #define CGI_H_INCLUDED -#define CGI_H_VERSION "$Id: cgi.h,v 1.6 2001/06/29 21:45:41 oes Exp $" +#define CGI_H_VERSION "$Id: cgi.h,v 1.42 2012/11/09 10:47:42 fabiankeil Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.h,v $ * * Purpose : Declares functions to intercept request, generate * html or gif answers, and to compose HTTP resonses. - * + * * 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-2009 the + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General * Public License as published by the Free Software * Foundation; either version 2 of the License, or (at @@ -36,109 +36,96 @@ * or write to the Free Software Foundation, Inc., 59 * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - * Revisions : - * $Log: cgi.h,v $ - * Revision 1.6 2001/06/29 21:45:41 oes - * Indentation, CRLF->LF, Tab-> Space - * - * Revision 1.5 2001/06/29 13:22:44 oes - * - Cleaned up - * - Added new functions: default_exports(), make_menu(), - * error_response() etc, ranamed others and changed - * param and return types. - * - Removed HTTP/HTML snipplets - * - Removed logentry from cancelled commit - * - * Revision 1.4 2001/06/09 10:50:58 jongfoster - * Changing "show URL info" handler to new style. - * Adding "extern" to some function prototypes. - * - * Revision 1.3 2001/06/03 19:12:16 oes - * introduced new cgi handling - * - * No revisions before 1.3 - * **********************************************************************/ - -#include "project.h" -#ifdef __cplusplus -extern "C" { -#endif +#include "project.h" /* - * 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); /* * 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 char *fill_template(struct client_state *csp, const char *template, struct map *exports); - +extern struct http_response *finish_http_response(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(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(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_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(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); +#ifdef FEATURE_COMPRESSION +/* + * Minimum length which a buffer has to reach before + * we bother to (re-)compress it. Completely arbitrary. + */ +extern const size_t LOWER_LENGTH_LIMIT_FOR_COMPRESSION; +extern char *compress_buffer(char *buffer, size_t *buffer_length, int compression_level); +#endif /* * Text generators */ -extern char *make_menu(const char *self); -extern char *dump_map(struct map *map); - -#ifdef STATISTICS -extern struct map *add_stats(struct map *exports); -#endif /* def STATISTICS */ - +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); /* - * Hint: You can encode your own GIFs like that: - * perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }' + * Ad replacement images */ - -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;"; - +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[]; extern const char cgi_h_rcs[]; -#ifdef __cplusplus -} /* extern "C" */ -#endif - #endif /* ndef CGI_H_INCLUDED */ /*