---

cgisimple.h File Reference

Declares functions to intercept request, generate html or gif answers, and to compose HTTP resonses. More...

Go to the source code of this file.

Defines
#define	CGISIMPLE_H_VERSION   "$Id: cgisimple.h,v 2.0 2002/06/04 14:34:21 jongfoster Exp $"
Functions
jb_err	cgi_default (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_error_404 (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_robots_txt (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_send_banner (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_show_status (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_show_url_info (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_show_version (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_show_request (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_transparent_image (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
jb_err	cgi_send_stylesheet (struct client_state *csp, struct http_response *rsp, const struct map *parameters)
Variables
const char	cgisimple_rcs []
const char	cgisimple_h_rcs []

---

Detailed Description

Declares functions to intercept request, generate html or gif answers, and to compose HTTP resonses.

Functions declared include:

Log:

cgisimple.h,v

Revision 2.0 2002/06/04 14:34:21 jongfoster Moving source files to src/

Revision 1.11 2002/04/05 15:50:53 oes added send-stylesheet CGI

Revision 1.10 2002/03/26 22:29:54 swa we have a new homepage!

Revision 1.9 2002/03/24 13:25:43 swa name change related issues

Revision 1.8 2002/03/16 23:54:06 jongfoster Adding graceful termination feature, to help look for memory leaks. If you enable this (which, by design, has to be done by hand editing config.h) and then go to http://i.j.b/die, then the program will exit cleanly after the *next* request. It should free all the memory that was used.

Revision 1.7 2002/03/08 16:43:59 oes Renamed cgi_transparent_png to cgi_transparent_image

Revision 1.6 2002/03/07 03:48:59 oes

• Changed built-in images from GIF to PNG (with regard to Unisys patent issue)

Revision 1.5 2002/01/22 23:26:03 jongfoster Adding cgi_transparent_gif() for http://i.j.b/t

Revision 1.4 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.3 2001/10/14 22:00:32 jongfoster Adding support for a 404 error when an invalid CGI page is requested.

Revision 1.2 2001/10/02 15:31:20 oes Introduced show-request cgi

Revision 1.1 2001/09/16 17:08:54 jongfoster Moving simple CGI functions from cgi.c to new file cgisimple.c

---

Function Documentation

jb_err cgi_default (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function that is called for the CGI_SITE_1_HOST and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs. Boring - only exports the default exports. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: None Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory

jb_err cgi_error_404 (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function that is called if an unknown action was given. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: None Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

jb_err cgi_robots_txt (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function to return "/robots.txt". Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: None Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

jb_err cgi_send_banner (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function that returns a banner. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: type Selects the type of banner between "trans", "logo", and "auto". Defaults to "logo" if absent or invalid. "auto" means to select as if we were image-blocking. (Only the first character really counts). Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

jb_err cgi_send_stylesheet (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function that sends a css stylesheet found in the cgi-style.css template. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: None Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

jb_err cgi_show_request (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

Show the client's request and what sed() would have made of it. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: None Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

jb_err cgi_show_status (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function that returns a a web page describing the current status of Privoxy. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: file Which file to show. Only first letter is checked, valid values are: "p"ermissions (actions) file "r"egex "t"rust Default is to show menu and other information. Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

jb_err cgi_show_url_info (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function that determines and shows which actions Privoxy will perform for a given url, and which matches starting from the defaults have lead to that. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: url The url whose actions are to be determined. If url is unset, the url-given conditional will be set, so that all but the form can be suppressed in the template. Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

jb_err cgi_show_version (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function that returns a a web page describing the file versions of Privoxy. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: None Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

jb_err cgi_transparent_image (  struct client_state *    csp, struct http_response *    rsp, const struct map *    parameters )

CGI function that sends a 1x1 transparent image. Parameters: csp  Current client state (buffers, headers, etc...) rsp  http_response data structure for output parameters  map of cgi parameters CGI Parameters: None Returns: JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

---

Variable Documentation

const char cgisimple_h_rcs[]

Version information about cgisimple.h.

const char cgisimple_rcs[]

Version information about cgisimple.c.

---