#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 $"
+#define CGI_H_VERSION "$Id: cgi.h,v 1.27 2002/04/24 02:16:51 oes Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgi.h,v $
*
*
* Copyright : Written by and Copyright (C) 2001 the SourceForge
- * IJBSWA team. http://ijbswa.sourceforge.net
+ * 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.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
+ * potential source of "denial of service" attacks).
+ *
+ * CGI actions file editor that works and is actually useful.
+ *
+ * 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.
+ *
+ * Revision 1.16 2001/09/16 17:08:54 jongfoster
+ * Moving simple CGI functions from cgi.c to new file cgisimple.c
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * Revision 1.13 2001/09/16 11:00:10 jongfoster
+ * New function alloc_http_response, for symmetry with free_http_response
+ *
+ * Revision 1.12 2001/09/13 23:31:25 jongfoster
+ * Moving image data to cgi.c rather than cgi.h.
+ *
* 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
#endif
/*
- * 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,
+ int err);
/*
* 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 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(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);
+
+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,
+ 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 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 *add_help_link(const char *item, struct configuration_spec *config);
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 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[];