X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=cgi.c;h=f138f653fc0f711c2accb3eaa5b4e06c99ba8417;hb=f27501b7b906ccd824e763e0a7f934b24ec57177;hp=6860dd9196454cfd2ec94fd29e68da8fb89522cc;hpb=c35324374411cae44d7c40dd8403e30ef53ea1f0;p=privoxy.git diff --git a/cgi.c b/cgi.c index 6860dd91..f138f653 100644 --- a/cgi.c +++ b/cgi.c @@ -1,16 +1,18 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.23 2001/09/16 11:16:05 jongfoster Exp $"; +const char cgi_rcs[] = "$Id: cgi.c,v 1.59 2002/04/05 15:51:51 oes Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ * * Purpose : Declares functions to intercept request, generate * html or gif answers, and to compose HTTP resonses. + * This only contains the framework functions, the + * actual handler functions are declared elsewhere. * * Functions declared include: * * * 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 @@ -36,6 +38,174 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.23 2001/09/16 11:16:05 jongfoster Exp $"; * * Revisions : * $Log: cgi.c,v $ + * Revision 1.59 2002/04/05 15:51:51 oes + * - added send-stylesheet CGI + * - bugfix: error-pages now get correct request protocol + * - fixed + * - kludged CGI descriptions and menu not to break JS syntax + * + * Revision 1.58 2002/03/29 03:33:13 david__schmidt + * Fix Mac OSX compiler warnings + * + * Revision 1.57 2002/03/26 22:29:54 swa + * we have a new homepage! + * + * Revision 1.56 2002/03/24 17:50:46 jongfoster + * Fixing compile error if actions file editor disabled + * + * Revision 1.55 2002/03/24 16:55:06 oes + * Making GIF checkerboard transparent + * + * Revision 1.54 2002/03/24 16:18:15 jongfoster + * Removing old logo + * + * Revision 1.53 2002/03/24 16:06:00 oes + * Correct transparency for checkerboard PNG. Thanks, Magnus! + * + * Revision 1.52 2002/03/24 15:23:33 jongfoster + * Name changes + * + * Revision 1.51 2002/03/24 13:25:43 swa + * name change related issues + * + * Revision 1.50 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.49 2002/03/13 00:27:04 jongfoster + * Killing warnings + * + * Revision 1.48 2002/03/08 17:47:07 jongfoster + * Adding comments + * + * Revision 1.47 2002/03/08 16:41:33 oes + * Added GIF images again + * + * Revision 1.46 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.45 2002/03/06 22:54:35 jongfoster + * Automated function-comment nitpicking. + * + * Revision 1.44 2002/03/05 22:43:45 david__schmidt + * - Better error reporting on OS/2 + * - Fix double-slash comment (oops) + * + * Revision 1.43 2002/03/05 21:33:45 david__schmidt + * - Re-enable OS/2 building after new parms were added + * - Fix false out of memory report when resolving CGI templates when no IP + * address is available of failed attempt (a la no such domain) + * + * Revision 1.42 2002/01/21 00:33:20 jongfoster + * Replacing strsav() with the safer string_append() or string_join(). + * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML. + * Adding missing html_encode() to error message generators. + * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs. + * + * Revision 1.41 2002/01/17 20:56:22 jongfoster + * Replacing hard references to the URL of the config interface + * with #defines from project.h + * + * Revision 1.40 2002/01/09 14:26:46 oes + * Added support for thread-safe gmtime_r call. + * + * Revision 1.39 2001/11/16 00:48:13 jongfoster + * Fixing a compiler warning + * + * Revision 1.38 2001/11/13 00:31:21 jongfoster + * - Adding new CGIs for use by non-JavaScript browsers: + * edit-actions-url-form + * edit-actions-add-url-form + * edit-actions-remove-url-form + * - Fixing make_menu()'s HTML generation - it now quotes the href parameter. + * - Fixing || bug. + * + * Revision 1.37 2001/11/01 14:28:47 david__schmidt + * Show enablement/disablement status in almost all templates. + * There is a little trickiness here: apparent recursive resolution of + * @if-enabled-then@ caused the toggle template to show status out-of-phase with + * the actual enablement status. So a similar construct, + * @if-enabled-display-then@, is used to resolve the status display on non-'toggle' + * templates. + * + * Revision 1.36 2001/10/26 17:33:27 oes + * marginal bugfix + * + * Revision 1.35 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.34 2001/10/18 22:22:09 david__schmidt + * Only show "Local support" on templates conditionally: + * - if either 'admin-address' or 'proxy-info-url' are uncommented in config + * - if not, no Local support section appears + * + * Revision 1.33 2001/10/14 22:28:41 jongfoster + * Fixing stupid typo. + * + * Revision 1.32 2001/10/14 22:20:18 jongfoster + * - Changes to CGI dispatching method to match CGI names exactly, + * rather than doing a prefix match. + * - No longer need to count the length of the CGI handler names by hand. + * - Adding new handler for 404 error when disptching a CGI, if none of + * the handlers match. + * - Adding new handlers for CGI actionsfile editor. + * + * Revision 1.31 2001/10/10 10:56:39 oes + * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c + * + * Revision 1.30 2001/10/02 15:30:57 oes + * Introduced show-request cgi + * + * Revision 1.29 2001/09/20 15:47:44 steudten + * + * Fix BUG: Modify int size to size_t size in fill_template() + * - removes big trouble on machines where sizeof(int) != sizeof(size_t). + * + * Revision 1.28 2001/09/19 18:00:37 oes + * - Deletef time() FIXME (Can't fail under Linux either, if + * the argument is guaranteed to be in out address space, + * which it is.) + * - Fixed comments + * - Pointer notation cosmetics + * - Fixed a minor bug in template_fill(): Failiure of + * pcrs_execute() now secure. + * + * Revision 1.27 2001/09/16 17:08:54 jongfoster + * Moving simple CGI functions from cgi.c to new file cgisimple.c + * + * Revision 1.26 2001/09/16 15:47:37 jongfoster + * First version of CGI-based edit interface. This is very much a + * work-in-progress, and you can't actually use it to edit anything + * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes + * to have any effect. + * + * Revision 1.25 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.24 2001/09/16 11:38:01 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.23 2001/09/16 11:16:05 jongfoster * Better error handling in dispatch_cgi() and parse_cgi_parameters() * @@ -185,74 +355,205 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.23 2001/09/16 11:16:05 jongfoster Exp $"; #include "list.h" #include "encode.h" #include "ssplit.h" -#include "jcc.h" -#include "filters.h" -#include "actions.h" #include "errlog.h" #include "miscutil.h" -#include "showargs.h" +#include "cgisimple.h" +#ifdef FEATURE_CGI_EDIT_ACTIONS +#include "cgiedit.h" +#endif /* def FEATURE_CGI_EDIT_ACTIONS */ #include "loadcfg.h" +/* loadcfg.h is for g_bToggleIJB only */ const char cgi_h_rcs[] = CGI_H_VERSION; -const struct cgi_dispatcher cgi_dispatcher[] = { +/* + * List of CGI functions: name, handler, description + * Note: Do NOT use single quotes in the description; + * this will break the dynamic "blocked" template! + */ +static const struct cgi_dispatcher cgi_dispatchers[] = { + { "", + cgi_default, + "Privoxy main page" }, +#ifdef FEATURE_GRACEFUL_TERMINATION + { "die", + cgi_die, + "Shut down - Do not deploy this build in a production environment, " + "this is a one click Denial Of Service attack!!!" }, +#endif { "show-status", - 11, cgi_show_status, + cgi_show_status, "Show information about the current configuration" }, - { "show-url-info", - 13, cgi_show_url_info, - "Show which actions apply to a URL and why" }, { "show-version", - 12, cgi_show_version, + cgi_show_version, "Show the source code version numbers" }, + { "show-request", + cgi_show_request, + "Show the request headers." }, + { "show-url-info", + cgi_show_url_info, + "Show which actions apply to a URL and why" }, +#ifdef FEATURE_CGI_EDIT_ACTIONS + { "toggle", + cgi_toggle, + "Toggle Privoxy on or off" }, + { "edit-actions", + cgi_edit_actions, + "Edit the actions list" }, + + + { "eaa", /* Shortcut for edit-actions-add-url-form */ + cgi_edit_actions_add_url_form, + NULL }, + { "eau", /* Shortcut for edit-actions-url-form */ + cgi_edit_actions_url_form, + NULL }, + { "ear", /* Shortcut for edit-actions-remove-url-form */ + cgi_edit_actions_remove_url_form, + NULL }, + { "eas", /* Shortcut for edit-actions-for-url */ + cgi_edit_actions_for_url, + NULL }, + { "easa", /* Shortcut for edit-actions-section-add */ + cgi_edit_actions_section_add, + NULL }, + { "easr", /* Shortcut for edit-actions-section-remove */ + cgi_edit_actions_section_remove, + NULL }, + { "eass", /* Shortcut for edit-actions-section-swap */ + cgi_edit_actions_section_swap, + NULL }, + { "edit-actions-for-url", + cgi_edit_actions_for_url, + NULL /* Edit the actions for (a) specified URL(s) */ }, + { "edit-actions-list", + cgi_edit_actions_list, + NULL /* Edit the actions list */ }, + { "edit-actions-submit", + cgi_edit_actions_submit, + NULL /* Change the actions for (a) specified URL(s) */ }, + { "edit-actions-url", + cgi_edit_actions_url, + NULL /* Change a URL pattern in the actionsfile */ }, + { "edit-actions-url-form", + cgi_edit_actions_url_form, + NULL /* Form to change a URL pattern in the actionsfile */ }, + { "edit-actions-add-url", + cgi_edit_actions_add_url, + NULL /* Add a URL pattern to the actionsfile */ }, + { "edit-actions-add-url-form", + cgi_edit_actions_add_url_form, + NULL /* Form to add a URL pattern to the actionsfile */ }, + { "edit-actions-remove-url", + cgi_edit_actions_remove_url, + NULL /* Remove a URL pattern from the actionsfile */ }, + { "edit-actions-remove-url-form", + cgi_edit_actions_remove_url_form, + NULL /* Form to remove a URL pattern from the actionsfile */ }, + { "edit-actions-section-add", + cgi_edit_actions_section_add, + NULL /* Remove a section from the actionsfile */ }, + { "edit-actions-section-remove", + cgi_edit_actions_section_remove, + NULL /* Remove a section from the actionsfile */ }, + { "edit-actions-section-swap", + cgi_edit_actions_section_swap, + NULL /* Swap two sections in the actionsfile */ }, +#endif /* def FEATURE_CGI_EDIT_ACTIONS */ + { "robots.txt", + cgi_robots_txt, + NULL /* Sends a robots.txt file to tell robots to go away. */ }, { "send-banner", - 11, cgi_send_banner, - "HIDE Send the transparent or \"Junkbuster\" gif" }, - { "", - 0, cgi_default, - "Junkbuster main page" }, - { NULL, 0, NULL, NULL } + cgi_send_banner, + NULL /* Send a built-in image */ }, + { "send-stylesheet", + cgi_send_stylesheet, + NULL /* Send templates/cgi-style.css */ }, + { "t", + cgi_transparent_image, + NULL /* Send a transparent image (short name) */ }, + { NULL, /* NULL Indicates end of list and default page */ + cgi_error_404, + NULL /* Unknown CGI page */ } }; /* - * Some images + * Bulit-in images for ad replacement * - * Hint: You can encode your own GIFs like that: - * perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }' + * Hint: You can encode your own images like this: + * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }' */ -const char image_junkbuster_gif_data[] = - "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;"; +#ifdef FEATURE_NO_GIFS -const int image_junkbuster_gif_length = sizeof(image_junkbuster_gif_data) - 1; +/* + * Checkerboard pattern, as a PNG. + */ +const char image_pattern_data[] = + "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104" + "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046" + "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310" + "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170" + "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342" + "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000" + "\000\000\000\111\105\116\104\256\102\140\202"; + +/* + * 1x1 transparant PNG. + */ +const char image_blank_data[] = + "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122" + "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236" + "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070" + "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022" + "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115" + "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101" + "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006" + "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110" + "\000\000\000\000\111\105\116\104\256\102\140\202"; +#else +/* + * Checkerboard pattern, as a GIF. + */ +const char image_pattern_data[] = + "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310" + "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040" + "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000" + "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147" + "\270\005\000\073"; -const char image_blank_gif_data[] = +/* + * 1x1 transparant GIF. + */ +const char image_blank_data[] = "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;"; +#endif -const int image_blank_gif_length = sizeof(image_blank_gif_data) - 1; +const size_t image_pattern_length = sizeof(image_pattern_data) - 1; +const size_t image_blank_length = sizeof(image_blank_data) - 1; + + +static struct http_response cgi_error_memory_response[1]; + +static struct http_response *dispatch_known_cgi(struct client_state * csp, + const char * path); +static struct map *parse_cgi_parameters(char *argstring); /********************************************************************* * * Function : dispatch_cgi * - * Description : Checks if a request URL has either the magical hostname - * i.j.b or matches HOME_PAGE_URL/config/. If so, it parses - * the (rest of the) path as a cgi name plus query string, - * prepares a map that maps CGI parameter names to their values, - * initializes the http_response struct, and calls the - * relevant CGI handler function. + * Description : Checks if a request URL has either the magical + * hostname CGI_SITE_1_HOST (usully http://i.j.b/) or + * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually + * http://ijbswa.sourceforge.net/config). If so, it passes + * the (rest of the) path onto dispatch_known_cgi, which + * calls the relevant CGI handler function. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) @@ -262,31 +563,47 @@ const int image_blank_gif_length = sizeof(image_blank_gif_data) - 1; *********************************************************************/ struct http_response *dispatch_cgi(struct client_state *csp) { - char *argstring = NULL; - const struct cgi_dispatcher *d; - struct map *param_list; - struct http_response *rsp; + const char *host = csp->http->host; + const char *path = csp->http->path; /* * Should we intercept ? */ - /* Either the host matches CGI_PREFIX_HOST ..*/ - if (0 == strcmpic(csp->http->host, CGI_PREFIX_HOST)) + /* Note: "example.com" and "example.com." are equivalent hostnames. */ + + /* Either the host matches CGI_SITE_1_HOST ..*/ + if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST)) + || (0 == strcmpic(host, CGI_SITE_1_HOST "."))) + && (path[0] == '/') ) { - /* ..then the path will all be for us */ - argstring = csp->http->path; + /* ..then the path will all be for us. Remove leading '/' */ + path++; } - /* Or it's the host part HOME_PAGE_URL, and the path /config ? */ - else if ( (0 == strcmpic(csp->http->host, HOME_PAGE_URL + 7 )) - && (0 == strncmpic(csp->http->path,"/config", 7)) - && ((csp->http->path[7] == '/') || (csp->http->path[7] == '\0'))) + /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */ + else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST )) + || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) ) + && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) ) { - /* then it's everything following "/config" */ - argstring = csp->http->path + 7; + /* take everything following CGI_SITE_2_PATH */ + path += strlen(CGI_SITE_2_PATH); + if (*path == '/') + { + /* skip the forward slash after CGI_SITE_2_PATH */ + path++; + } + else if (*path != '\0') + { + /* + * wierdness: URL is /configXXX, where XXX is some string + * Do *NOT* intercept. + */ + return NULL; + } } else { + /* Not a CGI */ return NULL; } @@ -294,16 +611,74 @@ struct http_response *dispatch_cgi(struct client_state *csp) * This is a CGI call. */ - /* Get mem for response or fail*/ - if (NULL == (rsp = alloc_http_response())) + return dispatch_known_cgi(csp, path); +} + + +/********************************************************************* + * + * Function : dispatch_known_cgi + * + * Description : Processes a CGI once dispatch_cgi has determined that + * it matches one of the magic prefixes. Parses the path + * as a cgi name plus query string, prepares a map that + * maps CGI parameter names to their values, initializes + * the http_response struct, and calls the relevant CGI + * handler function. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : path = Path of CGI, with the CGI prefix removed. + * Should not have a leading "/". + * + * Returns : http_response, or NULL on handler failure or out of + * memory. + * + *********************************************************************/ +static struct http_response *dispatch_known_cgi(struct client_state * csp, + const char * path) +{ + const struct cgi_dispatcher *d; + struct map *param_list; + struct http_response *rsp; + char *query_args_start; + char *path_copy; + jb_err err; + + if (NULL == (path_copy = strdup(path))) { - return NULL; + return cgi_error_memory(); + } + + query_args_start = path_copy; + while (*query_args_start && *query_args_start != '?') + { + query_args_start++; + } + if (*query_args_start == '?') + { + *query_args_start++ = '\0'; } - /* Remove leading slash */ - if (*argstring == '/') + if (NULL == (param_list = parse_cgi_parameters(query_args_start))) + { + free(path_copy); + return cgi_error_memory(); + } + + + /* + * At this point: + * path_copy = CGI call name + * param_list = CGI params, as map + */ + + /* Get mem for response or fail*/ + if (NULL == (rsp = alloc_http_response())) { - argstring++; + free(path_copy); + free_map(param_list); + return cgi_error_memory(); } log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path); @@ -311,32 +686,32 @@ struct http_response *dispatch_cgi(struct client_state *csp) csp->ip_addr_str, csp->http->cmd); /* Find and start the right CGI function*/ - for (d = cgi_dispatcher; d->handler; d++) + d = cgi_dispatchers; + for (;;) { - if (strncmp(argstring, d->name, d->name_length) == 0) + if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0)) { - if (NULL == (param_list = - parse_cgi_parameters(argstring + d->name_length))) + err = (d->handler)(csp, rsp, param_list); + free(path_copy); + free_map(param_list); + if (err == JB_ERR_CGI_PARAMS) { - free_map(param_list); - free_http_response(rsp); - return(NULL); + err = cgi_error_bad_param(csp, rsp); } - if ((d->handler)(csp, rsp, param_list)) + if (!err) { - free_map(param_list); + /* It worked */ + return finish_http_response(rsp); + } + else + { + /* Error in handler, probably out-of-memory */ free_http_response(rsp); - return(NULL); + return cgi_error_memory(); } - - free_map(param_list); - return(finish_http_response(rsp)); } + d++; } - - /* Can't get here, since cgi_default will match all requests */ - free_http_response(rsp); - return(NULL); } @@ -348,14 +723,14 @@ struct http_response *dispatch_cgi(struct client_state *csp) * pairs and store them in a struct map list. * * Parameters : - * 1 : string = string to be parsed + * 1 : string = string to be parsed. Will be trashed. * * Returns : pointer to param list, or NULL if out of memory. * *********************************************************************/ -struct map *parse_cgi_parameters(char *argstring) +static struct map *parse_cgi_parameters(char *argstring) { - char *tmp, *p; + char *p; char *vector[BUFFER_SIZE]; int pairs, i; struct map *cgi_params; @@ -365,519 +740,286 @@ struct map *parse_cgi_parameters(char *argstring) return NULL; } - if(*argstring == '?') - { - argstring++; - } - if (NULL == (tmp = strdup(argstring))) - { - free_map(cgi_params); - return NULL; - } - - pairs = ssplit(tmp, "&", vector, SZ(vector), 1, 1); + pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1); for (i = 0; i < pairs; i++) { if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0')) { *p = '\0'; - map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0); + if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0)) + { + free_map(cgi_params); + return NULL; + } } } - free(tmp); - return(cgi_params); + return cgi_params; } /********************************************************************* * - * Function : cgi_default + * Function : error_response + * + * Description : returns an http_response that explains the reason + * why a request failed. * - * Description : CGI function that is called if no action was given. - * Lists menu of available unhidden CGIs. - * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : templatename = Which template should be used for the answer + * 3 : sys_err = system error number * - * Returns : 0 + * Returns : A http_response. If we run out of memory, this + * will be cgi_error_memory(). * *********************************************************************/ -int cgi_default(struct client_state *csp, struct http_response *rsp, - struct map *parameters) +struct http_response *error_response(struct client_state *csp, + const char *templatename, + int sys_err) { - char *p; - char *tmp = NULL; - struct map * exports = default_exports(csp, ""); - - /* If there were other parameters, export a dump as "cgi-parameters" */ - if(parameters) + jb_err err; + struct http_response *rsp; + struct map * exports = default_exports(csp, NULL); + if (exports == NULL) { - p = dump_map(parameters); - tmp = strsav(tmp, "
What made you think this cgi takes parameters?\n" - "Anyway, here they are, in case you're interested:
\n"); - tmp = strsav(tmp, p); - map(exports, "cgi-parameters", 1, tmp, 0); - free(p); + return cgi_error_memory(); } - else + + if (NULL == (rsp = alloc_http_response())) { - map(exports, "cgi-parameters", 1, "", 1); + free_map(exports); + return cgi_error_memory(); } - rsp->body = template_load(csp, "default"); - template_fill(&rsp->body, exports); - free_map(exports); - return(0); + err = map(exports, "host", 1, html_encode(csp->http->host), 0); + if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0); + if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0); + if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0); + if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1); + if (!err) + { + err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0); + if (err) + { + /* Some failures, like "404 no such domain", don't have an IP address. */ + err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0); + } + } -} + if (err) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } -/********************************************************************* - * - * Function : cgi_send_banner - * - * Description : CGI function that returns a banner. - * - * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters - * - * CGI Parameters : - * type : Selects the type of banner between "trans" and "jb". - * Defaults to "jb" if absent or != "trans". - * - * Returns : 0 - * - *********************************************************************/ -int cgi_send_banner(struct client_state *csp, struct http_response *rsp, - struct map *parameters) -{ - if(strcmp(lookup(parameters, "type"), "trans")) + if (!strcmp(templatename, "no-such-domain")) { - rsp->body = bindup(image_junkbuster_gif_data, image_junkbuster_gif_length); - rsp->content_length = image_junkbuster_gif_length; + rsp->status = strdup("404 No such domain"); + if (rsp->status == NULL) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } } - else + else if (!strcmp(templatename, "connect-failed")) { - rsp->body = bindup(image_blank_gif_data, image_blank_gif_length); - rsp->content_length = image_blank_gif_length; - } - - enlist(rsp->headers, "Content-Type: image/gif"); - rsp->is_static = 1; + rsp->status = strdup("503 Connect failed"); + if (rsp->status == NULL) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } + } - return(0); + err = template_fill_for_cgi(csp, templatename, exports, rsp); + if (err) + { + free_http_response(rsp); + return cgi_error_memory(); + } + return finish_http_response(rsp); } /********************************************************************* * - * Function : cgi_show_version + * Function : cgi_init_error_messages * - * Description : CGI function that returns a a web page describing the - * file versions of IJB. + * Description : Call at the start of the program to initialize + * the error message used by cgi_error_memory(). * - * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters - * - * CGI Parameters : - * type : Selects the type of banner between "trans" and "jb". - * Defaults to "jb" if absent or != "trans". + * Parameters : N/A * - * Returns : 0 + * Returns : N/A * *********************************************************************/ -int cgi_show_version(struct client_state *csp, struct http_response *rsp, - struct map *parameters) +void cgi_init_error_messages(void) { - struct map * exports = default_exports(csp, "show-version"); - - map(exports, "sourceversions", 1, show_rcs(), 0); - - rsp->body = template_load(csp, "show-version"); - template_fill(&rsp->body, exports); - free_map(exports); - return(0); - + memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response)); + cgi_error_memory_response->head = + "HTTP/1.0 500 Internal Privoxy Error\r\n" + "Content-Type: text/html\r\n" + "\r\n"; + cgi_error_memory_response->body = + "\r\n" + "Privoxy ran out of memory while processing your request.
\r\n" + "Please contact your proxy administrator, or try again later
\r\n" + "\r\n" + "\r\n"; + + cgi_error_memory_response->head_length = + strlen(cgi_error_memory_response->head); + cgi_error_memory_response->content_length = + strlen(cgi_error_memory_response->body); } - + /********************************************************************* * - * Function : cgi_show_status + * Function : cgi_error_memory * - * Description : CGI function that returns a a web page describing the - * current status of IJB. + * Description : Called if a CGI function runs out of memory. + * Returns a statically-allocated error response. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters - * - * CGI Parameters : - * type : Selects the type of banner between "trans" and "jb". - * Defaults to "jb" if absent or != "trans". + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : template_name = Name of template that could not + * be loaded. * - * Returns : 0 + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -int cgi_show_status(struct client_state *csp, struct http_response *rsp, - struct map *parameters) +struct http_response *cgi_error_memory(void) { - char *s = NULL; - int i; - - FILE * fp; - char buf[BUFFER_SIZE]; - char * p; - const char * filename = NULL; - char * file_description = NULL; - - struct map * exports = default_exports(csp, "show-status"); - - switch (*(lookup(parameters, "file"))) - { - case 'p': - if (csp->actions_list) - { - filename = csp->actions_list->filename; - file_description = "Actions List"; - } - break; - - case 'r': - if (csp->rlist) - { - filename = csp->rlist->filename; - file_description = "Regex Filter List"; - } - break; - -#ifdef FEATURE_TRUST - case 't': - if (csp->tlist) - { - filename = csp->tlist->filename; - file_description = "Trust List"; - } - break; -#endif /* def FEATURE_TRUST */ - } - - if (NULL != filename) - { - map(exports, "file-description", 1, file_description, 1); - map(exports, "filepath", 1, html_encode(filename), 0); - - if ((fp = fopen(filename, "r")) == NULL) - { - map(exports, "content", 1, "Privoxy encountered an error while processing your request:
\r\n" + "Could not load template file ";
+ static const char body_suffix[] =
+ "
Please contact your proxy administrator.
\r\n" + "If you are the proxy administrator, please put the required file "
+ "in the (confdir)/templates
directory. The "
+ "location of the (confdir)
directory "
+ "is specified in the main Privoxy config
"
+ "file. (It's typically the Privoxy install directory"
+#ifndef _WIN32
+ ", or /etc/privoxy/
"
+#endif /* ndef _WIN32 */
+ ").
");
- matches = strsav(matches, b->url->spec);
- matches = strsav(matches, "
"); - ret = strsav(ret, cur_entry->name); - ret = strsav(ret, " | "); - ret = strsav(ret, cur_entry->value); - ret = strsav(ret, " |
"); + string_join (&ret, html_encode(cur_entry->name)); + string_append(&ret, " | "); + string_join (&ret, html_encode(cur_entry->value)); + string_append(&ret, " |