X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.h;h=e4a132ee17c32702aeddf5d922e386ceb27b53ef;hp=8d7484ae04fe35b50699b782b72fbb1d5095be3f;hb=5d67369224f780b21d94cacf31dbcdf288c7ed6c;hpb=fef47f1318a4147305d5645290a8f4d72cdddf5c diff --git a/cgi.h b/cgi.h index 8d7484ae..e4a132ee 100644 --- a/cgi.h +++ b/cgi.h @@ -1,24 +1,23 @@ -#ifndef _CGI_H -#define _CGI_H -#define CGI_H_VERSION "$Id: cgi.h,v 1.3 2001/06/03 19:12:16 oes Exp $" +#ifndef CGI_H_INCLUDED +#define CGI_H_INCLUDED /********************************************************************* * * 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,287 +35,92 @@ * 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.3 2001/06/03 19:12:16 oes - * introduced new cgi handling - * - * Revision 1.1 2001/06/03 11:04:49 oes - * Makefile/in - * - * introduced cgi.c - * - * actions.c: - * - * adapted to new enlist_unique arg format - * - * conf loadcfg.c - * - * introduced confdir option - * - * filters.c filtrers.h - * - * extracted-CGI relevant stuff - * - * jbsockets.c - * - * filled comment - * - * jcc.c - * - * support for new cgi mechansim - * - * list.c list.h - * - * functions for new list type: "map" - * extended enlist_unique - * - * miscutil.c .h - * introduced bindup() - * - * parsers.c parsers.h - * - * deleted const struct interceptors - * - * pcrs.c - * added FIXME - * - * project.h - * - * added struct map - * added struct http_response - * changes struct interceptors to struct cgi_dispatcher - * moved HTML stuff to cgi.h - * - * re_filterfile: - * - * changed - * - * showargs.c - * NO TIME LEFT - * - * - * **********************************************************************/ - - -#include "project.h" -#ifdef __cplusplus -extern "C" { -#endif - -extern struct http_response *cgi_dispatch(struct client_state *csp); -extern int make_http_response(struct http_response *rsp); -extern void free_http_response(struct http_response *rsp); - -extern struct map *parse_cgi(char *argstring); -extern char *dump_map(struct map *map); - -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 char *redirect_url(struct http_request *http, struct client_state *csp); -extern int cgi_send_banner(struct client_state *csp, struct http_response *rsp, - struct map *parameters); - - - -#ifdef TRUST_FILES -extern char *ij_untrusted_url(struct http_request *http, struct client_state *csp); -#endif /* def TRUST_FILES */ - - - -#ifdef STATISTICS -extern char *add_stats(char *s); -#endif /* def STATISTICS */ - -static const char CJBGIF[] = - "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 CBLANKGIF[] = - "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;"; -static const char CBLOCK[] = -#ifdef AMIGA - "HTTP/1.0 403 Request for blocked URL\n" -#else /* ifndef AMIGA */ - "HTTP/1.0 202 Request for blocked URL\n" -#endif /* ndef AMIGA */ - "Pragma: no-cache\n" - "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT\n" - "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\n" - "Content-Type: text/html\n\n" - "\n" - "\n" - "Internet Junkbuster: Request for blocked URL\n" - "\n" - WHITEBG - "

" - BANNER - "

\n" - "

Your request for %s%s\n" - "was blocked.
See why" -#ifdef FORCE_LOAD - " or " - "go there anyway." -#endif /* def FORCE_LOAD */ - "

\n" - "\n" - "\n"; - -#ifdef TRUST_FILES -static const char CTRUST[] = -#ifdef AMIGA - "HTTP/1.0 403 Request for untrusted URL\n" -#else /* ifndef AMIGA */ - "HTTP/1.0 202 Request for untrusted URL\n" -#endif /* ndef AMIGA */ - "Pragma: no-cache\n" - "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT\n" - "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\n" - "Content-Type: text/html\n\n" - "\n" - "\n" - "Internet Junkbuster: Request for untrusted URL\n" - "\n" - WHITEBG - "
" - "" - BANNER - "" - "
" - "\n" - "\n"; -#endif /* def TRUST_FILES */ - - -static const char C_HOME_PAGE[] = - "\n" - "\n" - "Internet Junkbuster: Information\n" - "\n" - BODY - "

" - BANNER - "

\n" - "

JunkBuster web site

\n" - "

Proxy configuration

\n" - "

Look up a URL

\n" - "\n" - "\n"; - -static const char C_URL_INFO_HEADER[] = - "HTTP/1.0 200 OK\n" - "Pragma: no-cache\n" - "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\n" - "Content-Type: text/html\n\n" - "\n" - "\n" - "Internet Junkbuster: URL Info\n" - "\n" - BODY - "

" - BANNER - "

\n" - "

Information for: http://%s

\n"; -static const char C_URL_INFO_FOOTER[] = - "\n

\n" - "\n" - "\n"; - -static const char C_URL_INFO_FORM[] = - "HTTP/1.0 200 OK\n" - "Pragma: no-cache\n" - "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\n" - "Content-Type: text/html\n\n" - "\n" - "\n" - "Internet Junkbuster: URL Info\n" - "\n" - BODY - "

" - BANNER - "

\n" - "
\n" - "

Please enter a URL, without the leading "http://":

" - "

" - "

\n" - "
\n" - "\n" - "\n"; - -static const char CFAIL[] = - "HTTP/1.0 503 Connect failed\n" - "Content-Type: text/html\n\n" - "\n" - "\n" - "Internet Junkbuster: Connect failed\n" - "\n" - BODY - "

" - BANNER - "

" - "TCP connection to '%s' failed: %s.\n
" - "\n" - "\n"; - -static const char CNXDOM[] = - "HTTP/1.0 404 Non-existent domain\n" - "Content-Type: text/html\n\n" - "\n" - "\n" - "Internet Junkbuster: Non-existent domain\n" - "\n" - BODY - "

" - BANNER - "

" - "No such domain: %s\n" - "\n" - "\n"; +#include "project.h" -static const char CNOBANNER[] = - "HTTP/1.0 200 No Banner\n" - "Content-Type: text/html\n\n" - "\n" - "\n" - "Internet Junkbuster: No Banner\n" - "\n" - BODY - "

" - BANNER - "

" - "You asked for a banner that this proxy can't produce because either configuration does not permit.\n
" - "or the URL didn't end with .gif\n" - "\n" - "\n"; +/* + * Main dispatch function + */ +extern struct http_response *dispatch_cgi(struct client_state *csp); +/* Not exactly a CGI */ +extern struct http_response *error_response(struct client_state *csp, + const char *templatename); -/* Revision control strings from this header and associated .c file */ -extern const char cgi_rcs[]; -extern const char cgi_h_rcs[]; +/* + * CGI support functions + */ +extern struct http_response * alloc_http_response(void); +extern void free_http_response(struct http_response *rsp); -#ifdef __cplusplus -} /* extern "C" */ +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 -#endif /* ndef _CGI_H */ +/* + * 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 *dump_map(const struct map *the_map); + +/* + * 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; + +#endif /* ndef CGI_H_INCLUDED */ /* Local Variables: