-const char cgi_rcs[] = "$Id: cgi.c,v 1.19 2001/09/13 23:31:25 jongfoster Exp $";
+const char cgi_rcs[] = "$Id: cgi.c,v 1.32 2001/10/14 22:20:18 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.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.
*
#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 "loadcfg.h"
+#include "cgisimple.h"
+#ifdef FEATURE_CGI_EDIT_ACTIONS
+#include "cgiedit.h"
+#endif /* def FEATURE_CGI_EDIT_ACTIONS */
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" },
{ "show-status",
- 11, cgi_show_status,
+ cgi_show_status,
"Show information about the current configuration" },
- { "show-url-info",
- 13, cgi_show_url_info,
- "Show which actions apply to a URL and why" },
{ "show-version",
- 12, cgi_show_version,
+ cgi_show_version,
"Show the source code version numbers" },
+ { "show-request",
+ cgi_show_request,
+ "Show the client's request headers." },
+ { "show-url-info",
+ cgi_show_url_info,
+ "Show which actions apply to a URL and why" },
+#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
+ { "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) */ },
+#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 the transparent or \"Junkbuster\" gif */ },
+ { NULL, /* NULL Indicates end of list and default page */
+ cgi_error_404,
+ NULL /* Unknown CGI page */ }
};
/*
* Some images
*
- * Hint: You can encode your own GIFs like that:
+ * Hint: You can encode your own GIFs like this:
* perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }'
*/
const int image_blank_gif_length = sizeof(image_blank_gif_data) - 1;
+static struct http_response *dispatch_known_cgi(struct client_state * csp,
+ const char * path);
+
+
/*********************************************************************
*
* 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.
+ * i.j.b or matches HOME_PAGE_URL/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))
+ if ( (0 == strcmpic(host, CGI_PREFIX_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 HOME_PAGE_URL, and the path /config/ */
+ else if ( (0 == strcmpic(host, HOME_PAGE_URL + 7 ))
+ && (0 == strncmpic(path,"/config", 7)) )
{
- /* then it's everything following "/config" */
- argstring = csp->http->path + 7;
+ /* take everything following "/config" */
+ path += 7;
+ if (*path == '/')
+ {
+ /* skip the forward slash after "/config" */
+ path++;
+ }
+ else if (*path != '\0')
+ {
+ /* wierdness: URL is /configXXX, where XXX is some string */
+ 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 NULL;
- }
-
- /* Remove leading slash */
- if (*argstring == '/')
- {
- argstring++;
- }
-
- log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
- log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
- csp->ip_addr_str, csp->http->cmd);
-
- /* Find and start the right CGI function*/
- for (d = cgi_dispatcher; d->handler; d++)
- {
- if (strncmp(argstring, d->name, d->name_length) == 0)
- {
- param_list = parse_cgi_parameters(argstring + d->name_length);
- if ((d->handler)(csp, rsp, param_list))
- {
- freez(rsp);
- }
-
- free_map(param_list);
- return(finish_http_response(rsp));
- }
- }
-
- /* Can't get here, since cgi_default will match all requests */
- freez(rsp);
- return(NULL);
-
+ return dispatch_known_cgi(csp, path);
}
/*********************************************************************
+ *
+ * Function : dispatch_known_cgi
*
- * Function : parse_cgi_parameters
- *
- * Description : Parse a URL-encoded argument string into name/value
- * pairs and store them in a struct map list.
+ * 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 : string = string to be parsed
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : path = Path of CGI, with the CGI prefix removed.
+ * Should not have a leading "/".
*
- * Returns : pointer to param list
+ * Returns : http_response, or NULL on handler failure or out of
+ * memory.
*
*********************************************************************/
-struct map *parse_cgi_parameters(char *argstring)
+static struct http_response *dispatch_known_cgi(struct client_state * csp,
+ const char * path)
{
- char *tmp, *p;
- char *vector[BUFFER_SIZE];
- int pairs, i;
- struct map *cgi_params = new_map();
+ const struct cgi_dispatcher *d;
+ struct map *param_list;
+ struct http_response *rsp;
+ char *query_args_start;
+ char *path_copy;
+ int result;
- if(*argstring == '?')
+ if (NULL == (path_copy = strdup(path)))
{
- argstring++;
+ return NULL;
}
- tmp = strdup(argstring);
-
- pairs = ssplit(tmp, "&", vector, SZ(vector), 1, 1);
- for (i = 0; i < pairs; i++)
+ query_args_start = path_copy;
+ while (*query_args_start && *query_args_start != '?')
{
- if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
- {
- *p = '\0';
- map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0);
- }
+ query_args_start++;
}
-
- free(tmp);
- return(cgi_params);
-
-}
-
-
-/*********************************************************************
- *
- * Function : cgi_default
- *
- * 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
- *
- * Returns : 0
- *
- *********************************************************************/
-int cgi_default(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
-{
- char *p;
- char *tmp = NULL;
- struct map * exports = default_exports(csp, "");
-
- /* If there were other parameters, export a dump as "cgi-parameters" */
- if(parameters)
- {
- 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);
- map(exports, "cgi-parameters", 1, tmp, 0);
- free(p);
- }
- else
+ if (*query_args_start == '?')
{
- map(exports, "cgi-parameters", 1, "", 1);
+ *query_args_start++ = '\0';
}
- rsp->body = fill_template(csp, "default", exports);
- free_map(exports);
- return(0);
-
-}
-
-
-/*********************************************************************
- *
- * Function : cgi_send_banner
- *
- * Description : CGI function that returns a banner.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
- *
- * CGI Parameters :
- * type : Selects the type of banner between "trans" and "jb".
- * Defaults to "jb" if absent or != "trans".
- *
- * Returns : 0
- *
- *********************************************************************/
-int cgi_send_banner(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
-{
- if(strcmp(lookup(parameters, "type"), "trans"))
+ if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
{
- rsp->body = bindup(image_junkbuster_gif_data, image_junkbuster_gif_length);
- rsp->content_length = image_junkbuster_gif_length;
+ free(path_copy);
+ return(NULL);
}
- else
- {
- rsp->body = bindup(image_blank_gif_data, image_blank_gif_length);
- rsp->content_length = image_blank_gif_length;
- }
-
- enlist(rsp->headers, "Content-Type: image/gif");
-
- return(0);
-}
-
-
-/*********************************************************************
- *
- * Function : cgi_show_version
- *
- * Description : CGI function that returns a a web page describing the
- * file versions of IJB.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
- *
- * CGI Parameters :
- * type : Selects the type of banner between "trans" and "jb".
- * Defaults to "jb" if absent or != "trans".
- *
- * Returns : 0
- *
- *********************************************************************/
-int cgi_show_version(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
-{
- struct map * exports = default_exports(csp, "show-version");
-
- map(exports, "sourceversions", 1, show_rcs(), 0);
-
- rsp->body = fill_template(csp, "show-version", exports);
- free_map(exports);
- return(0);
-
-}
-
-
-/*********************************************************************
- *
- * Function : cgi_show_status
- *
- * Description : CGI function that returns a a web page describing the
- * current status of IJB.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
- *
- * CGI Parameters :
- * type : Selects the type of banner between "trans" and "jb".
- * Defaults to "jb" if absent or != "trans".
- *
- * Returns : 0
- *
- *********************************************************************/
-int cgi_show_status(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
-{
- char *s = NULL;
- int i;
-
- FILE * fp;
- char buf[BUFFER_SIZE];
- char * p;
- const char * filename = NULL;
- char * file_description = NULL;
- struct map * exports = default_exports(csp, "show-status");
+ /*
+ * At this point:
+ * path_copy = CGI call name
+ * param_list = CGI params, as map
+ */
- switch (*(lookup(parameters, "file")))
+ /* Get mem for response or fail*/
+ if (NULL == (rsp = alloc_http_response()))
{
- case 'p':
- if (csp->actions_list)
- {
- filename = csp->actions_list->filename;
- file_description = "Actions List";
- }
- break;
-
- case 'r':
- if (csp->rlist)
- {
- filename = csp->rlist->filename;
- file_description = "Regex Filter List";
- }
- break;
-
-#ifdef FEATURE_TRUST
- case 't':
- if (csp->tlist)
- {
- filename = csp->tlist->filename;
- file_description = "Trust List";
- }
- break;
-#endif /* def FEATURE_TRUST */
+ free(path_copy);
+ free_map(param_list);
+ return NULL;
}
- if (NULL != filename)
- {
- map(exports, "file-description", 1, file_description, 1);
- map(exports, "filepath", 1, html_encode(filename), 0);
+ log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
+ log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
+ csp->ip_addr_str, csp->http->cmd);
- if ((fp = fopen(filename, "r")) == NULL)
- {
- map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1);
- }
- else
+ /* Find and start the right CGI function*/
+ for (d = cgi_dispatchers; FOREVER; d++)
+ {
+ if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
{
- while (fgets(buf, sizeof(buf), fp))
+ result = (d->handler)(csp, rsp, param_list);
+ free(path_copy);
+ free_map(param_list);
+ if (result)
{
- p = html_encode(buf);
- if (p)
- {
- s = strsav(s, p);
- freez(p);
- s = strsav(s, "<br>");
- }
+ /* Error in handler */
+ free_http_response(rsp);
+ return(NULL);
+ }
+ else
+ {
+ /* It worked */
+ return(finish_http_response(rsp));
}
- fclose(fp);
- map(exports, "contents", 1, s, 0);
}
- rsp->body = fill_template(csp, "show-status-file", exports);
- free_map(exports);
- return(0);
-
- }
-
- map(exports, "redirect-url", 1, REDIRECT_URL, 1);
-
- s = NULL;
- for (i=0; i < Argc; i++)
- {
- s = strsav(s, Argv[i]);
- s = strsav(s, " ");
- }
- map(exports, "invocation", 1, s, 0);
-
- map(exports, "options", 1, csp->config->proxy_args, 1);
- show_defines(exports);
-
-#ifdef FEATURE_STATISTICS
- add_stats(exports);
-#else /* ndef FEATURE_STATISTICS */
- map_block_killer(exports, "statistics");
-#endif /* ndef FEATURE_STATISTICS */
-
- if (csp->actions_list)
- {
- map(exports, "actions-filename", 1, csp->actions_list->filename, 1);
- }
- else
- {
- map(exports, "actions-filename", 1, "None specified", 1);
- }
-
- if (csp->rlist)
- {
- map(exports, "re-filter-filename", 1, csp->rlist->filename, 1);
- }
- else
- {
- map(exports, "re-filter-filename", 1, "None specified", 1);
- }
-
-#ifdef FEATURE_TRUST
- if (csp->tlist)
- {
- map(exports, "trust-filename", 1, csp->tlist->filename, 1);
- }
- else
- {
- map(exports, "trust-filename", 1, "None specified", 1);
}
-#else
- map_block_killer(exports, "trust-support");
-#endif /* ndef FEATURE_TRUST */
-
- rsp->body = fill_template(csp, "show-status", exports);
- free_map(exports);
- return(0);
-
}
-
- /*********************************************************************
+
+/*********************************************************************
*
- * Function : cgi_show_url_info
+ * Function : parse_cgi_parameters
*
- * 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.
+ * Description : Parse a URL-encoded argument string into name/value
+ * pairs and store them in a struct map list.
*
* 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 :
- * 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.
+ * 1 : string = string to be parsed. Will be trashed.
*
- * Returns : 0
+ * Returns : pointer to param list, or NULL if out of memory.
*
*********************************************************************/
-int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+static struct map *parse_cgi_parameters(char *argstring)
{
- char *url_param;
- char *host = NULL;
- struct map * exports = default_exports(csp, "show-url-info");
+ char *p;
+ char *vector[BUFFER_SIZE];
+ int pairs, i;
+ struct map *cgi_params;
- if (NULL == (url_param = strdup(lookup(parameters, "url"))) || *url_param == '\0')
+ if (NULL == (cgi_params = new_map()))
{
- map_block_killer(exports, "url-given");
- map(exports, "url", 1, "", 1);
+ return NULL;
}
- 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;
-
- map(exports, "url", 1, host, 1);
- map(exports, "url-html", 1, html_encode(host), 0);
-
- init_current_action(action);
-
- s = current_action_to_text(action);
- map(exports, "default", 1, s , 0);
-
- if (((fl = csp->actions_list) == NULL) || ((b = fl->f) == NULL))
- {
- map(exports, "matches", 1, "none" , 1);
- 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)
- {
- map(exports, "matches", 1, "none" , 1);
- 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++;
- }
- }
- }
- }
+ pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
- if (hits)
- {
- map(exports, "matches", 1, matches , 0);
- }
- else
+ for (i = 0; i < pairs; i++)
+ {
+ if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
{
- map(exports, "matches", 1, "none", 1);
+ *p = '\0';
+ map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0);
}
- matches = NULL;
-
- freez(url->dbuf);
- freez(url->dvec);
-
- freez(url_param);
- freez(path);
-
- s = current_action_to_text(action);
- map(exports, "final", 1, s, 0);
- s = NULL;
-
- free_current_action(action);
}
- rsp->body = fill_template(csp, "show-url-info", exports);
- free_map(exports);
- return 0;
+ return(cgi_params);
}
struct http_response *rsp;
struct map * exports = default_exports(csp, NULL);
- if (NULL == ( rsp = (struct http_response *)zalloc(sizeof(*rsp))))
+ if (NULL == (rsp = alloc_http_response()))
{
return NULL;
- }
+ }
map(exports, "host-html", 1, html_encode(csp->http->host), 0);
map(exports, "hostport", 1, csp->http->hostport, 1);
map(exports, "error", 1, safe_strerror(err), 0);
map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1);
- rsp->body = fill_template(csp, templatename, exports);
+ rsp->body = template_load(csp, templatename);
+ template_fill(&rsp->body, exports);
free_map(exports);
-
+
if (!strcmp(templatename, "no-such-domain"))
{
rsp->status = strdup("404 No such domain");
}
return(finish_http_response(rsp));
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : get_http_time
+ *
+ * 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 : 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 : N/A
+ *
+ *********************************************************************/
+void get_http_time(int time_offset, char *buf)
+{
+ 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" };
+
+ struct tm *t;
+ time_t current_time;
+
+ assert(buf);
+
+ time(¤t_time); /* get current time */
+
+ current_time += time_offset;
+
+ /* get and save the gmt */
+ t = gmtime(¤t_time);
+
+ /* 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
+ );
+ buf[32] = '\0';
+
}
enlist(rsp->headers, buf);
/*
- * Fill in the default headers FIXME: Are these correct? sequence OK? check rfc!
- * FIXME: Should have:
- * "JunkBuster" GIF: Last-Modified: any *fixed* date in the past (as now).
- * Expires: 5 minutes after the time when reply sent
- * CGI, "blocked", & all other requests:
- * Last-Modified: Time when reply sent
- * Expires: Time when reply sent
- * "Cache-Control: no-cache"
- *
+ * 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);
+ 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.
+ */
+
+ get_http_time(0, buf);
+ 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");
+
+ get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
+ 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.
+ */
+ 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);
+ }
+
/*
* Write the head
}
+/*********************************************************************
+ *
+ * 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));
+
+}
+
+
/*********************************************************************
*
* Function : free_http_response
*********************************************************************/
void free_http_response(struct http_response *rsp)
{
- if(rsp)
+ if (rsp)
{
freez(rsp->status);
freez(rsp->head);
freez(rsp->body);
destroy_list(rsp->headers);
- freez(rsp);
+ free(rsp);
}
}
* Function : fill_template
*
* 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
*
- * Returns : char * with filled out form, or NULL if failiure
+ * Returns : char * with loaded template, or NULL if failure
*
*********************************************************************/
-char *fill_template(struct client_state *csp, const char *templatename, struct map *exports)
+char *template_load(struct client_state *csp, const char *templatename)
{
- struct map_entry *m;
- pcrs_job *job;
char buf[BUFFER_SIZE];
- char *tmp_out_buffer;
char *file_buffer = NULL;
- int size;
- int error;
FILE *fp;
-
/*
* Open template file or fail
*/
if(NULL == (fp = fopen(buf, "r")))
{
- log_error(LOG_LEVEL_ERROR, "error loading template %s: %E", buf);
+ log_error(LOG_LEVEL_FATAL, "error loading template %s: %E", buf);
return NULL;
}
while (fgets(buf, BUFFER_SIZE, fp))
{
/* skip lines starting with '#' */
- if(*buf == '#') continue;
+ if(*buf == '#')
+ {
+ continue;
+ }
file_buffer = strsav(file_buffer, buf);
}
fclose(fp);
+ return(file_buffer);
- /*
- * Execute the jobs
- */
+}
+
+
+/*********************************************************************
+ *
+ * Function : fill_template
+ *
+ * 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 : N/A
+ *
+ *********************************************************************/
+void template_fill(char **template_ptr, 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);
+
+ file_buffer = *template_ptr;
size = strlen(file_buffer) + 1;
/*
*/
for (m = exports->first; m != NULL; m = m->next)
{
- /* Enclose name in @@ */
- snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
+ 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, "sigTU", &error);
+ 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);
else
{
pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
- if (file_buffer != tmp_out_buffer)
+ if (NULL != tmp_out_buffer)
{
free(file_buffer);
file_buffer = tmp_out_buffer;
}
}
-
/*
* Return
*/
- return(file_buffer);
+ *template_ptr = file_buffer;
}
* Returns : NULL if no memory, else map
*
*********************************************************************/
-struct map * default_exports(const struct client_state *csp, const char *caller)
+struct map *default_exports(const struct client_state *csp, const char *caller)
{
char buf[20];
struct map * exports = new_map();
}
return (exports);
+
}
snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
map(exports, buf, 1, "", 1);
+
}
snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
map(exports, buf, 1, "", 1);
+
}
}
/* List available unhidden CGI's and export as "other-cgis" */
- for (d = cgi_dispatcher; d->handler; d++)
+ for (d = cgi_dispatchers; d->name; d++)
{
- if (strncmp(d->description, "HIDE", 4) && strcmp(d->name, self))
+ if (d->description && strcmp(d->name, self))
{
snprintf(buf, BUFFER_SIZE, "<li><a href=%s/config/%s>%s</a></li>\n",
HOME_PAGE_URL, d->name, d->description);
}
-#ifdef FEATURE_STATISTICS
-/*********************************************************************
- *
- * Function : add_stats
- *
- * Description : Add the blocking statistics to a given map.
- *
- * Parameters :
- * 1 : exports = map to write to.
- *
- * Returns : pointer to extended map
- *
- *********************************************************************/
-struct map *add_stats(struct map *exports)
-{
- 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 *
- */
-
- if (local_urls_read == 0)
- {
- map_block_killer(exports, "have-stats");
- }
- else
- {
- map_block_killer(exports, "have-no-stats");
-
- perc_rej = (float)local_urls_rejected * 100.0F /
- (float)local_urls_read;
-
- sprintf(buf, "%d", local_urls_read);
- map(exports, "requests-received", 1, buf, 1);
-
- sprintf(buf, "%d", local_urls_rejected);
- map(exports, "requests-blocked", 1, buf, 1);
-
- sprintf(buf, "%6.2f", perc_rej);
- map(exports, "percent-blocked", 1, buf, 1);
- }
-
- return(exports);
-
-}
-#endif /* def FEATURE_STATISTICS */
-
/*
Local Variables:
tab-width: 3