From: jongfoster <jongfoster@users.sourceforge.net>
Date: Tue, 23 Oct 2001 21:48:19 +0000 (+0000)
Subject: Cleaning up error handling in CGI functions - they now send back
X-Git-Tag: v_2_9_10~88
X-Git-Url: http://www.privoxy.org/gitweb/%22https:/faq/@default-cgi@/@proxy-info-url@?a=commitdiff_plain;h=fc38802c68b57157c6e3c763d15dbd9f8e85e170;p=privoxy.git
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.
---
diff --git a/cgi.c b/cgi.c
index d5f87703..7ad60170 100644
--- a/cgi.c
+++ b/cgi.c
@@ -1,4 +1,4 @@
-const char cgi_rcs[] = "$Id: cgi.c,v 1.33 2001/10/14 22:28:41 jongfoster Exp $";
+const char cgi_rcs[] = "$Id: cgi.c,v 1.34 2001/10/18 22:22:09 david__schmidt Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
@@ -38,6 +38,11 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.33 2001/10/14 22:28:41 jongfoster Exp $";
*
* Revisions :
* $Log: cgi.c,v $
+ * 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 are removed automatically
+ *
* Revision 1.33 2001/10/14 22:28:41 jongfoster
* Fixing stupid typo.
*
@@ -265,6 +270,9 @@ static const struct cgi_dispatcher cgi_dispatchers[] = {
cgi_show_url_info,
"Show which actions apply to a URL and why" },
#ifdef FEATURE_CGI_EDIT_ACTIONS
+ { "toggle",
+ cgi_toggle,
+ "Toggle JunkBuster on or off" },
{ "edit-actions",
cgi_edit_actions,
"Edit the actions list" },
@@ -280,6 +288,21 @@ static const struct cgi_dispatcher cgi_dispatchers[] = {
{ "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-add-url",
+ cgi_edit_actions_add_url,
+ NULL /* Add a URL pattern to the actionsfile */ },
+ { "edit-actions-remove-url",
+ cgi_edit_actions_remove_url,
+ NULL /* Add a URL pattern to the actionsfile */ },
+ { "edit-actions-section-remove",
+ cgi_edit_actions_section_remove,
+ NULL /* Remove a section from the actionsfile */ },
+ { "edit-actions-section-add",
+ cgi_edit_actions_section_add,
+ NULL /* Remove a section from the actionsfile */ },
#endif /* def FEATURE_CGI_EDIT_ACTIONS */
{ "robots.txt",
cgi_robots_txt,
@@ -321,6 +344,9 @@ const char image_blank_gif_data[] =
const int image_blank_gif_length = sizeof(image_blank_gif_data) - 1;
+static struct http_response cgi_error_memory_response[1];
+
+
static struct http_response *dispatch_known_cgi(struct client_state * csp,
const char * path);
@@ -415,11 +441,11 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp,
struct http_response *rsp;
char *query_args_start;
char *path_copy;
- int result;
+ jb_err err;
if (NULL == (path_copy = strdup(path)))
{
- return NULL;
+ return cgi_error_memory();
}
query_args_start = path_copy;
@@ -435,7 +461,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp,
if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
{
free(path_copy);
- return(NULL);
+ return cgi_error_memory();
}
@@ -450,7 +476,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp,
{
free(path_copy);
free_map(param_list);
- return NULL;
+ return cgi_error_memory();
}
log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
@@ -462,19 +488,23 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp,
{
if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
{
- result = (d->handler)(csp, rsp, param_list);
+ err = (d->handler)(csp, rsp, param_list);
free(path_copy);
free_map(param_list);
- if (result)
+ if (err == JB_ERR_CGI_PARAMS)
{
- /* Error in handler */
- free_http_response(rsp);
- return(NULL);
+ err = cgi_error_bad_param(csp, rsp);
}
- else
+ if (!err)
{
/* It worked */
- return(finish_http_response(rsp));
+ return finish_http_response(rsp);
+ }
+ else
+ {
+ /* Error in handler, probably out-of-memory */
+ free_http_response(rsp);
+ return cgi_error_memory();
}
}
}
@@ -513,11 +543,15 @@ static struct map *parse_cgi_parameters(char *argstring)
if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
{
*p = '\0';
- map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0);
+ if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
+ {
+ free_map(cgi_params);
+ return NULL;
+ }
}
}
- return(cgi_params);
+ return cgi_params;
}
@@ -532,44 +566,248 @@ static struct map *parse_cgi_parameters(char *argstring)
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
* 2 : templatename = Which template should be used for the answer
- * 3 : errno = system error number
+ * 3 : sys_err = system error number
*
- * Returns : NULL if no memory, else http_response
+ * Returns : A http_response. If we run out of memory, this
+ * will be cgi_error_memory().
*
*********************************************************************/
-struct http_response *error_response(struct client_state *csp, const char *templatename, int err)
+struct http_response *error_response(struct client_state *csp,
+ const char *templatename,
+ int sys_err)
{
+ jb_err err;
struct http_response *rsp;
struct map * exports = default_exports(csp, NULL);
+ if (exports == NULL)
+ {
+ return cgi_error_memory();
+ }
if (NULL == (rsp = alloc_http_response()))
{
- return NULL;
+ free_map(exports);
+ return cgi_error_memory();
}
- map(exports, "host-html", 1, html_encode(csp->http->host), 0);
- map(exports, "hostport", 1, csp->http->hostport, 1);
- map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0);
- map(exports, "path", 1, csp->http->path, 1);
- map(exports, "path-html", 1, html_encode(csp->http->path), 0);
- map(exports, "error", 1, safe_strerror(err), 0);
- map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1);
+ err = map(exports, "host-html", 1, html_encode(csp->http->host), 0)
+ || map(exports, "hostport", 1, csp->http->hostport, 1)
+ || map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0)
+ || map(exports, "path", 1, csp->http->path, 1)
+ || map(exports, "path-html", 1, html_encode(csp->http->path), 0)
+ || map(exports, "error", 1, safe_strerror(sys_err), 0)
+ || map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1);
- rsp->body = template_load(csp, templatename);
- template_fill(&rsp->body, exports);
- free_map(exports);
+ if (err)
+ {
+ free_map(exports);
+ free_http_response(rsp);
+ return cgi_error_memory();
+ }
if (!strcmp(templatename, "no-such-domain"))
{
- rsp->status = strdup("404 No such domain");
+ rsp->status = strdup("404 No such domain");
+ if (rsp->status == NULL)
+ {
+ free_map(exports);
+ free_http_response(rsp);
+ return cgi_error_memory();
+ }
}
else if (!strcmp(templatename, "connect-failed"))
{
rsp->status = strdup("503 Connect failed");
+ if (rsp->status == NULL)
+ {
+ free_map(exports);
+ free_http_response(rsp);
+ return cgi_error_memory();
+ }
}
- return(finish_http_response(rsp));
+ err = template_fill_for_cgi(csp, templatename, exports, rsp);
+ if (err)
+ {
+ free_http_response(rsp);
+ return cgi_error_memory();
+ }
+ return finish_http_response(rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_init_error_messages
+ *
+ * Description : Call at the start of the program to initialize
+ * the error message used by cgi_error_memory().
+ *
+ * Parameters : N/A
+ *
+ * Returns : N/A
+ *
+ *********************************************************************/
+void cgi_init_error_messages(void)
+{
+ memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
+ cgi_error_memory_response->head =
+ "HTTP/1.0 500 Internal JunkBuster Proxy Error\r\n"
+ "Content-Type: text/html\r\n"
+ "\r\n";
+ cgi_error_memory_response->body =
+ "<html>\r\n"
+ "<head><title>500 Internal JunkBuster Proxy Error</title></head>\r\n"
+ "<body>\r\n"
+ "<h1>500 Internal JunkBuster Proxy Error</h1>\r\n"
+ "<p>JunkBuster <b>ran out of memory</b> whilst processing your request.</p>\r\n"
+ "<p>Please contact your proxy administrator, or try again later</p>\r\n"
+ "</body>\r\n"
+ "</html>\r\n";
+
+ cgi_error_memory_response->head_length =
+ strlen(cgi_error_memory_response->head);
+ cgi_error_memory_response->content_length =
+ strlen(cgi_error_memory_response->body);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_error_memory
+ *
+ * Description : Called if a CGI function runs out of memory.
+ * Returns a statically-allocated error response.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : template_name = Name of template that could not
+ * be loaded.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+struct http_response *cgi_error_memory(void)
+{
+ /* assert that it's been initialized. */
+ assert(cgi_error_memory_response->head);
+
+ return cgi_error_memory_response;
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_error_no_template
+ *
+ * Description : Almost-CGI function that is called if a templae
+ * cannot be loaded. Note this is not a true CGI,
+ * it takes a template name rather than a map of
+ * parameters.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : template_name = Name of template that could not
+ * be loaded.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_error_no_template(struct client_state *csp,
+ struct http_response *rsp,
+ const char *template_name)
+{
+ static const char status[] =
+ "500 Internal JunkBuster Proxy Error";
+ static const char body_prefix[] =
+ "<html>\r\n"
+ "<head><title>500 Internal JunkBuster Proxy Error</title></head>\r\n"
+ "<body>\r\n"
+ "<h1>500 Internal JunkBuster Proxy Error</h1>\r\n"
+ "<p>JunkBuster encountered an error whilst processing your request:</p>\r\n"
+ "<p><b>Could not load template file <code>";
+ static const char body_suffix[] =
+ "</code></b></p>\r\n"
+ "<p>Please contact your proxy administrator.</p>\r\n"
+ "<p>If you are the proxy administrator, please put the required file "
+ "in the <code><i>(confdir)</i>/templates</code> directory. The "
+ "location of the <code><i>(confdir)</i></code> directory "
+ "is specified in the main JunkBuster <code>config</code> "
+ "file. (It's typically the JunkBuster install directory"
+#ifndef _WIN32
+ ", or <code>/etc/junkbuster/</code>"
+#endif /* ndef _WIN32 */
+ ").</p>\r\n"
+ "</body>\r\n"
+ "</html>\r\n";
+
+ assert(csp);
+ assert(rsp);
+ assert(template_name);
+
+ /* Reset rsp, if needed */
+ freez(rsp->status);
+ freez(rsp->head);
+ freez(rsp->body);
+ rsp->content_length = 0;
+ rsp->head_length = 0;
+ rsp->is_static = 0;
+
+ rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
+ if (rsp->body == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
+ strcpy(rsp->body, body_prefix);
+ strcat(rsp->body, template_name);
+ strcat(rsp->body, body_suffix);
+
+ rsp->status = strdup(status);
+ if (rsp->body == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ return JB_ERR_OK;
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_error_bad_param
+ *
+ * Description : CGI function that is called if the parameters
+ * (query string) for a CGI were wrong.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ *
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_error_bad_param(struct client_state *csp,
+ struct http_response *rsp)
+{
+ struct map *exports;
+
+ assert(csp);
+ assert(rsp);
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
}
@@ -621,7 +859,6 @@ void get_http_time(int time_offset, char *buf)
t->tm_min,
t->tm_sec
);
- buf[32] = '\0';
}
@@ -636,18 +873,28 @@ void get_http_time(int time_offset, char *buf)
* 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
@@ -657,7 +904,7 @@ struct http_response *finish_http_response(struct http_response *rsp)
rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
}
sprintf(buf, "Content-Length: %d", rsp->content_length);
- enlist(rsp->headers, buf);
+ err = err || enlist(rsp->headers, buf);
/*
* Fill in the default headers:
@@ -670,7 +917,7 @@ struct http_response *finish_http_response(struct http_response *rsp)
*
* See http://www.w3.org/Protocols/rfc2068/rfc2068
*/
- enlist_unique(rsp->headers, "Content-Type: text/html", 13);
+ err = err || enlist_unique(rsp->headers, "Content-Type: text/html", 13);
if (rsp->is_static)
{
@@ -680,13 +927,13 @@ struct http_response *finish_http_response(struct http_response *rsp)
*/
get_http_time(0, buf);
- enlist_unique_header(rsp->headers, "Date", buf);
+ err = err || enlist_unique_header(rsp->headers, "Date", buf);
/* Some date in the past. */
- enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
+ err = err || enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
- enlist_unique_header(rsp->headers, "Expires", buf);
+ err = err || enlist_unique_header(rsp->headers, "Expires", buf);
}
else
{
@@ -695,28 +942,28 @@ struct http_response *finish_http_response(struct http_response *rsp)
* 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");
+ err = err || enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
get_http_time(0, buf);
- enlist_unique_header(rsp->headers, "Date", buf);
- enlist_unique_header(rsp->headers, "Last-Modified", buf);
- enlist_unique_header(rsp->headers, "Expires", buf);
+ err = err || enlist_unique_header(rsp->headers, "Date", buf);
+ err = err || enlist_unique_header(rsp->headers, "Last-Modified", buf);
+ 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;
}
-
+
/*********************************************************************
*
@@ -751,7 +998,10 @@ struct http_response *alloc_http_response(void)
*********************************************************************/
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);
@@ -773,31 +1023,68 @@ void free_http_response(struct http_response *rsp)
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : template_ptr = Destination for pointer to loaded
+ * template text.
* 3 : template = name of the HTML template to be used
*
- * Returns : char * with loaded template, or NULL if failure
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ * JB_ERR_FILE if the template file cannot be read
*
*********************************************************************/
-char *template_load(struct client_state *csp, const char *templatename)
+jb_err template_load(struct client_state *csp, char ** template_ptr,
+ const char *templatename)
{
- char buf[BUFFER_SIZE];
- char *file_buffer = NULL;
+ char *templates_dir_path;
+ char *full_path;
+ char *file_buffer;
FILE *fp;
+ char buf[BUFFER_SIZE];
+
+ assert(csp);
+ assert(template_ptr);
+ assert(templatename);
+
+ *template_ptr = NULL;
/*
* Open template file or fail
*/
- snprintf(buf, BUFFER_SIZE, "%s/templates/%s", csp->config->confdir, templatename);
- if(NULL == (fp = fopen(buf, "r")))
+ templates_dir_path = make_path(csp->config->confdir, "templates");
+ if (templates_dir_path == NULL)
{
- log_error(LOG_LEVEL_FATAL, "error loading template %s: %E", buf);
- return NULL;
+ return JB_ERR_MEMORY;
+ }
+
+ full_path = make_path(templates_dir_path, templatename);
+ free(templates_dir_path);
+ if (full_path == NULL)
+ {
+ return JB_ERR_MEMORY;
}
-
+
+ file_buffer = strdup("");
+ if (file_buffer == NULL)
+ {
+ free(full_path);
+ return JB_ERR_MEMORY;
+ }
+
+ if (NULL == (fp = fopen(full_path, "r")))
+ {
+ log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
+ free(full_path);
+ free(file_buffer);
+ return JB_ERR_FILE;
+ }
+ free(full_path);
/*
- * Read the file, ignoring comments
+ * Read the file, ignoring comments.
+ *
+ * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
+ * This is unlikely in practise.
*/
while (fgets(buf, BUFFER_SIZE, fp))
{
@@ -806,19 +1093,24 @@ char *template_load(struct client_state *csp, const char *templatename)
{
continue;
}
-
- file_buffer = strsav(file_buffer, buf);
+
+ if (string_append(&file_buffer, buf))
+ {
+ fclose(fp);
+ return JB_ERR_MEMORY;
+ }
}
fclose(fp);
- return(file_buffer);
+ *template_ptr = file_buffer;
+ return JB_ERR_OK;
}
/*********************************************************************
*
- * Function : fill_template
+ * Function : template_fill
*
* Description : CGI support function that fills in a pre-loaded
* HTML template by replacing @name@ with value using
@@ -835,10 +1127,11 @@ char *template_load(struct client_state *csp, const char *templatename)
* Caller must free().
* 2 : exports = map with fill in symbol -> name pairs
*
- * Returns : N/A
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error
*
*********************************************************************/
-void template_fill(char **template_ptr, struct map *exports)
+jb_err template_fill(char **template_ptr, const struct map *exports)
{
struct map_entry *m;
pcrs_job *job;
@@ -891,17 +1184,29 @@ void template_fill(char **template_ptr, struct map *exports)
job = pcrs_compile(buf, m->value, flags, &error);
if (job == NULL)
{
- log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
+ if (error == PCRS_ERR_NOMEM)
+ {
+ free(file_buffer);
+ *template_ptr = NULL;
+ return JB_ERR_MEMORY;
+ }
+ else
+ {
+ log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
+ /* Hope it wasn't important and silently ignore the invalid job */
+ }
}
else
{
pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
- if (NULL != tmp_out_buffer)
+ free(file_buffer);
+ pcrs_free_job(job);
+ if (NULL == tmp_out_buffer)
{
- free(file_buffer);
- file_buffer = tmp_out_buffer;
+ *template_ptr = NULL;
+ return JB_ERR_MEMORY;
}
- pcrs_free_job(job);
+ file_buffer = tmp_out_buffer;
}
}
@@ -909,10 +1214,57 @@ void template_fill(char **template_ptr, struct map *exports)
* Return
*/
*template_ptr = file_buffer;
-
+ return JB_ERR_OK;
}
+/*********************************************************************
+ *
+ * Function : template_fill_for_cgi
+ *
+ * Description : CGI support function that loads a HTML template
+ * and fills it in. Handles file-not-found errors
+ * by sending a HTML error message. For convenience,
+ * this function also frees the passed "exports" map.
+ *
+ * Parameters :
+ * 1 : csp = Client state
+ * 2 : templatename = name of the HTML template to be used
+ * 3 : exports = map with fill in symbol -> name pairs.
+ * Will be freed by this function.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error
+ *
+ *********************************************************************/
+jb_err template_fill_for_cgi(struct client_state *csp,
+ const char *templatename,
+ struct map *exports,
+ struct http_response *rsp)
+{
+ jb_err err;
+
+ assert(csp);
+ assert(templatename);
+ assert(exports);
+ assert(rsp);
+
+ err = template_load(csp, &rsp->body, templatename);
+ if (err == JB_ERR_FILE)
+ {
+ free_map(exports);
+ return cgi_error_no_template(csp, rsp, templatename);
+ }
+ else if (err)
+ {
+ free_map(exports);
+ return err; /* JB_ERR_MEMORY */
+ }
+ err = template_fill(&rsp->body, exports);
+ free_map(exports);
+ return err;
+}
+
/*********************************************************************
*
* Function : default_exports
@@ -921,62 +1273,77 @@ void template_fill(char **template_ptr, struct map *exports)
* which are common to all CGI functions.
*
* Parameters :
- * 1 : exports = Structure to write output to. This
- * structure should be newly allocated and will be
- * zeroed.
* 1 : csp = Current client state (buffers, headers, etc...)
* 2 : caller = name of CGI who calls us and which should
- * be excluded from the generated menu.
- * Returns : NULL if no memory, else map
+ * be excluded from the generated menu. May be
+ * NULL.
+ * Returns : NULL if no memory, else a new map. Caller frees.
*
*********************************************************************/
struct map *default_exports(const struct client_state *csp, const char *caller)
{
char buf[20];
+ int err = 0;
+ struct map * exports;
int local_help_exists = 0;
- struct map * exports = new_map();
- map(exports, "version", 1, VERSION, 1);
- map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1);
- map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1);
- map(exports, "homepage", 1, HOME_PAGE_URL, 1);
- map(exports, "default-cgi", 1, HOME_PAGE_URL "/config", 1);
- map(exports, "menu", 1, make_menu(caller), 0);
- map(exports, "code-status", 1, CODE_STATUS, 1);
+ assert(csp);
+
+ exports = new_map();
+ if (exports == NULL)
+ {
+ return NULL;
+ }
+
+
+ err = map(exports, "version", 1, VERSION, 1)
+ || map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1)
+ || map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1)
+ || map(exports, "homepage", 1, HOME_PAGE_URL, 1)
+ || map(exports, "default-cgi", 1, HOME_PAGE_URL "/config", 1)
+ || map(exports, "menu", 1, make_menu(caller), 0)
+ || map(exports, "code-status", 1, CODE_STATUS, 1);
snprintf(buf, 20, "%d", csp->config->hport);
- map(exports, "my-port", 1, buf, 1);
+ err = err || map(exports, "my-port", 1, buf, 1);
if(!strcmp(CODE_STATUS, "stable"))
{
- map_block_killer(exports, "unstable");
+ err = err || map_block_killer(exports, "unstable");
}
if(csp->config->admin_address != NULL)
{
- map(exports, "admin-address", 1, csp->config->admin_address, 1);
+ err = err || map(exports, "admin-address", 1, csp->config->admin_address, 1);
local_help_exists = 1;
}
else
{
- map_block_killer(exports, "have-adminaddr-info");
+ err = err || map_block_killer(exports, "have-adminaddr-info");
}
if(csp->config->proxy_info_url != NULL)
{
- map(exports, "proxy-info-url", 1, csp->config->proxy_info_url, 1);
+ err = err || map(exports, "proxy-info-url", 1, csp->config->proxy_info_url, 1);
local_help_exists = 1;
}
else
{
- map_block_killer(exports, "have-proxy-info");
- }
+ err = err || map_block_killer(exports, "have-proxy-info");
+ }
if (local_help_exists == 0)
- map_block_killer(exports, "have-help-info");
+ {
+ err = err || map_block_killer(exports, "have-help-info");
+ }
- return (exports);
+ if (err)
+ {
+ free_map(exports);
+ return NULL;
+ }
+ return exports;
}
@@ -994,16 +1361,20 @@ struct map *default_exports(const struct client_state *csp, const char *caller)
* 1 : exports = map to extend
* 2 : name = name of conditional block
*
- * Returns : extended map
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-void map_block_killer(struct map *exports, const char *name)
+jb_err map_block_killer(struct map *exports, const char *name)
{
char buf[1000]; /* Will do, since the names are hardwired */
- snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
- map(exports, buf, 1, "", 1);
+ 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);
}
@@ -1028,22 +1399,32 @@ void map_block_killer(struct map *exports, const char *name)
* 2 : name = name of conditional block
* 3 : choose_first = nonzero for first, zero for second.
*
- * Returns : extended map
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-void map_conditional(struct map *exports, const char *name, int choose_first)
+jb_err map_conditional(struct map *exports, const char *name, int choose_first)
{
char buf[1000]; /* Will do, since the names are hardwired */
+ jb_err err;
+
+ assert(exports);
+ assert(name);
+ assert(strlen(name) < 480);
snprintf(buf, 1000, (choose_first
? "else-not-%s@.*@endif-%s"
: "if-%s-then@.*@else-not-%s"),
name, name);
- map(exports, buf, 1, "", 1);
- snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
- map(exports, buf, 1, "", 1);
+ err = map(exports, buf, 1, "", 1);
+ if (err)
+ {
+ return err;
+ }
+ snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
+ return map(exports, buf, 1, "", 1);
}
diff --git a/cgi.h b/cgi.h
index 064c8b89..acc9cc45 100644
--- a/cgi.h
+++ b/cgi.h
@@ -1,6 +1,6 @@
#ifndef CGI_H_INCLUDED
#define CGI_H_INCLUDED
-#define CGI_H_VERSION "$Id: cgi.h,v 1.15 2001/09/16 15:02:35 jongfoster Exp $"
+#define CGI_H_VERSION "$Id: cgi.h,v 1.16 2001/09/16 17:08:54 jongfoster Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgi.h,v $
@@ -38,6 +38,9 @@
*
* Revisions :
* $Log: cgi.h,v $
+ * Revision 1.16 2001/09/16 17:08:54 jongfoster
+ * Moving simple CGI functions from cgi.c to new file cgisimple.c
+ *
* Revision 1.15 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.
@@ -129,17 +132,29 @@ extern struct http_response *finish_http_response(struct http_response *rsp);
extern struct map * default_exports(const struct client_state *csp, const char *caller);
-extern void map_block_killer (struct map *exports, const char *name);
-extern void map_conditional (struct map *exports, const char *name, int choose_first);
-
-extern char *template_load(struct client_state *csp, const char *templatename);
-extern void template_fill(char ** template_ptr, struct map *exports);
-
-extern void get_http_time(int time_offset, char * buf);
+extern jb_err map_block_killer (struct map *exports, const char *name);
+extern jb_err map_conditional (struct map *exports, const char *name, int choose_first);
+
+extern jb_err template_load(struct client_state *csp, char ** template_ptr,
+ const char *templatename);
+extern jb_err template_fill(char ** template_ptr, const struct map *exports);
+extern jb_err template_fill_for_cgi(struct client_state *csp,
+ const char *templatename,
+ struct map *exports,
+ struct http_response *rsp);
+
+extern void cgi_init_error_messages(void);
+extern struct http_response *cgi_error_memory(void);
+extern jb_err cgi_error_no_template(struct client_state *csp,
+ struct http_response *rsp,
+ const char *template_name);
+extern jb_err cgi_error_bad_param(struct client_state *csp,
+ struct http_response *rsp);
/*
* Text generators
*/
+extern void get_http_time(int time_offset, char * buf);
extern char *make_menu(const char *self);
extern char *dump_map(const struct map *map);
diff --git a/cgiedit.c b/cgiedit.c
index 22dc6932..bcba4250 100644
--- a/cgiedit.c
+++ b/cgiedit.c
@@ -1,4 +1,4 @@
-const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster Exp $";
+const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.3 2001/10/14 22:12:49 jongfoster Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $
@@ -35,6 +35,17 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster
*
* Revisions :
* $Log: cgiedit.c,v $
+ * Revision 1.3 2001/10/14 22:12:49 jongfoster
+ * New version of CGI-based actionsfile editor.
+ * Major changes, including:
+ * - Completely new file parser and file output routines
+ * - edit-actions CGI renamed edit-actions-for-url
+ * - All CGIs now need a filename parameter, except for...
+ * - New CGI edit-actions which doesn't need a filename,
+ * to allow you to start the editor up.
+ * - edit-actions-submit now works, and now automatically
+ * redirects you back to the main edit-actions-list handler.
+ *
* Revision 1.2 2001/09/16 17:05:14 jongfoster
* Removing unused #include showarg.h
*
@@ -62,6 +73,7 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster
#include <string.h>
#include <assert.h>
#include <limits.h>
+#include <sys/stat.h>
#ifdef _WIN32
#define snprintf _snprintf
@@ -76,6 +88,8 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster
#include "actions.h"
#include "miscutil.h"
#include "errlog.h"
+#include "loadcfg.h"
+/* loadcfg.h is for g_bToggleIJB only */
const char cgiedit_h_rcs[] = CGIEDIT_H_VERSION;
@@ -128,23 +142,86 @@ struct file_line
#define FILE_LINE_DESCRIPTION_HEADER 9
#define FILE_LINE_DESCRIPTION_ENTRY 10
-/* FIXME: Following list of prototypes is not complete */
-/* FIXME: Following non-static functions should be prototyped in .h or made static */
-static int simple_read_line(char **dest, FILE *fp);
-static int edit_read_line (FILE *fp, char **raw_out, char **prefix_out, char **data_out);
- int edit_read_file (FILE *fp, struct file_line ** pfile);
- int edit_write_file (const char * filename, const struct file_line * file);
- void edit_free_file (struct file_line * file);
+struct editable_file
+{
+ struct file_line * lines;
+ const char * filename; /* Full pathname - e.g. "/etc/junkbuster/wibble.action" */
+ const char * identifier; /* Filename stub - e.g. "wibble". Use for CGI param. */
+ const char * version_str; /* Last modification time, as a string. For CGI param */
+ unsigned version; /* Last modification time - prevents chaos with
+ * the browser's "back" button. Note that this is a
+ * time_t cast to an unsigned. When comparing, always
+ * cast the time_t to an unsigned, and *NOT* vice-versa.
+ * This may lose the top few bits, but they're not
+ * significant anyway.
+ */
+ struct file_line * parse_error; /* On parse error, this is the offending line. */
+ const char * parse_error_text; /* On parse error, this is the problem.
+ * (Statically allocated) */
+};
+
+/* FIXME: Following non-static functions should be prototyped in .h or made static */
-/* FIXME: This should be in project.h and used everywhere */
-#define JB_ERR_OK 0 /* Success, no error */
-#define JB_ERR_MEMORY 1 /* Out of memory */
-#define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
-#define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
-#define JB_ERR_PARSE 4 /* Error parsing file */
-#define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
- /* CGI actions editor. */
+/* Functions to read and write arbitrary config files */
+jb_err edit_read_file(struct client_state *csp,
+ const struct map *parameters,
+ int require_version,
+ const char *suffix,
+ struct editable_file **pfile);
+jb_err edit_write_file(struct editable_file * file);
+void edit_free_file(struct editable_file * file);
+
+/* Functions to read and write actions files */
+jb_err edit_parse_actions_file(struct editable_file * file);
+jb_err edit_read_actions_file(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters,
+ int require_version,
+ struct editable_file **pfile);
+
+/* Error handlers */
+jb_err cgi_error_modified(struct client_state *csp,
+ struct http_response *rsp,
+ const char *filename);
+jb_err cgi_error_parse(struct client_state *csp,
+ struct http_response *rsp,
+ struct editable_file *file);
+jb_err cgi_error_file(struct client_state *csp,
+ struct http_response *rsp,
+ const char *filename);
+
+/* Internal arbitrary config file support functions */
+static jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile);
+static void edit_free_file_lines(struct file_line * first_line);
+static jb_err simple_read_line(char **dest, FILE *fp);
+static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out);
+
+/* Internal actions file support functions */
+static int match_actions_file_header_line(const char * line, const char * name);
+static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue);
+
+/* Internal parameter parsing functions */
+static jb_err get_file_name_param(struct client_state *csp,
+ const struct map *parameters,
+ const char *param_name,
+ const char *suffix,
+ char **pfilename,
+ const char **pparam);
+static jb_err get_number_param(struct client_state *csp,
+ const struct map *parameters,
+ char *name,
+ unsigned *pvalue);
+
+/* Internal actionsfile <==> HTML conversion functions */
+static jb_err map_radio(struct map * exports,
+ const char * optionname,
+ const char * values,
+ char value);
+static jb_err actions_to_radio(struct map * exports,
+ const struct action_spec *action);
+static jb_err actions_from_radio(const struct map * parameters,
+ struct action_spec *action);
/*********************************************************************
@@ -170,7 +247,7 @@ static int edit_read_line (FILE *fp, char **raw_out, char **prefix_out, char *
* JB_ERR_FILE on EOF.
*
*********************************************************************/
-static int simple_read_line(char **dest, FILE *fp)
+static jb_err simple_read_line(char **dest, FILE *fp)
{
int len;
char * buf;
@@ -261,7 +338,7 @@ static int simple_read_line(char **dest, FILE *fp)
* JB_ERR_FILE on EOF.
*
*********************************************************************/
-static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out)
+static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out)
{
char *p; /* Temporary pointer */
char *linebuf; /* Line read from file */
@@ -271,7 +348,7 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da
char *raw; /* String to be stored in raw_out */
char *prefix; /* String to be stored in prefix_out */
char *data; /* String to be stored in data_out */
- int rval = JB_ERR_OK;
+ jb_err rval = JB_ERR_OK;
assert(fp);
@@ -449,7 +526,7 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da
{
free(data);
}
- return(0);
+ return JB_ERR_OK;
}
else
{
@@ -464,86 +541,6 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da
}
-/*********************************************************************
- *
- * Function : edit_read_file
- *
- * Description : Read a complete file into memory.
- * Handles whitespace, comments and line continuation.
- *
- * Parameters :
- * 1 : fp = File to read from
- * 2 : pfile = Destination for a linked list of file_lines.
- * Will be set to NULL on error.
- *
- * Returns : JB_ERR_OK on success
- * JB_ERR_MEMORY on out-of-memory
- *
- *********************************************************************/
-int edit_read_file(FILE *fp, struct file_line ** pfile)
-{
- struct file_line * first_line; /* Keep for return value or to free */
- struct file_line * cur_line; /* Current line */
- struct file_line * prev_line; /* Entry with prev_line->next = cur_line */
- int rval;
-
- assert(fp);
- assert(pfile);
-
- *pfile = NULL;
-
- cur_line = first_line = zalloc(sizeof(struct file_line));
- if (cur_line == NULL)
- {
- return JB_ERR_MEMORY;
- }
-
- cur_line->type = FILE_LINE_UNPROCESSED;
-
- rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed);
- if (rval)
- {
- /* Out of memory or empty file. */
- /* Note that empty file is not an error we propogate up */
- free(cur_line);
- return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval);
- }
-
- do
- {
- prev_line = cur_line;
- cur_line = prev_line->next = zalloc(sizeof(struct file_line));
- if (cur_line == NULL)
- {
- /* Out of memory */
- edit_free_file(first_line);
- return JB_ERR_MEMORY;
- }
-
- cur_line->type = FILE_LINE_UNPROCESSED;
-
- rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed);
- if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE))
- {
- /* Out of memory */
- edit_free_file(first_line);
- return JB_ERR_MEMORY;
- }
-
- }
- while (rval != JB_ERR_FILE);
-
- /* EOF */
-
- /* We allocated one too many - free it */
- prev_line->next = NULL;
- free(cur_line);
-
- *pfile = first_line;
- return JB_ERR_OK;
-}
-
-
/*********************************************************************
*
* Function : edit_write_file
@@ -556,24 +553,33 @@ int edit_read_file(FILE *fp, struct file_line ** pfile)
*
* Returns : JB_ERR_OK on success
* JB_ERR_FILE on error writing to file.
+ * JB_ERR_MEMORY on out of memory
*
*********************************************************************/
-int edit_write_file(const char * filename, const struct file_line * file)
+jb_err edit_write_file(struct editable_file * file)
{
FILE * fp;
+ struct file_line * cur_line;
+ struct stat statbuf[1];
+ char version_buf[22]; /* 22 = ceil(log10(2^64)) + 2 = max number of
+ digits in time_t, assuming this is a 64-bit
+ machine, plus null terminator, plus one
+ for paranoia */
- assert(filename);
+ assert(file);
+ assert(file->filename);
- if (NULL == (fp = fopen(filename, "wt")))
+ if (NULL == (fp = fopen(file->filename, "wt")))
{
return JB_ERR_FILE;
}
- while (file != NULL)
+ cur_line = file->lines;
+ while (cur_line != NULL)
{
- if (file->raw)
+ if (cur_line->raw)
{
- if (fputs(file->raw, fp) < 0)
+ if (fputs(cur_line->raw, fp) < 0)
{
fclose(fp);
return JB_ERR_FILE;
@@ -581,17 +587,17 @@ int edit_write_file(const char * filename, const struct file_line * file)
}
else
{
- if (file->prefix)
+ if (cur_line->prefix)
{
- if (fputs(file->prefix, fp) < 0)
+ if (fputs(cur_line->prefix, fp) < 0)
{
fclose(fp);
return JB_ERR_FILE;
}
}
- if (file->unprocessed)
+ if (cur_line->unprocessed)
{
- if (fputs(file->unprocessed, fp) < 0)
+ if (fputs(cur_line->unprocessed, fp) < 0)
{
fclose(fp);
return JB_ERR_FILE;
@@ -608,10 +614,32 @@ int edit_write_file(const char * filename, const struct file_line * file)
assert(0);
}
}
- file = file->next;
+ cur_line = cur_line->next;
}
fclose(fp);
+
+
+ /* Update the version stamp in the file structure, since we just
+ * wrote to the file & changed it's date.
+ */
+ if (stat(file->filename, statbuf) < 0)
+ {
+ /* Error, probably file not found. */
+ return JB_ERR_FILE;
+ }
+ file->version = (unsigned)statbuf->st_mtime;
+
+ /* Correct file->version_str */
+ freez((char *)file->version_str);
+ snprintf(version_buf, 22, "%u", file->version);
+ version_buf[21] = '\0';
+ file->version_str = strdup(version_buf);
+ if (version_buf == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
+
return JB_ERR_OK;
}
@@ -628,18 +656,50 @@ int edit_write_file(const char * filename, const struct file_line * file)
* Returns : N/A
*
*********************************************************************/
-void edit_free_file(struct file_line * file)
+void edit_free_file(struct editable_file * file)
{
- struct file_line * next;
+ if (!file)
+ {
+ /* Silently ignore NULL pointer */
+ return;
+ }
+
+ edit_free_file_lines(file->lines);
+ freez((char *)file->filename);
+ freez((char *)file->identifier);
+ freez((char *)file->version_str);
+ file->version = 0;
+ file->parse_error_text = NULL; /* Statically allocated */
+ file->parse_error = NULL;
+
+ free(file);
+}
+
+
+/*********************************************************************
+ *
+ * Function : edit_free_file
+ *
+ * Description : Free an entire linked list of file lines.
+ *
+ * Parameters :
+ * 1 : first_line = Data structure to free.
+ *
+ * Returns : N/A
+ *
+ *********************************************************************/
+static void edit_free_file_lines(struct file_line * first_line)
+{
+ struct file_line * next_line;
- while (file != NULL)
+ while (first_line != NULL)
{
- next = file->next;
- file->next = NULL;
- freez(file->raw);
- freez(file->prefix);
- freez(file->unprocessed);
- switch(file->type)
+ next_line = first_line->next;
+ first_line->next = NULL;
+ freez(first_line->raw);
+ freez(first_line->prefix);
+ freez(first_line->unprocessed);
+ switch(first_line->type)
{
case 0: /* special case if memory zeroed */
case FILE_LINE_UNPROCESSED:
@@ -654,21 +714,21 @@ void edit_free_file(struct file_line * file)
break;
case FILE_LINE_ACTION:
- free_action(file->data.action);
+ free_action(first_line->data.action);
break;
case FILE_LINE_SETTINGS_ENTRY:
- freez(file->data.setting.name);
- freez(file->data.setting.svalue);
+ freez(first_line->data.setting.name);
+ freez(first_line->data.setting.svalue);
break;
default:
/* Should never happen */
assert(0);
break;
}
- file->type = 0; /* paranoia */
- free(file);
- file = next;
+ first_line->type = 0; /* paranoia */
+ free(first_line);
+ first_line = next_line;
}
}
@@ -750,7 +810,7 @@ static int match_actions_file_header_line(const char * line, const char * name)
* values *after* the "=" sign are legal).
*
*********************************************************************/
-static int split_line_on_equals(const char * line, char ** pname, char ** pvalue)
+static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue)
{
const char * name_end;
const char * value_start;
@@ -831,7 +891,7 @@ static int split_line_on_equals(const char * line, char ** pname, char ** pvalue
* JB_ERR_PARSE on error
*
*********************************************************************/
-int edit_parse_actions_file(struct file_line * file)
+jb_err edit_parse_actions_file(struct editable_file * file)
{
struct file_line * cur_line;
int len;
@@ -839,14 +899,14 @@ int edit_parse_actions_file(struct file_line * file)
char * name; /* For lines of the form name=value */
char * value; /* For lines of the form name=value */
struct action_alias * alias_list = NULL;
- int rval = JB_ERR_OK;
+ jb_err err = JB_ERR_OK;
/* alias_list contains the aliases defined in this file.
* It might be better to use the "file_line.data" fields
* in the relavent places instead.
*/
- cur_line = file;
+ cur_line = file->lines;
/* A note about blank line support: Blank lines should only
* ever occur as the last line in the file. This function
@@ -869,6 +929,8 @@ int edit_parse_actions_file(struct file_line * file)
&& (cur_line->unprocessed[0] != '{') )
{
/* File doesn't start with a header */
+ file->parse_error = cur_line;
+ file->parse_error_text = "First (non-comment) line of the file must contain a header.";
return JB_ERR_PARSE;
}
@@ -884,13 +946,19 @@ int edit_parse_actions_file(struct file_line * file)
{
cur_line->type = FILE_LINE_SETTINGS_ENTRY;
- rval = split_line_on_equals(cur_line->unprocessed,
+ err = split_line_on_equals(cur_line->unprocessed,
&cur_line->data.setting.name,
&cur_line->data.setting.svalue);
- if (rval != JB_ERR_OK)
+ if (err == JB_ERR_MEMORY)
+ {
+ return err;
+ }
+ else if (err != JB_ERR_OK)
{
- /* Line does not contain a name=value pair, or out-of-memory */
- return rval;
+ /* Line does not contain a name=value pair */
+ file->parse_error = cur_line;
+ file->parse_error_text = "Expected a name=value pair on this {{description}} line, but couldn't find one.";
+ return JB_ERR_PARSE;
}
}
else
@@ -936,11 +1004,17 @@ int edit_parse_actions_file(struct file_line * file)
cur_line->type = FILE_LINE_ALIAS_ENTRY;
- rval = split_line_on_equals(cur_line->unprocessed, &name, &value);
- if (rval != JB_ERR_OK)
+ err = split_line_on_equals(cur_line->unprocessed, &name, &value);
+ if (err == JB_ERR_MEMORY)
+ {
+ return err;
+ }
+ else if (err != JB_ERR_OK)
{
- /* Line does not contain a name=value pair, or out-of-memory */
- return rval;
+ /* Line does not contain a name=value pair */
+ file->parse_error = cur_line;
+ file->parse_error_text = "Expected a name=value pair on this {{alias}} line, but couldn't find one.";
+ return JB_ERR_PARSE;
}
if ((new_alias = zalloc(sizeof(*new_alias))) == NULL)
@@ -952,14 +1026,25 @@ int edit_parse_actions_file(struct file_line * file)
return JB_ERR_MEMORY;
}
- if (get_actions(value, alias_list, new_alias->action))
+ err = get_actions(value, alias_list, new_alias->action);
+ if (err)
{
/* Invalid action or out of memory */
free(name);
free(value);
free(new_alias);
free_alias_list(alias_list);
- return JB_ERR_PARSE; /* FIXME: or JB_ERR_MEMORY */
+ if (err == JB_ERR_MEMORY)
+ {
+ return err;
+ }
+ else
+ {
+ /* Line does not contain a name=value pair */
+ file->parse_error = cur_line;
+ file->parse_error_text = "This alias does not specify a valid set of actions.";
+ return JB_ERR_PARSE;
+ }
}
free(value);
@@ -989,6 +1074,10 @@ int edit_parse_actions_file(struct file_line * file)
{
/* No closing } on header */
free_alias_list(alias_list);
+ file->parse_error = cur_line;
+ file->parse_error_text = "Headers starting with '{' must have a "
+ "closing bracket ('}'). Headers starting with two brackets ('{{') "
+ "must close with two brackets ('}}').";
return JB_ERR_PARSE;
}
@@ -996,6 +1085,12 @@ int edit_parse_actions_file(struct file_line * file)
{
/* An invalid {{ header. */
free_alias_list(alias_list);
+ file->parse_error = cur_line;
+ file->parse_error_text = "Unknown or unexpected two-bracket header. "
+ "Please remember that the system (two-bracket) headers must "
+ "appear in the order {{settings}}, {{description}}, {{alias}}, "
+ "and must appear before any actions (one-bracket) headers. "
+ "Also note that system headers may not be repeated.";
return JB_ERR_PARSE;
}
@@ -1010,12 +1105,6 @@ int edit_parse_actions_file(struct file_line * file)
{
len--;
}
- if (len <= 0)
- {
- /* A line containing just { } */
- free_alias_list(alias_list);
- return JB_ERR_PARSE;
- }
cur_line->type = FILE_LINE_ACTION;
@@ -1030,12 +1119,23 @@ int edit_parse_actions_file(struct file_line * file)
value[len] = '\0';
/* Get actions */
- if (get_actions(value, alias_list, cur_line->data.action))
+ err = get_actions(value, alias_list, cur_line->data.action);
+ if (err)
{
/* Invalid action or out of memory */
free(value);
free_alias_list(alias_list);
- return JB_ERR_PARSE; /* FIXME: or JB_ERR_MEMORY */
+ if (err == JB_ERR_MEMORY)
+ {
+ return err;
+ }
+ else
+ {
+ /* Line does not contain a name=value pair */
+ file->parse_error = cur_line;
+ file->parse_error_text = "This header does not specify a valid set of actions.";
+ return JB_ERR_PARSE;
+ }
}
/* Done with string - it was clobbered anyway */
@@ -1069,152 +1169,416 @@ int edit_parse_actions_file(struct file_line * file)
/*********************************************************************
*
- * Function : edit_read_file
+ * Function : edit_read_file_lines
*
- * Description : Read a complete actions file into memory and
- * parses it.
+ * Description : Read all the lines of a file into memory.
+ * Handles whitespace, comments and line continuation.
*
* Parameters :
- * 1 : filename = Path to file to read from
+ * 1 : fp = File to read from. On return, this will be
+ * at EOF but it will not have been closed.
* 2 : pfile = Destination for a linked list of file_lines.
* Will be set to NULL on error.
*
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
- * JB_ERR_FILE if the file cannot be opened or
- * contains no data
*
*********************************************************************/
-int edit_read_actions_file(const char * filename, struct file_line ** pfile)
+jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile)
{
- struct file_line * file;
- FILE * fp;
- int rval;
+ struct file_line * first_line; /* Keep for return value or to free */
+ struct file_line * cur_line; /* Current line */
+ struct file_line * prev_line; /* Entry with prev_line->next = cur_line */
+ jb_err rval;
- assert(filename);
+ assert(fp);
assert(pfile);
*pfile = NULL;
- if (NULL == (fp = fopen(filename,"rt")))
+ cur_line = first_line = zalloc(sizeof(struct file_line));
+ if (cur_line == NULL)
{
- return JB_ERR_FILE;
+ return JB_ERR_MEMORY;
}
- rval = edit_read_file(fp, &file);
-
- fclose(fp);
+ cur_line->type = FILE_LINE_UNPROCESSED;
- if (JB_ERR_OK != rval)
+ rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed);
+ if (rval)
{
- return rval;
+ /* Out of memory or empty file. */
+ /* Note that empty file is not an error we propogate up */
+ free(cur_line);
+ return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval);
}
- if (JB_ERR_OK != (rval = edit_parse_actions_file(file)))
+ do
{
- edit_free_file(file);
- return rval;
+ prev_line = cur_line;
+ cur_line = prev_line->next = zalloc(sizeof(struct file_line));
+ if (cur_line == NULL)
+ {
+ /* Out of memory */
+ edit_free_file_lines(first_line);
+ return JB_ERR_MEMORY;
+ }
+
+ cur_line->type = FILE_LINE_UNPROCESSED;
+
+ rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed);
+ if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE))
+ {
+ /* Out of memory */
+ edit_free_file_lines(first_line);
+ return JB_ERR_MEMORY;
+ }
+
}
+ while (rval != JB_ERR_FILE);
- *pfile = file;
+ /* EOF */
+
+ /* We allocated one too many - free it */
+ prev_line->next = NULL;
+ free(cur_line);
+
+ *pfile = first_line;
return JB_ERR_OK;
}
/*********************************************************************
*
- * Function : get_file_name_param
- *
- * Description : Get the name of the file to edit from the parameters
- * passed to a CGI function. This function handles
- * security checks such as blocking urls containing
- * "/" or ".", prepending the config file directory,
- * and adding the specified suffix.
- *
- * (This is an essential security check, otherwise
- * users may be able to pass "../../../etc/passwd"
- * and overwrite the password file [linux], "prn:"
- * and print random data [Windows], etc...)
+ * Function : edit_read_file
*
- * This function only allows filenames contining the
- * characters '-', '_', 'A'-'Z', 'a'-'z', and '0'-'9'.
- * That's probably too restrictive but at least it's
- * secure.
+ * Description : Read a complete file into memory.
+ * Handles CGI parameter parsing. If requested, also
+ * checks the file's modification timestamp.
*
* Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : parameters = map of cgi parameters
- * 3 : suffix = File extension, e.g. ".actions"
- * 4 : pfilename = destination for full filename. Caller
- * free()s. Set to NULL on error.
- * 5 : pparam = destination for partial filename,
- * suitable for use in another URL. Allocated as part
- * of the map "parameters", so don't free it.
- * Set to NULL if not specified.
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : parameters = map of cgi parameters.
+ * 3 : require_version = true to check "ver" parameter.
+ * 4 : suffix = File extension, e.g. ".action".
+ * 5 : pfile = Destination for the file. Will be set
+ * to NULL on error.
+ *
+ * CGI Parameters :
+ * filename : The name of the file to read, without the
+ * path or ".action" extension.
+ * ver : (Only if require_version is nonzero)
+ * Timestamp of the actions file. If wrong, this
+ * function fails with JB_ERR_MODIFIED.
*
- * CGI Parameters : None
- *
- * Returns : JB_ERR_OK on success
- * JB_ERR_MEMORY on out-of-memory
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
* JB_ERR_CGI_PARAMS if "filename" was not specified
* or is not valid.
+ * JB_ERR_FILE if the file cannot be opened or
+ * contains no data
+ * JB_ERR_MODIFIED if version checking was requested and
+ * failed - the file was modified outside
+ * of this CGI editor instance.
*
*********************************************************************/
-static int get_file_name_param(struct client_state *csp,
- struct map *parameters,
- char *suffix,
- char **pfilename,
- const char **pparam)
+jb_err edit_read_file(struct client_state *csp,
+ const struct map *parameters,
+ int require_version,
+ const char *suffix,
+ struct editable_file **pfile)
{
- const char *param;
- const char *s;
- char *name;
- char *fullpath;
- char ch;
- int len;
+ struct file_line * lines;
+ FILE * fp;
+ jb_err err;
+ char * filename;
+ const char * identifier;
+ struct editable_file * file;
+ unsigned version = 0;
+ struct stat statbuf[1];
+ char version_buf[22];
assert(csp);
assert(parameters);
- assert(suffix);
- assert(pfilename);
- assert(pparam);
+ assert(pfile);
- *pfilename = NULL;
- *pparam = NULL;
+ *pfile = NULL;
- param = lookup(parameters, "filename");
- if (!*param)
+ err = get_file_name_param(csp, parameters, "filename", suffix,
+ &filename, &identifier);
+ if (err)
{
- return JB_ERR_CGI_PARAMS;
+ return err;
}
- *pparam = param;
-
- len = strlen(param);
- if (len >= FILENAME_MAX)
+ if (stat(filename, statbuf) < 0)
{
- /* Too long. */
- return JB_ERR_CGI_PARAMS;
+ /* Error, probably file not found. */
+ free(filename);
+ return JB_ERR_FILE;
}
+ version = (unsigned) statbuf->st_mtime;
- /* Check every character to see if it's legal */
- s = param;
- while ((ch = *s++) != '\0')
+ if (require_version)
{
- if ( ((ch < 'A') || (ch > 'Z'))
- && ((ch < 'a') || (ch > 'z'))
- && ((ch < '0') || (ch > '9'))
- && (ch != '-')
- && (ch != '_') )
+ unsigned specified_version;
+ err = get_number_param(csp, parameters, "ver", &specified_version);
+ if (err)
{
- /* Probable hack attempt. */
- return JB_ERR_CGI_PARAMS;
+ free(filename);
+ return err;
+ }
+
+ if (version != specified_version)
+ {
+ return JB_ERR_MODIFIED;
}
}
- /* Append extension */
- name = malloc(len + strlen(suffix) + 1);
- if (name == NULL)
+ if (NULL == (fp = fopen(filename,"rt")))
+ {
+ free(filename);
+ return JB_ERR_FILE;
+ }
+
+ err = edit_read_file_lines(fp, &lines);
+
+ fclose(fp);
+
+ if (err)
+ {
+ free(filename);
+ return err;
+ }
+
+ file = (struct editable_file *) zalloc(sizeof(*file));
+ if (err)
+ {
+ free(filename);
+ edit_free_file_lines(lines);
+ return err;
+ }
+
+ file->lines = lines;
+ file->filename = filename;
+ file->version = version;
+ file->identifier = strdup(identifier);
+
+ if (file->identifier == NULL)
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ /* Correct file->version_str */
+ freez((char *)file->version_str);
+ snprintf(version_buf, 22, "%u", file->version);
+ version_buf[21] = '\0';
+ file->version_str = strdup(version_buf);
+ if (version_buf == NULL)
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ *pfile = file;
+ return JB_ERR_OK;
+}
+
+
+/*********************************************************************
+ *
+ * Function : edit_read_actions_file
+ *
+ * Description : Read a complete actions file into memory.
+ * Handles CGI parameter parsing. If requested, also
+ * checks the file's modification timestamp.
+ *
+ * If this function detects an error in the categories
+ * JB_ERR_FILE, JB_ERR_MODIFIED, or JB_ERR_PARSE,
+ * then it handles it by filling in the specified
+ * response structure and returning JB_ERR_FILE.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = HTTP response. Only filled in on error.
+ * 2 : parameters = map of cgi parameters.
+ * 3 : require_version = true to check "ver" parameter.
+ * 4 : pfile = Destination for the file. Will be set
+ * to NULL on error.
+ *
+ * CGI Parameters :
+ * filename : The name of the actions file to read, without the
+ * path or ".action" extension.
+ * ver : (Only if require_version is nonzero)
+ * Timestamp of the actions file. If wrong, this
+ * function fails with JB_ERR_MODIFIED.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if "filename" was not specified
+ * or is not valid.
+ * JB_ERR_FILE if the file does not contain valid data,
+ * or if file cannot be opened or
+ * contains no data, or if version
+ * checking was requested and failed.
+ *
+ *********************************************************************/
+jb_err edit_read_actions_file(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters,
+ int require_version,
+ struct editable_file **pfile)
+{
+ jb_err err;
+ struct editable_file *file;
+
+ assert(csp);
+ assert(parameters);
+ assert(pfile);
+
+ *pfile = NULL;
+
+ err = edit_read_file(csp, parameters, require_version, ".action", &file);
+ if (err)
+ {
+ /* Try to handle if possible */
+ if (err == JB_ERR_FILE)
+ {
+ err = cgi_error_file(csp, rsp, lookup(parameters, "filename"));
+ }
+ else if (err == JB_ERR_MODIFIED)
+ {
+ err = cgi_error_modified(csp, rsp, lookup(parameters, "filename"));
+ }
+ if (err == JB_ERR_OK)
+ {
+ /*
+ * Signal to higher-level CGI code that there was a problem but we
+ * handled it, they should just return JB_ERR_OK.
+ */
+ err = JB_ERR_FILE;
+ }
+ return err;
+ }
+
+ err = edit_parse_actions_file(file);
+ if (err)
+ {
+ if (err == JB_ERR_PARSE)
+ {
+ err = cgi_error_parse(csp, rsp, file);
+ if (err == JB_ERR_OK)
+ {
+ /*
+ * Signal to higher-level CGI code that there was a problem but we
+ * handled it, they should just return JB_ERR_OK.
+ */
+ err = JB_ERR_FILE;
+ }
+ }
+ edit_free_file(file);
+ return err;
+ }
+
+ *pfile = file;
+ return JB_ERR_OK;
+}
+
+
+/*********************************************************************
+ *
+ * Function : get_file_name_param
+ *
+ * Description : Get the name of the file to edit from the parameters
+ * passed to a CGI function. This function handles
+ * security checks such as blocking urls containing
+ * "/" or ".", prepending the config file directory,
+ * and adding the specified suffix.
+ *
+ * (This is an essential security check, otherwise
+ * users may be able to pass "../../../etc/passwd"
+ * and overwrite the password file [linux], "prn:"
+ * and print random data [Windows], etc...)
+ *
+ * This function only allows filenames contining the
+ * characters '-', '_', 'A'-'Z', 'a'-'z', and '0'-'9'.
+ * That's probably too restrictive but at least it's
+ * secure.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : parameters = map of cgi parameters
+ * 3 : suffix = File extension, e.g. ".actions"
+ * 4 : pfilename = destination for full filename. Caller
+ * free()s. Set to NULL on error.
+ * 5 : pparam = destination for partial filename,
+ * suitable for use in another URL. Allocated as part
+ * of the map "parameters", so don't free it.
+ * Set to NULL if not specified.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if "filename" was not specified
+ * or is not valid.
+ *
+ *********************************************************************/
+static jb_err get_file_name_param(struct client_state *csp,
+ const struct map *parameters,
+ const char *param_name,
+ const char *suffix,
+ char **pfilename,
+ const char **pparam)
+{
+ const char *param;
+ const char *s;
+ char *name;
+ char *fullpath;
+ char ch;
+ int len;
+
+ assert(csp);
+ assert(parameters);
+ assert(suffix);
+ assert(pfilename);
+ assert(pparam);
+
+ *pfilename = NULL;
+ *pparam = NULL;
+
+ param = lookup(parameters, param_name);
+ if (!*param)
+ {
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ *pparam = param;
+
+ len = strlen(param);
+ if (len >= FILENAME_MAX)
+ {
+ /* Too long. */
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* Check every character to see if it's legal */
+ s = param;
+ while ((ch = *s++) != '\0')
+ {
+ if ( ((ch < 'A') || (ch > 'Z'))
+ && ((ch < 'a') || (ch > 'z'))
+ && ((ch < '0') || (ch > '9'))
+ && (ch != '-')
+ && (ch != '_') )
+ {
+ /* Probable hack attempt. */
+ return JB_ERR_CGI_PARAMS;
+ }
+ }
+
+ /* Append extension */
+ name = malloc(len + strlen(suffix) + 1);
+ if (name == NULL)
{
return JB_ERR_MEMORY;
}
@@ -1250,22 +1614,20 @@ static int get_file_name_param(struct client_state *csp,
* 4 : pvalue = destination for value.
* Set to -1 on error.
*
- * CGI Parameters : None
- *
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
- * JB_ERR_CGI_PARAMS if "filename" was not specified
+ * JB_ERR_CGI_PARAMS if the parameter was not specified
* or is not valid.
*
*********************************************************************/
-static int get_number_param(struct client_state *csp,
- struct map *parameters,
- char *name,
- int *pvalue)
+static jb_err get_number_param(struct client_state *csp,
+ const struct map *parameters,
+ char *name,
+ unsigned *pvalue)
{
const char *param;
char ch;
- int value;
+ unsigned value;
assert(csp);
assert(parameters);
@@ -1294,12 +1656,12 @@ static int get_number_param(struct client_state *csp,
/* Note:
*
- * <limits.h> defines INT_MAX
+ * <limits.h> defines UINT_MAX
*
- * (INT_MAX - ch) / 10 is the largest number that
+ * (UINT_MAX - ch) / 10 is the largest number that
* can be safely multiplied by 10 then have ch added.
*/
- if (value > ((INT_MAX - ch) / 10))
+ if (value > ((UINT_MAX - (unsigned)ch) / 10U))
{
return JB_ERR_CGI_PARAMS;
}
@@ -1316,313 +1678,97 @@ static int get_number_param(struct client_state *csp,
/*********************************************************************
*
- * Function : cgi_edit_actions
+ * Function : map_radio
*
- * Description : CGI function that allows the user to choose which
- * actions file to edit.
+ * Description : Map a set of radio button values. E.g. if you have
+ * 3 radio buttons, declare them as:
+ * <option type="radio" name="xyz" @xyz-a@>
+ * <option type="radio" name="xyz" @xyz-b@>
+ * <option type="radio" name="xyz" @xyz-c@>
+ * Then map one of the @xyz-?@ variables to "checked"
+ * and all the others to empty by calling:
+ * map_radio(exports, "xyz", "abc", sel)
+ * Where 'sel' is 'a', 'b', or 'c'.
*
* Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
+ * 1 : exports = Exports map to modify.
+ * 2 : optionname = name for map
+ * 3 : values = null-terminated list of values;
+ * 4 : value = Selected value.
*
* CGI Parameters : None
*
- * Returns : 0 on success, nonzero on error
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
*
*********************************************************************/
-int cgi_edit_actions(struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters)
+static jb_err map_radio(struct map * exports,
+ const char * optionname,
+ const char * values,
+ char value)
{
+ int len;
+ char * buf;
+ char * p;
+ char c;
+
+ assert(exports);
+ assert(optionname);
+ assert(values);
- /* FIXME: Incomplete */
- rsp->status = strdup("302 Local Redirect from Junkbuster");
- enlist_unique_header(rsp->headers, "Location", "http://ijbswa.sourceforge.net/config/edit-actions-list?filename=edit");
+ len = strlen(optionname);
+ buf = malloc(len + 3);
+ if (buf == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
- return 0;
+ strcpy(buf, optionname);
+ p = buf + len;
+ *p++ = '-';
+ p[1] = '\0';
+
+ while ((c = *values++) != '\0')
+ {
+ if (c != value)
+ {
+ *p = c;
+ if (map(exports, buf, 1, "", 1))
+ {
+ free(buf);
+ return JB_ERR_MEMORY;
+ }
+ }
+ }
+
+ *p = value;
+ if (map(exports, buf, 0, "checked", 1))
+ {
+ free(buf);
+ return JB_ERR_MEMORY;
+ }
+
+ return JB_ERR_OK;
}
/*********************************************************************
*
- * Function : cgi_edit_actions_list
+ * Function : actions_to_radio
*
- * Description : CGI function that edits the actions list.
- * FIXME: This function shouldn't FATAL ever.
- * FIXME: This function doesn't check the retval of map()
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
+ * Description : Converts a actionsfile entry into settings for
+ * radio buttons and edit boxes on a HTML form.
*
- * CGI Parameters : None
+ * Parameters :
+ * 1 : exports = List of substitutions to add to.
+ * 2 : action = Action to read
*
- * Returns : 0 on success, 1 on error.
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
*
*********************************************************************/
-int cgi_edit_actions_list(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
-{
- char * section_template;
- char * url_template;
- char * sections;
- char * urls;
- char buf[50];
- char * s;
- struct map * exports;
- struct map * section_exports;
- struct map * url_exports;
- struct file_line * file;
- struct file_line * cur_line;
- int line_number = 0;
- int url_1_2;
- int rval;
- char * filename;
- char * filename_param;
-
- rval = get_file_name_param(csp, parameters, ".action", &filename, &filename_param);
- if (rval)
- {
- /* No filename specified. */
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "No filename specified");
- return 1;
- }
-
- if (edit_read_actions_file(filename, &file))
- {
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "Cannot load file '%s' for editing", filename);
- return 1;
- }
-
- free(filename);
-
- if (NULL == (exports = default_exports(csp, NULL)))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
-
- map(exports, "filename", 1, filename_param, 1);
-
- /* Should do all global exports above this point */
-
- if (NULL == (section_template = template_load(csp, "edit-actions-list-section")))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
- if (NULL == (url_template = template_load(csp, "edit-actions-list-url")))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
-
- template_fill(§ion_template, exports);
- template_fill(&url_template, exports);
-
- /* Find start of actions in file */
- cur_line = file;
- line_number = 1;
- while ((cur_line != NULL) && (cur_line->type != FILE_LINE_ACTION))
- {
- cur_line = cur_line->next;
- line_number++;
- }
-
- if (NULL == (sections = strdup("")))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
-
- while ((cur_line != NULL) && (cur_line->type == FILE_LINE_ACTION))
- {
- if (NULL == (section_exports = new_map()))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
-
- snprintf(buf, 50, "%d", line_number);
- map(section_exports, "sectionid", 1, buf, 1);
-
- if (NULL == (s = actions_to_html(cur_line->data.action)))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
- map(section_exports, "actions", 1, s, 0);
-
- /* Should do all section-specific exports above this point */
-
- if (NULL == (urls = strdup("")))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
-
- url_1_2 = 2;
-
- cur_line = cur_line->next;
- line_number++;
-
- while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL))
- {
- if (NULL == (url_exports = new_map()))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
-
- snprintf(buf, 50, "%d", line_number);
- map(url_exports, "urlid", 1, buf, 1);
-
- snprintf(buf, 50, "%d", url_1_2);
- map(url_exports, "url-1-2", 1, buf, 1);
-
- if (NULL == (s = html_encode(cur_line->unprocessed)))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
-
- map(url_exports, "url", 1, s, 0);
-
- if (NULL == (s = strdup(url_template)))
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in cgi_edit_actions_list");
- return 1;
- }
- template_fill(&s, section_exports);
- template_fill(&s, url_exports);
- urls = strsav(urls, s);
- free_map(url_exports);
-
- url_1_2 = 3 - url_1_2;
-
- cur_line = cur_line->next;
- line_number++;
- }
-
- map(section_exports, "urls", 1, urls, 0);
-
- /* Could also do section-specific exports here, but it wouldn't be as fast */
-
- s = strdup(section_template);
- template_fill(&s, section_exports);
- sections = strsav(sections, s);
- free_map(section_exports);
- }
-
- edit_free_file(file);
-
- map(exports, "sections", 1, sections, 0);
-
- /* Could also do global exports here, but it wouldn't be as fast */
-
- rsp->body = template_load(csp, "edit-actions-list");
- template_fill(&rsp->body, exports);
- free_map(exports);
-
- return 0;
-}
-
-
-/*********************************************************************
- *
- * Function : map_radio
- *
- * Description : Map a set of radio button values. E.g. if you have
- * 3 radio buttons, declare them as:
- * <option type="radio" name="xyz" @xyz-a@>
- * <option type="radio" name="xyz" @xyz-b@>
- * <option type="radio" name="xyz" @xyz-c@>
- * Then map one of the @xyz-?@ variables to "checked"
- * and all the others to empty by calling:
- * map_radio(exports, "xyz", "abc", sel)
- * Where 'sel' is 'a', 'b', or 'c'.
- *
- * Parameters :
- * 1 : exports = Exports map to modify.
- * 2 : optionname = name for map
- * 3 : values = null-terminated list of values;
- * 4 : value = Selected value.
- *
- * CGI Parameters : None
- *
- * Returns : JB_ERR_OK on success
- * JB_ERR_MEMORY on out-of-memory
- *
- *********************************************************************/
-static int map_radio(struct map * exports,
- const char * optionname,
- const char * values,
- char value)
-{
- int len;
- char * buf;
- char * p;
- char c;
-
- assert(exports);
- assert(optionname);
- assert(values);
-
- len = strlen(optionname);
- buf = malloc(len + 3);
- if (buf == NULL)
- {
- return JB_ERR_MEMORY;
- }
-
- strcpy(buf, optionname);
- p = buf + len;
- *p++ = '-';
- p[1] = '\0';
-
- while ((c = *values++) != '\0')
- {
- if (c != value)
- {
- *p = c;
- if (map(exports, buf, 1, "", 1))
- {
- free(buf);
- return JB_ERR_MEMORY;
- }
- }
- }
-
- *p = value;
- if (map(exports, buf, 0, "checked", 1))
- {
- free(buf);
- return JB_ERR_MEMORY;
- }
-
- return JB_ERR_OK;
-}
-
-
-/*********************************************************************
- *
- * Function : actions_to_radio
- *
- * Description : Converts a actionsfile entry into settings for
- * radio buttons and edit boxes on a HTML form.
- *
- * Parameters :
- * 1 : exports = List of substitutions to add to.
- * 2 : action = Action to read
- *
- * Returns : JB_ERR_OK on success
- * JB_ERR_MEMORY on out-of-memory
- *
- *********************************************************************/
-static int actions_to_radio(struct map * exports, const struct action_spec *action)
+static jb_err actions_to_radio(struct map * exports,
+ const struct action_spec *action)
{
unsigned mask = action->mask;
unsigned add = action->add;
@@ -1735,91 +1881,6 @@ static int actions_to_radio(struct map * exports, const struct action_spec *acti
}
-/*********************************************************************
- *
- * Function : cgi_edit_actions
- *
- * Description : CGI function that edits the Actions 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 : None
- *
- * Returns : 0 on success, nonzero on error
- *
- *********************************************************************/
-int cgi_edit_actions_for_url(struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters)
-{
- struct map * exports;
- int sectionid;
-
- struct file_line * file;
- struct file_line * cur_line;
- int line_number;
- int rval;
- char * filename;
- char * filename_param;
-
- rval = get_file_name_param(csp, parameters, ".action", &filename, &filename_param);
- if (rval)
- {
- /* No filename specified. */
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "No filename specified");
- return 1;
- }
-
- if (get_number_param(csp, parameters, "section", §ionid))
- {
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "No 'section' parameter");
- return cgi_default(csp, rsp, parameters);
- }
-
- if (edit_read_actions_file(filename, &file))
- {
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "Cannot load file '%s' for editing", filename);
- return 1;
- }
- cur_line = file;
-
- for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++)
- {
- cur_line = cur_line->next;
- }
-
- if ( (cur_line == NULL)
- || (line_number != sectionid)
- || (sectionid < 1)
- || (cur_line->type != FILE_LINE_ACTION))
- {
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "Bad sectionid!");
- return 1;
- }
-
- exports = default_exports(csp, NULL);
- map(exports, "filename", 1, filename_param, 1);
- map(exports, "section", 1, lookup(parameters, "section"), 1);
-
- actions_to_radio(exports, cur_line->data.action);
-
- edit_free_file(file);
-
- rsp->body = template_load(csp, "edit-actions-for-url");
- template_fill(&rsp->body, exports);
- free_map(exports);
-
- return 0;
-}
-
-
/*********************************************************************
*
* Function : actions_from_radio
@@ -1837,7 +1898,7 @@ int cgi_edit_actions_for_url(struct client_state *csp,
* JB_ERR_MEMORY on out-of-memory
*
*********************************************************************/
-static int actions_from_radio(const struct map * parameters,
+static jb_err actions_from_radio(const struct map * parameters,
struct action_spec *action)
{
const char * param;
@@ -1955,142 +2016,1592 @@ static int actions_from_radio(const struct map * parameters,
/*********************************************************************
*
- * Function : cgi_edit_actions_submit
- *
- * Description : CGI function that actually edits the Actions list.
+ * Function : cgi_error_modified
*
+ * Description : CGI function that is called when a file is modified
+ * outside the CGI editor.
+ *
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
* 2 : rsp = http_response data structure for output
- * 3 : parameters = map of cgi parameters
+ * 3 : filename = The file that was modified.
*
- * CGI Parameters : None
+ * CGI Parameters : none
*
- * Returns : 0 on success, nonzero on error
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int cgi_edit_actions_submit(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+jb_err cgi_error_modified(struct client_state *csp,
+ struct http_response *rsp,
+ const char *filename)
{
-/*
+ struct map *exports;
+ jb_err err;
+
+ assert(csp);
+ assert(rsp);
+ assert(filename);
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ err = map(exports, "filename", 1, filename, 1);
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ return template_fill_for_cgi(csp, "cgi-error-modified", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_error_parse
+ *
+ * Description : CGI function that is called when a file cannot
+ * be parsed by the CGI editor.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : file = The file that was modified.
+ *
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_error_parse(struct client_state *csp,
+ struct http_response *rsp,
+ struct editable_file *file)
+{
+ struct map *exports;
+ jb_err err;
+ struct file_line *cur_line;
+
+ assert(csp);
+ assert(rsp);
+ assert(file);
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ err = map(exports, "filename", 1, file->identifier, 1);
+ err = err || map(exports, "parse-error", 1, file->parse_error_text, 1);
+
+ cur_line = file->parse_error;
+ assert(cur_line);
+
+ err = err || map(exports, "line-raw", 1, html_encode(cur_line->raw), 0);
+ err = err || map(exports, "line-data", 1, html_encode(cur_line->unprocessed), 0);
+
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ return template_fill_for_cgi(csp, "cgi-error-parse", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_error_file
+ *
+ * Description : CGI function that is called when a file cannot be
+ * opened by the CGI editor.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : filename = The file that was modified.
+ *
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_error_file(struct client_state *csp,
+ struct http_response *rsp,
+ const char *filename)
+{
+ struct map *exports;
+ jb_err err;
+
+ assert(csp);
+ assert(rsp);
+ assert(filename);
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ err = map(exports, "filename", 1, filename, 1);
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ return template_fill_for_cgi(csp, "cgi-error-file", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_error_bad_param
+ *
+ * Description : CGI function that is called if the parameters
+ * (query string) for a CGI were wrong.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ *
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_error_disabled(struct client_state *csp,
+ struct http_response *rsp)
+{
+ struct map *exports;
+
+ assert(csp);
+ assert(rsp);
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions
+ *
+ * Description : CGI function that allows the user to choose which
+ * actions file to edit.
+ *
+ * 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_edit_actions(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ /* FIXME: Incomplete */
+ rsp->status = strdup("302 Local Redirect from Junkbuster");
+ if (rsp->status == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
+ if (enlist_unique_header(rsp->headers, "Location", "http://ijbswa.sourceforge.net/config/edit-actions-list?filename=edit"))
+ {
+ free(rsp->status);
+ rsp->status = NULL;
+ return JB_ERR_MEMORY;
+ }
+
+ return JB_ERR_OK;
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_list
+ *
+ * Description : CGI function that edits the actions list.
+ * FIXME: This function shouldn't FATAL ever.
+ * FIXME: This function doesn't check the retval of map()
+ * 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 : filename
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_FILE if the file cannot be opened or
+ * contains no data
+ * JB_ERR_CGI_PARAMS if "filename" was not specified
+ * or is not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_list(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ char * section_template;
+ char * url_template;
+ char * sections;
+ char * urls;
+ char buf[50];
+ char * s;
struct map * exports;
-*/
- int sectionid;
- char * actiontext;
- char * newtext;
- int len;
+ struct map * section_exports;
+ struct map * url_exports;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ int line_number = 0;
+ int url_1_2;
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 0, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ err = map(exports, "filename", 1, file->identifier, 1);
+ err = err || map(exports, "ver", 1, file->version_str, 1);
+ if (err)
+ {
+ edit_free_file(file);
+ free_map(exports);
+ return err;
+ }
+
+ /* Should do all global exports above this point */
+
+ err = template_load(csp, §ion_template, "edit-actions-list-section");
+ if (err)
+ {
+ edit_free_file(file);
+ free_map(exports);
+ if (err == JB_ERR_FILE)
+ {
+ return cgi_error_no_template(csp, rsp, "edit-actions-list-section");
+ }
+ return err;
+ }
+
+ err = template_load(csp, &url_template, "edit-actions-list-url");
+ if (err)
+ {
+ free(section_template);
+ edit_free_file(file);
+ free_map(exports);
+ if (err == JB_ERR_FILE)
+ {
+ return cgi_error_no_template(csp, rsp, "edit-actions-list-url");
+ }
+ return err;
+ }
+
+ err = template_fill(§ion_template, exports);
+ if (err)
+ {
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free(url_template);
+ return err;
+ }
+
+ err = template_fill(&url_template, exports);
+ if (err)
+ {
+ free(section_template);
+ edit_free_file(file);
+ free_map(exports);
+ return err;
+ }
+
+ /* Find start of actions in file */
+ cur_line = file->lines;
+ line_number = 1;
+ while ((cur_line != NULL) && (cur_line->type != FILE_LINE_ACTION))
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if (NULL == (sections = strdup("")))
+ {
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+
+ while ((cur_line != NULL) && (cur_line->type == FILE_LINE_ACTION))
+ {
+ if (NULL == (section_exports = new_map()))
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+
+ snprintf(buf, 50, "%d", line_number);
+ err = map(section_exports, "sectionid", 1, buf, 1);
+
+ err = err || map(section_exports, "actions", 1,
+ actions_to_html(cur_line->data.action), 0);
+
+ if ((cur_line->next != NULL) && (cur_line->next->type == FILE_LINE_URL))
+ {
+ /* This section contains at least one URL, don't allow delete */
+ err = err || map_block_killer(section_exports, "empty-section");
+ }
+
+ if (err)
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return err;
+ }
+
+ /* Should do all section-specific exports above this point */
+
+ if (NULL == (urls = strdup("")))
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return JB_ERR_MEMORY;
+ }
+
+ url_1_2 = 2;
+
+ cur_line = cur_line->next;
+ line_number++;
+
+ while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL))
+ {
+ if (NULL == (url_exports = new_map()))
+ {
+ free(urls);
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return JB_ERR_MEMORY;
+ }
+
+ snprintf(buf, 50, "%d", line_number);
+ err = map(url_exports, "urlid", 1, buf, 1);
+
+ snprintf(buf, 50, "%d", url_1_2);
+ err = err || map(url_exports, "url-1-2", 1, buf, 1);
+
+ err = err || map(url_exports, "url", 1,
+ html_encode(cur_line->unprocessed), 0);
- struct file_line * file;
+ if (err)
+ {
+ free(urls);
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ free_map(url_exports);
+ return err;
+ }
+
+ if (NULL == (s = strdup(url_template)))
+ {
+ free(urls);
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ free_map(url_exports);
+ return JB_ERR_MEMORY;
+ }
+
+ err = template_fill(&s, section_exports);
+ err = err || template_fill(&s, url_exports);
+ err = err || string_append(&urls, s);
+ free_map(url_exports);
+ freez(s);
+
+ if (err)
+ {
+ freez(urls);
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return err;
+ }
+
+ url_1_2 = 3 - url_1_2;
+
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ err = map(section_exports, "urls", 1, urls, 0);
+
+ if (err)
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return err;
+ }
+
+ /* Could also do section-specific exports here, but it wouldn't be as fast */
+
+ if (NULL == (s = strdup(section_template)))
+ {
+ free(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ free_map(section_exports);
+ return JB_ERR_MEMORY;
+ }
+
+ err = template_fill(&s, section_exports);
+ err = err || string_append(§ions, s);
+ freez(s);
+ free_map(section_exports);
+
+ if (err)
+ {
+ freez(sections);
+ free(section_template);
+ free(url_template);
+ edit_free_file(file);
+ free_map(exports);
+ return err;
+ }
+ }
+
+ edit_free_file(file);
+ free(section_template);
+ free(url_template);
+
+ err = map(exports, "sections", 1, sections, 0);
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ /* Could also do global exports here, but it wouldn't be as fast */
+
+ return template_fill_for_cgi(csp, "edit-actions-list", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions
+ *
+ * Description : CGI function that edits the Actions 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 : None
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_for_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ struct map * exports;
+ unsigned sectionid;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "section", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ cur_line = file->lines;
+
+ for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++)
+ {
+ cur_line = cur_line->next;
+ }
+
+ if ( (cur_line == NULL)
+ || (line_number != sectionid)
+ || (sectionid < 1)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ err = map(exports, "filename", 1, file->identifier, 1);
+ err = err || map(exports, "ver", 1, file->version_str, 1);
+ err = err || map(exports, "section", 1, lookup(parameters, "section"), 1);
+
+ err = err || actions_to_radio(exports, cur_line->data.action);
+
+ edit_free_file(file);
+
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ return template_fill_for_cgi(csp, "edit-actions-for-url", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_submit
+ *
+ * Description : CGI function that actually edits the Actions 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 : None
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_submit(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ int sectionid;
+ char * actiontext;
+ char * newtext;
+ int len;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ int line_number;
+ char * target;
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "section", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ cur_line = file->lines;
+
+ for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++)
+ {
+ cur_line = cur_line->next;
+ }
+
+ if ( (cur_line == NULL)
+ || (line_number != sectionid)
+ || (sectionid < 1)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ err = actions_from_radio(parameters, cur_line->data.action);
+ if(err)
+ {
+ /* Out of memory */
+ edit_free_file(file);
+ return err;
+ }
+
+ if (NULL == (actiontext = actions_to_text(cur_line->data.action)))
+ {
+ /* Out of memory */
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ len = strlen(actiontext);
+ if (len == 0)
+ {
+ /*
+ * Empty action - must special-case this.
+ * Simply setting len to 1 is sufficient...
+ */
+ len = 1;
+ }
+
+ if (NULL == (newtext = malloc(len + 2)))
+ {
+ /* Out of memory */
+ free(actiontext);
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+ strcpy(newtext, actiontext);
+ free(actiontext);
+ newtext[0] = '{';
+ newtext[len] = '}';
+ newtext[len + 1] = '\0';
+
+ freez(cur_line->raw);
+ freez(cur_line->unprocessed);
+ cur_line->unprocessed = newtext;
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ edit_free_file(file);
+ return err;
+ }
+
+ target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ string_append(&target, file->identifier);
+
+ edit_free_file(file);
+
+ if (target == NULL)
+ {
+ /* Out of memory */
+ return JB_ERR_MEMORY;
+ }
+
+ rsp->status = strdup("302 Local Redirect from Junkbuster");
+ if (rsp->status == NULL)
+ {
+ free(target);
+ return JB_ERR_MEMORY;
+ }
+ err = enlist_unique_header(rsp->headers, "Location", target);
+ free(target);
+
+ return err;
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_url
+ *
+ * Description : CGI function that actually edits a URL pattern in
+ * an actions file.
+ *
+ * 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 :
+ * filename : Identifies the file to edit
+ * ver : File's last-modified time
+ * section : Line number of section to edit
+ * pattern : Line number of pattern to edit
+ * newval : New value for pattern
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ unsigned patternid;
+ const char * newval;
+ char * new_pattern;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ char * target;
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "section", §ionid);
+ err = err || get_number_param(csp, parameters, "pattern", &patternid);
+ if (err)
+ {
+ return err;
+ }
+
+ newval = lookup(parameters, "newval");
+
+ if ((*newval == '\0') || (sectionid < 1U) || (patternid < 1U))
+ {
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ cur_line = file->lines;
+
+ while ((cur_line != NULL) && (line_number < sectionid))
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ( (cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ while (line_number < patternid)
+ {
+ cur_line = cur_line->next;
+ line_number++;
+
+ if ( (cur_line == NULL)
+ || ( (cur_line->type != FILE_LINE_URL)
+ && (cur_line->type != FILE_LINE_BLANK) ) )
+ {
+ /* Invalid "patternid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+ }
+
+ if (cur_line->type != FILE_LINE_URL)
+ {
+ /* Invalid "patternid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* At this point, the line to edit is in cur_line */
+
+ new_pattern = strdup(newval);
+ if (NULL == new_pattern)
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ freez(cur_line->raw);
+ freez(cur_line->unprocessed);
+ cur_line->unprocessed = new_pattern;
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ edit_free_file(file);
+ return err;
+ }
+
+ target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ string_append(&target, file->identifier);
+
+ edit_free_file(file);
+
+ if (target == NULL)
+ {
+ /* Out of memory */
+ return JB_ERR_MEMORY;
+ }
+
+ rsp->status = strdup("302 Local Redirect from Junkbuster");
+ if (rsp->status == NULL)
+ {
+ free(target);
+ return JB_ERR_MEMORY;
+ }
+ err = enlist_unique_header(rsp->headers, "Location", target);
+ free(target);
+
+ return err;
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_add_url
+ *
+ * Description : CGI function that actually adds a URL pattern to
+ * an actions file.
+ *
+ * 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 :
+ * filename : Identifies the file to edit
+ * ver : File's last-modified time
+ * section : Line number of section to edit
+ * newval : New pattern
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_add_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ unsigned patternid;
+ const char * newval;
+ char * new_pattern;
+ struct file_line * new_line;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ char * target;
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "section", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ newval = lookup(parameters, "newval");
+
+ if ((*newval == '\0') || (sectionid < 1U) || (patternid < 1U))
+ {
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ cur_line = file->lines;
+
+ while ((cur_line != NULL) && (line_number < sectionid))
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ( (cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* At this point, the section header is in cur_line - add after this. */
+
+ new_pattern = strdup(newval);
+ if (NULL == new_pattern)
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ /* Allocate the new line */
+ new_line = (struct file_line *)zalloc(sizeof(*new_line));
+ if (new_line == NULL)
+ {
+ free(new_pattern);
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ /* Fill in the data members of the new line */
+ new_line->raw = NULL;
+ new_line->prefix = NULL;
+ new_line->unprocessed = new_pattern;
+ new_line->type = FILE_LINE_URL;
+
+ /* Link new_line into the list, after cur_line */
+ new_line->next = cur_line->next;
+ cur_line->next = new_line;
+
+ /* Done making changes, now commit */
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ edit_free_file(file);
+ return err;
+ }
+
+ target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ string_append(&target, file->identifier);
+
+ edit_free_file(file);
+
+ if (target == NULL)
+ {
+ /* Out of memory */
+ return JB_ERR_MEMORY;
+ }
+
+ rsp->status = strdup("302 Local Redirect from Junkbuster");
+ if (rsp->status == NULL)
+ {
+ free(target);
+ return JB_ERR_MEMORY;
+ }
+ err = enlist_unique_header(rsp->headers, "Location", target);
+ free(target);
+
+ return err;
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_remove_url
+ *
+ * Description : CGI function that actually removes a URL pattern from
+ * the actions file.
+ *
+ * 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 :
+ * filename : Identifies the file to edit
+ * ver : File's last-modified time
+ * section : Line number of section to edit
+ * pattern : Line number of pattern to edit
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_remove_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ unsigned patternid;
+ struct editable_file * file;
struct file_line * cur_line;
- int line_number;
- int rval;
- char * filename;
- const char * filename_param;
+ struct file_line * prev_line;
+ unsigned line_number;
char * target;
+ jb_err err;
- rval = get_file_name_param(csp, parameters, ".action", &filename, &filename_param);
- if (rval)
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
{
- /* No filename specified. */
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "No filename specified");
- return 1;
+ return cgi_error_disabled(csp, rsp);
}
- if (get_number_param(csp, parameters, "section", §ionid))
+ err = get_number_param(csp, parameters, "section", §ionid);
+ err = err || get_number_param(csp, parameters, "pattern", &patternid);
+ if (err)
{
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "No 'section' parameter");
- return cgi_default(csp, rsp, parameters);
+ return err;
}
- if (edit_read_actions_file(filename, &file))
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
{
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "Cannot load file '%s' for editing", filename);
- return 1;
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
}
- cur_line = file;
- for (line_number = 1; (cur_line != NULL) && (line_number < sectionid); line_number++)
+ line_number = 1;
+ cur_line = file->lines;
+
+ while ((cur_line != NULL) && (line_number < sectionid))
{
cur_line = cur_line->next;
+ line_number++;
}
if ( (cur_line == NULL)
- || (line_number != sectionid)
- || (sectionid < 1)
|| (cur_line->type != FILE_LINE_ACTION))
{
+ /* Invalid "sectionid" parameter */
edit_free_file(file);
- return cgi_default(csp, rsp, parameters);
+ return JB_ERR_CGI_PARAMS;
}
- if (actions_from_radio(parameters, cur_line->data.action))
+ prev_line = NULL;
+ while (line_number < patternid)
{
- /* Out of memory */
+ prev_line = cur_line;
+ cur_line = cur_line->next;
+ line_number++;
+
+ if ( (cur_line == NULL)
+ || ( (cur_line->type != FILE_LINE_URL)
+ && (cur_line->type != FILE_LINE_BLANK) ) )
+ {
+ /* Invalid "patternid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+ }
+
+ if (cur_line->type != FILE_LINE_URL)
+ {
+ /* Invalid "patternid" parameter */
edit_free_file(file);
- return 1;
+ return JB_ERR_CGI_PARAMS;
}
- if (NULL == (actiontext = actions_to_text(cur_line->data.action)))
+ assert(prev_line);
+
+ /* At this point, the line to remove is in cur_line, and the previous
+ * one is in prev_line
+ */
+
+ /* Unlink cur_line */
+ prev_line->next = cur_line->next;
+ cur_line->next = NULL;
+
+ /* Free cur_line */
+ edit_free_file_lines(cur_line);
+
+ err = edit_write_file(file);
+ if (err)
{
- /* Out of memory */
+ /* Error writing file */
edit_free_file(file);
- return 1;
+ return err;
}
- len = strlen(actiontext);
- if (NULL == (newtext = malloc(len + 2)))
+ target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ string_append(&target, file->identifier);
+
+ edit_free_file(file);
+
+ if (target == NULL)
{
/* Out of memory */
- free(actiontext);
+ return JB_ERR_MEMORY;
+ }
+
+ rsp->status = strdup("302 Local Redirect from Junkbuster");
+ if (rsp->status == NULL)
+ {
+ free(target);
+ return JB_ERR_MEMORY;
+ }
+ err = enlist_unique_header(rsp->headers, "Location", target);
+ free(target);
+
+ return err;
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_section_remove
+ *
+ * Description : CGI function that actually removes a whole section from
+ * the actions file. The section must be empty first
+ * (else JB_ERR_CGI_PARAMS).
+ *
+ * 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 :
+ * filename : Identifies the file to edit
+ * ver : File's last-modified time
+ * section : Line number of section to edit
+ * pattern : Line number of pattern to edit
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_section_remove(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ struct file_line * prev_line;
+ unsigned line_number;
+ char * target;
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "section", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ cur_line = file->lines;
+
+ prev_line = NULL;
+ while ((cur_line != NULL) && (line_number < sectionid))
+ {
+ prev_line = cur_line;
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ( (cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION) )
+ {
+ /* Invalid "sectionid" parameter */
edit_free_file(file);
- return 1;
+ return JB_ERR_CGI_PARAMS;
}
- strcpy(newtext, actiontext);
- free(actiontext);
- newtext[0] = '{';
- newtext[len] = '}';
- newtext[len + 1] = '\0';
- freez(cur_line->raw);
- freez(cur_line->unprocessed);
- cur_line->unprocessed = newtext;
+ if ( (cur_line->next != NULL)
+ && (cur_line->next->type == FILE_LINE_URL) )
+ {
+ /* Section not empty. */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* At this point, the line to remove is in cur_line, and the previous
+ * one is in prev_line
+ */
+
+ /* Unlink cur_line */
+ if (prev_line == NULL)
+ {
+ /* Removing the first line from the file */
+ file->lines = cur_line->next;
+ }
+ else
+ {
+ prev_line->next = cur_line->next;
+ }
+ cur_line->next = NULL;
- if (edit_write_file(filename, file))
+ /* Free cur_line */
+ edit_free_file_lines(cur_line);
+
+ err = edit_write_file(file);
+ if (err)
{
/* Error writing file */
edit_free_file(file);
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "Cannot save file '%s' after editing", filename);
- return 1;
+ return err;
}
+ target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ string_append(&target, file->identifier);
+
edit_free_file(file);
- free(filename);
+ if (target == NULL)
+ {
+ /* Out of memory */
+ return JB_ERR_MEMORY;
+ }
+
+ rsp->status = strdup("302 Local Redirect from Junkbuster");
+ if (rsp->status == NULL)
+ {
+ free(target);
+ return JB_ERR_MEMORY;
+ }
+ err = enlist_unique_header(rsp->headers, "Location", target);
+ free(target);
+
+ return err;
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_section_add
+ *
+ * Description : CGI function that adds a new empty section to
+ * an actions file.
+ *
+ * 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 :
+ * filename : Identifies the file to edit
+ * ver : File's last-modified time
+ * section : Line number of section to add after, 0 for start
+ * of file.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the CGI parameters are not
+ * specified or not valid.
+ *
+ *********************************************************************/
+jb_err cgi_edit_actions_section_add(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned sectionid;
+ struct file_line * new_line;
+ char * new_text;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ char * target;
+ jb_err err;
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ err = get_number_param(csp, parameters, "section", §ionid);
+ if (err)
+ {
+ return err;
+ }
+
+ err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
+ if (err)
+ {
+ /* No filename specified, can't read file, modified, or out of memory. */
+ return (err == JB_ERR_FILE ? JB_ERR_OK : err);
+ }
+
+ line_number = 1;
+ cur_line = file->lines;
+
+ if (sectionid < 1U)
+ {
+ /* Add to start of file */
+ if (cur_line != NULL)
+ {
+ /* There's something in the file, find the line before the first
+ * action.
+ */
+ while ( (cur_line->next != NULL)
+ && (cur_line->next->type != FILE_LINE_ACTION) )
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+ }
+ }
+ else
+ {
+ /* Add after stated section. */
+ while ((cur_line != NULL) && (line_number < sectionid))
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ( (cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION))
+ {
+ /* Invalid "sectionid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* Skip through the section to find the last line in it. */
+ while ( (cur_line->next != NULL)
+ && (cur_line->next->type != FILE_LINE_ACTION) )
+ {
+ cur_line = cur_line->next;
+ line_number++;
+ }
+ }
+
+ /* At this point, the last line in the previous section is in cur_line
+ * - add after this. (Or if we need to add as the first line, cur_line
+ * will be NULL).
+ */
+
+ new_text = strdup("{}");
+ if (NULL == new_text)
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ /* Allocate the new line */
+ new_line = (struct file_line *)zalloc(sizeof(*new_line));
+ if (new_line == NULL)
+ {
+ free(new_text);
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
+
+ /* Fill in the data members of the new line */
+ new_line->raw = NULL;
+ new_line->prefix = NULL;
+ new_line->unprocessed = new_text;
+ new_line->type = FILE_LINE_ACTION;
+
+ if (cur_line != NULL)
+ {
+ /* Link new_line into the list, after cur_line */
+ new_line->next = cur_line->next;
+ cur_line->next = new_line;
+ }
+ else
+ {
+ /* Link new_line into the list, as first line */
+ new_line->next = file->lines;
+ file->lines = new_line;
+ }
+
+ /* Done making changes, now commit */
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ edit_free_file(file);
+ return err;
+ }
target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
- string_append(&target, filename_param);
+ string_append(&target, file->identifier);
+
+ edit_free_file(file);
if (target == NULL)
{
/* Out of memory */
- /* FIXME: Shouldn't FATAL here */
- log_error(LOG_LEVEL_FATAL, "Out of memory");
- return 1;
+ return JB_ERR_MEMORY;
}
rsp->status = strdup("302 Local Redirect from Junkbuster");
- enlist_unique_header(rsp->headers, "Location", target);
+ if (rsp->status == NULL)
+ {
+ free(target);
+ return JB_ERR_MEMORY;
+ }
+ err = enlist_unique_header(rsp->headers, "Location", target);
free(target);
- return 0;
- /* return cgi_edit_actions_list(csp, rsp, parameters); */
+ return err;
}
+/*********************************************************************
+ *
+ * Function : cgi_toggle
+ *
+ * Description : CGI function that adds a new empty section to
+ * an actions file.
+ *
+ * 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 :
+ * set : If present, how to change toggle setting:
+ * "enable", "disable", "toggle", or none (default).
+ * mini : If present, use mini reply template.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ *
+ *********************************************************************/
+jb_err cgi_toggle(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ struct map *exports;
+ char mode;
+ const char *template_name;
+ jb_err err;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_TOGGLE))
+ {
+ return cgi_error_disabled(csp, rsp);
+ }
+
+ if (NULL == (exports = default_exports(csp, "toggle")))
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ mode = *(lookup(parameters, "set"));
+
+ if (mode == 'e')
+ {
+ /* Enable */
+ g_bToggleIJB = 1;
+ }
+ else if (mode == 'd')
+ {
+ /* Disable */
+ g_bToggleIJB = 0;
+ }
+ else if (mode == 't')
+ {
+ /* Toggle */
+ g_bToggleIJB = !g_bToggleIJB;
+ }
+
+ err = map_conditional(exports, "enabled", g_bToggleIJB);
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ template_name = (*(lookup(parameters, "mini"))
+ ? "toggle-mini"
+ : "toggle");
+
+ return template_fill_for_cgi(csp, template_name, exports, rsp);
+}
#endif /* def FEATURE_CGI_EDIT_ACTIONS */
diff --git a/cgiedit.h b/cgiedit.h
index 6604cf6b..38443a04 100644
--- a/cgiedit.h
+++ b/cgiedit.h
@@ -1,6 +1,6 @@
#ifndef CGIEDIT_H_INCLUDED
#define CGIEDIT_H_INCLUDED
-#define CGIEDIT_H_VERSION "$Id: cgiedit.h,v 1.1 2001/09/16 15:47:37 jongfoster Exp $"
+#define CGIEDIT_H_VERSION "$Id: cgiedit.h,v 1.2 2001/10/14 22:12:49 jongfoster Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgiedit.h,v $
@@ -37,6 +37,17 @@
*
* Revisions :
* $Log: cgiedit.h,v $
+ * Revision 1.2 2001/10/14 22:12:49 jongfoster
+ * New version of CGI-based actionsfile editor.
+ * Major changes, including:
+ * - Completely new file parser and file output routines
+ * - edit-actions CGI renamed edit-actions-for-url
+ * - All CGIs now need a filename parameter, except for...
+ * - New CGI edit-actions which doesn't need a filename,
+ * to allow you to start the editor up.
+ * - edit-actions-submit now works, and now automatically
+ * redirects you back to the main edit-actions-list handler.
+ *
* Revision 1.1 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
@@ -57,18 +68,36 @@ extern "C" {
* CGI functions
*/
#ifdef FEATURE_CGI_EDIT_ACTIONS
-extern int cgi_edit_actions (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_edit_actions_for_url(struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_edit_actions_list (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_edit_actions_submit (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
+extern jb_err cgi_edit_actions (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_edit_actions_for_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_edit_actions_list (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_edit_actions_submit (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_edit_actions_url (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_edit_actions_add_url(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_edit_actions_remove_url (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_edit_actions_section_remove(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_edit_actions_section_add (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_toggle(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
#endif /* def FEATURE_CGI_EDIT_ACTIONS */
diff --git a/cgisimple.c b/cgisimple.c
index fcf71e7e..bc0131b7 100644
--- a/cgisimple.c
+++ b/cgisimple.c
@@ -1,4 +1,4 @@
-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.5 2001/10/07 15:30:41 oes Exp $";
+const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.6 2001/10/14 22:00:32 jongfoster Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
@@ -36,6 +36,9 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.5 2001/10/07 15:30:41 oes Exp
*
* Revisions :
* $Log: cgisimple.c,v $
+ * Revision 1.6 2001/10/14 22:00:32 jongfoster
+ * Adding support for a 404 error when an invalid CGI page is requested.
+ *
* Revision 1.5 2001/10/07 15:30:41 oes
* Removed FEATURE_DENY_GZIP
*
@@ -84,7 +87,7 @@ const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
static char *show_rcs(void);
-static void show_defines(struct map *exports);
+static jb_err show_defines(struct map *exports);
/*********************************************************************
@@ -99,36 +102,63 @@ static void show_defines(struct map *exports);
* 2 : rsp = http_response data structure for output
* 3 : parameters = map of cgi parameters
*
- * Returns : 0
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * (Problems other than out-of-memory should be
+ * handled by this routine - it should set the
+ * rsp appropriately and return "success")
*
*********************************************************************/
-int cgi_default(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+jb_err cgi_default(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
char *p;
- char *tmp = NULL;
- struct map *exports = default_exports(csp, "");
+ char *tmp;
+ struct map *exports;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (NULL == (exports = default_exports(csp, "")))
+ {
+ return JB_ERR_MEMORY;
+ }
/* If there were other parameters, export a dump as "cgi-parameters" */
- if(parameters)
+ if (parameters->first)
{
- 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);
+ 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);
+ if (tmp == NULL)
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ if (map(exports, "cgi-parameters", 1, tmp, 0))
+ {
+ return JB_ERR_MEMORY;
+ }
}
else
{
- map(exports, "cgi-parameters", 1, "", 1);
+ if (map(exports, "cgi-parameters", 1, "", 1))
+ {
+ return JB_ERR_MEMORY;
+ }
}
- rsp->body = template_load(csp, "default");
- template_fill(&rsp->body, exports);
- free_map(exports);
- return(0);
-
+ return template_fill_for_cgi(csp, "default", exports, rsp);
}
@@ -138,7 +168,7 @@ int cgi_default(struct client_state *csp, struct http_response *rsp,
*
* Function : cgi_error_404
*
- * Description : CGI function that is called if an unknow action was
+ * Description : CGI function that is called if an unknown action was
* given.
*
* Parameters :
@@ -146,20 +176,35 @@ int cgi_default(struct client_state *csp, struct http_response *rsp,
* 2 : rsp = http_response data structure for output
* 3 : parameters = map of cgi parameters
*
- * Returns : 0
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int cgi_error_404(struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters)
+jb_err cgi_error_404(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
- struct map *exports = default_exports(csp, NULL);
+ struct map *exports;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ return JB_ERR_MEMORY;
+ }
rsp->status = strdup("404 JunkBuster configuration page not found");
- rsp->body = template_load(csp, "cgi-error-404");
- template_fill(&rsp->body, exports);
- free_map(exports);
- return 0;
+ if (rsp->status == NULL)
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+
+ return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
}
@@ -175,14 +220,27 @@ int cgi_error_404(struct client_state *csp,
* 2 : rsp = http_response data structure for output
* 3 : parameters = map of cgi parameters
*
- * Returns : 0
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int cgi_show_request(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+jb_err cgi_show_request(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
char *p;
- struct map *exports = default_exports(csp, "show-request");
+ struct map *exports;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (NULL == (exports = default_exports(csp, "show-request")))
+ {
+ return JB_ERR_MEMORY;
+ }
/*
* Repair the damage done to the IOB by get_header()
@@ -196,14 +254,20 @@ int cgi_show_request(struct client_state *csp, struct http_response *rsp,
* Export the original client's request and the one we would
* be sending to the server if this wasn't a CGI call
*/
- map(exports, "client-request", 1, csp->iob->buf, 1);
- map(exports, "processed-request", 1, sed(client_patterns, add_client_headers, csp), 0);
+
+ if (map(exports, "client-request", 1, csp->iob->buf, 1))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+
+ if (map(exports, "processed-request", 1, sed(client_patterns, add_client_headers, csp), 0))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
- rsp->body = template_load(csp, "show-request");
- template_fill(&rsp->body, exports);
- free_map(exports);
- return(0);
-
+ return template_fill_for_cgi(csp, "show-request", exports, rsp);
}
@@ -222,13 +286,15 @@ int cgi_show_request(struct client_state *csp, struct http_response *rsp,
* type : Selects the type of banner between "trans" and "jb".
* Defaults to "jb" if absent or != "trans".
*
- * Returns : 0
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int cgi_send_banner(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+jb_err cgi_send_banner(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
- if(strcmp(lookup(parameters, "type"), "trans"))
+ if (strcmp(lookup(parameters, "type"), "trans"))
{
rsp->body = bindup(image_junkbuster_gif_data, image_junkbuster_gif_length);
rsp->content_length = image_junkbuster_gif_length;
@@ -239,10 +305,19 @@ int cgi_send_banner(struct client_state *csp, struct http_response *rsp,
rsp->content_length = image_blank_gif_length;
}
- enlist(rsp->headers, "Content-Type: image/gif");
+ if (rsp->body == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
+
+ if (enlist(rsp->headers, "Content-Type: image/gif"))
+ {
+ return JB_ERR_MEMORY;
+ }
+
rsp->is_static = 1;
- return(0);
+ return JB_ERR_OK;
}
@@ -261,22 +336,32 @@ int cgi_send_banner(struct client_state *csp, struct http_response *rsp,
*
* CGI Parameters : none
*
- * Returns : 0
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int cgi_show_version(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+jb_err cgi_show_version(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
- struct map * exports = default_exports(csp, "show-version");
+ struct map *exports;
- map(exports, "sourceversions", 1, show_rcs(), 0);
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
- rsp->body = template_load(csp, "show-version");
- template_fill(&rsp->body, exports);
- free_map(exports);
+ if (NULL == (exports = default_exports(csp, "show-version")))
+ {
+ return JB_ERR_MEMORY;
+ }
- return(0);
+ if (map(exports, "sourceversions", 1, show_rcs(), 0))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ return template_fill_for_cgi(csp, "show-version", exports, rsp);
}
@@ -292,13 +377,21 @@ int cgi_show_version(struct client_state *csp, struct http_response *rsp,
* 2 : rsp = http_response data structure for output
* 3 : parameters = map of cgi parameters
*
- * CGI Parameters : none
+ * CGI Parameters :
+ * file : Which file to show. Only first letter is checked,
+ * valid values are:
+ * - "p"ermissions (actions) file
+ * - "r"egex
+ * - "t"rust
+ * Default is to show menu and other information.
*
- * 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)
+jb_err cgi_show_status(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
char *s = NULL;
int i;
@@ -313,8 +406,18 @@ int cgi_show_status(struct client_state *csp, struct http_response *rsp,
int local_urls_read;
int local_urls_rejected;
#endif /* ndef FEATURE_STATISTICS */
+ jb_err err;
- struct map * exports = default_exports(csp, "show-status");
+ struct map *exports;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (NULL == (exports = default_exports(csp, "show-status")))
+ {
+ return JB_ERR_MEMORY;
+ }
switch (*(lookup(parameters, "file")))
{
@@ -347,47 +450,66 @@ int cgi_show_status(struct client_state *csp, struct http_response *rsp,
if (NULL != filename)
{
- map(exports, "file-description", 1, file_description, 1);
- map(exports, "filepath", 1, html_encode(filename), 0);
+ if ( map(exports, "file-description", 1, file_description, 1)
+ || map(exports, "filepath", 1, html_encode(filename), 0) )
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
if ((fp = fopen(filename, "r")) == NULL)
{
- map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1);
+ if (map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
}
else
{
- while (fgets(buf, sizeof(buf), fp))
+ s = strdup("");
+ while ((s != NULL) && fgets(buf, sizeof(buf), fp))
{
p = html_encode(buf);
if (p)
{
- s = strsav(s, p);
+ string_append(&s, p);
freez(p);
- s = strsav(s, "<br>");
+ string_append(&s, "<br>");
}
}
fclose(fp);
- map(exports, "contents", 1, s, 0);
+
+ if (map(exports, "contents", 1, s, 0))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
}
- rsp->body = template_load(csp, "show-status-file");
- template_fill(&rsp->body, exports);
- free_map(exports);
- return(0);
+ return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
}
- map(exports, "redirect-url", 1, REDIRECT_URL, 1);
+ if (map(exports, "redirect-url", 1, REDIRECT_URL, 1))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
- s = NULL;
+ s = strdup("");
for (i=0; i < Argc; i++)
{
- s = strsav(s, Argv[i]);
- s = strsav(s, " ");
+ string_append(&s, Argv[i]);
+ string_append(&s, " ");
+ }
+ if (map(exports, "invocation", 1, s, 0))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
}
- map(exports, "invocation", 1, s, 0);
- map(exports, "options", 1, csp->config->proxy_args, 1);
- show_defines(exports);
+ err = map(exports, "options", 1, csp->config->proxy_args, 1);
+ err = err || show_defines(exports);
#ifdef FEATURE_STATISTICS
local_urls_read = urls_read;
@@ -405,65 +527,67 @@ int cgi_show_status(struct client_state *csp, struct http_response *rsp,
if (local_urls_read == 0)
{
- map_block_killer(exports, "have-stats");
+ err = err || map_block_killer(exports, "have-stats");
}
else
{
- map_block_killer(exports, "have-no-stats");
+ err = err || 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);
+ err = err || map(exports, "requests-received", 1, buf, 1);
sprintf(buf, "%d", local_urls_rejected);
- map(exports, "requests-blocked", 1, buf, 1);
+ err = err || map(exports, "requests-blocked", 1, buf, 1);
sprintf(buf, "%6.2f", perc_rej);
- map(exports, "percent-blocked", 1, buf, 1);
+ err = err || map(exports, "percent-blocked", 1, buf, 1);
}
#else /* ndef FEATURE_STATISTICS */
- map_block_killer(exports, "statistics");
+ err = err || map_block_killer(exports, "statistics");
#endif /* ndef FEATURE_STATISTICS */
if (csp->actions_list)
{
- map(exports, "actions-filename", 1, csp->actions_list->filename, 1);
+ err = err || map(exports, "actions-filename", 1, csp->actions_list->filename, 1);
}
else
{
- map(exports, "actions-filename", 1, "None specified", 1);
+ err = err || map(exports, "actions-filename", 1, "None specified", 1);
}
if (csp->rlist)
{
- map(exports, "re-filter-filename", 1, csp->rlist->filename, 1);
+ err = err || map(exports, "re-filter-filename", 1, csp->rlist->filename, 1);
}
else
{
- map(exports, "re-filter-filename", 1, "None specified", 1);
+ err = err || map(exports, "re-filter-filename", 1, "None specified", 1);
}
#ifdef FEATURE_TRUST
if (csp->tlist)
{
- map(exports, "trust-filename", 1, csp->tlist->filename, 1);
+ err = err || map(exports, "trust-filename", 1, csp->tlist->filename, 1);
}
else
{
- map(exports, "trust-filename", 1, "None specified", 1);
+ err = err || map(exports, "trust-filename", 1, "None specified", 1);
}
#else
- map_block_killer(exports, "trust-support");
+ err = err || map_block_killer(exports, "trust-support");
#endif /* ndef FEATURE_TRUST */
- rsp->body = template_load(csp, "show-status");
- template_fill(&rsp->body, exports);
- free_map(exports);
- return(0);
+ if (err)
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ return template_fill_for_cgi(csp, "show-status", exports, rsp);
}
@@ -486,24 +610,41 @@ int cgi_show_status(struct client_state *csp, struct http_response *rsp,
* set, so that all but the form can be suppressed in
* the template.
*
- * 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_show_url_info(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
- char *url_param;
+ const char *url_param_const;
char *host = NULL;
- struct map * exports = default_exports(csp, "show-url-info");
+ struct map *exports;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (NULL == (exports = default_exports(csp, "show-url-info")))
+ {
+ return JB_ERR_MEMORY;
+ }
- if (NULL == (url_param = strdup(lookup(parameters, "url"))) || *url_param == '\0')
+ url_param_const = lookup(parameters, "url");
+ if (*url_param_const == '\0')
{
- map_block_killer(exports, "url-given");
- map(exports, "url", 1, "", 1);
+ if (map_block_killer(exports, "url-given")
+ || map(exports, "url", 1, "", 1))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
}
else
{
- char *matches = NULL;
+ char *url_param;
+ char *matches;
char *path;
char *s;
int port = 80;
@@ -513,30 +654,51 @@ int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
struct url_spec url[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;
- map(exports, "url", 1, host, 1);
- map(exports, "url-html", 1, html_encode(host), 0);
+ if (map(exports, "url", 1, host, 1)
+ || map(exports, "url-html", 1, html_encode(host), 0))
+ {
+ free(url_param);
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
init_current_action(action);
s = current_action_to_text(action);
- map(exports, "default", 1, s , 0);
+ if (map(exports, "default", 1, s , 0))
+ {
+ free_current_action(action);
+ free(url_param);
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
if (((fl = csp->actions_list) == NULL) || ((b = fl->f) == NULL))
{
- map(exports, "matches", 1, "none" , 1);
- map(exports, "final", 1, lookup(exports, "default"), 1);
+ jb_err err;
+
+ err = map(exports, "matches", 1, "none" , 1)
+ || map(exports, "final", 1, lookup(exports, "default"), 1);
- freez(url_param);
free_current_action(action);
+ free(url_param);
- rsp->body = template_load(csp, "show-url-info");
- template_fill(&rsp->body, exports);
- free_map(exports);
+ if (err)
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
- return 0;
+ return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
}
s = strchr(host, '/');
@@ -549,6 +711,14 @@ int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
{
path = strdup("");
}
+ if (NULL == path)
+ {
+ free_current_action(action);
+ free(url_param);
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+
s = strchr(host, ':');
if (s != NULL)
{
@@ -562,20 +732,26 @@ int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
/* if splitting the domain fails, punt */
if (url->dbuf == NULL)
{
- map(exports, "matches", 1, "none" , 1);
- map(exports, "final", 1, lookup(exports, "default"), 1);
+ 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);
- rsp->body = template_load(csp, "show-url-info");
- template_fill(&rsp->body, exports);
- free_map(exports);
+ if (err)
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
- return 0;
+ return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
}
+ matches = strdup("");
+
for (b = b->next; NULL != b; b = b->next)
{
if ((b->url->port == 0) || (b->url->port == port))
@@ -591,48 +767,68 @@ int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
)
{
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);
+ 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++;
}
}
}
}
- if (hits)
+ freez(url->dbuf);
+ freez(url->dvec);
+
+ free(url_param);
+ free(path);
+
+ if (matches == NULL)
{
- map(exports, "matches", 1, matches , 0);
+ free_current_action(action);
+ free_map(exports);
+ return JB_ERR_MEMORY;
}
- else
+
+ if (!hits)
{
- map(exports, "matches", 1, "none", 1);
+ free(matches);
+ matches = strdup("none");
+ }
+ if (map(exports, "matches", 1, matches , 0))
+ {
+ free_current_action(action);
+ free_map(exports);
+ return JB_ERR_MEMORY;
}
- 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 = template_load(csp, "show-url-info");
- template_fill(&rsp->body, exports);
- free_map(exports);
- return 0;
+ if (map(exports, "final", 1, s, 0))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ }
+ return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
}
@@ -649,13 +845,16 @@ int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
*
* CGI Parameters : None
*
- * Returns : 0
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int cgi_robots_txt(struct client_state *csp, struct http_response *rsp,
- struct map *parameters)
+jb_err cgi_robots_txt(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
char buf[100];
+ jb_err err;
rsp->body = strdup(
"# This is the Internet Junkbuster control interface.\n"
@@ -665,16 +864,19 @@ int cgi_robots_txt(struct client_state *csp, struct http_response *rsp,
"User-agent: *\n"
"Disallow: /\n"
"\n");
+ if (rsp->body == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
- enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
+ err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
rsp->is_static = 1;
get_http_time(7 * 24 * 60 * 60, buf); /* 7 days into future */
- enlist_unique_header(rsp->headers, "Expires", buf);
-
- return 0;
+ err = err || enlist_unique_header(rsp->headers, "Expires", buf);
+ return (err ? JB_ERR_MEMORY : JB_ERR_OK);
}
@@ -682,109 +884,113 @@ int cgi_robots_txt(struct client_state *csp, struct http_response *rsp,
*
* Function : show_defines
*
- * Description : Create a string with all conditional #defines used
- * when building
+ * Description : Add to a map the state od all conditional #defines
+ * used when building
*
- * Parameters : None
+ * Parameters :
+ * 1 : exports = map to extend
*
- * Returns : string
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-static void show_defines(struct map *exports)
+static jb_err show_defines(struct map *exports)
{
+ jb_err err = JB_ERR_OK;
#ifdef FEATURE_ACL
- map_conditional(exports, "FEATURE_ACL", 1);
+ err = err || map_conditional(exports, "FEATURE_ACL", 1);
#else /* ifndef FEATURE_ACL */
- map_conditional(exports, "FEATURE_ACL", 0);
+ err = err || map_conditional(exports, "FEATURE_ACL", 0);
#endif /* ndef FEATURE_ACL */
#ifdef FEATURE_COOKIE_JAR
- map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
+ err = err || map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
#else /* ifndef FEATURE_COOKIE_JAR */
- map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
+ err = err || map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
#endif /* ndef FEATURE_COOKIE_JAR */
#ifdef FEATURE_FAST_REDIRECTS
- map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
+ err = err || map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
#else /* ifndef FEATURE_FAST_REDIRECTS */
- map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
+ err = err || map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
#endif /* ndef FEATURE_FAST_REDIRECTS */
#ifdef FEATURE_FORCE_LOAD
- map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
+ err = err || map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
#else /* ifndef FEATURE_FORCE_LOAD */
- map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
+ err = err || map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
#endif /* ndef FEATURE_FORCE_LOAD */
#ifdef FEATURE_IMAGE_BLOCKING
- map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
+ err = err || map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
#else /* ifndef FEATURE_IMAGE_BLOCKING */
- map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
+ err = err || map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
#endif /* ndef FEATURE_IMAGE_BLOCKING */
#ifdef FEATURE_IMAGE_DETECT_MSIE
- map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
+ err = err || map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
#else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
- map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
+ err = err || map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
#endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
#ifdef FEATURE_KILL_POPUPS
- map_conditional(exports, "FEATURE_KILL_POPUPS", 1);
+ err = err || map_conditional(exports, "FEATURE_KILL_POPUPS", 1);
#else /* ifndef FEATURE_KILL_POPUPS */
- map_conditional(exports, "FEATURE_KILL_POPUPS", 0);
+ err = err || map_conditional(exports, "FEATURE_KILL_POPUPS", 0);
#endif /* ndef FEATURE_KILL_POPUPS */
#ifdef FEATURE_PTHREAD
- map_conditional(exports, "FEATURE_PTHREAD", 1);
+ err = err || map_conditional(exports, "FEATURE_PTHREAD", 1);
#else /* ifndef FEATURE_PTHREAD */
- map_conditional(exports, "FEATURE_PTHREAD", 0);
+ err = err || map_conditional(exports, "FEATURE_PTHREAD", 0);
#endif /* ndef FEATURE_PTHREAD */
#ifdef FEATURE_STATISTICS
- map_conditional(exports, "FEATURE_STATISTICS", 1);
+ err = err || map_conditional(exports, "FEATURE_STATISTICS", 1);
#else /* ifndef FEATURE_STATISTICS */
- map_conditional(exports, "FEATURE_STATISTICS", 0);
+ err = err || map_conditional(exports, "FEATURE_STATISTICS", 0);
#endif /* ndef FEATURE_STATISTICS */
#ifdef FEATURE_TOGGLE
- map_conditional(exports, "FEATURE_TOGGLE", 1);
+ err = err || map_conditional(exports, "FEATURE_TOGGLE", 1);
#else /* ifndef FEATURE_TOGGLE */
- map_conditional(exports, "FEATURE_TOGGLE", 0);
+ err = err || map_conditional(exports, "FEATURE_TOGGLE", 0);
#endif /* ndef FEATURE_TOGGLE */
#ifdef FEATURE_TRUST
- map_conditional(exports, "FEATURE_TRUST", 1);
+ err = err || map_conditional(exports, "FEATURE_TRUST", 1);
#else /* ifndef FEATURE_TRUST */
- map_conditional(exports, "FEATURE_TRUST", 0);
+ err = err || map_conditional(exports, "FEATURE_TRUST", 0);
#endif /* ndef FEATURE_TRUST */
#ifdef REGEX_GNU
- map_conditional(exports, "REGEX_GNU", 1);
+ err = err || map_conditional(exports, "REGEX_GNU", 1);
#else /* ifndef REGEX_GNU */
- map_conditional(exports, "REGEX_GNU", 0);
+ err = err || map_conditional(exports, "REGEX_GNU", 0);
#endif /* def REGEX_GNU */
#ifdef REGEX_PCRE
- map_conditional(exports, "REGEX_PCRE", 1);
+ err = err || map_conditional(exports, "REGEX_PCRE", 1);
#else /* ifndef REGEX_PCRE */
- map_conditional(exports, "REGEX_PCRE", 0);
+ err = err || map_conditional(exports, "REGEX_PCRE", 0);
#endif /* def REGEX_PCRE */
#ifdef STATIC_PCRE
- map_conditional(exports, "STATIC_PCRE", 1);
+ err = err || map_conditional(exports, "STATIC_PCRE", 1);
#else /* ifndef STATIC_PCRE */
- map_conditional(exports, "STATIC_PCRE", 0);
+ err = err || map_conditional(exports, "STATIC_PCRE", 0);
#endif /* ndef STATIC_PCRE */
#ifdef STATIC_PCRS
- map_conditional(exports, "STATIC_PCRS", 1);
+ err = err || map_conditional(exports, "STATIC_PCRS", 1);
#else /* ifndef STATIC_PCRS */
- map_conditional(exports, "STATIC_PCRS", 0);
+ err = err || map_conditional(exports, "STATIC_PCRS", 0);
#endif /* ndef STATIC_PCRS */
- map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
+ err = err || map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
+ return err;
}
@@ -796,12 +1002,12 @@ static void show_defines(struct map *exports)
*
* Parameters : None
*
- * Returns : string
+ * Returns : A string, or NULL on out-of-memory.
*
*********************************************************************/
static char *show_rcs(void)
{
- char *b = NULL;
+ char *result = strdup("");
char buf[BUFFER_SIZE];
/* Instead of including *all* dot h's in the project (thus creating a
@@ -809,11 +1015,11 @@ static char *show_rcs(void)
* as extern's. This forces the developer to add to this list, but oh well.
*/
-#define SHOW_RCS(__x) \
- { \
- extern const char __x[]; \
- sprintf(buf, "%s\n", __x); \
- b = strsav(b, buf); \
+#define SHOW_RCS(__x) \
+ { \
+ extern const char __x[]; \
+ sprintf(buf, "%s\n", __x); \
+ string_append(&result, buf); \
}
/* In alphabetical order */
@@ -881,7 +1087,7 @@ static char *show_rcs(void)
#undef SHOW_RCS
- return(b);
+ return result;
}
diff --git a/cgisimple.h b/cgisimple.h
index 6be066d9..31aca341 100644
--- a/cgisimple.h
+++ b/cgisimple.h
@@ -1,6 +1,6 @@
#ifndef CGISIMPLE_H_INCLUDED
#define CGISIMPLE_H_INCLUDED
-#define CGISIMPLE_H_VERSION "$Id: cgisimple.h,v 1.2 2001/10/02 15:31:20 oes Exp $"
+#define CGISIMPLE_H_VERSION "$Id: cgisimple.h,v 1.3 2001/10/14 22:00:32 jongfoster Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgisimple.h,v $
@@ -38,6 +38,9 @@
*
* Revisions :
* $Log: cgisimple.h,v $
+ * Revision 1.3 2001/10/14 22:00:32 jongfoster
+ * Adding support for a 404 error when an invalid CGI page is requested.
+ *
* Revision 1.2 2001/10/02 15:31:20 oes
* Introduced show-request cgi
*
@@ -57,30 +60,30 @@ extern "C" {
/*
* CGI functions
*/
-extern int cgi_default (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_error_404 (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_robots_txt (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_send_banner (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_show_status (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_show_url_info (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_show_version (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
-extern int cgi_show_request (struct client_state *csp,
- struct http_response *rsp,
- struct map *parameters);
+extern jb_err cgi_default (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_error_404 (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_robots_txt (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_send_banner (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_show_status (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_show_url_info(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_show_version (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
+extern jb_err cgi_show_request (struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters);
/* Revision control strings from this header and associated .c file */
extern const char cgisimple_rcs[];
diff --git a/templates/cgi-error-bad-param b/templates/cgi-error-bad-param
new file mode 100644
index 00000000..1ce2048c
--- /dev/null
+++ b/templates/cgi-error-bad-param
@@ -0,0 +1,157 @@
+##########################################################
+#
+# No-Such-Domain Error Output template for junkbuster 2.9.x.
+#
+#
+# USING HTML TEMPLATES:
+# ---------------------
+#
+# Template files are written win plain HTML, with a few
+# additions:
+#
+# - Lines that start with a '#' character like this one
+# are ignored
+#
+# - Each item in the below list of exported symbols will
+# be replaced by dynamically generated text, if they
+# are enclosed in '@'-characters. E.g. The string @version@
+# will be replaced by the version number of Junkbuster.
+#
+# - One special application of this is to make whole blocks
+# of the HTML template disappear if the condition <name>
+# is not given. Simply enclose the block between the two
+# strings @if-<name>start and if-<name>-end@. The strings
+# should be placed in HTML comments (<!-- -->), so the
+# html structure won't be messed when the magic happens.
+#
+# USABLE SYMBOLS IN THIS TEMPLATE:
+# --------------------------------
+#
+# my-ip-addr:
+# The IP-address that the client used to reach this proxy
+# my-hostname:
+# The hostname associated with my-ip-addr
+# admin-address:
+# The email address of the pxoxy's administrator, as configured
+# in the config file
+# default-cgi:
+# The URL for the "main menu" builtin CGI of this proxy
+# menu:
+# List of <li> elements linking to the other available CGIs
+# version:
+# The version number of the proxy software
+# code-status:
+# The development status of the proxy software: "alpha", "beta",
+# or "stable".
+# homepage:
+# The URL of the SourceForge ijbswa project, who maintains this
+# software.
+#
+# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
+# ------------------------------------------------------------------
+#
+# unstable:
+# this is an alpha or beta release of the proxy software
+# have-adminaddr-info:
+# An e-mail address for the local Junkbuster adminstrator has
+# been specified and is available through the "admin-address"
+# symbol
+# have-proxy-info:
+# A URL for online documentation about this proxy has been
+# specified and is available through the "proxy-info-url"
+# symbol
+# have-help-info:
+# If either have-proxy-info is true or have-adminaddr-info is
+# true, have-help-info is true. Used to conditionally include
+# a grey box for any and all help info.
+#
+<html>
+
+<head>
+ <title>JunkBuster: Bad parameter</title>
+ <style type="text/css">
+ BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
+ </style>
+</head>
+
+<body bgcolor="#ffffff">
+
+ <table cellpadding=20 cellspacing=10 border=0 width=100%>
+ <tr>
+ <td bgcolor=#dddddd width=100%>
+ <p><font size=+2><b>This is the Internet J</b></font><font size=+1><b>UNK<i></font><font color="red">BUSTER</font></i></b>
+ <font size=+2><b>@version@ on @my-hostname@ (@my-ip-address@), port @my-port@</b></font></p>
+ </td>
+ </tr>
+
+<!-- @if-unstable-start -->
+# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
+ <tr>
+ <td bgcolor=#ffdddd>
+ <p><b>Please note that this <font color=red>@code-status@</font> release
+ of the proxy software is not intended for production systems!
+ <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
+ </p>
+
+ <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
+ with any problems you encounter.
+ </p>
+ </td>
+ </tr>
+<!-- if-unstable-end@ -->
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>Bad parameter to JunkBuster configuration page</h2>
+ <blockquote>
+ <p>You've found a page used to configure JunkBuster, but the
+ parameters (the part of the web page address after the
+ "?" mark) are wrong or missing.</p>
+ <p>Possible causes:</p>
+ <ul>
+ <li>If you tried to type in the URL, then you've found a
+ page where you can't do that. You can only view this
+ page by following links from elsewhere in the configuration
+ interface.</li>
+ <li>If you got here using your browser's "back" button, then
+ that is deliberately disabled for this page.</li>
+ <li>If you got here by clicking a link in the
+ configuration interface, please file a bug report!</li>
+ </ul>
+ <p>You can use the menu below to select from the available
+ configuration options</p>
+ </blockquote>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>More Junkbuster:</h2>
+ <ul>@menu@</ul>
+ </td>
+ </tr>
+
+<!-- @if-have-help-info-start -->
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>Local Junkbuster support:</h2>
+
+<!-- @if-have-proxy-info-start -->
+ <p>You can consult the <a href="@proxy-info-url@">online documentation</a> for more information about this Junkbuster installation.
+<!-- if-have-proxy-info-end@ -->
+
+<!-- @if-have-adminaddr-info-start -->
+ <p>Address e-mail questions about this service to
+ <a href=mailto:@admin-address@><code>@admin-address@</code></a>,
+ who will be glad to help you.
+<!-- if-have-adminaddr-info-end@ -->
+
+ </p>
+ </td>
+ </tr>
+<!-- if-have-help-info-end@ -->
+
+ </table>
+
+</body>
+</html>
diff --git a/templates/cgi-error-disabled b/templates/cgi-error-disabled
new file mode 100644
index 00000000..d4bc239a
--- /dev/null
+++ b/templates/cgi-error-disabled
@@ -0,0 +1,147 @@
+##########################################################
+#
+# No-Such-Domain Error Output template for junkbuster 2.9.x.
+#
+#
+# USING HTML TEMPLATES:
+# ---------------------
+#
+# Template files are written win plain HTML, with a few
+# additions:
+#
+# - Lines that start with a '#' character like this one
+# are ignored
+#
+# - Each item in the below list of exported symbols will
+# be replaced by dynamically generated text, if they
+# are enclosed in '@'-characters. E.g. The string @version@
+# will be replaced by the version number of Junkbuster.
+#
+# - One special application of this is to make whole blocks
+# of the HTML template disappear if the condition <name>
+# is not given. Simply enclose the block between the two
+# strings @if-<name>start and if-<name>-end@. The strings
+# should be placed in HTML comments (<!-- -->), so the
+# html structure won't be messed when the magic happens.
+#
+# USABLE SYMBOLS IN THIS TEMPLATE:
+# --------------------------------
+#
+# my-ip-addr:
+# The IP-address that the client used to reach this proxy
+# my-hostname:
+# The hostname associated with my-ip-addr
+# admin-address:
+# The email address of the pxoxy's administrator, as configured
+# in the config file
+# default-cgi:
+# The URL for the "main menu" builtin CGI of this proxy
+# menu:
+# List of <li> elements linking to the other available CGIs
+# version:
+# The version number of the proxy software
+# code-status:
+# The development status of the proxy software: "alpha", "beta",
+# or "stable".
+# homepage:
+# The URL of the SourceForge ijbswa project, who maintains this
+# software.
+#
+# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
+# ------------------------------------------------------------------
+#
+# unstable:
+# this is an alpha or beta release of the proxy software
+# have-adminaddr-info:
+# An e-mail address for the local Junkbuster adminstrator has
+# been specified and is available through the "admin-address"
+# symbol
+# have-proxy-info:
+# A URL for online documentation about this proxy has been
+# specified and is available through the "proxy-info-url"
+# symbol
+# have-help-info:
+# If either have-proxy-info is true or have-adminaddr-info is
+# true, have-help-info is true. Used to conditionally include
+# a grey box for any and all help info.
+#
+<html>
+
+<head>
+ <title>Configuration Page Disabled</title>
+ <style type="text/css">
+ BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
+ </style>
+</head>
+
+<body bgcolor="#ffffff">
+
+ <table cellpadding=20 cellspacing=10 border=0 width=100%>
+ <tr>
+ <td bgcolor=#dddddd width=100%>
+ <p><font size=+2><b>This is the Internet J</b></font><font size=+1><b>UNK<i></font><font color="red">BUSTER</font></i></b>
+ <font size=+2><b>@version@ on @my-hostname@ (@my-ip-address@), port @my-port@</b></font></p>
+ </td>
+ </tr>
+
+<!-- @if-unstable-start -->
+# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
+ <tr>
+ <td bgcolor=#ffdddd>
+ <p><b>Please note that this <font color=red>@code-status@</font> release
+ of the proxy software is not intended for production systems!
+ <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
+ </p>
+
+ <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
+ with any problems you encounter.
+ </p>
+ </td>
+ </tr>
+<!-- if-unstable-end@ -->
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>JunkBuster Configuration page diasabled</h2>
+ <blockquote>
+ <p>The JunkBuster administrator has decided to disable this
+ feature. If you want to use it, you must ask them to
+ enable it.</p>
+ <p>If you are the JunkBuster administrator, you can enable
+ this feature by changing the appropriate line in your
+ configuration file.</p>
+ </blockquote>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>More Junkbuster:</h2>
+ <ul>@menu@</ul>
+ </td>
+ </tr>
+
+<!-- @if-have-help-info-start -->
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>Local Junkbuster support:</h2>
+
+<!-- @if-have-proxy-info-start -->
+ <p>You can consult the <a href="@proxy-info-url@">online documentation</a> for more information about this Junkbuster installation.
+<!-- if-have-proxy-info-end@ -->
+
+<!-- @if-have-adminaddr-info-start -->
+ <p>Address e-mail questions about this service to
+ <a href=mailto:@admin-address@><code>@admin-address@</code></a>,
+ who will be glad to help you.
+<!-- if-have-adminaddr-info-end@ -->
+
+ </p>
+ </td>
+ </tr>
+<!-- if-have-help-info-end@ -->
+
+ </table>
+
+</body>
+</html>
diff --git a/templates/cgi-error-file b/templates/cgi-error-file
new file mode 100644
index 00000000..02282173
--- /dev/null
+++ b/templates/cgi-error-file
@@ -0,0 +1,143 @@
+##########################################################
+#
+# No-Such-Domain Error Output template for junkbuster 2.9.x.
+#
+#
+# USING HTML TEMPLATES:
+# ---------------------
+#
+# Template files are written win plain HTML, with a few
+# additions:
+#
+# - Lines that start with a '#' character like this one
+# are ignored
+#
+# - Each item in the below list of exported symbols will
+# be replaced by dynamically generated text, if they
+# are enclosed in '@'-characters. E.g. The string @version@
+# will be replaced by the version number of Junkbuster.
+#
+# - One special application of this is to make whole blocks
+# of the HTML template disappear if the condition <name>
+# is not given. Simply enclose the block between the two
+# strings @if-<name>start and if-<name>-end@. The strings
+# should be placed in HTML comments (<!-- -->), so the
+# html structure won't be messed when the magic happens.
+#
+# USABLE SYMBOLS IN THIS TEMPLATE:
+# --------------------------------
+#
+# my-ip-addr:
+# The IP-address that the client used to reach this proxy
+# my-hostname:
+# The hostname associated with my-ip-addr
+# admin-address:
+# The email address of the pxoxy's administrator, as configured
+# in the config file
+# default-cgi:
+# The URL for the "main menu" builtin CGI of this proxy
+# menu:
+# List of <li> elements linking to the other available CGIs
+# version:
+# The version number of the proxy software
+# code-status:
+# The development status of the proxy software: "alpha", "beta",
+# or "stable".
+# homepage:
+# The URL of the SourceForge ijbswa project, who maintains this
+# software.
+#
+# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
+# ------------------------------------------------------------------
+#
+# unstable:
+# this is an alpha or beta release of the proxy software
+# have-adminaddr-info:
+# An e-mail address for the local Junkbuster adminstrator has
+# been specified and is available through the "admin-address"
+# symbol
+# have-proxy-info:
+# A URL for online documentation about this proxy has been
+# specified and is available through the "proxy-info-url"
+# symbol
+# have-help-info:
+# If either have-proxy-info is true or have-adminaddr-info is
+# true, have-help-info is true. Used to conditionally include
+# a grey box for any and all help info.
+#
+<html>
+
+<head>
+ <title>JunkBuster: Actions file not found</title>
+ <style type="text/css">
+ BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
+ </style>
+</head>
+
+<body bgcolor="#ffffff">
+
+ <table cellpadding=20 cellspacing=10 border=0 width=100%>
+ <tr>
+ <td bgcolor=#dddddd width=100%>
+ <p><font size=+2><b>This is the Internet J</b></font><font size=+1><b>UNK<i></font><font color="red">BUSTER</font></i></b>
+ <font size=+2><b>@version@ on @my-hostname@ (@my-ip-address@), port @my-port@</b></font></p>
+ </td>
+ </tr>
+
+<!-- @if-unstable-start -->
+# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
+ <tr>
+ <td bgcolor=#ffdddd>
+ <p><b>Please note that this <font color=red>@code-status@</font> release
+ of the proxy software is not intended for production systems!
+ <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
+ </p>
+
+ <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
+ with any problems you encounter.
+ </p>
+ </td>
+ </tr>
+<!-- if-unstable-end@ -->
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>Actions file not found</h2>
+ <blockquote>
+ <p>The actions file you are trying to edit (<code>@filename@.action</code>)
+ does not exist, or cannot be read.</p>
+ </blockquote>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>More Junkbuster:</h2>
+ <ul>@menu@</ul>
+ </td>
+ </tr>
+
+<!-- @if-have-help-info-start -->
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>Local Junkbuster support:</h2>
+
+<!-- @if-have-proxy-info-start -->
+ <p>You can consult the <a href="@proxy-info-url@">online documentation</a> for more information about this Junkbuster installation.
+<!-- if-have-proxy-info-end@ -->
+
+<!-- @if-have-adminaddr-info-start -->
+ <p>Address e-mail questions about this service to
+ <a href=mailto:@admin-address@><code>@admin-address@</code></a>,
+ who will be glad to help you.
+<!-- if-have-adminaddr-info-end@ -->
+
+ </p>
+ </td>
+ </tr>
+<!-- if-have-help-info-end@ -->
+
+ </table>
+
+</body>
+</html>
diff --git a/templates/cgi-error-modified b/templates/cgi-error-modified
new file mode 100644
index 00000000..7702c625
--- /dev/null
+++ b/templates/cgi-error-modified
@@ -0,0 +1,162 @@
+##########################################################
+#
+# No-Such-Domain Error Output template for junkbuster 2.9.x.
+#
+#
+# USING HTML TEMPLATES:
+# ---------------------
+#
+# Template files are written win plain HTML, with a few
+# additions:
+#
+# - Lines that start with a '#' character like this one
+# are ignored
+#
+# - Each item in the below list of exported symbols will
+# be replaced by dynamically generated text, if they
+# are enclosed in '@'-characters. E.g. The string @version@
+# will be replaced by the version number of Junkbuster.
+#
+# - One special application of this is to make whole blocks
+# of the HTML template disappear if the condition <name>
+# is not given. Simply enclose the block between the two
+# strings @if-<name>start and if-<name>-end@. The strings
+# should be placed in HTML comments (<!-- -->), so the
+# html structure won't be messed when the magic happens.
+#
+# USABLE SYMBOLS IN THIS TEMPLATE:
+# --------------------------------
+#
+# my-ip-addr:
+# The IP-address that the client used to reach this proxy
+# my-hostname:
+# The hostname associated with my-ip-addr
+# admin-address:
+# The email address of the pxoxy's administrator, as configured
+# in the config file
+# default-cgi:
+# The URL for the "main menu" builtin CGI of this proxy
+# menu:
+# List of <li> elements linking to the other available CGIs
+# version:
+# The version number of the proxy software
+# code-status:
+# The development status of the proxy software: "alpha", "beta",
+# or "stable".
+# homepage:
+# The URL of the SourceForge ijbswa project, who maintains this
+# software.
+#
+# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
+# ------------------------------------------------------------------
+#
+# unstable:
+# this is an alpha or beta release of the proxy software
+# have-adminaddr-info:
+# An e-mail address for the local Junkbuster adminstrator has
+# been specified and is available through the "admin-address"
+# symbol
+# have-proxy-info:
+# A URL for online documentation about this proxy has been
+# specified and is available through the "proxy-info-url"
+# symbol
+# have-help-info:
+# If either have-proxy-info is true or have-adminaddr-info is
+# true, have-help-info is true. Used to conditionally include
+# a grey box for any and all help info.
+#
+<html>
+
+<head>
+ <title>JunkBuster: URL out of date</title>
+ <style type="text/css">
+ BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
+ </style>
+</head>
+
+<body bgcolor="#ffffff">
+
+ <table cellpadding=20 cellspacing=10 border=0 width=100%>
+ <tr>
+ <td bgcolor=#dddddd width=100%>
+ <p><font size=+2><b>This is the Internet J</b></font><font size=+1><b>UNK<i></font><font color="red">BUSTER</font></i></b>
+ <font size=+2><b>@version@ on @my-hostname@ (@my-ip-address@), port @my-port@</b></font></p>
+ </td>
+ </tr>
+
+<!-- @if-unstable-start -->
+# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
+ <tr>
+ <td bgcolor=#ffdddd>
+ <p><b>Please note that this <font color=red>@code-status@</font> release
+ of the proxy software is not intended for production systems!
+ <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
+ </p>
+
+ <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
+ with any problems you encounter.
+ </p>
+ </td>
+ </tr>
+<!-- if-unstable-end@ -->
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>URL out of date - file has changed since it was generated</h2>
+ <blockquote>
+ <p>The URL you're viewing is out of date. To prevent possible
+ damage to your configuration file, this action has been ignored.
+ </p>
+ <p>Possible causes:</p>
+ <ul>
+ <li>If you got here using your browser's "back" button, then
+ that is deliberately disabled for this page. Please
+ navigate around the configuration editor using the
+ links provided.</li>
+ <li>Perhaps you've got more than one browser window open, and
+ you're trying to change the same file in both? You can
+ only have one editor window open at a time. Your other edit
+ window should continue to function.</li>
+ <li>You may have modified the file some other way - perhaps by
+ editing it with a text editor. Simply go back in to the
+ configuration interface using the links below.</li>
+ </ul>
+ <p>You can go back into the edit interface using the menu below,
+ or by clicking <a
+ href="http://ijbswa.sourceforge.net/config/edit-actions-list?filename=@filename@"
+ >here</a>.</p>
+ </blockquote>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>More Junkbuster:</h2>
+ <ul>@menu@</ul>
+ </td>
+ </tr>
+
+<!-- @if-have-help-info-start -->
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>Local Junkbuster support:</h2>
+
+<!-- @if-have-proxy-info-start -->
+ <p>You can consult the <a href="@proxy-info-url@">online documentation</a> for more information about this Junkbuster installation.
+<!-- if-have-proxy-info-end@ -->
+
+<!-- @if-have-adminaddr-info-start -->
+ <p>Address e-mail questions about this service to
+ <a href=mailto:@admin-address@><code>@admin-address@</code></a>,
+ who will be glad to help you.
+<!-- if-have-adminaddr-info-end@ -->
+
+ </p>
+ </td>
+ </tr>
+<!-- if-have-help-info-end@ -->
+
+ </table>
+
+</body>
+</html>
diff --git a/templates/cgi-error-parse b/templates/cgi-error-parse
new file mode 100644
index 00000000..0b636543
--- /dev/null
+++ b/templates/cgi-error-parse
@@ -0,0 +1,180 @@
+##########################################################
+#
+# No-Such-Domain Error Output template for junkbuster 2.9.x.
+#
+#
+# USING HTML TEMPLATES:
+# ---------------------
+#
+# Template files are written win plain HTML, with a few
+# additions:
+#
+# - Lines that start with a '#' character like this one
+# are ignored
+#
+# - Each item in the below list of exported symbols will
+# be replaced by dynamically generated text, if they
+# are enclosed in '@'-characters. E.g. The string @version@
+# will be replaced by the version number of Junkbuster.
+#
+# - One special application of this is to make whole blocks
+# of the HTML template disappear if the condition <name>
+# is not given. Simply enclose the block between the two
+# strings @if-<name>start and if-<name>-end@. The strings
+# should be placed in HTML comments (<!-- -->), so the
+# html structure won't be messed when the magic happens.
+#
+# USABLE SYMBOLS IN THIS TEMPLATE:
+# --------------------------------
+#
+# my-ip-addr:
+# The IP-address that the client used to reach this proxy
+# my-hostname:
+# The hostname associated with my-ip-addr
+# admin-address:
+# The email address of the pxoxy's administrator, as configured
+# in the config file
+# default-cgi:
+# The URL for the "main menu" builtin CGI of this proxy
+# menu:
+# List of <li> elements linking to the other available CGIs
+# version:
+# The version number of the proxy software
+# code-status:
+# The development status of the proxy software: "alpha", "beta",
+# or "stable".
+# homepage:
+# The URL of the SourceForge ijbswa project, who maintains this
+# software.
+#
+# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
+# ------------------------------------------------------------------
+#
+# unstable:
+# this is an alpha or beta release of the proxy software
+# have-adminaddr-info:
+# An e-mail address for the local Junkbuster adminstrator has
+# been specified and is available through the "admin-address"
+# symbol
+# have-proxy-info:
+# A URL for online documentation about this proxy has been
+# specified and is available through the "proxy-info-url"
+# symbol
+# have-help-info:
+# If either have-proxy-info is true or have-adminaddr-info is
+# true, have-help-info is true. Used to conditionally include
+# a grey box for any and all help info.
+#
+<html>
+
+<head>
+ <title>JunkBuster: Parse error</title>
+ <style type="text/css">
+ BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
+ </style>
+</head>
+
+<body bgcolor="#ffffff">
+
+ <table cellpadding=20 cellspacing=10 border=0 width=100%>
+ <tr>
+ <td bgcolor=#dddddd width=100%>
+ <p><font size=+2><b>This is the Internet J</b></font><font size=+1><b>UNK<i></font><font color="red">BUSTER</font></i></b>
+ <font size=+2><b>@version@ on @my-hostname@ (@my-ip-address@), port @my-port@</b></font></p>
+ </td>
+ </tr>
+
+<!-- @if-unstable-start -->
+# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
+ <tr>
+ <td bgcolor=#ffdddd>
+ <p><b>Please note that this <font color=red>@code-status@</font> release
+ of the proxy software is not intended for production systems!
+ <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
+ </p>
+
+ <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
+ with any problems you encounter.
+ </p>
+ </td>
+ </tr>
+<!-- if-unstable-end@ -->
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>Parse error</h2>
+ <blockquote>
+ <p>The file you're trying to edit is not valid. You need to fix
+ it using a text editor before you can edit it using the
+ web-based editor.</p>
+ <p>This error should only occur if you edited the file using a text
+ editor. If you managed to take a valid file and break it this
+ badly using the web-based editor, please file a bug report!</p>
+ <p>When you've fixed the problem, you can go back into the edit
+ interface using the menu below, or by clicking <a
+ href="http://ijbswa.sourceforge.net/config/edit-actions-list?filename=@filename@"
+ >here</a>.</p>
+ </blockquote>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>Problem description:</h2>
+ <p>@parse-error@</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>The line which caused the problem:</h2>
+ <pre>@line-raw@</pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>The line which caused the problem, with comments removed</h2>
+ <p><code>@line-data@</code></p>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>Note</h2>
+ <p>Only the first error is reported - the file may contain other
+ errors, as well as the one reported above.</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>More Junkbuster:</h2>
+ <ul>@menu@</ul>
+ </td>
+ </tr>
+
+<!-- @if-have-help-info-start -->
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>Local Junkbuster support:</h2>
+
+<!-- @if-have-proxy-info-start -->
+ <p>You can consult the <a href="@proxy-info-url@">online documentation</a> for more information about this Junkbuster installation.
+<!-- if-have-proxy-info-end@ -->
+
+<!-- @if-have-adminaddr-info-start -->
+ <p>Address e-mail questions about this service to
+ <a href=mailto:@admin-address@><code>@admin-address@</code></a>,
+ who will be glad to help you.
+<!-- if-have-adminaddr-info-end@ -->
+
+ </p>
+ </td>
+ </tr>
+<!-- if-have-help-info-end@ -->
+
+ </table>
+
+</body>
+</html>
diff --git a/templates/edit-actions-for-url b/templates/edit-actions-for-url
index a2b98f8f..e0859389 100644
--- a/templates/edit-actions-for-url
+++ b/templates/edit-actions-for-url
@@ -71,6 +71,7 @@ function disable_unless(target, checkbox)
<p> </p>
<form method="GET" action="http://i.j.b/edit-actions-submit" id="myform">
<input type="hidden" name="filename" value="@filename@">
+ <input type="hidden" name="ver" value="@ver@">
<input type="hidden" name="section" value="@section@">
<table border="0" width="100%" cellspacing="0">
<tr align="left">
diff --git a/templates/edit-actions-list b/templates/edit-actions-list
index ff6ebd73..846af133 100644
--- a/templates/edit-actions-list
+++ b/templates/edit-actions-list
@@ -22,29 +22,58 @@ td.action { font-weight: bold; font-style: italic }
<script type="text/javascript">
<!--
+function not_yet()
+{
+ window.alert("The feature you are trying to use has not been implemented yet.");
+}
+
function edit_pattern(b,p,ct)
{
ct=unescape(ct);
- nt=window.prompt("Edit this URL pattern:",ct);
- if ((nt!=null)&&(nt!=ct)&&(nt!=""))
- { window.location.href="http://i.j.b/edit-actions-url?filename=@filename@&filename=@filename@§ion="+b+"&pattern="+p+"&newval="+escape(nt)+"#s"+b+"url"+p; }
+ nt=window.prompt("Edit this URL pattern:",ct);
+ if ((nt!=null)&&(nt!=ct)&&(nt!=""))
+ { window.location.href="http://i.j.b/edit-actions-url?filename=@filename@&ver=@ver@§ion="+b+"&pattern="+p+"&newval="+escape(nt)+"#s"+b+"url"+p; }
+}
+
+function remove_pattern(b,p,ct)
+{
+ if (window.confirm("Are you sure you want to delete this URL pattern?\nPattern is: "+unescape(ct)))
+ { window.location.href="http://i.j.b/edit-actions-remove-url?filename=@filename@&ver=@ver@§ion="+b+"&pattern="+p+"#s"+b+"urls"; }
}
function add_pattern(b)
{
- nt=window.prompt("Enter URL pattern to add:", "");
- if ((nt!=null)&&(nt!=""))
- { window.location.href="http://i.j.b/edit-actions-add-url?filename=@filename@§ion="+b+"&newval="+escape(nt)+"#s"+b+"urls"; }
+ nt=window.prompt("Enter URL pattern to add:", "");
+ if ((nt!=null)&&(nt!=""))
+ { window.location.href="http://i.j.b/edit-actions-add-url?filename=@filename@&ver=@ver@§ion="+b+"&newval="+escape(nt)+"#s"+b+"urls"; }
}
function edit_actions(b)
{
- window.location.href="http://i.j.b/edit-actions-for-url?filename=@filename@§ion="+b;
+ window.location.href="http://i.j.b/edit-actions-for-url?filename=@filename@&ver=@ver@§ion="+b;
}
-function not_yet()
+function section_down(b)
+{
+ not_yet();
+ //window.location.href="http://i.j.b/edit-actions-section-down?filename=@filename@&ver=@ver@§ion="+b+"#s"+b+"urls";
+}
+
+function section_up(b)
+{
+ not_yet();
+ //window.location.href="http://i.j.b/edit-actions-section-up?filename=@filename@&ver=@ver@§ion="+b+"#s"+b+"urls";
+}
+
+function section_add(b)
{
- window.alert("The feature you are trying to use has not been implemented yet.");
+ window.location.href="http://i.j.b/edit-actions-section-add?filename=@filename@&ver=@ver@§ion="+b+"#s"+b+"urls";
+}
+
+function section_remove(b)
+{
+ if (window.confirm("Are you REALLY sure you want to delete this empty section?"))
+ window.location.href="http://i.j.b/edit-actions-section-remove?filename=@filename@&ver=@ver@§ion="+b+"#s"+b+"urls";
}
//-->
</script>
@@ -53,6 +82,12 @@ function not_yet()
<body>
<h1>Editing @filename@.action</h1>
+<p>
+<form action="http://i.j.b/">
+<input type="button" onclick="section_add(0)" value="Insert new section at top">
+</form>
+</p>
+
@sections@
</body>
diff --git a/templates/edit-actions-list-section b/templates/edit-actions-list-section
index d624902e..8a05856a 100644
--- a/templates/edit-actions-list-section
+++ b/templates/edit-actions-list-section
@@ -28,16 +28,17 @@
<td colspan="2">
<table border="0" cellspacing="0" cellpadding="4">
<tr valign="middle" align="center">
- <td> <input type="button" onclick="not_yet()"
+ <td> <input type="button" onclick="section_up(@sectionid@)"
value="Move section up"> </td>
- <td> <input type="button" onclick="not_yet()"
- value="Split section"> </td>
+ <td> <input type="button" onclick="section_add(@sectionid@)"
+ value="Insert new section below"> </td>
</tr>
<tr valign="middle" align="center">
- <td> <input type="button" onclick="not_yet()"
+ <td> <input type="button" onclick="section_down(@sectionid@)"
value="Move section down"> </td>
- <td> <input type="button" onclick="not_yet()"
- value="Merge with next"> </td>
+ <td><!-- @if-empty-section-start --> <input
+ type="button" onclick="section_remove(@sectionid@)" value="Delete whole section"
+ > <!-- if-empty-section-end@ --> </td>
</tr>
</table>
</td>
diff --git a/templates/edit-actions-list-url b/templates/edit-actions-list-url
index 57b4bdba..55493252 100644
--- a/templates/edit-actions-list-url
+++ b/templates/edit-actions-list-url
@@ -1,8 +1,9 @@
<tr class="url@url-1-2@" valign="top">
<td align="left"> </td>
- <td align="center"><a name="s@sectionid@url@urlid@"></a><input type="button"
- onclick="edit_pattern(@sectionid@,@urlid@,'@url@');"
- value="Edit"></td>
+ <td align="center"><nobr><a name="s@sectionid@url@urlid@"></a><input
+ type="button" onclick="remove_pattern(@sectionid@,@urlid@,'@url@');" value="Remove">
+ <input type="button" onclick="edit_pattern(@sectionid@,@urlid@,'@url@');" value="Edit"
+ ></nobr></td>
<td class="url" align="left">@url@</td>
</tr>
diff --git a/templates/toggle b/templates/toggle
new file mode 100644
index 00000000..41cecad5
--- /dev/null
+++ b/templates/toggle
@@ -0,0 +1,186 @@
+##########################################################
+#
+# Toggle Output template for junkbuster 2.9.x.
+#
+#
+# USING HTML TEMPLATES:
+# ---------------------
+#
+# Template files are written win plain HTML, with a few
+# additions:
+#
+# - Lines that start with a '#' character like this one
+# are ignored
+#
+# - Each item in the below list of exported symbols will
+# be replaced by dynamically generated text, if they
+# are enclosed in '@'-characters. E.g. The string @version@
+# will be replaced by the version number of Junkbuster.
+#
+# - One special application of this is to make whole blocks
+# of the HTML template disappear if the condition <name>
+# is not given. Simply enclose the block between the two
+# strings @if-<name>start and if-<name>-end@. The strings
+# should be placed in HTML comments (<!-- -->), so the
+# html structure won't be messed when the magic happens.
+#
+# USABLE SYMBOLS IN THIS TEMPLATE:
+# --------------------------------
+#
+# my-ip-addr:
+# The IP-address that the client used to reach this proxy
+# my-hostname:
+# The hostname associated with my-ip-addr
+# admin-address:
+# The email address of the pxoxy's administrator, as configured
+# in the config file
+# default-cgi:
+# The URL for the "main menu" builtin CGI of this proxy
+# menu:
+# List of <li> elements linking to the other available CGIs
+# version:
+# The version number of the proxy software
+# code-status:
+# The development status of the proxy software: "alpha", "beta",
+# or "stable".
+# homepage:
+# The URL of the SourceForge ijbswa project, who maintains this
+# software.
+#
+# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
+# ------------------------------------------------------------------
+#
+# unstable:
+# this is an alpha or beta release of the proxy software
+# have-adminaddr-info:
+# An e-mail address for the local Junkbuster adminstrator has
+# been specified and is available through the "admin-address"
+# symbol
+# have-proxy-info:
+# A URL for online documentation about this proxy has been
+# specified and is available through the "proxy-info-url"
+# symbol
+# have-help-info:
+# If either have-proxy-info is true or have-adminaddr-info is
+# true, have-help-info is true. Used to conditionally include
+# a grey box for any and all help info.
+# @if-enabled-then@ on @else-not-enabled@ off @endif-enabled@
+#
+<html>
+
+<head>
+
+ <title>@if-enabled-then@Enabled@else-not-enabled@Disabled@endif-enabled@ - JunkBuster@@my-hostname@</title>
+ <style type="text/css">
+ BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
+ </style>
+</head>
+
+<body bgcolor="#ffffff">
+
+ <table cellpadding=20 cellspacing=10 border=0 width=100%>
+ <tr>
+ <td bgcolor=#dddddd width=100%>
+ <p><font size=+2><b>This is the Internet J</b></font><font size=+1><b>UNK<i></font><font color="red">BUSTER</font></i></b>
+ <font size=+2><b>@version@ on @my-hostname@ (@my-ip-address@), port @my-port@</b></font></p>
+ </td>
+ </tr>
+
+<!-- @if-unstable-start -->
+# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
+ <tr>
+ <td bgcolor=#ffdddd>
+ <p><b>Please note that this <font color=red>@code-status@</font> release
+ of the proxy software is not intended for production systems!
+ <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
+ </p>
+
+ <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
+ with any problems you encounter.
+ </p>
+ </td>
+ </tr>
+<!-- if-unstable-end@ -->
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>JunkBuster is @if-enabled-then@Enabled@else-not-enabled@Disabled@endif-enabled@</h2>
+ <blockquote>
+ <p>When enabled, JunkBuster performs it's magic - blocking
+ adverts, filtering cookies, regex-filtering, etc.</p>
+ <p>When disabled, JunkBuster behaves as a normal HTTP proxy,
+ and will not affect your web browsing.</p>
+ <p><a href="@default-cgi@/toggle?set=@if-enabled-then@disable@else-not-enabled@enable@endif-enabled@">Click
+ here</a> to @if-enabled-then@disable@else-not-enabled@enable@endif-enabled@ JunkBuster.</p>
+ </blockquote>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>Bookmarklets</h2>
+ <blockquote>
+ <p>Here are some bookmarklets to allow you to easily access a
+ "mini" version of this page. They are designed for MS
+ Internet Explorer, but should work equally well in
+ Netscape, Mozilla, and other browsers which support
+ JavaScript. They are designed to run directly from
+ your bookmarks - <b>not</b> by clicking the links
+ below (although that will work for testing).</p>
+
+ <p>To save them, right-click the link and choose
+ "Add to Favorites" (IE) or "Add Bookmark" (Netscape). You
+ will get a warning that the bookmark "may not be safe" - just
+ click OK. Then you can run the Bookmarklet directly from your
+ favourites/bookmarks. For even faster access, you can put
+ them on the "Links" bar (IE) or the "Personal Toolbar"
+ (Netscape), and run them with a single click.</p>
+
+ <ul>
+ <li><a href="javascript:void(window.open('@default-cgi@/toggle?mini=y&set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Enable JunkBuster</a></li>
+ <li><a href="javascript:void(window.open('@default-cgi@/toggle?mini=y&set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Disable JunkBuster</a></li>
+ <li><a href="javascript:void(window.open('@default-cgi@/toggle?mini=y&set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Toggle JunkBuster</a>
+ (Toggles between enabled and disabled)</li>
+ <li><a href="javascript:void(window.open('@default-cgi@/toggle?mini=y','ijbstatus','width=250,height=2,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">View JunkBuster Status</a></li>
+ </ul>
+
+ <p><b>Credit:</b> The site which gave me the general idea for these
+ bookmarklets is
+ <a href="http://www.bookmarklets.com/">www.bookmarklets.com</a>.
+ They have more information
+ <a href="http://www.bookmarklets.com/about/">about bookmarklets</a>.</p>
+ </blockquote>
+ </td>
+ </tr>
+
+ <tr>
+ <td bgcolor=#eeeeee>
+ <h2>More Junkbuster:</h2>
+ <ul>@menu@</ul>
+ </td>
+ </tr>
+
+<!-- @if-have-help-info-start -->
+ <tr>
+ <td bgcolor=#dddddd>
+ <h2>Local Junkbuster support:</h2>
+
+<!-- @if-have-proxy-info-start -->
+ <p>You can consult the <a href="@proxy-info-url@">online documentation</a> for more information about this Junkbuster installation.
+<!-- if-have-proxy-info-end@ -->
+
+<!-- @if-have-adminaddr-info-start -->
+ <p>Address e-mail questions about this service to
+ <a href=mailto:@admin-address@><code>@admin-address@</code></a>,
+ who will be glad to help you.
+<!-- if-have-adminaddr-info-end@ -->
+
+ </p>
+ </td>
+ </tr>
+<!-- if-have-help-info-end@ -->
+
+ </table>
+
+</body>
+</html>
diff --git a/templates/toggle-mini b/templates/toggle-mini
new file mode 100644
index 00000000..f2156bf2
--- /dev/null
+++ b/templates/toggle-mini
@@ -0,0 +1,90 @@
+##########################################################
+#
+# Toggle Output template for junkbuster 2.9.x.
+#
+#
+# USING HTML TEMPLATES:
+# ---------------------
+#
+# Template files are written win plain HTML, with a few
+# additions:
+#
+# - Lines that start with a '#' character like this one
+# are ignored
+#
+# - Each item in the below list of exported symbols will
+# be replaced by dynamically generated text, if they
+# are enclosed in '@'-characters. E.g. The string @version@
+# will be replaced by the version number of Junkbuster.
+#
+# - One special application of this is to make whole blocks
+# of the HTML template disappear if the condition <name>
+# is not given. Simply enclose the block between the two
+# strings @if-<name>start and if-<name>-end@. The strings
+# should be placed in HTML comments (<!-- -->), so the
+# html structure won't be messed when the magic happens.
+#
+# USABLE SYMBOLS IN THIS TEMPLATE:
+# --------------------------------
+#
+# my-ip-addr:
+# The IP-address that the client used to reach this proxy
+# my-hostname:
+# The hostname associated with my-ip-addr
+# admin-address:
+# The email address of the pxoxy's administrator, as configured
+# in the config file
+# default-cgi:
+# The URL for the "main menu" builtin CGI of this proxy
+# menu:
+# List of <li> elements linking to the other available CGIs
+# version:
+# The version number of the proxy software
+# code-status:
+# The development status of the proxy software: "alpha", "beta",
+# or "stable".
+# homepage:
+# The URL of the SourceForge ijbswa project, who maintains this
+# software.
+#
+# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
+# ------------------------------------------------------------------
+#
+# unstable:
+# this is an alpha or beta release of the proxy software
+# have-adminaddr-info:
+# An e-mail address for the local Junkbuster adminstrator has
+# been specified and is available through the "admin-address"
+# symbol
+# have-proxy-info:
+# A URL for online documentation about this proxy has been
+# specified and is available through the "proxy-info-url"
+# symbol
+# have-help-info:
+# If either have-proxy-info is true or have-adminaddr-info is
+# true, have-help-info is true. Used to conditionally include
+# a grey box for any and all help info.
+# @if-enabled-then@ on @else-not-enabled@ off @endif-enabled@
+#
+<html>
+
+<head>
+
+ <title>@if-enabled-then@Enabled@else-not-enabled@Disabled@endif-enabled@ - JunkBuster@@my-hostname@</title>
+ <style type="text/css">
+ BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
+ </style>
+</head>
+
+<body bgcolor="#eeeeee" marginwidth="3" marginheight="3"
+leftmargin="3" rightmargin="3" topmargin="3" bottommargin="3">
+<center>
+<a href="@default-cgi@/" target="_blank">JunkBuster</a> is
+<b>@if-enabled-then@Enabled@else-not-enabled@Disabled@endif-enabled@</b>.
+<a href="@default-cgi@/toggle?mini=y&set=@if-enabled-then@disable@else-not-enabled@enable@endif-enabled@"
+>@if-enabled-then@[Disable]@else-not-enabled@[Enable]@endif-enabled@</a>
+<br>
+<a href="" onclick="window.close();">[Close]</a>
+</center>
+</body>
+</html>