X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.c;h=7f99e74310b02441ed3aa1d6a9c170511cb1d431;hp=383c33930b7710d003e0d505894a1d168b3518f4;hb=24143b74d371a06f25a585047192507085c9be5a;hpb=83a36343155a2f17d29ff1c706809bf56382a9ec diff --git a/cgi.c b/cgi.c index 383c3393..7f99e743 100644 --- a/cgi.c +++ b/cgi.c @@ -1,4 +1,4 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.26 2001/09/16 15:47:37 jongfoster Exp $"; +const char cgi_rcs[] = "$Id: cgi.c,v 1.42 2002/01/21 00:33:20 jongfoster Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ @@ -38,6 +38,92 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.26 2001/09/16 15:47:37 jongfoster Exp $"; * * Revisions : * $Log: cgi.c,v $ + * 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 @@ -211,47 +297,113 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.26 2001/09/16 15:47:37 jongfoster Exp $"; #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[] = { - { "robots.txt", - 10, cgi_robots_txt, - "HIDE Sends a robots.txt file to tell robots to go away." }, +static const struct cgi_dispatcher cgi_dispatchers[] = { + { "", + cgi_default, + "Junkbuster main page" }, { "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" }, - { "send-banner", - 11, cgi_send_banner, - "HIDE Send the transparent or \"Junkbuster\" gif" }, + { "show-request", + cgi_show_request, + "Show the client's request headers." }, + { "show-url-info", + cgi_show_url_info, + "Show which actions apply to a URL and why" }, + { "toggle", + cgi_toggle, + "Toggle JunkBuster on or off" }, #ifdef FEATURE_CGI_EDIT_ACTIONS - { "edit-actions-list", - 17, cgi_edit_actions_list, + { "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", - 19, cgi_edit_actions_submit, - "HIDE Change the actions for (a) specified URL(s)" }, - { "edit-actions", - 12, cgi_edit_actions, - "HIDE Edit the actions for (a) specified URL(s)" }, + 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 */ - { "", - 0, cgi_default, - "Junkbuster main page" }, - { NULL, 0, NULL, NULL } + { "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 */ }, + { "t", + cgi_transparent_gif, + NULL /* Send a transparent gif (short name) */ }, + { NULL, /* NULL Indicates end of list and default page */ + cgi_error_404, + NULL /* Unknown CGI page */ } }; /* * Some images * - * Hint: You can encode your own GIFs like that: + * Hint: You can encode your own GIFs like this: * perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }' */ @@ -276,16 +428,24 @@ const char image_blank_gif_data[] = const int image_blank_gif_length = sizeof(image_blank_gif_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...) @@ -295,31 +455,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; } @@ -327,17 +503,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'; } + 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 + */ - /* Remove leading slash */ - if (*argstring == '/') + /* 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); @@ -345,32 +578,30 @@ 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++) + for (d = cgi_dispatchers; FOREVER; d++) { - 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)); } } - - /* Can't get here, since cgi_default will match all requests */ - free_http_response(rsp); - return(NULL); } @@ -382,14 +613,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; @@ -399,29 +630,22 @@ 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; } @@ -436,43 +660,255 @@ struct map *parse_cgi_parameters(char *argstring) * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) * 2 : templatename = Which template should be used for the answer - * 3 : errno = system error number + * 3 : sys_err = system error number * - * Returns : NULL if no memory, else http_response + * Returns : A http_response. If we run out of memory, this + * will be cgi_error_memory(). * *********************************************************************/ -struct http_response *error_response(struct client_state *csp, const char *templatename, int err) +struct http_response *error_response(struct client_state *csp, + const char *templatename, + int sys_err) { + jb_err err; struct http_response *rsp; struct map * exports = default_exports(csp, NULL); + if (exports == NULL) + { + return cgi_error_memory(); + } if (NULL == (rsp = alloc_http_response())) { - return NULL; + free_map(exports); + return cgi_error_memory(); } - map(exports, "host-html", 1, html_encode(csp->http->host), 0); - map(exports, "hostport", 1, csp->http->hostport, 1); - map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0); - map(exports, "path", 1, csp->http->path, 1); - map(exports, "path-html", 1, html_encode(csp->http->path), 0); - map(exports, "error", 1, safe_strerror(err), 0); - 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, "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); + } + } - rsp->body = template_load(csp, templatename); - template_fill(&rsp->body, exports); - free_map(exports); + + if (err) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } if (!strcmp(templatename, "no-such-domain")) { - rsp->status = strdup("404 No such domain"); + rsp->status = strdup("404 No such domain"); + if (rsp->status == NULL) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } } else if (!strcmp(templatename, "connect-failed")) { rsp->status = strdup("503 Connect failed"); + if (rsp->status == NULL) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } } - return(finish_http_response(rsp)); + 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_init_error_messages + * + * Description : Call at the start of the program to initialize + * the error message used by cgi_error_memory(). + * + * Parameters : N/A + * + * Returns : N/A + * + *********************************************************************/ +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" + "Content-Type: text/html\r\n" + "\r\n"; + cgi_error_memory_response->body = + "\r\n" + "500 Internal JunkBuster Proxy Error\r\n" + "\r\n" + "

500 Internal JunkBuster Proxy Error

\r\n" + "

JunkBuster 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_error_memory + * + * 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 : template_name = Name of template that could not + * be loaded. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +struct http_response *cgi_error_memory(void) +{ + /* assert that it's been initialized. */ + assert(cgi_error_memory_response->head); + + return cgi_error_memory_response; +} + + +/********************************************************************* + * + * Function : cgi_error_no_template + * + * Description : Almost-CGI function that is called if a templae + * cannot be loaded. Note this is not a true CGI, + * it takes a template name rather than a map of + * 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 + * be loaded. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_error_no_template(struct client_state *csp, + struct http_response *rsp, + const char *template_name) +{ + static const char status[] = + "500 Internal JunkBuster Proxy Error"; + static const char body_prefix[] = + "\r\n" + "500 Internal JunkBuster Proxy Error\r\n" + "\r\n" + "

500 Internal JunkBuster Proxy Error

\r\n" + "

JunkBuster encountered an error while processing your request:

\r\n" + "

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

\r\n" + "

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 JunkBuster config " + "file. (It's typically the JunkBuster install directory" +#ifndef _WIN32 + ", or /etc/junkbuster/" +#endif /* ndef _WIN32 */ + ").

\r\n" + "\r\n" + "\r\n"; + + assert(csp); + assert(rsp); + assert(template_name); + + /* Reset rsp, if needed */ + freez(rsp->status); + freez(rsp->head); + freez(rsp->body); + rsp->content_length = 0; + rsp->head_length = 0; + rsp->is_static = 0; + + rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1); + if (rsp->body == NULL) + { + return JB_ERR_MEMORY; + } + strcpy(rsp->body, body_prefix); + strcat(rsp->body, template_name); + strcat(rsp->body, body_suffix); + + rsp->status = strdup(status); + if (rsp->body == NULL) + { + return JB_ERR_MEMORY; + } + + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : cgi_error_bad_param + * + * Description : CGI function that is called if the parameters + * (query string) for a CGI were wrong. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * + * CGI Parameters : none + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_error_bad_param(struct client_state *csp, + struct http_response *rsp) +{ + struct map *exports; + + assert(csp); + assert(rsp); + + if (NULL == (exports = default_exports(csp, NULL))) + { + return JB_ERR_MEMORY; + } + + return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp); } @@ -493,7 +929,7 @@ struct http_response *error_response(struct client_state *csp, const char *templ * Returns : N/A * *********************************************************************/ -void get_http_time(int time_offset, char * buf) +void get_http_time(int time_offset, char *buf) { static const char day_names[7][4] = { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" }; @@ -508,17 +944,17 @@ void get_http_time(int time_offset, char * buf) time(¤t_time); /* get current time */ -/* FIXME: is this needed? time() can't fail on Win32. What about Linux? - if(current_time <= 0) - { - return NULL; - } -*/ - current_time += time_offset; /* get and save the gmt */ - t = gmtime(¤t_time); + { +#ifdef HAVE_GMTIME_R + struct tm dummy; + t = gmtime_r(¤t_time, &dummy); +#else + t = gmtime(¤t_time); +#endif + } /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */ snprintf(buf, 30, @@ -531,7 +967,7 @@ void get_http_time(int time_offset, char * buf) t->tm_min, t->tm_sec ); - buf[32] = '\0'; + } @@ -545,18 +981,28 @@ void get_http_time(int time_offset, char * buf) * Parameters : * 1 : rsp = pointer to http_response to be processed * - * Returns : http_response, or NULL on failiure + * Returns : A http_response, usually the rsp parameter. + * On error, free()s rsp and returns cgi_error_memory() * *********************************************************************/ struct http_response *finish_http_response(struct http_response *rsp) { char buf[BUFFER_SIZE]; + jb_err err; + + /* Special case - do NOT change this statically allocated response, + * which is ready for output anyway. + */ + if (rsp == cgi_error_memory_response) + { + return rsp; + } /* * Fill in the HTTP Status */ sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK"); - enlist_first(rsp->headers, buf); + err = enlist_first(rsp->headers, buf); /* * Set the Content-Length @@ -565,8 +1011,11 @@ struct http_response *finish_http_response(struct http_response *rsp) { rsp->content_length = rsp->body ? strlen(rsp->body) : 0; } - sprintf(buf, "Content-Length: %d", rsp->content_length); - enlist(rsp->headers, buf); + if (!err) + { + sprintf(buf, "Content-Length: %d", rsp->content_length); + err = enlist(rsp->headers, buf); + } /* * Fill in the default headers: @@ -579,7 +1028,7 @@ struct http_response *finish_http_response(struct http_response *rsp) * * See http://www.w3.org/Protocols/rfc2068/rfc2068 */ - enlist_unique(rsp->headers, "Content-Type: text/html", 13); + if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13); if (rsp->is_static) { @@ -588,14 +1037,20 @@ struct http_response *finish_http_response(struct http_response *rsp) * occasionally, e.g. if IJB gets upgraded. */ - get_http_time(0, buf); - enlist_unique_header(rsp->headers, "Date", buf); + if (!err) + { + get_http_time(0, buf); + err = enlist_unique_header(rsp->headers, "Date", buf); + } /* Some date in the past. */ - enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT"); + if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT"); - get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */ - enlist_unique_header(rsp->headers, "Expires", buf); + if (!err) + { + get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */ + err = enlist_unique_header(rsp->headers, "Expires", buf); + } } else { @@ -604,28 +1059,29 @@ struct http_response *finish_http_response(struct http_response *rsp) * setting. However, to be certain, we also set both "Last-Modified" * and "Expires" to the current time. */ - enlist_unique_header(rsp->headers, "Cache-Control", "no-cache"); + if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache"); + get_http_time(0, buf); - enlist_unique_header(rsp->headers, "Date", buf); - enlist_unique_header(rsp->headers, "Last-Modified", buf); - enlist_unique_header(rsp->headers, "Expires", buf); + if (!err) err = enlist_unique_header(rsp->headers, "Date", buf); + if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf); + if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf); } /* * Write the head */ - if (NULL == (rsp->head = list_to_text(rsp->headers))) + if (err || (NULL == (rsp->head = list_to_text(rsp->headers)))) { free_http_response(rsp); - return(NULL); + return cgi_error_memory(); } rsp->head_length = strlen(rsp->head); - return(rsp); + return rsp; } - + /********************************************************************* * @@ -638,9 +1094,10 @@ struct http_response *finish_http_response(struct http_response *rsp) * Returns : pointer to a new http_response, or NULL. * *********************************************************************/ -struct http_response * alloc_http_response(void) +struct http_response *alloc_http_response(void) { return (struct http_response *) zalloc(sizeof(struct http_response)); + } @@ -659,7 +1116,10 @@ struct http_response * alloc_http_response(void) *********************************************************************/ void free_http_response(struct http_response *rsp) { - if (rsp) + /* + * Must special case cgi_error_memory_response, which is never freed. + */ + if (rsp && (rsp != cgi_error_memory_response)) { freez(rsp->status); freez(rsp->head); @@ -673,40 +1133,76 @@ void free_http_response(struct http_response *rsp) /********************************************************************* * - * Function : fill_template + * Function : template_load * * Description : CGI support function that loads a given HTML - * template from the confdir, and fills it in - * by replacing @name@ with value using pcrs, - * for each item in the output map. + * template from the confdir, ignoring comment + * lines. * * Parameters : * 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 * - * Returns : char * with loaded template, or NULL if failure + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * JB_ERR_FILE if the template file cannot be read * *********************************************************************/ -char *template_load(struct client_state *csp, const char *templatename) +jb_err template_load(struct client_state *csp, char ** template_ptr, + const char *templatename) { - char buf[BUFFER_SIZE]; - char *file_buffer = NULL; + char *templates_dir_path; + char *full_path; + char *file_buffer; FILE *fp; + char buf[BUFFER_SIZE]; + + assert(csp); + assert(template_ptr); + assert(templatename); + + *template_ptr = NULL; /* * Open template file or fail */ - snprintf(buf, BUFFER_SIZE, "%s/templates/%s", csp->config->confdir, templatename); - if(NULL == (fp = fopen(buf, "r"))) + templates_dir_path = make_path(csp->config->confdir, "templates"); + if (templates_dir_path == NULL) { - log_error(LOG_LEVEL_ERROR, "error loading template %s: %E", buf); - return NULL; + return JB_ERR_MEMORY; + } + + full_path = make_path(templates_dir_path, templatename); + free(templates_dir_path); + if (full_path == NULL) + { + return JB_ERR_MEMORY; + } + + file_buffer = strdup(""); + if (file_buffer == NULL) + { + free(full_path); + return JB_ERR_MEMORY; } - + + if (NULL == (fp = fopen(full_path, "r"))) + { + log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path); + free(full_path); + free(file_buffer); + return JB_ERR_FILE; + } + free(full_path); /* - * Read the file, ignoring comments + * Read the file, ignoring comments. + * + * FIXME: The comment handling could break with lines >BUFFER_SIZE long. + * This is unlikely in practise. */ while (fgets(buf, BUFFER_SIZE, fp)) { @@ -715,23 +1211,32 @@ char *template_load(struct client_state *csp, const char *templatename) { continue; } - - file_buffer = strsav(file_buffer, buf); + + if (string_append(&file_buffer, buf)) + { + fclose(fp); + return JB_ERR_MEMORY; + } } fclose(fp); - return(file_buffer); + *template_ptr = file_buffer; + + return JB_ERR_OK; } /********************************************************************* * - * Function : fill_template + * Function : template_fill * - * Description : CGI support function that loads a given HTML - * template from the confdir, and fills it in - * by replacing @name@ with value using pcrs, - * for each item in the output map. + * Description : CGI support function that fills in a pre-loaded + * HTML template by replacing @name@ with value using + * pcrs, for each item in the output map. + * + * Note that a leading '$' charachter in the export map's + * values will be stripped and toggle on backreference + * interpretation. * * Parameters : * 1 : template_ptr = IN: Template to be filled out. @@ -740,19 +1245,20 @@ char *template_load(struct client_state *csp, const char *templatename) * Caller must free(). * 2 : exports = map with fill in symbol -> name pairs * - * Returns : N/A + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error * *********************************************************************/ -void template_fill(char ** template_ptr, struct map *exports) +jb_err template_fill(char **template_ptr, const struct map *exports) { struct map_entry *m; pcrs_job *job; char buf[BUFFER_SIZE]; char *tmp_out_buffer; char *file_buffer; - int size; + size_t size; int error; - const char * flags; + const char *flags; assert(template_ptr); assert(*template_ptr); @@ -796,17 +1302,29 @@ void template_fill(char ** template_ptr, struct map *exports) job = pcrs_compile(buf, m->value, flags, &error); if (job == NULL) { - log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error); + if (error == PCRS_ERR_NOMEM) + { + free(file_buffer); + *template_ptr = NULL; + return JB_ERR_MEMORY; + } + else + { + log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error); + /* Hope it wasn't important and silently ignore the invalid job */ + } } else { pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size); - if (file_buffer != tmp_out_buffer) + free(file_buffer); + pcrs_free_job(job); + if (NULL == tmp_out_buffer) { - free(file_buffer); - file_buffer = tmp_out_buffer; + *template_ptr = NULL; + return JB_ERR_MEMORY; } - pcrs_free_job(job); + file_buffer = tmp_out_buffer; } } @@ -814,6 +1332,55 @@ void template_fill(char ** template_ptr, struct map *exports) * Return */ *template_ptr = file_buffer; + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : template_fill_for_cgi + * + * Description : CGI support function that loads a HTML template + * and fills it in. Handles file-not-found errors + * by sending a HTML error message. For convenience, + * 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. + * Will be freed by this function. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error + * + *********************************************************************/ +jb_err template_fill_for_cgi(struct client_state *csp, + const char *templatename, + struct map *exports, + struct http_response *rsp) +{ + jb_err err; + + assert(csp); + assert(templatename); + assert(exports); + assert(rsp); + + err = template_load(csp, &rsp->body, templatename); + if (err == JB_ERR_FILE) + { + free_map(exports); + return cgi_error_no_template(csp, rsp, templatename); + } + else if (err) + { + free_map(exports); + return err; /* JB_ERR_MEMORY */ + } + err = template_fill(&rsp->body, exports); + free_map(exports); + return err; } @@ -825,47 +1392,77 @@ void template_fill(char ** template_ptr, struct map *exports) * which are common to all CGI functions. * * Parameters : - * 1 : exports = Structure to write output to. This - * structure should be newly allocated and will be - * zeroed. * 1 : csp = Current client state (buffers, headers, etc...) * 2 : caller = name of CGI who calls us and which should - * be excluded from the generated menu. - * Returns : NULL if no memory, else map + * be excluded from the generated menu. May be + * NULL. + * Returns : NULL if no memory, else a new map. Caller frees. * *********************************************************************/ -struct map * default_exports(const struct client_state *csp, const char *caller) +struct map *default_exports(const struct client_state *csp, const char *caller) { char buf[20]; - struct map * exports = new_map(); + jb_err err; + struct map * exports; + int local_help_exists = 0; + + assert(csp); + + exports = new_map(); + if (exports == NULL) + { + return NULL; + } - map(exports, "version", 1, VERSION, 1); - map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1); - map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1); - map(exports, "admin-address", 1, csp->config->admin_address ? csp->config->admin_address : "fill@me.in.please", 1); - map(exports, "homepage", 1, HOME_PAGE_URL, 1); - map(exports, "default-cgi", 1, HOME_PAGE_URL "/config", 1); - map(exports, "menu", 1, make_menu(caller), 0); - 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_conditional(exports, "enabled-display", g_bToggleIJB); snprintf(buf, 20, "%d", csp->config->hport); - map(exports, "my-port", 1, buf, 1); + if (!err) err = map(exports, "my-port", 1, buf, 1); if(!strcmp(CODE_STATUS, "stable")) { - map_block_killer(exports, "unstable"); + if (!err) err = map_block_killer(exports, "unstable"); } - if(csp->config->proxy_info_url != NULL) + if (csp->config->admin_address != NULL) { - map(exports, "proxy-info-url", 1, csp->config->proxy_info_url, 1); + if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0); + local_help_exists = 1; } else { - map_block_killer(exports, "have-proxy-info"); - } + if (!err) err = map_block_killer(exports, "have-adminaddr-info"); + } + + if (csp->config->proxy_info_url != NULL) + { + if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0); + local_help_exists = 1; + } + else + { + if (!err) err = map_block_killer(exports, "have-proxy-info"); + } + + if (local_help_exists == 0) + { + if (!err) err = map_block_killer(exports, "have-help-info"); + } - return (exports); + if (err) + { + free_map(exports); + return NULL; + } + + return exports; } @@ -883,15 +1480,58 @@ struct map * default_exports(const struct client_state *csp, const char *caller) * 1 : exports = map to extend * 2 : name = name of conditional block * - * Returns : extended map + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -void map_block_killer(struct map *exports, const char *name) +jb_err map_block_killer(struct map *exports, const char *name) { char buf[1000]; /* Will do, since the names are hardwired */ + assert(exports); + assert(name); + assert(strlen(name) < 490); + snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name); - map(exports, buf, 1, "", 1); + return map(exports, buf, 1, "", 1); +} + + +/********************************************************************* + * + * 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); } @@ -916,21 +1556,32 @@ void map_block_killer(struct map *exports, const char *name) * 2 : name = name of conditional block * 3 : choose_first = nonzero for first, zero for second. * - * Returns : extended map + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -void map_conditional(struct map *exports, const char *name, int choose_first) +jb_err map_conditional(struct map *exports, const char *name, int choose_first) { char buf[1000]; /* Will do, since the names are hardwired */ + jb_err err; + + assert(exports); + assert(name); + assert(strlen(name) < 480); snprintf(buf, 1000, (choose_first ? "else-not-%s@.*@endif-%s" : "if-%s-then@.*@else-not-%s"), name, name); - map(exports, buf, 1, "", 1); + + err = map(exports, buf, 1, "", 1); + if (err) + { + return err; + } snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name); - map(exports, buf, 1, "", 1); + return map(exports, buf, 1, "", 1); } @@ -943,14 +1594,13 @@ void map_conditional(struct map *exports, const char *name, int choose_first) * * Parameters : self = name of CGI to leave out, can be NULL * - * 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) { @@ -958,17 +1608,19 @@ char *make_menu(const char *self) } /* List available unhidden CGI's and export as "other-cgis" */ - for (d = cgi_dispatcher; d->handler; d++) + for (d = cgi_dispatchers; d->name; d++) { - if (strncmp(d->description, "HIDE", 4) && strcmp(d->name, self)) + if (d->description && strcmp(d->name, self)) { - snprintf(buf, BUFFER_SIZE, "
  • %s
    • \n", - HOME_PAGE_URL, d->name, d->description); - result = strsav(result, buf); + string_append(&result, "
  • name); + string_append(&result, "\">"); + string_append(&result, d->description); + string_append(&result, "
    • \n"); } } - return(result); + return result; } @@ -986,24 +1638,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; }