-#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
+#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 $
* 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
*
* Revisions :
* $Log: cgi.h,v $
- * Revision 1.3 2001/06/03 19:12:16 oes
- * introduced new cgi handling
+ * 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.1 2001/06/03 11:04:49 oes
- * Makefile/in
+ * Revision 1.28 2002/04/26 12:54:03 oes
+ * New function add_help_link
*
- * introduced cgi.c
+ * 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
*
- * actions.c:
+ * Revision 1.26 2002/04/10 13:38:35 oes
+ * load_template signature changed
*
- * adapted to new enlist_unique arg format
+ * Revision 1.25 2002/04/08 20:50:25 swa
+ * fixed JB spelling
*
- * conf loadcfg.c
+ * Revision 1.24 2002/03/26 22:29:54 swa
+ * we have a new homepage!
*
- * introduced confdir option
+ * Revision 1.23 2002/03/24 16:18:15 jongfoster
+ * Removing old logo
*
- * filters.c filtrers.h
+ * Revision 1.22 2002/03/24 13:25:43 swa
+ * name change related issues
*
- * extracted-CGI relevant stuff
+ * 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
*
- * jbsockets.c
+ * Revision 1.20 2002/03/04 17:53:22 oes
+ * Fixed compiled warning
*
- * filled comment
+ * 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.
*
- * jcc.c
+ * Revision 1.18 2001/11/16 00:46:31 jongfoster
+ * Fixing compiler warnings
*
- * support for new cgi mechansim
+ * 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).
*
- * list.c list.h
+ * CGI actions file editor that works and is actually useful.
*
- * functions for new list type: "map"
- * extended enlist_unique
+ * Ability to toggle Junkbuster remotely using a CGI call.
*
- * miscutil.c .h
- * introduced bindup()
+ * You can turn off both the above features in the main configuration
+ * file, e.g. if you are running a multi-user proxy.
*
- * parsers.c parsers.h
+ * Revision 1.16 2001/09/16 17:08:54 jongfoster
+ * Moving simple CGI functions from cgi.c to new file cgisimple.c
*
- * deleted const struct interceptors
+ * 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.
*
- * pcrs.c
- * added FIXME
+ * 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.
*
- * project.h
+ * Revision 1.13 2001/09/16 11:00:10 jongfoster
+ * New function alloc_http_response, for symmetry with free_http_response
*
- * added struct map
- * added struct http_response
- * changes struct interceptors to struct cgi_dispatcher
- * moved HTML stuff to cgi.h
+ * Revision 1.12 2001/09/13 23:31:25 jongfoster
+ * Moving image data to cgi.c rather than cgi.h.
*
- * re_filterfile:
+ * 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).
*
- * changed
+ * Revision 1.10 2001/08/01 21:19:22 jongfoster
+ * Moving file version information to a separate CGI page.
*
- * showargs.c
- * NO TIME LEFT
+ * 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
*
**********************************************************************/
\f
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,\r
- 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;";
+/*
+ * Main dispatch function
+ */
+extern struct http_response *dispatch_cgi(struct client_state *csp);
-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;";
+/* Not exactly a CGI */
+extern struct http_response * error_response(struct client_state *csp,
+ const char *templatename,
+ int err);
-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"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: Request for blocked URL</title>\n"
- "</head>\n"
- WHITEBG
- "<center><h1>"
- BANNER
- "</h1></center>\n"
- "<p align=center>Your request for <b>%s%s</b>\n"
- "was blocked.<br><a href=\"http://i.j.b/show-url-info?url=%s%s\">See why</a>"
-#ifdef FORCE_LOAD
- " or <a href=\"http://%s" FORCE_PREFIX "%s\">"
- "go there anyway.</a>"
-#endif /* def FORCE_LOAD */
- "</p>\n"
- "</body>\n"
- "</html>\n";
+/*
+ * CGI support functions
+ */
+extern struct http_response * alloc_http_response(void);
+extern void free_http_response(struct http_response *rsp);
-#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"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: Request for untrusted URL</title>\n"
- "</head>\n"
- WHITEBG
- "<center>"
- "<a href=http://i.j.b/ij-untrusted-url?%s+%s+%s>"
- BANNER
- "</a>"
- "</center>"
- "</body>\n"
- "</html>\n";
-#endif /* def TRUST_FILES */
+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);
-static const char C_HOME_PAGE[] =
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: Information</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</h1></center>\n"
- "<p><a href=\"" HOME_PAGE_URL "\">JunkBuster web site</a></p>\n"
- "<p><a href=\"http://i.j.b/show-proxy-arg\">Proxy configuration</a></p>\n"
- "<p><a href=\"http://i.j.b/show-url-info\">Look up a URL</a></p>\n"
- "</body>\n"
- "</html>\n";
+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);
-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"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: URL Info</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</h1></center>\n"
- "<p>Information for: <a href=\"http://%s\">http://%s</a></p>\n";
-static const char C_URL_INFO_FOOTER[] =
- "\n</p>\n"
- "</body>\n"
- "</html>\n";
+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);
-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"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: URL Info</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</h1></center>\n"
- "<form method=\"GET\" action=\"http://i.j.b/show-url-info\">\n"
- "<p>Please enter a URL, without the leading "http://":</p>"
- "<p><input type=\"text\" name=\"url\" size=\"80\">"
- "<input type=\"submit\" value=\"Info\"></p>\n"
- "</form>\n"
- "</body>\n"
- "</html>\n";
+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);
-static const char CFAIL[] =
- "HTTP/1.0 503 Connect failed\n"
- "Content-Type: text/html\n\n"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: Connect failed</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</center></h1>"
- "TCP connection to '%s' failed: %s.\n<br>"
- "</body>\n"
- "</html>\n";
+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);
-static const char CNXDOM[] =
- "HTTP/1.0 404 Non-existent domain\n"
- "Content-Type: text/html\n\n"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: Non-existent domain</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</center></h1>"
- "No such domain: %s\n"
- "</body>\n"
- "</html>\n";
+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);
-static const char CNOBANNER[] =
- "HTTP/1.0 200 No Banner\n"
- "Content-Type: text/html\n\n"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: No Banner</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</h1>"
- "You asked for a banner that this proxy can't produce because either configuration does not permit.\n<br>"
- "or the URL didn't end with .gif\n"
- "</center></body>\n"
- "</html>\n";
+/*
+ * 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);
+/*
+ * 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[];
} /* extern "C" */
#endif
-#endif /* ndef _CGI_H */
+#endif /* ndef CGI_H_INCLUDED */
/*
Local Variables:
projects / privoxy.git / blobdiff