-const char cgi_rcs[] = "$Id: cgi.c,v 1.33 2001/10/14 22:28:41 jongfoster Exp $";
+const char cgi_rcs[] = "$Id: cgi.c,v 1.49 2002/03/13 00:27:04 jongfoster Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
*
* Revisions :
* $Log: cgi.c,v $
+ * 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.
*
#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;
{ "",
cgi_default,
"Junkbuster main page" },
+#ifdef FEATURE_GRACEFUL_TERMINATION
+ { "die",
+ cgi_die,
+ "<b>Shut down</b> - <font color=red size='+1'>Do not deploy this build in a production environment, this is a one click Denial Of Service attack!!!</font>" },
+#endif
{ "show-status",
cgi_show_status,
"Show information about the current configuration" },
{ "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",
cgi_edit_actions,
"Edit the actions list" },
-#endif /* def FEATURE_CGI_EDIT_ACTIONS */
-#ifdef FEATURE_CGI_EDIT_ACTIONS
+
+ { "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-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",
cgi_send_banner,
- NULL /* Send the transparent or \"Junkbuster\" gif */ },
+ NULL /* Send a built-in image */ },
+ { "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 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)); }'
+ */
+
+#ifdef FEATURE_NO_GIFS
+
+/*
+ * "Junkbuster" logo, as a PNG.
+ */
+const char image_logo_data[] =
+ "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
+ "\122\000\000\000\104\000\000\000\013\001\003\000\000\000\374"
+ "\323\271\110\000\000\000\004\147\101\115\101\000\000\261\217"
+ "\013\374\141\005\000\000\000\006\120\114\124\105\310\310\310"
+ "\000\000\000\062\100\100\345\000\000\000\001\164\122\116\123"
+ "\000\100\346\330\146\000\000\000\001\142\113\107\104\000\210"
+ "\005\035\110\000\000\000\126\111\104\101\124\170\332\143\140"
+ "\200\003\066\006\146\066\006\006\011\124\326\331\315\146\147"
+ "\316\333\174\116\000\262\156\247\347\334\234\071\373\001\220"
+ "\065\373\130\316\035\311\331\015\020\326\161\311\337\014\014"
+ "\151\147\147\247\345\034\236\331\014\144\335\235\155\236\173"
+ "\163\366\154\006\006\233\334\331\162\307\316\363\174\106\330"
+ "\300\000\000\002\127\040\324\250\204\044\102\000\000\000\000"
+ "\111\105\116\104\256\102\140\202";
+
+/*
+ * 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\002\000\000\000\002\010\002\000\000\000\375"
+ "\324\232\163\000\000\000\006\142\113\107\104\000\310\000\310"
+ "\000\310\052\045\225\037\000\000\000\027\111\104\101\124\170"
+ "\332\143\374\377\377\377\311\223\047\031\116\234\070\361\377"
+ "\377\177\000\112\335\012\257\162\103\306\335\000\000\000\000"
+ "\111\105\116\104\256\102\140\202o";
+#else
-const char image_junkbuster_gif_data[] =
+/*
+ * "Junkbuster" logo, as a GIF.
+ */
+const char image_logo_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"
"\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276"
"\037Q\000\000;";
-const int image_junkbuster_gif_length = sizeof(image_junkbuster_gif_data) - 1;
-
+/*
+ * 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\025\111\040\165\163\145\144\040\164"
+ "\157\040\142\145\040\141\040\142\141\156\156\145\162\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 size_t image_logo_length = sizeof(image_logo_data) - 1;
+const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
+const size_t image_blank_length = sizeof(image_blank_data) - 1;
-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 passes
+ * 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.
*
* Should we intercept ?
*/
- /* Either the host matches CGI_PREFIX_HOST ..*/
- if ( (0 == strcmpic(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. Remove leading '/' */
path++;
}
- /* Or it's the host part HOME_PAGE_URL, and the path /config/ */
- else if ( (0 == strcmpic(host, HOME_PAGE_URL + 7 ))
- && (0 == strncmpic(path,"/config", 7)) )
+ /* 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))) )
{
- /* take everything following "/config" */
- path += 7;
+ /* take everything following CGI_SITE_2_PATH */
+ path += strlen(CGI_SITE_2_PATH);
if (*path == '/')
{
- /* skip the forward slash after "/config" */
+ /* skip the forward slash after CGI_SITE_2_PATH */
path++;
}
else if (*path != '\0')
{
- /* wierdness: URL is /configXXX, where XXX is some string */
+ /*
+ * wierdness: URL is /configXXX, where XXX is some string
+ * Do *NOT* intercept.
+ */
return NULL;
}
}
struct http_response *rsp;
char *query_args_start;
char *path_copy;
- int result;
+ jb_err err;
if (NULL == (path_copy = strdup(path)))
{
- return NULL;
+ return cgi_error_memory();
}
query_args_start = path_copy;
if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
{
free(path_copy);
- return(NULL);
+ return cgi_error_memory();
}
{
free(path_copy);
free_map(param_list);
- return NULL;
+ return cgi_error_memory();
}
log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
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))
{
- result = (d->handler)(csp, rsp, param_list);
+ err = (d->handler)(csp, rsp, param_list);
free(path_copy);
free_map(param_list);
- if (result)
+ if (err == JB_ERR_CGI_PARAMS)
{
- /* Error in handler */
- free_http_response(rsp);
- return(NULL);
+ err = cgi_error_bad_param(csp, rsp);
}
- else
+ if (!err)
{
/* It worked */
- return(finish_http_response(rsp));
+ return finish_http_response(rsp);
+ }
+ else
+ {
+ /* Error in handler, probably out-of-memory */
+ free_http_response(rsp);
+ return cgi_error_memory();
}
}
+ d++;
}
}
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;
+ }
}
}
- return(cgi_params);
+ return cgi_params;
}
* 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 =
+ "<html>\r\n"
+ "<head><title>500 Internal JunkBuster Proxy Error</title></head>\r\n"
+ "<body>\r\n"
+ "<h1>500 Internal JunkBuster Proxy Error</h1>\r\n"
+ "<p>JunkBuster <b>ran out of memory</b> while processing your request.</p>\r\n"
+ "<p>Please contact your proxy administrator, or try again later</p>\r\n"
+ "</body>\r\n"
+ "</html>\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[] =
+ "<html>\r\n"
+ "<head><title>500 Internal JunkBuster Proxy Error</title></head>\r\n"
+ "<body>\r\n"
+ "<h1>500 Internal JunkBuster Proxy Error</h1>\r\n"
+ "<p>JunkBuster encountered an error while processing your request:</p>\r\n"
+ "<p><b>Could not load template file <code>";
+ static const char body_suffix[] =
+ "</code></b></p>\r\n"
+ "<p>Please contact your proxy administrator.</p>\r\n"
+ "<p>If you are the proxy administrator, please put the required file "
+ "in the <code><i>(confdir)</i>/templates</code> directory. The "
+ "location of the <code><i>(confdir)</i></code> directory "
+ "is specified in the main JunkBuster <code>config</code> "
+ "file. (It's typically the JunkBuster install directory"
+#ifndef _WIN32
+ ", or <code>/etc/junkbuster/</code>"
+#endif /* ndef _WIN32 */
+ ").</p>\r\n"
+ "</body>\r\n"
+ "</html>\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);
}
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,
t->tm_min,
t->tm_sec
);
- buf[32] = '\0';
}
* 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
{
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:
*
* 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)
{
* 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
{
* 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;
}
-
+
/*********************************************************************
*
*********************************************************************/
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);
/*********************************************************************
*
- * Function : fill_template
+ * Function : template_load
*
* Description : CGI support function that loads a given HTML
* template from the confdir, ignoring comment
* lines.
*
* Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 3 : template = name of the HTML template to be used
+ * 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_FATAL, "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))
{
{
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 fills in a pre-loaded
* HTML template by replacing @name@ with value using
* 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 : 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;
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 (NULL != 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;
}
}
* 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;
}
* 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)
{
char buf[20];
+ jb_err err;
+ struct map * exports;
int local_help_exists = 0;
- struct map * exports = new_map();
- 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, "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);
+ assert(csp);
+
+ exports = new_map();
+ if (exports == NULL)
+ {
+ return NULL;
+ }
+
+ 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->admin_address != NULL)
+ if (csp->config->admin_address != NULL)
{
- 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
{
- map_block_killer(exports, "have-adminaddr-info");
+ if (!err) err = map_block_killer(exports, "have-adminaddr-info");
}
- if(csp->config->proxy_info_url != NULL)
+ if (csp->config->proxy_info_url != NULL)
{
- 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
{
- map_block_killer(exports, "have-proxy-info");
+ if (!err) err = map_block_killer(exports, "have-proxy-info");
}
if (local_help_exists == 0)
- map_block_killer(exports, "have-help-info");
+ {
+ if (!err) err = map_block_killer(exports, "have-help-info");
+ }
- return (exports);
+ if (err)
+ {
+ free_map(exports);
+ return NULL;
+ }
+ return exports;
}
* 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-<name>-start@" and "@if-<name>-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);
}
* 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);
- snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), 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);
+ return map(exports, buf, 1, "", 1);
}
*
* 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)
{
{
if (d->description && strcmp(d->name, self))
{
- snprintf(buf, BUFFER_SIZE, "<li><a href=%s/config/%s>%s</a></li>\n",
- HOME_PAGE_URL, d->name, d->description);
- result = strsav(result, buf);
+ string_append(&result, "<li><a href=\"" CGI_PREFIX);
+ string_append(&result, d->name);
+ string_append(&result, "\">");
+ string_append(&result, d->description);
+ string_append(&result, "</a></li>\n");
}
}
- return(result);
+ return result;
}
*********************************************************************/
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, "<table>\n");
+
string_append(&ret, "<table>\n");
- while (cur_entry)
+ for (cur_entry = the_map->first;
+ (cur_entry != NULL) && (ret != NULL);
+ cur_entry = cur_entry->next)
{
- ret = strsav(ret, "<tr><td><b>");
- ret = strsav(ret, cur_entry->name);
- ret = strsav(ret, "</b></td><td>");
- ret = strsav(ret, cur_entry->value);
- ret = strsav(ret, "</td></tr>\n");
- cur_entry = cur_entry->next;
+ string_append(&ret, "<tr><td><b>");
+ string_join (&ret, html_encode(cur_entry->name));
+ string_append(&ret, "</b></td><td>");
+ string_join (&ret, html_encode(cur_entry->value));
+ string_append(&ret, "</td></tr>\n");
}
- ret = strsav(ret, "</table>\n");
- return(ret);
-
+ string_append(&ret, "</table>\n");
+ return ret;
}
projects / privoxy.git / blobdiff