-const char cgi_rcs[] = "$Id: cgi.c,v 1.21 2001/09/13 23:53:03 jongfoster Exp $";
+const char cgi_rcs[] = "$Id: cgi.c,v 1.28 2001/09/19 18:00:37 oes 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.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.
#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[] = {
+ { "robots.txt",
+ 10, cgi_robots_txt,
+ "HIDE Sends a robots.txt file to tell robots to go away." },
{ "show-status",
11, cgi_show_status,
"Show information about the current configuration" },
{ "send-banner",
11, cgi_send_banner,
"HIDE Send the transparent or \"Junkbuster\" gif" },
+#ifdef FEATURE_CGI_EDIT_ACTIONS
+ { "edit-actions-list",
+ 17, cgi_edit_actions_list,
+ "Edit the actions list" },
+ { "edit-actions-submit",
+ 19, cgi_edit_actions_submit,
+ "HIDE Change the actions for (a) specified URL(s)" },
+ { "edit-actions",
+ 12, cgi_edit_actions,
+ "HIDE Edit the actions for (a) specified URL(s)" },
+#endif /* def FEATURE_CGI_EDIT_ACTIONS */
{ "",
0, cgi_default,
"Junkbuster main page" },
return NULL;
}
+
/* Remove leading slash */
if (*argstring == '/')
{
{
if (strncmp(argstring, d->name, d->name_length) == 0)
{
- param_list = parse_cgi_parameters(argstring + d->name_length);
+ if (NULL == (param_list =
+ parse_cgi_parameters(argstring + d->name_length)))
+ {
+ free_map(param_list);
+ free_http_response(rsp);
+ return(NULL);
+ }
if ((d->handler)(csp, rsp, param_list))
{
- freez(rsp);
+ free_map(param_list);
+ free_http_response(rsp);
+ return(NULL);
}
free_map(param_list);
}
/* Can't get here, since cgi_default will match all requests */
- freez(rsp);
+ free_http_response(rsp);
return(NULL);
}
* Parameters :
* 1 : string = string to be parsed
*
- * Returns : pointer to param list
+ * Returns : pointer to param list, or NULL if out of memory.
*
*********************************************************************/
struct map *parse_cgi_parameters(char *argstring)
char *tmp, *p;
char *vector[BUFFER_SIZE];
int pairs, i;
- struct map *cgi_params = new_map();
+ struct map *cgi_params;
+
+ if (NULL == (cgi_params = new_map()))
+ {
+ return NULL;
+ }
if(*argstring == '?')
{
argstring++;
}
- tmp = strdup(argstring);
+ if (NULL == (tmp = strdup(argstring)))
+ {
+ free_map(cgi_params);
+ return NULL;
+ }
pairs = ssplit(tmp, "&", vector, SZ(vector), 1, 1);
}
-/*********************************************************************
- *
- * 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
- {
- map(exports, "cgi-parameters", 1, "", 1);
- }
-
- 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"))
- {
- rsp->body = bindup(image_junkbuster_gif_data, image_junkbuster_gif_length);
- rsp->content_length = image_junkbuster_gif_length;
- }
- 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");
- rsp->is_static = 1;
-
- 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");
-
- switch (*(lookup(parameters, "file")))
- {
- 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 */
- }
-
- if (NULL != filename)
- {
- map(exports, "file-description", 1, file_description, 1);
- map(exports, "filepath", 1, html_encode(filename), 0);
-
- if ((fp = fopen(filename, "r")) == NULL)
- {
- 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);
- 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
- *
- * 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.
- *
- * 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.
- *
- * Returns : 0
- *
- *********************************************************************/
-int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
-{
- char *url_param;
- char *host = NULL;
- struct map * exports = default_exports(csp, "show-url-info");
-
- if (NULL == (url_param = strdup(lookup(parameters, "url"))) || *url_param == '\0')
- {
- map_block_killer(exports, "url-given");
- 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;
-
- 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++;
- }
- }
- }
- }
-
- if (hits)
- {
- map(exports, "matches", 1, matches , 0);
- }
- else
- {
- map(exports, "matches", 1, "none", 1);
- }
- 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;
-
-}
-
-
/*********************************************************************
*
* Function : error_response
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));
+
}
* Returns : N/A
*
*********************************************************************/
-static void get_http_time(int time_offset, char * buf)
+void get_http_time(int time_offset, char *buf)
{
static const char day_names[7][4] =
{ "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
time(¤t_time); /* get current time */
-/* FIXME: is this needed? time() can't fail on Win32. What about Linux?
- if(current_time <= 0)
- {
- return NULL;
- }
-*/
-
current_time += time_offset;
/* get and save the gmt */
t->tm_sec
);
buf[32] = '\0';
+
}
return(rsp);
}
-
+
/*********************************************************************
*
* Returns : pointer to a new http_response, or NULL.
*
*********************************************************************/
-struct http_response * alloc_http_response(void)
+struct http_response *alloc_http_response(void)
{
return (struct http_response *) zalloc(sizeof(struct http_response));
+
}
*********************************************************************/
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
*/
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);
+
}
}
-#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
projects / privoxy.git / blobdiff