X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.h;h=e4a132ee17c32702aeddf5d922e386ceb27b53ef;hp=2217b06521dae323663619046b38557c98fcbbe1;hb=23445442f4bf0aa0bcf6e35df09daf8ef0d69d99;hpb=0c1c3e0f9caa559cd00bd2081240d2822c46a66b diff --git a/cgi.h b/cgi.h index 2217b065..e4a132ee 100644 --- a/cgi.h +++ b/cgi.h @@ -1,24 +1,23 @@ #ifndef CGI_H_INCLUDED #define CGI_H_INCLUDED -#define CGI_H_VERSION "$Id: cgi.h,v 1.11 2001/08/05 16:06:20 jongfoster 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. - * + * html or gif answers, and to compose HTTP responses. + * * 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. https://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,121 +35,90 @@ * 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.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 - * - Permanently turned off WIN_GUI_EDIT - * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS - * - * Revision 1.7 2001/07/29 18:43:08 jongfoster - * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to - * ANSI C rules. - * - * 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_show_version(struct client_state *csp, struct http_response *rsp, - struct map *parameters); -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 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 void map_block_killer(struct map *map, const char *name); -extern void map_conditional(struct map *exports, const char *name, int choose_first); -extern char *fill_template(struct client_state *csp, const char *templatename, struct map *exports); +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(const struct map *map); - -#ifdef FEATURE_STATISTICS -extern struct map *add_stats(struct map *exports); -#endif /* def FEATURE_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 *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; - - -/* 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 +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; #endif /* ndef CGI_H_INCLUDED */