-const char cgi_rcs[] = "$Id: cgi.c,v 1.11 2001/07/18 17:24:37 oes 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 $
*
* Purpose : Declares functions to intercept request, generate
* html or gif answers, and to compose HTTP resonses.
+ * This only contains the framework functions, the
+ * actual handler functions are declared elsewhere.
*
* Functions declared include:
*
*
* 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.
+ *
+ * Revision 1.32 2001/10/14 22:20:18 jongfoster
+ * - Changes to CGI dispatching method to match CGI names exactly,
+ * rather than doing a prefix match.
+ * - No longer need to count the length of the CGI handler names by hand.
+ * - Adding new handler for 404 error when disptching a CGI, if none of
+ * the handlers match.
+ * - Adding new handlers for CGI actionsfile editor.
+ *
+ * Revision 1.31 2001/10/10 10:56:39 oes
+ * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
+ *
+ * Revision 1.30 2001/10/02 15:30:57 oes
+ * Introduced show-request cgi
+ *
+ * Revision 1.29 2001/09/20 15:47:44 steudten
+ *
+ * Fix BUG: Modify int size to size_t size in fill_template()
+ * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
+ *
+ * Revision 1.28 2001/09/19 18:00:37 oes
+ * - Deletef time() FIXME (Can't fail under Linux either, if
+ * the argument is guaranteed to be in out address space,
+ * which it is.)
+ * - Fixed comments
+ * - Pointer notation cosmetics
+ * - Fixed a minor bug in template_fill(): Failiure of
+ * pcrs_execute() now secure.
+ *
+ * Revision 1.27 2001/09/16 17:08:54 jongfoster
+ * Moving simple CGI functions from cgi.c to new file cgisimple.c
+ *
+ * Revision 1.26 2001/09/16 15:47:37 jongfoster
+ * First version of CGI-based edit interface. This is very much a
+ * work-in-progress, and you can't actually use it to edit anything
+ * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
+ * to have any effect.
+ *
+ * Revision 1.25 2001/09/16 15:02:35 jongfoster
+ * Adding i.j.b/robots.txt.
+ * Inlining add_stats() since it's only ever called from one place.
+ *
+ * Revision 1.24 2001/09/16 11:38:01 jongfoster
+ * Splitting fill_template() into 2 functions:
+ * template_load() loads the file
+ * template_fill() performs the PCRS regexps.
+ * This is because the CGI edit interface has a "table row"
+ * template which is used many times in the page - this
+ * change means it's only loaded from disk once.
+ *
+ * Revision 1.23 2001/09/16 11:16:05 jongfoster
+ * Better error handling in dispatch_cgi() and parse_cgi_parameters()
+ *
+ * Revision 1.22 2001/09/16 11:00:10 jongfoster
+ * New function alloc_http_response, for symmetry with free_http_response
+ *
+ * Revision 1.21 2001/09/13 23:53:03 jongfoster
+ * Support for both static and dynamically generated CGI pages.
+ * Correctly setting Last-Modified: and Expires: HTTP headers.
+ *
+ * Revision 1.20 2001/09/13 23:40:36 jongfoster
+ * (Cosmetic only) Indentation correction
+ *
+ * Revision 1.19 2001/09/13 23:31:25 jongfoster
+ * Moving image data to cgi.c rather than cgi.h.
+ *
+ * Revision 1.18 2001/08/05 16:06:20 jongfoster
+ * Modifiying "struct map" so that there are now separate header and
+ * "map_entry" structures. This means that functions which modify a
+ * map no longer need to return a pointer to the modified map.
+ * Also, it no longer reverses the order of the entries (which may be
+ * important with some advanced template substitutions).
+ *
+ * Revision 1.17 2001/08/05 15:57:38 oes
+ * Adapted finish_http_response to new list_to_text
+ *
+ * Revision 1.16 2001/08/01 21:33:18 jongfoster
+ * Changes to fill_template() that reduce memory usage without having
+ * an impact on performance. I also renamed some variables so as not
+ * to clash with the C++ keywords "new" and "template".
+ *
+ * Revision 1.15 2001/08/01 21:19:22 jongfoster
+ * Moving file version information to a separate CGI page.
+ *
+ * Revision 1.14 2001/08/01 00:19:03 jongfoster
+ * New function: map_conditional() for an if-then-else syntax.
+ * Changing to use new version of show_defines()
+ *
+ * Revision 1.13 2001/07/30 22:08:36 jongfoster
+ * Tidying up #defines:
+ * - All feature #defines are now of the form FEATURE_xxx
+ * - Permanently turned off WIN_GUI_EDIT
+ * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
+ *
+ * Revision 1.12 2001/07/29 18:47:05 jongfoster
+ * Adding missing #include "loadcfg.h"
+ *
* Revision 1.11 2001/07/18 17:24:37 oes
* Changed to conform to new pcrs interface
*
#include <stdlib.h>
#include <ctype.h>
#include <string.h>
+#include <assert.h>
#ifdef _WIN32
#define snprintf _snprintf
#include "list.h"
#include "encode.h"
#include "ssplit.h"
-#include "jcc.h"
-#include "filters.h"
-#include "actions.h"
#include "errlog.h"
#include "miscutil.h"
-#include "showargs.h"
+#include "cgisimple.h"
+#ifdef FEATURE_CGI_EDIT_ACTIONS
+#include "cgiedit.h"
+#endif /* def FEATURE_CGI_EDIT_ACTIONS */
#include "loadcfg.h"
+/* loadcfg.h is for g_bToggleIJB only */
const char cgi_h_rcs[] = CGI_H_VERSION;
-const struct cgi_dispatcher cgi_dispatcher[] = {
+static const struct cgi_dispatcher cgi_dispatchers[] = {
+ { "",
+ 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",
- 11, cgi_show_status,
- "Show information about the version and configuration" },
+ cgi_show_status,
+ "Show information about the current configuration" },
+ { "show-version",
+ cgi_show_version,
+ "Show the source code version numbers" },
+ { "show-request",
+ cgi_show_request,
+ "Show the client's request headers." },
{ "show-url-info",
- 13, cgi_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" },
+
+
+ { "eaa", /* Shortcut for edit-actions-add-url-form */
+ cgi_edit_actions_add_url_form,
+ NULL },
+ { "eau", /* Shortcut for edit-actions-url-form */
+ cgi_edit_actions_url_form,
+ NULL },
+ { "ear", /* Shortcut for edit-actions-remove-url-form */
+ cgi_edit_actions_remove_url_form,
+ NULL },
+ { "eas", /* Shortcut for edit-actions-for-url */
+ cgi_edit_actions_for_url,
+ NULL },
+ { "easa", /* Shortcut for edit-actions-section-add */
+ cgi_edit_actions_section_add,
+ NULL },
+ { "easr", /* Shortcut for edit-actions-section-remove */
+ cgi_edit_actions_section_remove,
+ NULL },
+ { "eass", /* Shortcut for edit-actions-section-swap */
+ cgi_edit_actions_section_swap,
+ NULL },
+ { "edit-actions-for-url",
+ cgi_edit_actions_for_url,
+ NULL /* Edit the actions for (a) specified URL(s) */ },
+ { "edit-actions-list",
+ cgi_edit_actions_list,
+ NULL /* Edit the actions list */ },
+ { "edit-actions-submit",
+ cgi_edit_actions_submit,
+ NULL /* Change the actions for (a) specified URL(s) */ },
+ { "edit-actions-url",
+ cgi_edit_actions_url,
+ NULL /* Change a URL pattern in the actionsfile */ },
+ { "edit-actions-url-form",
+ cgi_edit_actions_url_form,
+ NULL /* Form to change a URL pattern in the actionsfile */ },
+ { "edit-actions-add-url",
+ cgi_edit_actions_add_url,
+ NULL /* Add a URL pattern to the actionsfile */ },
+ { "edit-actions-add-url-form",
+ cgi_edit_actions_add_url_form,
+ NULL /* Form to add a URL pattern to the actionsfile */ },
+ { "edit-actions-remove-url",
+ cgi_edit_actions_remove_url,
+ NULL /* Remove a URL pattern from the actionsfile */ },
+ { "edit-actions-remove-url-form",
+ cgi_edit_actions_remove_url_form,
+ NULL /* Form to remove a URL pattern from the actionsfile */ },
+ { "edit-actions-section-add",
+ cgi_edit_actions_section_add,
+ NULL /* Remove a section from the actionsfile */ },
+ { "edit-actions-section-remove",
+ cgi_edit_actions_section_remove,
+ NULL /* Remove a section from the actionsfile */ },
+ { "edit-actions-section-swap",
+ cgi_edit_actions_section_swap,
+ NULL /* Swap two sections in the actionsfile */ },
+#endif /* def FEATURE_CGI_EDIT_ACTIONS */
+ { "robots.txt",
+ cgi_robots_txt,
+ NULL /* Sends a robots.txt file to tell robots to go away. */ },
{ "send-banner",
- 11, cgi_send_banner,
- "HIDE Send the transparent or \"Junkbuster\" gif" },
- { "",
- 0, cgi_default,
- "Junkbuster main page" },
- { NULL, 0, NULL, NULL }
+ cgi_send_banner,
+ NULL /* Send a built-in image */ },
+ { "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 */ }
};
+/*
+ * Bulit-in images for ad replacement
+ *
+ * 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
+
+/*
+ * "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"
+ "\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;";
+
+/*
+ * 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";
+
+/*
+ * 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;
+
+
+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...)
*********************************************************************/
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;
}
* This is a CGI call.
*/
- /* Get mem for response or fail*/
- if (NULL == ( rsp = zalloc(sizeof(*rsp))))
+ 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();
}
- /* Remove leading slash */
- if (*argstring == '/')
+
+ /*
+ * At this point:
+ * path_copy = CGI call name
+ * param_list = CGI params, as map
+ */
+
+ /* Get mem for response or fail*/
+ if (NULL == (rsp = alloc_http_response()))
{
- argstring++;
+ free(path_copy);
+ free_map(param_list);
+ return cgi_error_memory();
}
log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
csp->ip_addr_str, csp->http->cmd);
/* Find and start the right CGI function*/
- for (d = cgi_dispatcher; d->handler; d++)
+ d = cgi_dispatchers;
+ for (;;)
{
- if (strncmp(argstring, d->name, d->name_length) == 0)
+ if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
{
- param_list = parse_cgi_parameters(argstring + d->name_length);
- if ((d->handler)(csp, rsp, param_list))
+ err = (d->handler)(csp, rsp, param_list);
+ free(path_copy);
+ free_map(param_list);
+ if (err == JB_ERR_CGI_PARAMS)
{
- freez(rsp);
+ err = cgi_error_bad_param(csp, rsp);
+ }
+ if (!err)
+ {
+ /* It worked */
+ return finish_http_response(rsp);
+ }
+ else
+ {
+ /* Error in handler, probably out-of-memory */
+ free_http_response(rsp);
+ return cgi_error_memory();
}
-
- free_map(param_list);
- return(finish_http_response(rsp));
}
+ d++;
}
-
- /* Can't get here, since cgi_default will match all requests */
- freez(rsp);
- return(NULL);
-
}
* 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 : poniter to param list, or NULL if failiure
+ * 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 = NULL;
+ struct map *cgi_params;
- if(*argstring == '?') argstring++;
- tmp = strdup(argstring);
+ if (NULL == (cgi_params = new_map()))
+ {
+ 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';
- cgi_params = map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0);
+ if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
+ {
+ free_map(cgi_params);
+ return NULL;
+ }
}
}
- free(tmp);
- return(cgi_params);
+ return cgi_params;
}
/*********************************************************************
*
- * Function : cgi_default
+ * Function : error_response
+ *
+ * Description : returns an http_response that explains the reason
+ * why a request failed.
*
- * Description : CGI function that is called if no action was given.
- * Lists menu of available unhidden CGIs.
- *
* Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : templatename = Which template should be used for the answer
+ * 3 : sys_err = system error number
*
- * Returns : 0
+ * Returns : A http_response. If we run out of memory, this
+ * will be cgi_error_memory().
*
*********************************************************************/
-int cgi_default(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+struct http_response *error_response(struct client_state *csp,
+ const char *templatename,
+ int sys_err)
{
- char *p, *tmp = NULL;
- struct map *exports = default_exports(csp, "");
+ jb_err err;
+ struct http_response *rsp;
+ struct map * exports = default_exports(csp, NULL);
+ if (exports == NULL)
+ {
+ return cgi_error_memory();
+ }
- /* If there were other parameters, export a dump as "cgi-parameters" */
- if(parameters)
+ if (NULL == (rsp = alloc_http_response()))
{
- p = dump_map(parameters);
- tmp = strsav(tmp, "<p>What made you think this cgi takes parameters?\n"
- "Anyway, here they are, in case you're interested:</p>\n");
- tmp = strsav(tmp, p);
- exports = map(exports, "cgi-parameters", 1, tmp, 0);
- free(p);
+ free_map(exports);
+ return cgi_error_memory();
}
- else
+
+ 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)
{
- exports = map(exports, "cgi-parameters", 1, "", 1);
+ 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 = fill_template(csp, "default", exports);
- free_map(exports);
- return(0);
+ 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");
+ 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();
+ }
+ }
+
+ 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_send_banner
- *
- * Description : CGI function that returns a banner.
+ * Function : cgi_init_error_messages
*
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
+ * Description : Call at the start of the program to initialize
+ * the error message used by cgi_error_memory().
*
- * CGI Parameters :
- * type : Selects the type of banner between "trans" and "jb".
- * Defaults to "jb" if absent or != "trans".
+ * Parameters : N/A
*
- * Returns : 0
+ * Returns : N/A
*
*********************************************************************/
-int cgi_send_banner(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+void cgi_init_error_messages(void)
{
- if(strcmp(lookup(parameters, "type"), "trans"))
- {
- rsp->body = bindup(JBGIF, sizeof(JBGIF));
- rsp->content_length = sizeof(JBGIF);
- }
- else
- {
- rsp->body = bindup(BLANKGIF, sizeof(BLANKGIF));
- rsp->content_length = sizeof(BLANKGIF);
- }
-
- enlist(rsp->headers, "Content-Type: image/gif");
-
- return(0);
-
+ 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_show_status
+ * Function : cgi_error_memory
*
- * Description : CGI function that returns a a web page describing the
- * current status of IJB.
+ * Description : Called if a CGI function runs out of memory.
+ * Returns a statically-allocated error response.
*
* Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
- *
- * CGI Parameters :
- * type : Selects the type of banner between "trans" and "jb".
- * Defaults to "jb" if absent or != "trans".
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : template_name = Name of template that could not
+ * be loaded.
*
- * Returns : 0
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int cgi_show_status(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+struct http_response *cgi_error_memory(void)
{
- char *s = NULL;
- int i;
- struct map *exports = default_exports(csp, "show-status");
-
-#ifdef SPLIT_PROXY_ARGS
- FILE * fp;
- char buf[BUFFER_SIZE];
- char * p;
- const char * filename = NULL;
- char * file_description = NULL;
-
+ /* assert that it's been initialized. */
+ assert(cgi_error_memory_response->head);
- p = lookup(parameters, "file");
- switch (*p)
- {
- case 'p':
- if (csp->actions_list)
- {
- filename = csp->actions_list->filename;
- file_description = "Actions List";
- }
- break;
-
- case 'r':
- if (csp->rlist)
- {
- filename = csp->rlist->filename;
- file_description = "Regex Filter List";
- }
- break;
-
-#ifdef TRUST_FILES
- case 't':
- if (csp->tlist)
- {
- filename = csp->tlist->filename;
- file_description = "Trust List";
- }
- break;
-#endif /* def TRUST_FILES */
- }
-
- if (NULL != filename)
- {
- exports = map(exports, "file-description", 1, file_description, 1);
- exports = map(exports, "filepath", 1, html_encode(filename), 0);
-
- if ((fp = fopen(filename, "r")) == NULL)
- {
- exports = map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1);
- }
- else
- {
- while (fgets(buf, sizeof(buf), fp))
- {
- p = html_encode(buf);
- if (p)
- {
- s = strsav(s, p);
- freez(p);
- s = strsav(s, "<br>");
- }
- }
- fclose(fp);
- exports = map(exports, "contents", 1, s, 0);
- }
- rsp->body = fill_template(csp, "show-status-file", exports);
- free_map(exports);
- return(0);
-
- }
-
-#endif /* def SPLIT_PROXY_ARGS */
-
- exports = map(exports, "redirect-url", 1, REDIRECT_URL, 1);
-
- s = NULL;
- for (i=0; i < Argc; i++)
- {
- s = strsav(s, Argv[i]);
- s = strsav(s, " ");
- }
- exports = map(exports, "invocation", 1, s, 0);
-
- exports = map(exports, "options", 1, csp->config->proxy_args, 1);
- s = show_rcs();
- exports = map(exports, "sourceversions", 1, s, 0);
- s = show_defines();
- exports = map(exports, "defines", 1, s, 0);
-
-#ifdef STATISTICS
- exports = add_stats(exports);
-#else
- exports = map_block_killer(exports, "statistics");
-#endif /* ndef STATISTICS */
-
-#ifdef SPLIT_PROXY_ARGS
-
- exports = map_block_killer(exports, "no-split-args");
-
- if (csp->actions_list)
- {
- exports = map(exports, "actions-filename", 1, csp->actions_list->filename, 1);
- }
- else
- {
- exports = map(exports, "actions-filename", 1, "None specified", 1);
- }
-
- if (csp->rlist)
- {
- exports = map(exports, "re-filter-filename", 1, csp->rlist->filename, 1);
- }
- else
- {
- exports = map(exports, "re-filter-filename", 1, "None specified", 1);
- }
-
-#ifdef TRUST_FILES
- if (csp->tlist)
- {
- exports = map(exports, "trust-filename", 1, csp->tlist->filename, 1);
- }
- else
- {
- exports = map(exports, "trust-filename", 1, "None specified", 1);
- }
-#else
- exports = map_block_killer(exports, "trust-support");
-#endif /* ndef TRUST_FILES */
-
-#else /* ifndef SPLIT_PROXY_ARGS */
- exports = map_block_killer(exports, "split-args");
+ return cgi_error_memory_response;
+}
- if (csp->clist)
- {
- map(exports, "clist", 1, csp->clist->proxy_args , 1);
- }
- if (csp->rlist)
+/*********************************************************************
+ *
+ * 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)
{
- map(exports, "rlist", 1, csp->rlist->proxy_args , 1);
+ return JB_ERR_MEMORY;
}
+ strcpy(rsp->body, body_prefix);
+ strcat(rsp->body, template_name);
+ strcat(rsp->body, body_suffix);
-#ifdef TRUST_FILES
- if (csp->tlist)
+ rsp->status = strdup(status);
+ if (rsp->body == NULL)
{
- map(exports, "tlist", 1, csp->tlist->proxy_args , 1);
+ return JB_ERR_MEMORY;
}
-#endif /* def TRUST_FILES */
-
-#endif /* ndef SPLIT_PROXY_ARGS */
-
- rsp->body = fill_template(csp, "show-status", exports);
- free_map(exports);
- return(0);
+ return JB_ERR_OK;
}
-
- /*********************************************************************
- *
- * Function : cgi_show_url_info
+
+/*********************************************************************
*
- * Description : CGI function that determines and shows which actions
- * junkbuster will perform for a given url, and which
- * matches starting from the defaults have lead to that.
+ * 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
- * 3 : parameters = map of cgi parameters
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
*
- * CGI Parameters :
- * url : The url whose actions are to be determined.
- * If url is unset, the url-given conditional will be
- * set, so that all but the form can be suppressed in
- * the template.
+ * CGI Parameters : none
*
- * Returns : 0
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+jb_err cgi_error_bad_param(struct client_state *csp,
+ struct http_response *rsp)
{
- struct map *exports = default_exports(csp, "show-url-info");
- char *url_param, *host = NULL;
-
- if (NULL == (url_param = strdup(lookup(parameters, "url"))) || *url_param == '\0')
- {
- exports = map_block_killer(exports, "url-given");
- exports = map(exports, "url", 1, "", 1);
- }
- else
- {
- char *matches = NULL;
- char *path;
- char *s;
- int port = 80;
- int hits = 0;
- struct file_list *fl;
- struct url_actions *b;
- struct url_spec url[1];
- struct current_action_spec action[1];
-
- host = url_param;
- host += (strncmp(url_param, "http://", 7)) ? 0 : 7;
-
- exports = map(exports, "url", 1, host, 1);
- exports = map(exports, "url-html", 1, html_encode(host), 0);
-
- init_current_action(action);
-
- s = current_action_to_text(action);
- exports = map(exports, "default", 1, s , 0);
-
- if (((fl = csp->actions_list) == NULL) || ((b = fl->f) == NULL))
- {
- exports = map(exports, "matches", 1, "none" , 1);
- exports = map(exports, "final", 1, lookup(exports, "default"), 1);
-
- freez(url_param);
- free_current_action(action);
-
- rsp->body = fill_template(csp, "show-url-info", exports);
- free_map(exports);
-
- return 0;
- }
-
- s = strchr(host, '/');
- if (s != NULL)
- {
- path = strdup(s);
- *s = '\0';
- }
- else
- {
- path = strdup("");
- }
- s = strchr(host, ':');
- if (s != NULL)
- {
- *s++ = '\0';
- port = atoi(s);
- s = NULL;
- }
-
- *url = dsplit(host);
-
- /* if splitting the domain fails, punt */
- if (url->dbuf == NULL)
- {
- exports = map(exports, "matches", 1, "none" , 1);
- exports = map(exports, "final", 1, lookup(exports, "default"), 1);
-
- freez(url_param);
- freez(path);
- free_current_action(action);
-
- rsp->body = fill_template(csp, "show-url-info", exports);
- free_map(exports);
-
- return 0;
- }
-
- for (b = b->next; NULL != b; b = b->next)
- {
- if ((b->url->port == 0) || (b->url->port == port))
- {
- if ((b->url->domain[0] == '\0') || (domaincmp(b->url, url) == 0))
- {
- if ((b->url->path == NULL) ||
-#ifdef REGEX
- (regexec(b->url->preg, path, 0, NULL, 0) == 0)
-#else
- (strncmp(b->url->path, path, b->url->pathlen) == 0)
-#endif
- )
- {
- s = actions_to_text(b->action);
- matches = strsav(matches, "<b>{");
- matches = strsav(matches, s);
- matches = strsav(matches, " }</b><br>\n<code>");
- matches = strsav(matches, b->url->spec);
- matches = strsav(matches, "</code><br>\n<br>\n");
- freez(s);
-
- merge_current_action(action, b->action);
- hits++;
- }
- }
- }
- }
-
- if (hits)
- {
- exports = map(exports, "matches", 1, matches , 0);
- }
- else
- {
- exports = map(exports, "matches", 1, "none", 1);
- }
- matches = NULL;
-
- freez(url->dbuf);
- freez(url->dvec);
-
- freez(url_param);
- freez(path);
+ struct map *exports;
- s = current_action_to_text(action);
- exports = map(exports, "final", 1, s, 0);
- s = NULL;
+ assert(csp);
+ assert(rsp);
- free_current_action(action);
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ return JB_ERR_MEMORY;
}
- rsp->body = fill_template(csp, "show-url-info", exports);
- free_map(exports);
- return 0;
-
+ return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
}
/*********************************************************************
*
- * Function : error_response
+ * Function : get_http_time
*
- * Description : returns an http_response that explains the reason
- * why a request failed.
+ * Description : Get the time in a format suitable for use in a
+ * HTTP header - e.g.:
+ * "Sun, 06 Nov 1994 08:49:37 GMT"
*
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : template = Which template should be used for the answer
- * 3 : errno = system error number
+ * Parameters :
+ * 1 : time_offset = Time returned will be current time
+ * plus this number of seconds.
+ * 2 : buf = Destination for result. Must be long enough
+ * to hold 29 characters plus a trailing zero.
*
- * Returns : NULL if no memory, else http_response
+ * Returns : N/A
*
*********************************************************************/
-struct http_response *error_response(struct client_state *csp, const char *template, int err)
+void get_http_time(int time_offset, char *buf)
{
- struct http_response *rsp;
- struct map *exports = default_exports(csp, NULL);
+ static const char day_names[7][4] =
+ { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
+ static const char month_names[12][4] =
+ { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
+ "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
- if (NULL == ( rsp = (struct http_response *)zalloc(sizeof(*rsp))))
- {
- return NULL;
- }
+ struct tm *t;
+ time_t current_time;
- exports = map(exports, "host-html", 1, html_encode(csp->http->host), 0);
- exports = map(exports, "hostport", 1, csp->http->hostport, 1);
- exports = map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0);
- exports = map(exports, "path", 1, csp->http->path, 1);
- exports = map(exports, "path-html", 1, html_encode(csp->http->path), 0);
- exports = map(exports, "error", 1, safe_strerror(err), 0);
- exports = map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1);
+ assert(buf);
- rsp->body = fill_template(csp, template, exports);
- free_map(exports);
-
- if (!strcmp(template, "no-such-domain"))
- {
- rsp->status = strdup("404 No such domain");
- }
- else if (!strcmp(template, "connect-failed"))
- {
- rsp->status = strdup("503 Connect failed");
- }
+ time(¤t_time); /* get current time */
+
+ current_time += time_offset;
+
+ /* get and save the gmt */
+ {
+#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,
+ "%s, %02d %s %4d %02d:%02d:%02d GMT",
+ day_names[t->tm_wday],
+ t->tm_mday,
+ month_names[t->tm_mon],
+ t->tm_year + 1900,
+ t->tm_hour,
+ t->tm_min,
+ t->tm_sec
+ );
- return(finish_http_response(rsp));
}
* 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 FIXME: Are these correct? sequence OK? check rfc!
+ * Fill in the default headers:
+ *
+ * Content-Type: default to text/html if not already specified.
+ * Date: set to current date/time.
+ * Last-Modified: set to date/time the page was last changed.
+ * Expires: set to date/time page next needs reloading.
+ * Cache-Control: set to "no-cache" if applicable.
+ *
+ * See http://www.w3.org/Protocols/rfc2068/rfc2068
*/
- enlist_unique(rsp->headers, "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT", 14);
- enlist_unique(rsp->headers, "Expires: Thu Jul 31, 1997 07:42:22 pm GMT", 8);
- enlist_unique(rsp->headers, "Content-Type: text/html", 13);
- enlist(rsp->headers, "");
-
+ if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
+
+ if (rsp->is_static)
+ {
+ /*
+ * Set Expires to about 10 min into the future so it'll get reloaded
+ * occasionally, e.g. if IJB gets upgraded.
+ */
+
+ if (!err)
+ {
+ get_http_time(0, buf);
+ err = enlist_unique_header(rsp->headers, "Date", buf);
+ }
+
+ /* Some date in the past. */
+ if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
+
+ if (!err)
+ {
+ get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
+ err = enlist_unique_header(rsp->headers, "Expires", buf);
+ }
+ }
+ else
+ {
+ /*
+ * Compliant browsers should not cache this due to the "Cache-Control"
+ * setting. However, to be certain, we also set both "Last-Modified"
+ * and "Expires" to the current time.
+ */
+ if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
+
+ get_http_time(0, 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;
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : alloc_http_response
+ *
+ * Description : Allocates a new http_response structure.
+ *
+ * Parameters : N/A
+ *
+ * Returns : pointer to a new http_response, or NULL.
+ *
+ *********************************************************************/
+struct http_response *alloc_http_response(void)
+{
+ return (struct http_response *) zalloc(sizeof(struct http_response));
}
-
+
/*********************************************************************
*
*********************************************************************/
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);
freez(rsp->body);
destroy_list(rsp->headers);
- freez(rsp);
+ free(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...)
- * 3 : template = name of the HTML template to be used
- * 2 : exports = map with fill in symbol -> name pairs
+ * 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 filled out form, or NULL if failiure
+ * 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 *fill_template(struct client_state *csp, const char *template, struct map *exports)
+jb_err template_load(struct client_state *csp, char ** template_ptr,
+ const char *templatename)
{
- struct map *m;
- pcrs_job *job, *joblist = NULL;
- char buf[BUFFER_SIZE];
- char *new, *old = NULL;
- int size;
+ 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, template);
- 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;
}
-
- /*
- * Assemble pcrs joblist from exports map
- */
- for (m = exports; m; m = m->next)
+ full_path = make_path(templates_dir_path, templatename);
+ free(templates_dir_path);
+ if (full_path == NULL)
{
- int error;
-
- /* Enclose name in @@ */
- snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
+ return JB_ERR_MEMORY;
+ }
- /* Make and chain job */
- if ( NULL == (job = (pcrs_compile(buf, m->value, "sigTU", &error))) )
- {
- log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
- }
- else
- {
- job->next = joblist;
- joblist = job;
- }
+ 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))
{
/* skip lines starting with '#' */
- if(*buf == '#') continue;
-
- old = strsav(old, buf);
+ if(*buf == '#')
+ {
+ continue;
+ }
+
+ if (string_append(&file_buffer, buf))
+ {
+ fclose(fp);
+ return JB_ERR_MEMORY;
+ }
}
fclose(fp);
+ *template_ptr = file_buffer;
- /*
- * Execute the jobs
- */
- size = strlen(old) + 1;
- new = old;
+ return JB_ERR_OK;
+}
+
+
+/*********************************************************************
+ *
+ * Function : template_fill
+ *
+ * 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.
+ * Will be free()d.
+ * OUT: Filled out template.
+ * Caller must free().
+ * 2 : exports = map with fill in symbol -> name pairs
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error
+ *
+ *********************************************************************/
+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;
+ size_t size;
+ int error;
+ const char *flags;
+
+ assert(template_ptr);
+ assert(*template_ptr);
+ assert(exports);
- for (job = joblist; NULL != job; job = job->next)
+ file_buffer = *template_ptr;
+ size = strlen(file_buffer) + 1;
+
+ /*
+ * Assemble pcrs joblist from exports map
+ */
+ for (m = exports->first; m != NULL; m = m->next)
{
- pcrs_execute(job, old, size, &new, &size);
- if (old != buf) free(old);
- old = new;
- }
+ if (*m->name == '$')
+ {
+ /*
+ * First character of name is '$', so remove this flag
+ * character and allow backreferences ($1 etc) in the
+ * "replace with" text.
+ */
+ snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
+ flags = "sigU";
+ }
+ else
+ {
+ /*
+ * Treat the "replace with" text as a literal string -
+ * no quoting needed, no backreferences allowed.
+ * ("Trivial" ['T'] flag).
+ */
+ flags = "sigTU";
+
+ /* Enclose name in @@ */
+ snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
+ }
+
+ log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
+
+ /* Make and run job. */
+ job = pcrs_compile(buf, m->value, flags, &error);
+ if (job == NULL)
+ {
+ 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);
+ free(file_buffer);
+ pcrs_free_job(job);
+ if (NULL == tmp_out_buffer)
+ {
+ *template_ptr = NULL;
+ return JB_ERR_MEMORY;
+ }
+ file_buffer = tmp_out_buffer;
+ }
+ }
/*
- * Free the jobs & return
+ * Return
*/
- pcrs_free_joblist(joblist);
- return(new);
+ *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;
}
* Parameters :
* 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(struct client_state *csp, char *caller)
+struct map *default_exports(const struct client_state *csp, const char *caller)
{
- struct map *exports = NULL;
char buf[20];
+ jb_err err;
+ struct map * exports;
+ int local_help_exists = 0;
- exports = map(exports, "version", 1, VERSION, 1);
- exports = map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1);
- exports = map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1);
- exports = map(exports, "admin-address", 1, csp->config->admin_address ? csp->config->admin_address : "fill@me.in.please", 1);
- exports = map(exports, "homepage", 1, HOME_PAGE_URL, 1);
- exports = map(exports, "default-cgi", 1, HOME_PAGE_URL "/config", 1);
- exports = map(exports, "menu", 1, make_menu(caller), 0);
- exports = 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);
- exports = map(exports, "my-port", 1, buf, 1);
+ if (!err) err = map(exports, "my-port", 1, buf, 1);
if(!strcmp(CODE_STATUS, "stable"))
{
- exports = map_block_killer(exports, "unstable");
+ if (!err) err = map_block_killer(exports, "unstable");
+ }
+
+ if (csp->config->admin_address != NULL)
+ {
+ if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
+ local_help_exists = 1;
+ }
+ else
+ {
+ if (!err) err = map_block_killer(exports, "have-adminaddr-info");
}
- if(csp->config->proxy_info_url != NULL)
+ if (csp->config->proxy_info_url != NULL)
{
- exports = 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
{
- exports = map_block_killer(exports, "have-proxy-info");
- }
+ if (!err) err = map_block_killer(exports, "have-proxy-info");
+ }
- return(exports);
+ if (local_help_exists == 0)
+ {
+ if (!err) err = map_block_killer(exports, "have-help-info");
+ }
+ 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.
*
*********************************************************************/
-struct map *map_block_killer(struct map *exports, char *name)
+jb_err map_block_killer(struct map *exports, const char *name)
{
char buf[1000]; /* Will do, since the names are hardwired */
- snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
- exports = map(exports, buf, 1, "", 1);
-
- return(exports);
+ assert(exports);
+ assert(name);
+ assert(strlen(name) < 490);
+ snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
+ return map(exports, buf, 1, "", 1);
}
/*********************************************************************
*
- * Function : make_menu
+ * Function : map_block_keep
*
- * Description : Returns an HTML-formatted menu of the available
- * unhidden CGIs, excluding the one given in <self>.
+ * 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 : self = name of CGI to leave out, can be NULL
+ * Parameters :
+ * 1 : exports = map to extend
+ * 2 : name = name of conditional block
*
- * Returns : menu string
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-char *make_menu(const char *self)
+jb_err map_block_keep(struct map *exports, const char *name)
{
- const struct cgi_dispatcher *d;
- char buf[BUFFER_SIZE], *tmp = NULL;
+ jb_err err;
+ char buf[500]; /* Will do, since the names are hardwired */
- if (self == NULL) self = "NO-SUCH-CGI!";
+ assert(exports);
+ assert(name);
+ assert(strlen(name) < 490);
- /* List available unhidden CGI's and export as "other-cgis" */
- for (d = cgi_dispatcher; d->handler; d++)
+ snprintf(buf, 500, "if-%s-start", name);
+ err = map(exports, buf, 1, "", 1);
+
+ if (err)
{
- if (strncmp(d->description, "HIDE", 4) && 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);
- tmp = strsav(tmp, buf);
- }
+ return err;
}
- return(tmp);
+ snprintf(buf, 500, "if-%s-end", name);
+ return map(exports, buf, 1, "", 1);
}
/*********************************************************************
*
- * Function : dump_map
+ * Function : map_conditional
*
- * Description : HTML-dump a map for debugging
+ * Description : Convenience function.
+ * Adds an "if-then-else" for the conditional HTML-template
+ * block <name>, i.e. a substitution of the form:
+ * @if-<name>-then@
+ * True text
+ * @else-not-<name>@
+ * False text
+ * @endif-<name>@
*
- * Parameters :
- * 1 : map = map to dump
+ * The control structure and one of the alternatives
+ * will be hidden.
*
- * Returns : string with HTML
+ * Parameters :
+ * 1 : exports = map to extend
+ * 2 : name = name of conditional block
+ * 3 : choose_first = nonzero for first, zero for second.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-char *dump_map(struct map *map)
+jb_err map_conditional(struct map *exports, const char *name, int choose_first)
{
- struct map *p = map;
- char *ret = NULL;
+ char buf[1000]; /* Will do, since the names are hardwired */
+ jb_err err;
- ret = strsav(ret, "<table>\n");
+ assert(exports);
+ assert(name);
+ assert(strlen(name) < 480);
- while (p)
+ snprintf(buf, 1000, (choose_first
+ ? "else-not-%s@.*@endif-%s"
+ : "if-%s-then@.*@else-not-%s"),
+ name, name);
+
+ err = map(exports, buf, 1, "", 1);
+ if (err)
{
- ret = strsav(ret, "<tr><td><b>");
- ret = strsav(ret, p->name);
- ret = strsav(ret, "</b></td><td>");
- ret = strsav(ret, p->value);
- ret = strsav(ret, "</td></tr>\n");
- p = p->next;
+ return err;
}
- ret = strsav(ret, "</table>\n");
- return(ret);
-
+ snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
+ return map(exports, buf, 1, "", 1);
}
-#ifdef STATISTICS
/*********************************************************************
*
- * Function : add_stats
+ * Function : make_menu
*
- * Description : Add the blocking statistics to a given map.
+ * Description : Returns an HTML-formatted menu of the available
+ * unhidden CGIs, excluding the one given in <self>.
*
- * Parameters :
- * 1 : exports = map to write to.
+ * Parameters : self = name of CGI to leave out, can be NULL
*
- * Returns : pointer to extended map
+ * Returns : menu string, or NULL on out-of-memory error.
*
*********************************************************************/
-struct map *add_stats(struct map *exports)
+char *make_menu(const char *self)
{
- float perc_rej; /* Percentage of http requests rejected */
- char buf[1000];
- int local_urls_read = urls_read;
- int local_urls_rejected = urls_rejected;
-
- /*
- * Need to alter the stats not to include the fetch of this
- * page.
- *
- * Can't do following thread safely! doh!
- *
- * urls_read--;
- * urls_rejected--; * This will be incremented subsequently *
- */
+ const struct cgi_dispatcher *d;
+ char *result = strdup("");
- if (local_urls_read == 0)
+ if (self == NULL)
{
- exports = map_block_killer(exports, "have-stats");
+ self = "NO-SUCH-CGI!";
}
- else
+
+ /* List available unhidden CGI's and export as "other-cgis" */
+ for (d = cgi_dispatchers; d->name; d++)
{
- exports = map_block_killer(exports, "have-no-stats");
+ if (d->description && strcmp(d->name, self))
+ {
+ 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;
+}
- perc_rej = (float)local_urls_rejected * 100.0F /
- (float)local_urls_read;
- sprintf(buf, "%d", local_urls_read);
- exports = map(exports, "requests-received", 1, buf, 1);
+/*********************************************************************
+ *
+ * Function : dump_map
+ *
+ * Description : HTML-dump a map for debugging
+ *
+ * Parameters :
+ * 1 : the_map = map to dump
+ *
+ * Returns : string with HTML
+ *
+ *********************************************************************/
+char *dump_map(const struct map *the_map)
+{
+ struct map_entry *cur_entry;
+ char *ret = strdup("");
- sprintf(buf, "%d", local_urls_rejected);
- exports = map(exports, "requests-blocked", 1, buf, 1);
+ string_append(&ret, "<table>\n");
- sprintf(buf, "%6.2f", perc_rej);
- exports = map(exports, "percent-blocked", 1, buf, 1);
+ for (cur_entry = the_map->first;
+ (cur_entry != NULL) && (ret != NULL);
+ 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");
}
- return(exports);
-
+ string_append(&ret, "</table>\n");
+ return ret;
}
-#endif /* def STATISTICS */
+
/*
Local Variables:
projects / privoxy.git / blobdiff