-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.8 2001/11/13 00:14:07 jongfoster Exp $";
+const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.22 2002/03/24 16:18:15 jongfoster Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
*
- * Purpose : Simple CGIs to get information about JunkBuster's
+ * Purpose : Simple CGIs to get information about Privoxy's
* status.
*
* Functions declared include:
*
*
* Copyright : Written by and Copyright (C) 2001 the SourceForge
- * IJBSWA team. http://ijbswa.sourceforge.net
+ * Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* by and Copyright (C) 1997 Anonymous Coders and
*
* Revisions :
* $Log: cgisimple.c,v $
+ * Revision 1.22 2002/03/24 16:18:15 jongfoster
+ * Removing old logo
+ *
+ * Revision 1.21 2002/03/24 15:23:33 jongfoster
+ * Name changes
+ *
+ * Revision 1.20 2002/03/24 13:25:43 swa
+ * name change related issues
+ *
+ * Revision 1.19 2002/03/16 23:54:06 jongfoster
+ * Adding graceful termination feature, to help look for memory leaks.
+ * If you enable this (which, by design, has to be done by hand
+ * editing config.h) and then go to http://i.j.b/die, then the program
+ * will exit cleanly after the *next* request. It should free all the
+ * memory that was used.
+ *
+ * Revision 1.18 2002/03/12 01:44:49 oes
+ * Changed default for "blocked" image from jb logo to checkboard pattern
+ *
+ * Revision 1.17 2002/03/08 16:43:18 oes
+ * Added choice beween GIF and PNG built-in images
+ *
+ * Revision 1.16 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.15 2002/03/06 22:54:35 jongfoster
+ * Automated function-comment nitpicking.
+ *
+ * Revision 1.14 2002/03/02 04:14:50 david__schmidt
+ * Clean up a little CRLF unpleasantness that suddenly appeared
+ *
+ * Revision 1.13 2002/02/21 00:10:37 jongfoster
+ * Adding send-banner?type=auto option
+ *
+ * Revision 1.12 2002/01/23 01:03:32 jongfoster
+ * Fixing gcc [CygWin] compiler warnings
+ *
+ * Revision 1.11 2002/01/23 00:01:04 jongfoster
+ * Adding cgi_transparent_gif() for http://i.j.b/t
+ * Adding missing html_encode() to many CGI functions.
+ * Adding urlmatch.[ch] to http://i.j.b/show-version
+ *
+ * Revision 1.10 2002/01/17 21:10:37 jongfoster
+ * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
+ * Also fixing a problem in the same function with improperly quoted URLs
+ * in output HTML, and adding code to handle https:// URLs correctly.
+ *
+ * Revision 1.9 2001/11/30 23:09:15 jongfoster
+ * Now reports on FEATURE_CGI_EDIT_ACTIONS
+ * Removing FEATURE_DENY_GZIP from template
+ *
* Revision 1.8 2001/11/13 00:14:07 jongfoster
* Fixing stupid bug now I've figured out what || means.
* (It always returns 0 or 1, not one of it's paramaters.)
#include "miscutil.h"
#include "loadcfg.h"
#include "parsers.h"
+#include "urlmatch.h"
const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
* 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 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
*
* CGI Parameters : none
*
struct http_response *rsp,
const struct map *parameters)
{
- char *p;
char *tmp;
struct map *exports;
/* If there were other parameters, export a dump as "cgi-parameters" */
if (parameters->first)
{
- if (NULL == (p = dump_map(parameters)))
- {
- free_map(exports);
- return JB_ERR_MEMORY;
- }
tmp = strdup("<p>What made you think this cgi takes parameters?\n"
"Anyway, here they are, in case you're interested:</p>\n");
- string_append(&tmp, p);
- free(p);
+ string_join(&tmp, dump_map(parameters));
if (tmp == NULL)
{
free_map(exports);
* given.
*
* 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
+ * 3 : parameters = map of cgi parameters
*
* CGI Parameters : none
*
return JB_ERR_MEMORY;
}
- rsp->status = strdup("404 JunkBuster configuration page not found");
+ rsp->status = strdup("404 Privoxy configuration page not found");
if (rsp->status == NULL)
{
free_map(exports);
}
+#ifdef FEATURE_GRACEFUL_TERMINATION
+/*********************************************************************
+ *
+ * Function : cgi_die
+ *
+ * Description : CGI function to shut down Privoxy.
+ * NOTE: Turning this on in a production build
+ * would be a BAD idea. An EXTREMELY BAD idea.
+ * In short, don't do it.
+ *
+ * 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 : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_die (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ /* quit */
+ g_terminate = 1;
+
+ /*
+ * I don't really care what gets sent back to the browser.
+ * Take the easy option - "out of memory" page.
+ */
+
+ return JB_ERR_MEMORY;
+}
+#endif /* def FEATURE_GRACEFUL_TERMINATION */
+
+
/*********************************************************************
*
* Function : cgi_show_request
* made of it.
*
* 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
+ * 3 : parameters = map of cgi parameters
*
* CGI Parameters : none
*
* be sending to the server if this wasn't a CGI call
*/
- if (map(exports, "client-request", 1, csp->iob->buf, 1))
+ if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
{
free_map(exports);
return JB_ERR_MEMORY;
}
- if (map(exports, "processed-request", 1, sed(client_patterns, add_client_headers, csp), 0))
+ if (map(exports, "processed-request", 1, html_encode_and_free_original(
+ sed(client_patterns, add_client_headers, csp)), 0))
{
free_map(exports);
return JB_ERR_MEMORY;
}
-
+
return template_fill_for_cgi(csp, "show-request", exports, rsp);
}
* 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
+ * 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".
+ * type : Selects the type of banner between "trans", "logo",
+ * and "auto". Defaults to "logo" if absent or invalid.
+ * "auto" means to select as if we were image-blocking.
+ * (Only the first character really counts).
*
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory error.
struct http_response *rsp,
const struct map *parameters)
{
- if (strcmp(lookup(parameters, "type"), "trans"))
+ char imagetype = lookup(parameters, "type")[0];
+
+ if (imagetype == 'a') /* auto */
{
- rsp->body = bindup(image_junkbuster_gif_data, image_junkbuster_gif_length);
- rsp->content_length = image_junkbuster_gif_length;
+ /* Default to pattern */
+ imagetype = 'p';
+#ifdef FEATURE_IMAGE_BLOCKING
+ if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
+ {
+ /* determine HOW images should be blocked */
+ const char * p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
+
+ /* and handle accordingly: */
+ if ((p != NULL) && (0 == strcmpic(p, "blank")))
+ {
+ imagetype = 'b';
+ }
+ else if ((p != NULL) && (0 == strcmpic(p, "pattern")))
+ {
+ imagetype = 'p';
+ }
+ }
+#endif /* def FEATURE_IMAGE_BLOCKING */
}
- else
+
+ if ((imagetype == 'b') || (imagetype == 't')) /* blank / transparent */
+ {
+ rsp->body = bindup(image_blank_data, image_blank_length);
+ rsp->content_length = image_blank_length;
+
+ }
+ else /* pattern */
{
- rsp->body = bindup(image_blank_gif_data, image_blank_gif_length);
- rsp->content_length = image_blank_gif_length;
+ rsp->body = bindup(image_pattern_data, image_pattern_length);
+ rsp->content_length = image_pattern_length;
}
if (rsp->body == NULL)
return JB_ERR_MEMORY;
}
- if (enlist(rsp->headers, "Content-Type: image/gif"))
+ if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ rsp->is_static = 1;
+
+ return JB_ERR_OK;
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_transparent_image
+ *
+ * Description : CGI function that sends a 1x1 transparent image.
+ *
+ * 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 : None
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_transparent_image(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ rsp->body = bindup(image_blank_data, image_blank_length);
+ rsp->content_length = image_blank_length;
+
+ if (rsp->body == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
{
return JB_ERR_MEMORY;
}
* Function : cgi_show_version
*
* Description : CGI function that returns a a web page describing the
- * file versions of IJB.
+ * file versions of Privoxy.
*
* 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
+ * 3 : parameters = map of cgi parameters
*
* CGI Parameters : none
*
* Function : cgi_show_status
*
* Description : CGI function that returns a a web page describing the
- * current status of IJB.
+ * current status of Privoxy.
*
* 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
+ * 3 : parameters = map of cgi parameters
*
* CGI Parameters :
* file : Which file to show. Only first letter is checked,
FILE * fp;
char buf[BUFFER_SIZE];
- char * p;
const char * filename = NULL;
char * file_description = NULL;
#ifdef FEATURE_STATISTICS
s = strdup("");
while ((s != NULL) && fgets(buf, sizeof(buf), fp))
{
- p = html_encode(buf);
- if (p)
- {
- string_append(&s, p);
- freez(p);
- string_append(&s, "<br>");
- }
+ string_join (&s, html_encode(buf));
+ string_append(&s, "<br>");
}
fclose(fp);
return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
}
- if (map(exports, "redirect-url", 1, REDIRECT_URL, 1))
+ if (map(exports, "redirect-url", 1, html_encode(REDIRECT_URL), 0))
{
free_map(exports);
return JB_ERR_MEMORY;
}
s = strdup("");
- for (i=0; i < Argc; i++)
+ for (i = 0; (s != NULL) && (i < Argc); i++)
{
- string_append(&s, Argv[i]);
+ string_join (&s, html_encode(Argv[i]));
string_append(&s, " ");
}
if (map(exports, "invocation", 1, s, 0))
if (csp->actions_list)
{
- if (!err) err = map(exports, "actions-filename", 1, csp->actions_list->filename, 1);
+ if (!err) err = map(exports, "actions-filename", 1, html_encode(csp->actions_list->filename), 0);
}
else
{
if (csp->rlist)
{
- if (!err) err = map(exports, "re-filter-filename", 1, csp->rlist->filename, 1);
+ if (!err) err = map(exports, "re-filter-filename", 1, html_encode(csp->rlist->filename), 0);
}
else
{
#ifdef FEATURE_TRUST
if (csp->tlist)
{
- if (!err) err = map(exports, "trust-filename", 1, csp->tlist->filename, 1);
+ if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
}
else
{
* Function : cgi_show_url_info
*
* Description : CGI function that determines and shows which actions
- * junkbuster will perform for a given url, and which
+ * Privoxy 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
+ * 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.
struct http_response *rsp,
const struct map *parameters)
{
- const char *url_param_const;
- char *host = NULL;
+ char *url_param;
struct map *exports;
assert(csp);
return JB_ERR_MEMORY;
}
- url_param_const = lookup(parameters, "url");
- if (*url_param_const == '\0')
+ /*
+ * Get the url= parameter (if present) and remove any leading/trailing spaces.
+ */
+ url_param = strdup(lookup(parameters, "url"));
+ if (url_param == NULL)
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ chomp(url_param);
+
+ /*
+ * Handle prefixes. 4 possibilities:
+ * 1) "http://" or "https://" prefix present and followed by URL - OK
+ * 2) Only the "http://" or "https://" part is present, no URL - change
+ * to empty string so it will be detected later as "no URL".
+ * 3) Parameter specified but doesn't contain "http(s?)://" - add a
+ * "http://" prefix.
+ * 4) Parameter not specified or is empty string - let this fall through
+ * for now, next block of code will handle it.
+ */
+ if (0 == strncmp(url_param, "http://", 7))
{
+ if (url_param[7] == '\0')
+ {
+ /*
+ * Empty URL (just prefix).
+ * Make it totally empty so it's caught by the next if()
+ */
+ url_param[0] = '\0';
+ }
+ }
+ else if (0 == strncmp(url_param, "https://", 8))
+ {
+ if (url_param[8] == '\0')
+ {
+ /*
+ * Empty URL (just prefix).
+ * Make it totally empty so it's caught by the next if()
+ */
+ url_param[0] = '\0';
+ }
+ }
+ else if (url_param[0] != '\0')
+ {
+ /*
+ * Unknown prefix - assume http://
+ */
+ char * url_param_prefixed = malloc(7 + 1 + strlen(url_param));
+ if (NULL == url_param_prefixed)
+ {
+ free(url_param);
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ strcpy(url_param_prefixed, "http://");
+ strcpy(url_param_prefixed + 7, url_param);
+ free(url_param);
+ url_param = url_param_prefixed;
+ }
+
+
+ if (url_param[0] == '\0')
+ {
+ /* URL paramater not specified, display query form only. */
+ free(url_param);
if (map_block_killer(exports, "url-given")
|| map(exports, "url", 1, "", 1))
{
}
else
{
- char *url_param;
+ /* Given a URL, so query it. */
+ jb_err err;
char *matches;
- char *path;
char *s;
- int port = 80;
int hits = 0;
struct file_list *fl;
struct url_actions *b;
- struct url_spec url[1];
+ struct http_request url_to_query[1];
struct current_action_spec action[1];
- if (NULL == (url_param = strdup(url_param_const)))
- {
- free_map(exports);
- return JB_ERR_MEMORY;
- }
-
- host = url_param;
- host += (strncmp(url_param, "http://", 7)) ? 0 : 7;
-
- if (map(exports, "url", 1, host, 1)
- || map(exports, "url-html", 1, html_encode(host), 0))
+ if (map(exports, "url", 1, html_encode(url_param), 0))
{
free(url_param);
free_map(exports);
init_current_action(action);
- s = current_action_to_text(action);
- if (map(exports, "default", 1, s , 0))
+ if (map(exports, "default", 1, html_encode_and_free_original(
+ current_action_to_text(action)), 0))
{
free_current_action(action);
free(url_param);
if (((fl = csp->actions_list) == NULL) || ((b = fl->f) == NULL))
{
- jb_err err;
-
- err = map(exports, "matches", 1, "none" , 1)
- || map(exports, "final", 1, lookup(exports, "default"), 1);
+ err = map(exports, "matches", 1, "none" , 1);
+ if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
free_current_action(action);
free(url_param);
return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
}
- s = strchr(host, '/');
- if (s != NULL)
- {
- path = strdup(s);
- *s = '\0';
- }
- else
- {
- path = strdup("");
- }
- if (NULL == path)
+ err = parse_http_url(url_param, url_to_query, csp);
+
+ free(url_param);
+
+ if (err == JB_ERR_MEMORY)
{
free_current_action(action);
- free(url_param);
free_map(exports);
return JB_ERR_MEMORY;
}
-
- s = strchr(host, ':');
- if (s != NULL)
+ else if (err)
{
- *s++ = '\0';
- port = atoi(s);
- s = NULL;
- }
+ /* Invalid URL */
- *url = dsplit(host);
+ err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
+ if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
- /* if splitting the domain fails, punt */
- if (url->dbuf == NULL)
- {
- jb_err err;
-
- err = map(exports, "matches", 1, "none" , 1)
- || map(exports, "final", 1, lookup(exports, "default"), 1);
-
- freez(url_param);
- freez(path);
free_current_action(action);
if (err)
return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
}
+ /*
+ * We have a warning about SSL paths. Hide it for insecure sites.
+ */
+ if (!url_to_query->ssl)
+ {
+ if (map_block_killer(exports, "https"))
+ {
+ free_current_action(action);
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ }
+
matches = strdup("");
- for (b = b->next; NULL != b; b = b->next)
+ for (b = b->next; (b != NULL) && (matches != NULL); b = b->next)
{
- if ((b->url->port == 0) || (b->url->port == port))
+ if (url_match(b->url, url_to_query))
{
- if ((b->url->domain[0] == '\0') || (domaincmp(b->url, url) == 0))
+ string_append(&matches, "<b>{");
+ string_join (&matches, html_encode_and_free_original(
+ actions_to_text(b->action)));
+ string_append(&matches, " }</b><br>\n<code>");
+ string_join (&matches, html_encode(b->url->spec));
+ string_append(&matches, "</code><br>\n<br>\n");
+
+ if (merge_current_action(action, b->action))
{
- 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);
- if (s == NULL)
- {
- freez(url->dbuf);
- freez(url->dvec);
-
- free(url_param);
- free(path);
- free_current_action(action);
- free_map(exports);
- return JB_ERR_MEMORY;
- }
- string_append(&matches, "<b>{");
- string_append(&matches, s);
- string_append(&matches, " }</b><br>\n<code>");
- string_append(&matches, b->url->spec);
- string_append(&matches, "</code><br>\n<br>\n");
- free(s);
-
- merge_current_action(action, b->action); /* FIXME: Add error checking */
- hits++;
- }
+ freez(matches);
+ free_http_request(url_to_query);
+ free_current_action(action);
+ free_map(exports);
+ return JB_ERR_MEMORY;
}
+ hits++;
}
}
- freez(url->dbuf);
- freez(url->dvec);
-
- free(url_param);
- free(path);
+ free_http_request(url_to_query);
if (matches == NULL)
{
return JB_ERR_MEMORY;
}
- s = current_action_to_text(action);
+ s = html_encode_and_free_original(current_action_to_text(action));
free_current_action(action);
* Description : CGI function to return "/robots.txt".
*
* 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
+ * 3 : parameters = map of cgi parameters
*
* CGI Parameters : None
*
jb_err err;
rsp->body = strdup(
- "# This is the Internet Junkbuster control interface.\n"
+ "# This is the Privoxy control interface.\n"
"# It isn't very useful to index it, and you're likely to break stuff.\n"
"# So go away!\n"
"\n"
* used when building
*
* Parameters :
- * 1 : exports = map to extend
+ * 1 : exports = map to extend
*
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory error.
if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 0);
#endif /* ndef FEATURE_KILL_POPUPS */
+#ifdef FEATURE_NO_GIFS
+ if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
+#else /* ifndef FEATURE_NO_GIFS */
+ if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
+#endif /* ndef FEATURE_NO_GIFS */
+
#ifdef FEATURE_PTHREAD
if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
#else /* ifndef FEATURE_PTHREAD */
SHOW_RCS(project_h_rcs)
SHOW_RCS(ssplit_h_rcs)
SHOW_RCS(ssplit_rcs)
+ SHOW_RCS(urlmatch_h_rcs)
+ SHOW_RCS(urlmatch_rcs)
#ifdef _WIN32
#ifndef _WIN_CONSOLE
SHOW_RCS(w32log_h_rcs)