Main Page   Alphabetical List   Data Structures   File List   Data Fields   Globals  

cgisimple.c File Reference

Simple CGIs to get information about Privoxy's status. More...


Defines

#define SHOW_RCS(__x)

Functions

char * show_rcs (void)
jb_err show_defines (struct map *exports)
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_show_request (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_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)
jb_err cgi_show_version (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_robots_txt (struct client_state *csp, struct http_response *rsp, const struct map *parameters)

Variables

const char cgisimple_rcs [] = "$Id: cgisimple.c,v 2.0 2002/06/04 14:34:21 jongfoster Exp $"
const char cgisimple_h_rcs [] = CGISIMPLE_H_VERSION

Detailed Description

Simple CGIs to get information about Privoxy's status.

Functions declared include:

Log:
cgisimple.c,v
Revision 2.0 2002/06/04 14:34:21 jongfoster Moving source files to src/

Revision 1.35 2002/05/12 21:44:44 jongfoster Adding amiga.[ch] revision information, if on an amiga.

Revision 1.34 2002/04/30 12:06:12 oes Deleted unused code from default_cgi

Revision 1.33 2002/04/30 11:14:52 oes Made csp the first parameter in *action_to_html

Revision 1.32 2002/04/26 18:29:13 jongfoster Fixing this Visual C++ warning: cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch

Revision 1.31 2002/04/26 12:54:36 oes

Revision 1.30 2002/04/24 02:18:08 oes Revision 1.29 2002/04/10 13:38:35 oes load_template signature changed

Revision 1.28 2002/04/07 15:42:12 jongfoster Fixing send-banner?type=auto when the image-blocker is a redirect to send-banner

Revision 1.27 2002/04/05 15:50:48 oes added send-stylesheet CGI

Revision 1.26 2002/04/04 00:36:36 gliptak always use pcre for matching

Revision 1.25 2002/04/03 22:28:03 gliptak Removed references to gnu_regex

Revision 1.24 2002/04/02 16:12:47 oes Fix: moving misplaced lines into ifdef FEATURE_FORCE

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

Revision 1.22 2002/03/24 16:18:15 jongfoster Removing old logo

Revision 1.21 2002/03/24 15:23:33 jongfoster Name changes

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

Revision 1.19 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.18 2002/03/12 01:44:49 oes Changed default for "blocked" image from jb logo to checkboard pattern

Revision 1.17 2002/03/08 16:43:18 oes Added choice beween GIF and PNG built-in images

Revision 1.16 2002/03/07 03:48:38 oes

Revision 1.15 2002/03/06 22:54:35 jongfoster Automated function-comment nitpicking.

Revision 1.14 2002/03/02 04:14:50 david__schmidt Clean up a little CRLF unpleasantness that suddenly appeared

Revision 1.13 2002/02/21 00:10:37 jongfoster Adding send-banner?type=auto option

Revision 1.12 2002/01/23 01:03:32 jongfoster Fixing gcc [CygWin] compiler warnings

Revision 1.11 2002/01/23 00:01:04 jongfoster Adding cgi_transparent_gif() for http://i.j.b/t Adding missing html_encode() to many CGI functions. Adding urlmatch.[ch] to http://i.j.b/show-version

Revision 1.10 2002/01/17 21:10:37 jongfoster Changes to cgi_show_url_info to use new matching code from urlmatch.c. Also fixing a problem in the same function with improperly quoted URLs in output HTML, and adding code to handle https:// URLs correctly.

Revision 1.9 2001/11/30 23:09:15 jongfoster Now reports on FEATURE_CGI_EDIT_ACTIONS Removing FEATURE_DENY_GZIP from template

Revision 1.8 2001/11/13 00:14:07 jongfoster Fixing stupid bug now I've figured out what || means. (It always returns 0 or 1, not one of it's paramaters.)

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

Revision 1.5 2001/10/07 15:30:41 oes Removed FEATURE_DENY_GZIP

Revision 1.4 2001/10/02 15:31:12 oes Introduced show-request cgi

Revision 1.3 2001/09/22 16:34:44 jongfoster Removing unneeded includes

Revision 1.2 2001/09/19 18:01:11 oes Fixed comments; cosmetics

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

Define Documentation

#define SHOW_RCS (  __x    ) 
 

Value:

{                               \
      extern const char __x[];     \
      sprintf(buf, "%s\n", __x);   \
      string_append(&result, buf); \
   }

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.

jb_err show_defines (  struct map *    exports )  [static]
 

Add to a map the state od all conditional defines used when building.

Parameters:
exports  map to extend
Returns:
JB_ERR_OK on success JB_ERR_MEMORY on out-of-memory error.

char * show_rcs (  void    )  [static]
 

Create a string with the rcs info for all sourcefiles.

Returns:
A string, or NULL on out-of-memory.

Variable Documentation

const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION
 

Version information about cgisimple.h.

const char cgisimple_rcs[] = "$Id: cgisimple.c,v 2.0 2002/06/04 14:34:21 jongfoster Exp $"
 

Version information about cgisimple.c.

Generated on Tue Jun 4 18:54:49 2002 for Privoxy 3.1.1 by doxygen1.2.15