X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.c;h=0cc7fe49669eb3d0a1c16ffae4194c5a43d74037;hp=356f0e0e8d41239c63eefbe7807c8016419c6ecc;hb=96d0efa4ca17b96077b04957f3a328ebc7835ede;hpb=bd8c476f053258f68476b246c435ad09baae85ab diff --git a/cgi.c b/cgi.c index 356f0e0e..0cc7fe49 100644 --- a/cgi.c +++ b/cgi.c @@ -1,4 +1,4 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.40 2002/01/09 14:26:46 oes Exp $"; +const char cgi_rcs[] = "$Id: cgi.c,v 1.64 2002/04/24 02:17:21 oes Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ @@ -12,7 +12,7 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.40 2002/01/09 14:26:46 oes Exp $"; * * * 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 @@ -38,6 +38,100 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.40 2002/01/09 14:26:46 oes Exp $"; * * Revisions : * $Log: cgi.c,v $ + * Revision 1.64 2002/04/24 02:17:21 oes + * - Better descriptions for CGIs + * - Hide edit-actions, more shortcuts + * - Moved get_char_param, get_string_param and get_number_param here + * from cgiedit.c + * + * Revision 1.63 2002/04/15 19:06:43 jongfoster + * Typos + * + * Revision 1.62 2002/04/10 19:59:46 jongfoster + * Fixes to #include in templates: + * - Didn't close main file if loading an included template fails. + * - I'm paranoid and want to disallow "#include /etc/passwd". + * + * Revision 1.61 2002/04/10 13:37:48 oes + * Made templates modular: template_load now recursive with max depth 1 + * + * Revision 1.60 2002/04/08 20:50:25 swa + * fixed JB spelling + * + * 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. * @@ -70,7 +164,7 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.40 2002/01/09 14:26:46 oes Exp $"; * * CGI actions file editor that works and is actually useful. * - * Ability to toggle JunkBuster remotely using a CGI call. + * 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. @@ -270,6 +364,7 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.40 2002/01/09 14:26:46 oes Exp $"; #include #include #include +#include #include #ifdef _WIN32 @@ -292,29 +387,65 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.40 2002/01/09 14:26:46 oes Exp $"; const char cgi_h_rcs[] = CGI_H_VERSION; +/* + * 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, - "Junkbuster main page" }, + "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", cgi_show_status, - "Show information about the current configuration" }, + "View & change the current configuration" }, { "show-version", cgi_show_version, - "Show the source code version numbers" }, + "View the source code version numbers" }, { "show-request", cgi_show_request, - "Show the client's request headers." }, + "View the request headers." }, { "show-url-info", cgi_show_url_info, - "Show which actions apply to a URL and why" }, + "Look up which actions apply to a URL and why" }, +#ifdef FEATURE_CGI_EDIT_ACTIONS { "toggle", cgi_toggle, - "Toggle JunkBuster on or off" }, -#ifdef FEATURE_CGI_EDIT_ACTIONS - { "edit-actions", + "Toggle Privoxy on or off" }, + + { "edit-actions", /* Edit the actions list */ cgi_edit_actions, - "Edit the actions list" }, + NULL }, + { "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 }, + { "eafu", /* Shortcut for edit-actions-for-url */ + cgi_edit_actions_for_url, + NULL }, + { "eas", /* Shortcut for edit-actions-submit */ + cgi_edit_actions_submit, + 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) */ }, @@ -342,19 +473,28 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { { "edit-actions-remove-url-form", cgi_edit_actions_remove_url_form, NULL /* Form to remove a URL pattern from the actionsfile */ }, - { "edit-actions-section-remove", - cgi_edit_actions_section_remove, - NULL /* Remove a section 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", cgi_send_banner, - NULL /* Send the transparent or \"Junkbuster\" gif */ }, + 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 */ } @@ -362,36 +502,66 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { /* - * Some images + * Bulit-in images for ad replacement * - * Hint: You can encode your own GIFs like this: - * 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 -const char image_blank_gif_data[] = +/* + * 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"; + +/* + * 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); @@ -402,7 +572,7 @@ static struct map *parse_cgi_parameters(char *argstring); * Function : dispatch_cgi * * Description : Checks if a request URL has either the magical - * hostname CGI_SITE_1_HOST (usully http://i.j.b/) or + * hostname CGI_SITE_1_HOST (usually http://p.p/) 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 @@ -539,7 +709,8 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, csp->ip_addr_str, csp->http->cmd); /* Find and start the right CGI function*/ - for (d = cgi_dispatchers; FOREVER; d++) + d = cgi_dispatchers; + for (;;) { if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0)) { @@ -562,6 +733,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, return cgi_error_memory(); } } + d++; } } @@ -611,6 +783,188 @@ static struct map *parse_cgi_parameters(char *argstring) } +/********************************************************************* + * + * Function : get_char_param + * + * Description : Get a single-character parameter passed to a CGI + * function. + * + * Parameters : + * 1 : parameters = map of cgi parameters + * 2 : param_name = The name of the parameter to read + * + * Returns : Uppercase character on success, '\0' on error. + * + *********************************************************************/ +char get_char_param(const struct map *parameters, + const char *param_name) +{ + char ch; + + assert(parameters); + assert(param_name); + + ch = *(lookup(parameters, param_name)); + if ((ch >= 'a') && (ch <= 'z')) + { + ch = ch - 'a' + 'A'; + } + + return ch; +} + + +/********************************************************************* + * + * Function : get_string_param + * + * Description : Get a string paramater, to be used as an + * ACTION_STRING or ACTION_MULTI paramater. + * Validates the input to prevent stupid/malicious + * users from corrupting their action file. + * + * Parameters : + * 1 : parameters = map of cgi parameters + * 2 : param_name = The name of the parameter to read + * 3 : pparam = destination for paramater. Allocated as + * part of the map "parameters", so don't free it. + * Set to NULL if not specified. + * + * Returns : JB_ERR_OK on success, or if the paramater + * was not specified. + * JB_ERR_MEMORY on out-of-memory. + * JB_ERR_CGI_PARAMS if the paramater is not valid. + * + *********************************************************************/ +jb_err get_string_param(const struct map *parameters, + const char *param_name, + const char **pparam) +{ + const char *param; + const char *s; + char ch; + + assert(parameters); + assert(param_name); + assert(pparam); + + *pparam = NULL; + + param = lookup(parameters, param_name); + if (!*param) + { + return JB_ERR_OK; + } + + if (strlen(param) >= CGI_PARAM_LEN_MAX) + { + /* + * Too long. + * + * Note that the length limit is arbitrary, it just seems + * sensible to limit it to *something*. There's no + * technical reason for any limit at all. + */ + return JB_ERR_CGI_PARAMS; + } + + /* Check every character to see if it's legal */ + s = param; + while ((ch = *s++) != '\0') + { + if ( ((unsigned char)ch < (unsigned char)' ') + || (ch == '}') ) + { + /* Probable hack attempt, or user accidentally used '}'. */ + return JB_ERR_CGI_PARAMS; + } + } + + /* Success */ + *pparam = param; + + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : get_number_param + * + * Description : Get a non-negative integer from the parameters + * passed to a CGI function. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : parameters = map of cgi parameters + * 3 : name = Name of CGI parameter to read + * 4 : pvalue = destination for value. + * Set to -1 on error. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the parameter was not specified + * or is not valid. + * + *********************************************************************/ +jb_err get_number_param(struct client_state *csp, + const struct map *parameters, + char *name, + unsigned *pvalue) +{ + const char *param; + char ch; + unsigned value; + + assert(csp); + assert(parameters); + assert(name); + assert(pvalue); + + *pvalue = 0; + + param = lookup(parameters, name); + if (!*param) + { + return JB_ERR_CGI_PARAMS; + } + + /* We don't use atoi because I want to check this carefully... */ + + value = 0; + while ((ch = *param++) != '\0') + { + if ((ch < '0') || (ch > '9')) + { + return JB_ERR_CGI_PARAMS; + } + + ch -= '0'; + + /* Note: + * + * defines UINT_MAX + * + * (UINT_MAX - ch) / 10 is the largest number that + * can be safely multiplied by 10 then have ch added. + */ + if (value > ((UINT_MAX - (unsigned)ch) / 10U)) + { + return JB_ERR_CGI_PARAMS; + } + + value = value * 10 + ch; + } + + /* Success */ + *pvalue = value; + + return JB_ERR_OK; + +} + + /********************************************************************* * * Function : error_response @@ -645,13 +999,21 @@ struct http_response *error_response(struct client_state *csp, return cgi_error_memory(); } - err = map(exports, "host-html", 1, html_encode(csp->http->host), 0); - if (!err) err = map(exports, "hostport", 1, csp->http->hostport, 1); - if (!err) err = map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0); - if (!err) err = map(exports, "path", 1, csp->http->path, 1); - if (!err) err = map(exports, "path-html", 1, html_encode(csp->http->path), 0); - if (!err) err = map(exports, "error", 1, safe_strerror(sys_err), 0); - if (!err) err = map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1); + 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) { @@ -708,15 +1070,15 @@ void cgi_init_error_messages(void) { memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response)); cgi_error_memory_response->head = - "HTTP/1.0 500 Internal JunkBuster Proxy Error\r\n" + "HTTP/1.0 500 Internal Privoxy Error\r\n" "Content-Type: text/html\r\n" "\r\n"; cgi_error_memory_response->body = "\r\n" - "500 Internal JunkBuster Proxy Error\r\n" + "500 Internal Privoxy Error\r\n" "\r\n" - "

500 Internal JunkBuster Proxy Error

\r\n" - "

JunkBuster ran out of memory whilst processing your request.

\r\n" + "

500 Internal Privoxy Error

\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"; @@ -736,9 +1098,9 @@ void cgi_init_error_messages(void) * Returns a statically-allocated error response. * * Parameters : - * 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 + * 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 : JB_ERR_OK on success @@ -764,9 +1126,9 @@ struct http_response *cgi_error_memory(void) * parameters. * * Parameters : - * 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 + * 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 : JB_ERR_OK on success @@ -778,24 +1140,24 @@ jb_err cgi_error_no_template(struct client_state *csp, const char *template_name) { static const char status[] = - "500 Internal JunkBuster Proxy Error"; + "500 Internal Privoxy Error"; static const char body_prefix[] = "\r\n" - "500 Internal JunkBuster Proxy Error\r\n" + "500 Internal Privoxy Error\r\n" "\r\n" - "

500 Internal JunkBuster Proxy Error

\r\n" - "

JunkBuster encountered an error whilst processing your request:

\r\n" + "

500 Internal Privoxy Error

\r\n" + "

Privoxy encountered an error while processing your request:

\r\n" "

Could not load template file "; static const char body_suffix[] = - "

\r\n" + " or one of it's included components.

\r\n" "

Please contact your proxy administrator.

\r\n" - "

If you are the proxy administrator, please put the required file " + "

If you are the proxy administrator, please put the required file(s)" "in the (confdir)/templates directory. The " "location of the (confdir) directory " - "is specified in the main JunkBuster config " - "file. (It's typically the JunkBuster install directory" + "is specified in the main Privoxy config " + "file. (It's typically the Privoxy install directory" #ifndef _WIN32 - ", or /etc/junkbuster/" + ", or /etc/privoxy/" #endif /* ndef _WIN32 */ ").

\r\n" "\r\n" @@ -840,8 +1202,8 @@ jb_err cgi_error_no_template(struct client_state *csp, * (query string) for a CGI were wrong. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output * * CGI Parameters : none * @@ -866,6 +1228,43 @@ jb_err cgi_error_bad_param(struct client_state *csp, } +/********************************************************************* + * + * Function : add_help_link + * + * Description : Produce a copy of the string given as item, + * embedded in an HTML link to its corresponding + * section (item name in uppercase) in the configuration + * chapter of the user manual, (whose URL is given in + * the config and defaults to our web site). + * + * Parameters : + * 1 : item = item (will NOT be free()d.) + * It is assumed to be HTML-safe. + * + * Returns : String with item embedded in link, or NULL on + * out-of-memory + * + *********************************************************************/ +char *add_help_link(const char *item, + struct configuration_spec *config) +{ + char *result = strdup(""); + + if (!item) return NULL; + + string_append(&result, "usermanual); + string_append(&result, HELP_LINK_PREFIX); + string_join (&result, string_toupper(item)); + string_append(&result, "\">"); + string_append(&result, item); + string_append(&result, " "); + + return result; +} + + /********************************************************************* * * Function : get_http_time @@ -967,7 +1366,7 @@ struct http_response *finish_http_response(struct http_response *rsp) } if (!err) { - sprintf(buf, "Content-Length: %d", rsp->content_length); + sprintf(buf, "Content-Length: %d", (int)rsp->content_length); err = enlist(rsp->headers, buf); } @@ -988,7 +1387,7 @@ struct http_response *finish_http_response(struct http_response *rsp) { /* * Set Expires to about 10 min into the future so it'll get reloaded - * occasionally, e.g. if IJB gets upgraded. + * occasionally, e.g. if Privoxy gets upgraded. */ if (!err) @@ -1091,25 +1490,31 @@ void free_http_response(struct http_response *rsp) * * Description : CGI support function that loads a given HTML * template from the confdir, ignoring comment - * lines. + * lines and following #include statements up to + * a depth of 1. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : template_ptr = Destination for pointer to loaded + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : template_ptr = Destination for pointer to loaded * template text. - * 3 : template = name of the HTML template to be used + * 3 : template = name of the HTML template to be used + * 4 : recursive = Flag set if this function calls itself + * following an #include statament * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory error. * JB_ERR_FILE if the template file cannot be read * *********************************************************************/ -jb_err template_load(struct client_state *csp, char ** template_ptr, - const char *templatename) +jb_err template_load(struct client_state *csp, char **template_ptr, + const char *templatename, int recursive) { + jb_err err; char *templates_dir_path; char *full_path; char *file_buffer; + char *included_module; + const char *p; FILE *fp; char buf[BUFFER_SIZE]; @@ -1119,9 +1524,21 @@ jb_err template_load(struct client_state *csp, char ** template_ptr, *template_ptr = NULL; - /* - * Open template file or fail - */ + /* Validate template name. Paranoia. */ + for (p = templatename; *p != 0; p++) + { + if ( ((*p < 'a') || (*p > 'z')) + && ((*p < 'A') || (*p > 'Z')) + && ((*p < '0') || (*p > '9')) + && (*p != '-') + && (*p != '.')) + { + /* Illegal character */ + return JB_ERR_FILE; + } + } + + /* Generate full path */ templates_dir_path = make_path(csp->config->confdir, "templates"); if (templates_dir_path == NULL) @@ -1136,6 +1553,8 @@ jb_err template_load(struct client_state *csp, char ** template_ptr, return JB_ERR_MEMORY; } + /* Allocate buffer */ + file_buffer = strdup(""); if (file_buffer == NULL) { @@ -1143,6 +1562,8 @@ jb_err template_load(struct client_state *csp, char ** template_ptr, return JB_ERR_MEMORY; } + /* Open template file */ + if (NULL == (fp = fopen(full_path, "r"))) { log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path); @@ -1153,15 +1574,34 @@ jb_err template_load(struct client_state *csp, char ** template_ptr, free(full_path); /* - * Read the file, ignoring comments. + * Read the file, ignoring comments, and honoring #include + * statements, unless we're already called recursively. * * FIXME: The comment handling could break with lines >BUFFER_SIZE long. * This is unlikely in practise. */ while (fgets(buf, BUFFER_SIZE, fp)) { + if (!recursive && !strncmp(buf, "#include ", 9)) + { + if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1))) + { + free(file_buffer); + fclose(fp); + return err; + } + + if (string_join(&file_buffer, included_module)) + { + fclose(fp); + return JB_ERR_MEMORY; + } + + continue; + } + /* skip lines starting with '#' */ - if(*buf == '#') + if (*buf == '#') { continue; } @@ -1193,11 +1633,11 @@ jb_err template_load(struct client_state *csp, char ** template_ptr, * interpretation. * * Parameters : - * 1 : template_ptr = IN: Template to be filled out. + * 1 : template_ptr = IN: Template to be filled out. * Will be free()d. * OUT: Filled out template. * Caller must free(). - * 2 : exports = map with fill in symbol -> name pairs + * 2 : exports = map with fill in symbol -> name pairs * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory error @@ -1300,9 +1740,9 @@ jb_err template_fill(char **template_ptr, const struct map *exports) * this function also frees the passed "exports" map. * * Parameters : - * 1 : csp = Client state - * 2 : templatename = name of the HTML template to be used - * 3 : exports = map with fill in symbol -> name pairs. + * 1 : csp = Client state + * 2 : templatename = name of the HTML template to be used + * 3 : exports = map with fill in symbol -> name pairs. * Will be freed by this function. * * Returns : JB_ERR_OK on success @@ -1321,7 +1761,7 @@ jb_err template_fill_for_cgi(struct client_state *csp, assert(exports); assert(rsp); - err = template_load(csp, &rsp->body, templatename); + err = template_load(csp, &rsp->body, templatename, 0); if (err == JB_ERR_FILE) { free_map(exports); @@ -1368,13 +1808,15 @@ struct map *default_exports(const struct client_state *csp, const char *caller) return NULL; } - err = map(exports, "version", 1, VERSION, 1); - if (!err) err = map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1); - if (!err) err = map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1); - if (!err) err = map(exports, "homepage", 1, HOME_PAGE_URL, 1); - if (!err) err = map(exports, "default-cgi", 1, CGI_PREFIX, 1); - if (!err) err = map(exports, "menu", 1, make_menu(caller), 0); - if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1); + err = map(exports, "version", 1, html_encode(VERSION), 0); + if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0); + if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0); + if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0); + if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0); + if (!err) err = map(exports, "menu", 1, make_menu(caller), 0); + if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1); + if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1); + if (!err) err = map(exports, "helplink", 1, HELP_LINK_PREFIX ,1); if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB); snprintf(buf, 20, "%d", csp->config->hport); @@ -1387,7 +1829,7 @@ struct map *default_exports(const struct client_state *csp, const char *caller) if (csp->config->admin_address != NULL) { - if (!err) err = map(exports, "admin-address", 1, csp->config->admin_address, 1); + if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0); local_help_exists = 1; } else @@ -1397,7 +1839,7 @@ struct map *default_exports(const struct client_state *csp, const char *caller) if (csp->config->proxy_info_url != NULL) { - if (!err) err = map(exports, "proxy-info-url", 1, csp->config->proxy_info_url, 1); + if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0); local_help_exists = 1; } else @@ -1451,6 +1893,44 @@ jb_err map_block_killer(struct map *exports, const char *name) } +/********************************************************************* + * + * Function : map_block_keep + * + * Description : Convenience function. Removes the markers used + * by map-block-killer, to save a few bytes. + * i.e. removes "@if--start@" and "@if--end@" + * + * Parameters : + * 1 : exports = map to extend + * 2 : name = name of conditional block + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err map_block_keep(struct map *exports, const char *name) +{ + jb_err err; + char buf[500]; /* Will do, since the names are hardwired */ + + assert(exports); + assert(name); + assert(strlen(name) < 490); + + snprintf(buf, 500, "if-%s-start", name); + err = map(exports, buf, 1, "", 1); + + if (err) + { + return err; + } + + snprintf(buf, 500, "if-%s-end", name); + return map(exports, buf, 1, "", 1); +} + + /********************************************************************* * * Function : map_conditional @@ -1506,18 +1986,18 @@ jb_err map_conditional(struct map *exports, const char *name, int choose_first) * Function : make_menu * * Description : Returns an HTML-formatted menu of the available - * unhidden CGIs, excluding the one given in . + * unhidden CGIs, excluding the one given in * - * Parameters : self = name of CGI to leave out, can be NULL + * Parameters : self = name of CGI to leave out, can be NULL for + * complete listing. * - * Returns : menu string + * Returns : menu string, or NULL on out-of-memory error. * *********************************************************************/ char *make_menu(const char *self) { const struct cgi_dispatcher *d; - char buf[BUFFER_SIZE]; - char *result = NULL; + char *result = strdup(""); if (self == NULL) { @@ -1529,13 +2009,15 @@ char *make_menu(const char *self) { if (d->description && strcmp(d->name, self)) { - snprintf(buf, BUFFER_SIZE, "
  • %s
    • \n", - CGI_PREFIX, d->name, d->description); - result = strsav(result, buf); + string_append(&result, "
  • name); + string_append(&result, "\">"); + string_append(&result, d->description); + string_append(&result, "
    • "); } } - return(result); + return result; } @@ -1543,7 +2025,7 @@ char *make_menu(const char *self) * * Function : dump_map * - * Description : HTML-dump a map for debugging + * Description : HTML-dump a map for debugging (as table) * * Parameters : * 1 : the_map = map to dump @@ -1553,24 +2035,24 @@ char *make_menu(const char *self) *********************************************************************/ char *dump_map(const struct map *the_map) { - struct map_entry *cur_entry = the_map->first; - char *ret = NULL; + struct map_entry *cur_entry; + char *ret = strdup(""); - ret = strsav(ret, "\n"); + string_append(&ret, "
    \n"); - while (cur_entry) + for (cur_entry = the_map->first; + (cur_entry != NULL) && (ret != NULL); + cur_entry = cur_entry->next) { - ret = strsav(ret, "\n"); - cur_entry = cur_entry->next; + string_append(&ret, "\n"); } - ret = strsav(ret, "
    "); - 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, "
    \n"); - return(ret); - + string_append(&ret, "\n"); + return ret; }