-const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.4 2001/10/23 21:48:19 jongfoster Exp $";
+const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.14 2002/03/05 00:24:51 jongfoster Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $
*
* Purpose : CGI-based actionsfile editor.
*
- * Functions declared include:
+ * Functions declared include: cgi_edit_*
*
+ * NOTE: The CGIs in this file use parameter names
+ * such as "f" and "s" which are really *BAD* choices.
+ * However, I'm trying to save bytes in the
+ * edit-actions-list HTML page - the standard actions
+ * file generated a 550kbyte page, which is ridiculous.
+ *
+ * Stick to the short names in this file for consistency.
*
* Copyright : Written by and Copyright (C) 2001 the SourceForge
* IJBSWA team. http://ijbswa.sourceforge.net
*
* Revisions :
* $Log: cgiedit.c,v $
+ * Revision 1.14 2002/03/05 00:24:51 jongfoster
+ * Patch to always edit the current actions file.
+ *
+ * Revision 1.13 2002/03/04 02:07:59 david__schmidt
+ * Enable web editing of actions file on OS/2 (it had been broken all this time!)
+ *
+ * Revision 1.12 2002/03/03 09:18:03 joergs
+ * Made jumbjuster work on AmigaOS again.
+ *
+ * Revision 1.11 2002/01/23 01:03:31 jongfoster
+ * Fixing gcc [CygWin] compiler warnings
+ *
+ * Revision 1.10 2002/01/23 00:22:59 jongfoster
+ * Adding new function cgi_edit_actions_section_swap(), to reorder
+ * the actions file.
+ *
+ * Adding get_url_spec_param() to get a validated URL pattern.
+ *
+ * Moving edit_read_line() out of this file and into loaders.c.
+ *
+ * Adding missing html_encode() to many CGI functions.
+ *
+ * Moving the functions that #include actionlist.h to the end of the file,
+ * because the Visual C++ 97 debugger gets extremely confused if you try
+ * to debug any code that comes after them in the file.
+ *
+ * Major optimizations in cgi_edit_actions_list() to reduce the size of
+ * the generated HTML (down 40% from 550k to 304k), with major side-effects
+ * throughout the editor and templates. In particular, the length of the
+ * URLs throughout the editor has been drastically reduced, by cutting
+ * paramater names down to 1 character and CGI names down to 3-4
+ * characters, by removing all non-essential CGI paramaters even at the
+ * expense of having to re-read the actions file for the most trivial
+ * page, and by using relative rather than absolute URLs. This means
+ * that this (typical example):
+ *
+ * <a href="http://ijbswa.sourceforge.net/config/edit-actions-url-form?
+ * filename=ijb&ver=1011487572&section=12&pattern=13
+ * &oldval=www.oesterhelt.org%2Fdeanimate-demo">
+ *
+ * is now this:
+ *
+ * <a href="eau?f=ijb&v=1011487572&p=13">
+ *
+ * Revision 1.9 2002/01/17 20:56:22 jongfoster
+ * Replacing hard references to the URL of the config interface
+ * with #defines from project.h
+ *
+ * Revision 1.8 2001/11/30 23:35:51 jongfoster
+ * Renaming actionsfile to ijb.action
+ *
+ * Revision 1.7 2001/11/13 00:28:24 jongfoster
+ * - Renaming parameters from edit-actions-for-url so that they only
+ * contain legal JavaScript characters. If we wanted to write
+ * JavaScript that worked with Netscape 4, this is nessacery.
+ * (Note that at the moment the JavaScript doesn't actually work
+ * with Netscape 4, but now this is purely a template issue, not
+ * one affecting code).
+ * - Adding new CGIs for use by non-JavaScript browsers:
+ * edit-actions-url-form
+ * edit-actions-add-url-form
+ * edit-actions-remove-url-form
+ * - Fixing || bug.
+ *
+ * Revision 1.6 2001/10/29 03:48:09 david__schmidt
+ * OS/2 native needed a snprintf() routine. Added one to miscutil, brackedted
+ * by and __OS2__ ifdef.
+ *
+ * Revision 1.5 2001/10/25 03:40:48 david__schmidt
+ * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
+ * threads to call select() simultaneously. So, it's time to do a real, live,
+ * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
+ * (native). Both versions will work, but using __OS2__ offers multi-threading.
+ *
* Revision 1.4 2001/10/23 21:48:19 jongfoster
* Cleaning up error handling in CGI functions - they now send back
* a HTML error page and should never cause a FATAL error. (Fixes one
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
-#include <stdlib.h>
#include <ctype.h>
#include <string.h>
#include <assert.h>
#define snprintf _snprintf
#endif /* def _WIN32 */
-#ifdef __OS2__
-/*
- * FIXME: gotta write a snprintf routine. snprintf. You guys kill me.
- */
-#define snprintf(X,Y,Z) sprintf(X,Z)
-#endif /* __OS2__ */
-
#include "project.h"
#include "cgi.h"
#include "cgiedit.h"
#include "actions.h"
#include "miscutil.h"
#include "errlog.h"
+#include "loaders.h"
#include "loadcfg.h"
/* loadcfg.h is for g_bToggleIJB only */
+#include "urlmatch.h"
const char cgiedit_h_rcs[] = CGIEDIT_H_VERSION;
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. */
+ /* Pre-encoded with url_encode() for ease of use. */
const char * version_str; /* Last modification time, as a string. For CGI param */
+ /* Can be used in URL without using url_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
* This may lose the top few bits, but they're not
* significant anyway.
*/
+ int newline; /* Newline convention - one of the NEWLINE_xxx constants.
+ * Note that changing this after the file has been
+ * read in will cause a mess.
+ */
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) */
jb_err cgi_error_file(struct client_state *csp,
struct http_response *rsp,
const char *filename);
+jb_err cgi_error_disabled(struct client_state *csp,
+ struct http_response *rsp);
/* Internal arbitrary config file support functions */
-static jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile);
+static jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile, int *newline);
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);
const struct map *parameters,
char *name,
unsigned *pvalue);
+static jb_err get_url_spec_param(struct client_state *csp,
+ const struct map *parameters,
+ const char *name,
+ char **pvalue);
/* Internal actionsfile <==> HTML conversion functions */
static jb_err map_radio(struct map * exports,
struct action_spec *action);
+static jb_err map_copy_parameter_html(struct map *out,
+ const struct map *in,
+ const char *name);
+#if 0 /* unused function */
+static jb_err map_copy_parameter_url(struct map *out,
+ const struct map *in,
+ const char *name);
+#endif /* unused function */
+
/*********************************************************************
*
- * Function : simple_read_line
- *
- * Description : Read a single line from a file and return it.
- * This is basically a version of fgets() that malloc()s
- * it's own line buffer. Note that the buffer will
- * always be a multiple of BUFFER_SIZE bytes long.
- * Therefore if you are going to keep the string for
- * an extended period of time, you should probably
- * strdup() it and free() the original, to save memory.
+ * Function : map_copy_parameter_html
*
+ * Description : Copy a CGI parameter from one map to another, HTML
+ * encoding it.
*
* Parameters :
- * 1 : dest = destination for newly malloc'd pointer to
- * line data. Will be set to NULL on error.
- * 2 : fp = File to read from
+ * 1 : out = target map
+ * 2 : in = source map
+ * 3 : name = name of cgi parameter to copy
*
- * Returns : JB_ERR_OK on success
+ * Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
- * JB_ERR_FILE on EOF.
+ * JB_ERR_CGI_PARAMS if the parameter doesn't exist
+ * in the source map
*
*********************************************************************/
-static jb_err simple_read_line(char **dest, FILE *fp)
+static jb_err map_copy_parameter_html(struct map *out,
+ const struct map *in,
+ const char *name)
{
- int len;
- char * buf;
- char * newbuf;
+ const char * value;
+ jb_err err;
- assert(fp);
- assert(dest);
+ assert(out);
+ assert(in);
+ assert(name);
- *dest = NULL;
+ value = lookup(in, name);
+ err = map(out, name, 1, html_encode(value), 0);
- if (NULL == (buf = malloc(BUFFER_SIZE)))
+ if (err)
{
- return JB_ERR_MEMORY;
+ /* Out of memory */
+ return err;
}
-
- *buf = '\0';
- len = 0;
-
- while (FOREVER)
+ else if (*value == '\0')
{
- newbuf = buf + len;
- if ((!fgets(newbuf, BUFFER_SIZE, fp)) || (*newbuf == '\0'))
- {
- /* (*newbuf == '\0') should never happen unless fgets fails */
- if (*buf == '\0')
- {
- free(buf);
- return JB_ERR_FILE;
- }
- else
- {
- *dest = buf;
- return JB_ERR_OK;
- }
- }
- len = strlen(buf);
- if ((buf[len - 1] == '\n') || (buf[len - 1] == '\r'))
- {
- *dest = buf;
- return JB_ERR_OK;
- }
-
- if (NULL == (newbuf = realloc(buf, len + BUFFER_SIZE)))
- {
- free(buf);
- return JB_ERR_MEMORY;
- }
- buf = newbuf;
+ return JB_ERR_CGI_PARAMS;
+ }
+ else
+ {
+ return JB_ERR_OK;
}
}
+#if 0 /* unused function */
/*********************************************************************
*
- * Function : edit_read_line
- *
- * Description : Read a single non-empty line from a file and return
- * it. Trims comments, leading and trailing whitespace
- * and respects escaping of newline and comment char.
- * Provides the line in 2 alternative forms: raw and
- * preprocessed.
- * - raw is the raw data read from the file. If the
- * line is not modified, then this should be written
- * to the new file.
- * - prefix is any comments and blank lines that were
- * read from the file. If the line is modified, then
- * this should be written out to the file followed
- * by the modified data. (If this string is non-empty
- * then it will have a newline at the end).
- * - data is the actual data that will be parsed
- * further by appropriate routines.
- * On EOF, the 3 strings will all be set to NULL and
- * 0 will be returned.
+ * Function : map_copy_parameter_html
+ *
+ * Description : Copy a CGI parameter from one map to another, URL
+ * encoding it.
*
* Parameters :
- * 1 : fp = File to read from
- * 2 : raw_out = destination for newly malloc'd pointer to
- * raw line data. May be NULL if you don't want it.
- * 3 : prefix_out = destination for newly malloc'd pointer to
- * comments. May be NULL if you don't want it.
- * 4 : data_out = destination for newly malloc'd pointer to
- * line data with comments and leading/trailing spaces
- * removed, and line continuation performed. May be
- * NULL if you don't want it.
+ * 1 : out = target map
+ * 2 : in = source map
+ * 3 : name = name of cgi parameter to copy
*
- * Returns : JB_ERR_OK on success
+ * Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
- * JB_ERR_FILE on EOF.
+ * JB_ERR_CGI_PARAMS if the parameter doesn't exist
+ * in the source map
*
*********************************************************************/
-static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out)
+static jb_err map_copy_parameter_url(struct map *out,
+ const struct map *in,
+ const char *name)
{
- char *p; /* Temporary pointer */
- char *linebuf; /* Line read from file */
- char *linestart; /* Start of linebuf, usually first non-whitespace char */
- char newline[3]; /* Used to store the newline - "\n", "\r", or "\r\n" */
- int contflag = 0; /* Nonzero for line continuation - i.e. line ends '\' */
- 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 */
- jb_err rval = JB_ERR_OK;
+ const char * value;
+ jb_err err;
- assert(fp);
+ assert(out);
+ assert(in);
+ assert(name);
- /* Set output parameters to NULL */
- if (raw_out)
+ value = lookup(in, name);
+ err = map(out, name, 1, url_encode(value), 0);
+
+ if (err)
{
- *raw_out = NULL;
+ /* Out of memory */
+ return err;
}
- if (prefix_out)
+ else if (*value == '\0')
{
- *prefix_out = NULL;
+ return JB_ERR_CGI_PARAMS;
}
- if (data_out)
+ else
{
- *data_out = NULL;
+ return JB_ERR_OK;
}
+}
+#endif /* 0 - unused function */
- /* Set string variables to new, empty strings. */
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_url_form
+ *
+ * Description : CGI function that displays a form for
+ * edit-actions-url
+ *
+ * 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
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * p : (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_url_form(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ struct map * exports;
+ unsigned patternid;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ unsigned line_number;
+ jb_err err;
- raw = malloc(1);
- prefix = malloc(1);
- data = malloc(1);
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
- if ((raw == NULL) || (prefix == NULL) || (data == NULL))
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
{
- freez(raw);
- freez(prefix);
- freez(data);
- return JB_ERR_MEMORY;
+ return cgi_error_disabled(csp, rsp);
}
- *raw = '\0';
- *prefix = '\0';
- *data = '\0';
-
- /* Main loop. Loop while we need more data & it's not EOF. */
-
- while ( (contflag || (*data == '\0'))
- && (JB_ERR_OK == (rval = simple_read_line(&linebuf, fp))))
+ err = get_number_param(csp, parameters, "p", &patternid);
+ if (err)
{
- if (string_append(&raw,linebuf))
- {
- free(prefix);
- free(data);
- free(linebuf);
- return JB_ERR_MEMORY;
- }
+ return err;
+ }
- /* Trim off newline */
- p = linebuf + strlen(linebuf);
- if ((p != linebuf) && ((p[-1] == '\r') || (p[-1] == '\n')))
- {
- p--;
- if ((p != linebuf) && ((p[-1] == '\r') || (p[-1] == '\n')))
- {
- p--;
- }
- }
- strcpy(newline, p);
- *p = '\0';
+ 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 continuation? Trim escape and set flag. */
- contflag = ((p != linebuf) && (*--p == '\\'));
- if (contflag)
- {
- *p = '\0';
- }
+ cur_line = file->lines;
- /* Trim leading spaces if we're at the start of the line */
- linestart = linebuf;
- if (*data == '\0')
- {
- /* Trim leading spaces */
- while (*linestart && isspace((int)(unsigned char)*linestart))
- {
- linestart++;
- }
- }
+ for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++)
+ {
+ cur_line = cur_line->next;
+ }
- /* Handle comment characters. */
- p = linestart;
- while ((p = strchr(p, '#')) != NULL)
- {
- /* Found a comment char.. */
- if ((p != linebuf) && (*(p-1) == '\\'))
- {
- /* ..and it's escaped, left-shift the line over the escape. */
- char *q = p - 1;
- while ((*q = *(q + 1)) != '\0')
- {
- q++;
- }
- /* Now scan from just after the "#". */
- }
- else
- {
- /* Real comment. Save it... */
- if (p == linestart)
- {
- /* Special case: Line only contains a comment, so all the
- * previous whitespace is considered part of the comment.
- * Undo the whitespace skipping, if any.
- */
- linestart = linebuf;
- p = linestart;
- }
- string_append(&prefix,p);
- if (string_append(&prefix,newline))
- {
- free(raw);
- free(data);
- free(linebuf);
- return JB_ERR_MEMORY;
- }
- *newline = '\0';
+ if ( (cur_line == NULL)
+ || (line_number != patternid)
+ || (patternid < 1)
+ || (cur_line->type != FILE_LINE_URL))
+ {
+ /* Invalid "patternid" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
- /* ... and chop off the rest of the line */
- *p = '\0';
- }
- } /* END while (there's a # character) */
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ edit_free_file(file);
+ return JB_ERR_MEMORY;
+ }
- /* Write to the buffer */
- if (*linestart)
- {
- if (string_append(&data, linestart))
- {
- free(raw);
- free(prefix);
- free(linebuf);
- return JB_ERR_MEMORY;
- }
- }
+ err = map(exports, "f", 1, file->identifier, 1);
+ if (!err) err = map(exports, "v", 1, file->version_str, 1);
+ if (!err) err = map(exports, "p", 1, url_encode(lookup(parameters, "p")), 0);
+ if (!err) err = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0);
- free(linebuf);
- } /* END while(we need more data) */
+ edit_free_file(file);
- /* Handle simple_read_line() errors - ignore EOF */
- if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE))
+ if (err)
{
- free(raw);
- free(prefix);
- free(data);
- return rval;
+ free_map(exports);
+ return err;
}
+ return template_fill_for_cgi(csp, "edit-actions-url-form", exports, rsp);
+}
- if (*raw)
- {
- /* Got at least some data */
- /* Remove trailing whitespace */
- chomp(data);
+/*********************************************************************
+ *
+ * Function : cgi_edit_actions_add_url_form
+ *
+ * Description : CGI function that displays a form for
+ * edit-actions-url
+ *
+ * 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 :
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * s : (section) Line number of section 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_add_url_form(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ struct map *exports;
+ jb_err err;
- if (raw_out)
- {
- *raw_out = raw;
- }
- else
- {
- free(raw);
- }
- if (prefix_out)
- {
- *prefix_out = prefix;
- }
- else
- {
- free(prefix);
- }
- if (data_out)
- {
- *data_out = data;
- }
- else
- {
- free(data);
- }
- return JB_ERR_OK;
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+ {
+ return cgi_error_disabled(csp, rsp);
}
- else
+
+ if (NULL == (exports = default_exports(csp, NULL)))
{
- /* EOF and no data there. */
+ return JB_ERR_MEMORY;
+ }
- free(raw);
- free(prefix);
- free(data);
+ err = map_copy_parameter_html(exports, parameters, "f");
+ if (!err) err = map_copy_parameter_html(exports, parameters, "v");
+ if (!err) err = map_copy_parameter_html(exports, parameters, "s");
- return JB_ERR_FILE;
+ if (err)
+ {
+ free_map(exports);
+ return err;
}
+
+ return template_fill_for_cgi(csp, "edit-actions-add-url-form", exports, rsp);
}
/*********************************************************************
*
- * Function : edit_write_file
+ * Function : cgi_edit_actions_remove_url_form
*
- * Description : Write a complete file to disk.
+ * Description : CGI function that displays a form for
+ * edit-actions-url
*
* Parameters :
- * 1 : filename = File to write to.
- * 2 : file = Data structure to write.
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
*
- * Returns : JB_ERR_OK on success
- * JB_ERR_FILE on error writing to file.
- * JB_ERR_MEMORY on out of memory
+ * CGI Parameters :
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * p : (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 edit_write_file(struct editable_file * file)
+jb_err cgi_edit_actions_remove_url_form(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
{
- FILE * fp;
+ struct map * exports;
+ unsigned patternid;
+ struct editable_file * file;
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 */
+ unsigned line_number;
+ jb_err err;
- assert(file);
- assert(file->filename);
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
- if (NULL == (fp = fopen(file->filename, "wt")))
+ if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
{
- return JB_ERR_FILE;
+ return cgi_error_disabled(csp, rsp);
}
- cur_line = file->lines;
- while (cur_line != NULL)
+ err = get_number_param(csp, parameters, "p", &patternid);
+ if (err)
{
- if (cur_line->raw)
- {
+ 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 < patternid); line_number++)
+ {
+ cur_line = cur_line->next;
+ }
+
+ if ( (cur_line == NULL)
+ || (line_number != patternid)
+ || (patternid < 1)
+ || (cur_line->type != FILE_LINE_URL))
+ {
+ /* Invalid "patternid" 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, "f", 1, file->identifier, 1);
+ if (!err) err = map(exports, "v", 1, file->version_str, 1);
+ if (!err) err = map(exports, "s", 1, url_encode(lookup(parameters, "s")), 0);
+ if (!err) err = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0);
+
+ edit_free_file(file);
+
+ if (err)
+ {
+ free_map(exports);
+ return err;
+ }
+
+ return template_fill_for_cgi(csp, "edit-actions-remove-url-form", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : edit_write_file
+ *
+ * Description : Write a complete file to disk.
+ *
+ * Parameters :
+ * 1 : filename = File to write to.
+ * 2 : file = Data structure to write.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_FILE on error writing to file.
+ * JB_ERR_MEMORY on out of memory
+ *
+ *********************************************************************/
+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(file);
+ assert(file->filename);
+
+#if defined(AMIGA) || defined(__OS2__)
+ if (NULL == (fp = fopen(file->filename, "w")))
+#else
+ if (NULL == (fp = fopen(file->filename, "wt")))
+#endif /* def AMIGA */
+ {
+ return JB_ERR_FILE;
+ }
+
+ cur_line = file->lines;
+ while (cur_line != NULL)
+ {
+ if (cur_line->raw)
+ {
if (fputs(cur_line->raw, fp) < 0)
{
fclose(fp);
}
if (cur_line->unprocessed)
{
- if (fputs(cur_line->unprocessed, fp) < 0)
+ /* This should be a single line - sanity check. */
+ assert(NULL == strchr(cur_line->unprocessed, '\r'));
+ assert(NULL == strchr(cur_line->unprocessed, '\n'));
+
+ if (NULL != strchr(cur_line->unprocessed, '#'))
{
- fclose(fp);
- return JB_ERR_FILE;
+ /* Must quote '#' characters */
+ int numhash = 0;
+ int len;
+ char * src;
+ char * dest;
+ char * str;
+
+ /* Count number of # characters, so we know length of output string */
+ src = cur_line->unprocessed;
+ while (NULL != (src = strchr(src, '#')))
+ {
+ numhash++;
+ src++;
+ }
+ assert(numhash > 0);
+
+ /* Allocate new memory for string */
+ len = strlen(cur_line->unprocessed);
+ if (NULL == (str = malloc(len + 1 + numhash)))
+ {
+ /* Uh oh, just trashed file! */
+ fclose(fp);
+ return JB_ERR_MEMORY;
+ }
+
+ /* Loop through string from end */
+ src = cur_line->unprocessed + len;
+ dest = str + len + numhash;
+ for ( ; len >= 0; len--)
+ {
+ if ((*dest-- = *src--) == '#')
+ {
+ *dest-- = '\\';
+ numhash--;
+ assert(numhash >= 0);
+ }
+ }
+ assert(numhash == 0);
+ assert(src + 1 == cur_line->unprocessed);
+ assert(dest + 1 == str);
+
+ if (fputs(str, fp) < 0)
+ {
+ free(str);
+ fclose(fp);
+ return JB_ERR_FILE;
+ }
+
+ free(str);
+ }
+ else
+ {
+ /* Can write without quoting '#' characters. */
+ if (fputs(cur_line->unprocessed, fp) < 0)
+ {
+ fclose(fp);
+ return JB_ERR_FILE;
+ }
}
- if (fputs("\n", fp) < 0)
+ if (fputs(NEWLINE(file->newline), fp) < 0)
{
fclose(fp);
return JB_ERR_FILE;
* Description : Match an actions file {{header}} line
*
* Parameters :
- * 1 : line - String from file
- * 2 : name - Header to match against
+ * 1 : line = String from file
+ * 2 : name = Header to match against
*
* Returns : 0 iff they match.
*
* Description : Match an actions file {{header}} line
*
* Parameters :
- * 1 : line - String from file. Must not start with
+ * 1 : line = String from file. Must not start with
* whitespace (else infinite loop!)
- * 2 : name - Destination for name
- * 2 : name - Destination for value
+ * 2 : name = Destination for name
+ * 2 : name = Destination for value
*
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
* JB_ERR_MEMORY on out-of-memory
*
*********************************************************************/
-jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile)
+jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile, int *newline)
{
struct file_line * first_line; /* Keep for return value or to free */
struct file_line * cur_line; /* Current line */
cur_line->type = FILE_LINE_UNPROCESSED;
- rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed);
+ rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed, newline, NULL);
if (rval)
{
/* Out of memory or empty file. */
cur_line->type = FILE_LINE_UNPROCESSED;
- rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed);
+ rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed, newline, NULL);
if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE))
{
/* Out of memory */
unsigned version = 0;
struct stat statbuf[1];
char version_buf[22];
+ int newline = NEWLINE_UNKNOWN;
assert(csp);
assert(parameters);
*pfile = NULL;
- err = get_file_name_param(csp, parameters, "filename", suffix,
+ err = get_file_name_param(csp, parameters, "f", suffix,
&filename, &identifier);
if (err)
{
if (require_version)
{
unsigned specified_version;
- err = get_number_param(csp, parameters, "ver", &specified_version);
+ err = get_number_param(csp, parameters, "v", &specified_version);
if (err)
{
free(filename);
}
}
+#if defined(AMIGA) || defined(__OS2__)
+ if (NULL == (fp = fopen(filename,"r")))
+#else
if (NULL == (fp = fopen(filename,"rt")))
+#endif /* def AMIGA */
{
free(filename);
return JB_ERR_FILE;
}
- err = edit_read_file_lines(fp, &lines);
+ err = edit_read_file_lines(fp, &lines, &newline);
fclose(fp);
}
file->lines = lines;
+ file->newline = newline;
file->filename = filename;
file->version = version;
- file->identifier = strdup(identifier);
+ file->identifier = url_encode(identifier);
if (file->identifier == NULL)
{
/* Try to handle if possible */
if (err == JB_ERR_FILE)
{
- err = cgi_error_file(csp, rsp, lookup(parameters, "filename"));
+ err = cgi_error_file(csp, rsp, lookup(parameters, "f"));
}
else if (err == JB_ERR_MODIFIED)
{
- err = cgi_error_modified(csp, rsp, lookup(parameters, "filename"));
+ err = cgi_error_modified(csp, rsp, lookup(parameters, "f"));
}
if (err == JB_ERR_OK)
{
* 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
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : parameters = map of cgi parameters
+ * 3 : param_name = The name of the parameter to read
+ * 4 : suffix = File extension, e.g. ".actions"
+ * 5 : pfilename = destination for full filename. Caller
* free()s. Set to NULL on error.
- * 5 : pparam = destination for partial filename,
+ * 6 : 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.
{
const char *param;
const char *s;
+#if 0 /* Patch to make 3.0.0 work properly. */
char *name;
+#endif /* 0 - Patch to make 3.0.0 work properly. */
char *fullpath;
char ch;
int len;
}
}
+ /*
+ * FIXME Following is a hack to make 3.0.0 work properly.
+ * Change "#if 0" --> "#if 1" below when we have modular action
+ * files.
+ * -- Jon
+ */
+#if 0 /* Patch to make 3.0.0 work properly. */
/* Append extension */
name = malloc(len + strlen(suffix) + 1);
if (name == NULL)
/* Prepend path */
fullpath = make_path(csp->config->confdir, name);
free(name);
+#else /* 1 - Patch to make 3.0.0 work properly. */
+ if ((csp->actions_list == NULL)
+ || (csp->actions_list->filename == NULL))
+ {
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ fullpath = ( (csp->actions_list && csp->actions_list->filename)
+ ? strdup(csp->actions_list->filename) : NULL);
+#endif /* 1 - Patch to make 3.0.0 work properly. */
if (fullpath == NULL)
{
return JB_ERR_MEMORY;
* passed to a CGI function.
*
* Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : parameters = map of cgi parameters
- * 3 : name = Name of CGI parameter to read
- * 4 : pvalue = destination for value.
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : parameters = map of cgi parameters
+ * 3 : name = Name of CGI parameter to read
+ * 4 : pvalue = destination for value.
* Set to -1 on error.
*
* Returns : JB_ERR_OK on success
}
+/*********************************************************************
+ *
+ * Function : get_url_spec_param
+ *
+ * Description : Get a URL pattern from the parameters
+ * passed to a CGI function. Removes leading/trailing
+ * spaces and validates it.
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : parameters = map of cgi parameters
+ * 3 : name = Name of CGI parameter to read
+ * 4 : pvalue = destination for value. Will be malloc()'d.
+ * Set to NULL on error.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ * JB_ERR_CGI_PARAMS if the parameter was not specified
+ * or is not valid.
+ *
+ *********************************************************************/
+static jb_err get_url_spec_param(struct client_state *csp,
+ const struct map *parameters,
+ const char *name,
+ char **pvalue)
+{
+ const char *orig_param;
+ char *param;
+ char *s;
+ struct url_spec compiled[1];
+ jb_err err;
+
+ assert(csp);
+ assert(parameters);
+ assert(name);
+ assert(pvalue);
+
+ *pvalue = NULL;
+
+ orig_param = lookup(parameters, name);
+ if (!*orig_param)
+ {
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* Copy and trim whitespace */
+ param = strdup(orig_param);
+ if (param == NULL)
+ {
+ return JB_ERR_MEMORY;
+ }
+ chomp(param);
+
+ /* Must be non-empty, and can't allow 1st character to be '{' */
+ if (param[0] == '\0' || param[0] == '{')
+ {
+ free(param);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* Check for embedded newlines */
+ for (s = param; *s != '\0'; s++)
+ {
+ if ((*s == '\r') || (*s == '\n'))
+ {
+ free(param);
+ return JB_ERR_CGI_PARAMS;
+ }
+ }
+
+ /* Check that regex is valid */
+ s = strdup(param);
+ if (s == NULL)
+ {
+ free(param);
+ return JB_ERR_MEMORY;
+ }
+ err = create_url_spec(compiled, s);
+ free(s);
+ if (err)
+ {
+ free(param);
+ return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS;
+ }
+ free_url_spec(compiled);
+
+ if (param[strlen(param) - 1] == '\\')
+ {
+ /*
+ * Must protect trailing '\\' from becoming line continuation character.
+ * Two methods: 1) If it's a domain only, add a trailing '/'.
+ * 2) For path, add the do-nothing PCRE expression (?:) to the end
+ */
+ if (strchr(param, '/') == NULL)
+ {
+ err = string_append(¶m, "/");
+ }
+ else
+ {
+ err = string_append(¶m, "(?:)");
+ }
+ if (err)
+ {
+ return err;
+ }
+
+ /* Check that the modified regex is valid */
+ s = strdup(param);
+ if (s == NULL)
+ {
+ free(param);
+ return JB_ERR_MEMORY;
+ }
+ err = create_url_spec(compiled, s);
+ free(s);
+ if (err)
+ {
+ free(param);
+ return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS;
+ }
+ free_url_spec(compiled);
+ }
+
+ *pvalue = param;
+ return JB_ERR_OK;
+}
+
/*********************************************************************
*
* Function : map_radio
* 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.
+ * 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
*
/*********************************************************************
*
- * Function : actions_to_radio
+ * Function : cgi_error_modified
*
- * Description : Converts a actionsfile entry into settings for
- * radio buttons and edit boxes on a HTML form.
+ * Description : CGI function that is called when a file is modified
+ * outside the CGI editor.
*
* Parameters :
- * 1 : exports = List of substitutions to add to.
- * 2 : action = Action to read
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : filename = The file that was modified.
*
- * Returns : JB_ERR_OK on success
- * JB_ERR_MEMORY on out-of-memory
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-static jb_err actions_to_radio(struct map * exports,
- const struct action_spec *action)
+jb_err cgi_error_modified(struct client_state *csp,
+ struct http_response *rsp,
+ const char *filename)
{
- unsigned mask = action->mask;
- unsigned add = action->add;
- int mapped_param;
- int checked;
- char current_mode;
-
- assert(exports);
- assert(action);
-
- mask = action->mask;
- add = action->add;
-
- /* sanity - prevents "-feature +feature" */
- mask |= add;
+ struct map *exports;
+ jb_err err;
+ assert(csp);
+ assert(rsp);
+ assert(filename);
-#define DEFINE_ACTION_BOOL(name, bit) \
- if (!(mask & bit)) \
- { \
- current_mode = 'n'; \
- } \
- else if (add & bit) \
- { \
- current_mode = 'y'; \
- } \
- else \
- { \
- current_mode = 'x'; \
- } \
- if (map_radio(exports, name, "ynx", current_mode)) \
- { \
- return JB_ERR_MEMORY; \
+ if (NULL == (exports = default_exports(csp, NULL)))
+ {
+ return JB_ERR_MEMORY;
}
-#define DEFINE_ACTION_STRING(name, bit, index) \
- DEFINE_ACTION_BOOL(name, bit); \
- mapped_param = 0;
-
-#define DEFINE_CGI_PARAM_RADIO(name, bit, index, value, is_default) \
- if (add & bit) \
- { \
- checked = !strcmp(action->string[index], value); \
- } \
- else \
- { \
- checked = is_default; \
- } \
- mapped_param |= checked; \
- if (map(exports, name "-param-" value, 1, (checked ? "checked" : ""), 1)) \
- { \
- return JB_ERR_MEMORY; \
- }
-
-#define DEFINE_CGI_PARAM_CUSTOM(name, bit, index, default_val) \
- if (map(exports, name "-param-custom", 1, \
- ((!mapped_param) ? "checked" : ""), 1)) \
- { \
- return JB_ERR_MEMORY; \
- } \
- if (map(exports, name "-param", 1, \
- (((add & bit) && !mapped_param) ? \
- action->string[index] : default_val), 1)) \
- { \
- return JB_ERR_MEMORY; \
- }
-
-#define DEFINE_CGI_PARAM_NO_RADIO(name, bit, index, default_val) \
- if (map(exports, name "-param", 1, \
- ((add & bit) ? action->string[index] : default_val), 1)) \
- { \
- return JB_ERR_MEMORY; \
- }
-
-#define DEFINE_ACTION_MULTI(name, index) \
- if (action->multi_add[index]->first) \
- { \
- current_mode = 'y'; \
- } \
- else if (action->multi_remove_all[index]) \
- { \
- current_mode = 'n'; \
- } \
- else if (action->multi_remove[index]->first) \
- { \
- current_mode = 'y'; \
- } \
- else \
- { \
- current_mode = 'x'; \
- } \
- if (map_radio(exports, name, "ynx", current_mode)) \
- { \
- return JB_ERR_MEMORY; \
- }
-
-#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
-
-#include "actionlist.h"
-
-#undef DEFINE_ACTION_MULTI
-#undef DEFINE_ACTION_STRING
-#undef DEFINE_ACTION_BOOL
-#undef DEFINE_ACTION_ALIAS
-#undef DEFINE_CGI_PARAM_CUSTOM
-#undef DEFINE_CGI_PARAM_RADIO
-#undef DEFINE_CGI_PARAM_NO_RADIO
-
- return JB_ERR_OK;
-}
-
-
-/*********************************************************************
- *
- * Function : actions_from_radio
- *
- * Description : Converts a map of parameters passed to a CGI function
- * into an actionsfile entry.
- *
- * Parameters :
- * 1 : parameters = parameters to the CGI call
- * 2 : action = Action to change. Must be valid before
- * the call, actions not specified will be
- * left unchanged.
- *
- * Returns : JB_ERR_OK on success
- * JB_ERR_MEMORY on out-of-memory
- *
- *********************************************************************/
-static jb_err actions_from_radio(const struct map * parameters,
- struct action_spec *action)
-{
- const char * param;
- char * param_dup;
- char ch;
-
- assert(parameters);
- assert(action);
-
-#define DEFINE_ACTION_BOOL(name, bit) \
- if (NULL != (param = lookup(parameters, name))) \
- { \
- ch = toupper((int)param[0]); \
- if (ch == 'Y') \
- { \
- action->add |= bit; \
- action->mask |= bit; \
- } \
- else if (ch == 'N') \
- { \
- action->add &= ~bit; \
- action->mask &= ~bit; \
- } \
- else if (ch == 'X') \
- { \
- action->add &= ~bit; \
- action->mask |= bit; \
- } \
- }
-
-#define DEFINE_ACTION_STRING(name, bit, index) \
- if (NULL != (param = lookup(parameters, name))) \
- { \
- ch = toupper((int)param[0]); \
- if (ch == 'Y') \
- { \
- param = lookup(parameters, name "-mode"); \
- if ((*param == '\0') || (0 == strcmp(param, "CUSTOM"))) \
- { \
- param = lookup(parameters, name "-param"); \
- } \
- if (*param != '\0') \
- { \
- if (NULL == (param_dup = strdup(param))) \
- { \
- return JB_ERR_MEMORY; \
- } \
- freez(action->string[index]); \
- action->add |= bit; \
- action->mask |= bit; \
- action->string[index] = param_dup; \
- } \
- } \
- else if (ch == 'N') \
- { \
- if (action->add & bit) \
- { \
- freez(action->string[index]); \
- } \
- action->add &= ~bit; \
- action->mask &= ~bit; \
- } \
- else if (ch == 'X') \
- { \
- if (action->add & bit) \
- { \
- freez(action->string[index]); \
- } \
- action->add &= ~bit; \
- action->mask |= bit; \
- } \
- }
-
-#define DEFINE_ACTION_MULTI(name, index) \
- if (NULL != (param = lookup(parameters, name))) \
- { \
- ch = toupper((int)param[0]); \
- if (ch == 'Y') \
- { \
- /* FIXME */ \
- } \
- else if (ch == 'N') \
- { \
- list_remove_all(action->multi_add[index]); \
- list_remove_all(action->multi_remove[index]); \
- action->multi_remove_all[index] = 1; \
- } \
- else if (ch == 'X') \
- { \
- list_remove_all(action->multi_add[index]); \
- list_remove_all(action->multi_remove[index]); \
- action->multi_remove_all[index] = 0; \
- } \
- }
-
-#define DEFINE_CGI_PARAM_CUSTOM(name, bit, index, default_val)
-#define DEFINE_CGI_PARAM_RADIO(name, bit, index, value, is_default)
-#define DEFINE_CGI_PARAM_NO_RADIO(name, bit, index, default_val)
-
-#define DEFINE_ACTION_ALIAS 0 /* No aliases for URL parsing */
-
-#include "actionlist.h"
-
-#undef DEFINE_ACTION_MULTI
-#undef DEFINE_ACTION_STRING
-#undef DEFINE_ACTION_BOOL
-#undef DEFINE_ACTION_ALIAS
-#undef DEFINE_CGI_PARAM_CUSTOM
-#undef DEFINE_CGI_PARAM_RADIO
-#undef DEFINE_CGI_PARAM_NO_RADIO
-
- return JB_ERR_OK;
-}
-
-
-/*********************************************************************
- *
- * 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 : 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_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;
+ err = map(exports, "f", 1, html_encode(filename), 0);
+ if (err)
+ {
+ free_map(exports);
+ return err;
}
return template_fill_for_cgi(csp, "cgi-error-modified", exports, rsp);
* 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.
+ * 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
*
return JB_ERR_MEMORY;
}
- err = map(exports, "filename", 1, file->identifier, 1);
- err = err || map(exports, "parse-error", 1, file->parse_error_text, 1);
+ err = map(exports, "f", 1, file->identifier, 1);
+ if (!err) err = map(exports, "parse-error", 1, html_encode(file->parse_error_text), 0);
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) err = map(exports, "line-raw", 1, html_encode(cur_line->raw), 0);
+ if (!err) err = map(exports, "line-data", 1, html_encode(cur_line->unprocessed), 0);
if (err)
{
* 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.
+ * 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
*
return JB_ERR_MEMORY;
}
- err = map(exports, "filename", 1, filename, 1);
+ err = map(exports, "f", 1, html_encode(filename), 0);
if (err)
{
free_map(exports);
* (query string) for a CGI were wrong.
*
* Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : rsp = http_response data structure for output
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
*
* CGI Parameters : none
*
* 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
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
*
* CGI Parameters : None
*
{
return JB_ERR_MEMORY;
}
- if (enlist_unique_header(rsp->headers, "Location", "http://ijbswa.sourceforge.net/config/edit-actions-list?filename=edit"))
+ if (enlist_unique_header(rsp->headers, "Location",
+ CGI_PREFIX "edit-actions-list?f=ijb"))
{
free(rsp->status);
rsp->status = NULL;
* 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
+ * 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
*
struct map * url_exports;
struct editable_file * file;
struct file_line * cur_line;
- int line_number = 0;
+ unsigned line_number = 0;
+ unsigned prev_section_line_number = ((unsigned) (-1));
int url_1_2;
jb_err err;
return JB_ERR_MEMORY;
}
- err = map(exports, "filename", 1, file->identifier, 1);
- err = err || map(exports, "ver", 1, file->version_str, 1);
+ err = map(exports, "f", 1, file->identifier, 1);
+ if (!err) err = map(exports, "v", 1, file->version_str, 1);
+
if (err)
{
edit_free_file(file);
}
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);
+ err = map(section_exports, "s", 1, buf, 1);
+ if (!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))
+ if ( (!err)
+ && (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");
+ err = map_block_killer(section_exports, "empty-section");
+ }
+ else
+ {
+ if (!err) err = map_block_keep(section_exports, "empty-section");
+ }
+
+ if (prev_section_line_number != ((unsigned)(-1)))
+ {
+ /* Not last section */
+ snprintf(buf, 50, "%d", prev_section_line_number);
+ if (!err) err = map(section_exports, "s-prev", 1, buf, 1);
+ if (!err) err = map_block_keep(section_exports, "s-prev-exists");
+ }
+ else
+ {
+ /* Last section */
+ if (!err) err = map_block_killer(section_exports, "s-prev-exists");
}
+ prev_section_line_number = line_number;
if (err)
{
}
snprintf(buf, 50, "%d", line_number);
- err = map(url_exports, "urlid", 1, buf, 1);
+ err = map(url_exports, "p", 1, buf, 1);
snprintf(buf, 50, "%d", url_1_2);
- err = err || map(url_exports, "url-1-2", 1, buf, 1);
+ if (!err) err = map(url_exports, "url-1-2", 1, buf, 1);
- err = err || map(url_exports, "url", 1,
- html_encode(cur_line->unprocessed), 0);
+ if (!err) err = map(url_exports, "url-html", 1,
+ html_encode(cur_line->unprocessed), 0);
+ if (!err) err = map(url_exports, "url", 1,
+ url_encode(cur_line->unprocessed), 0);
if (err)
{
return JB_ERR_MEMORY;
}
- err = template_fill(&s, section_exports);
- err = err || template_fill(&s, url_exports);
- err = err || string_append(&urls, s);
+ err = template_fill(&s, section_exports);
+ if (!err) err = template_fill(&s, url_exports);
+ if (!err) err = string_append(&urls, s);
+
free_map(url_exports);
freez(s);
err = map(section_exports, "urls", 1, urls, 0);
+ /* Could also do section-specific exports here, but it wouldn't be as fast */
+
+ if ( (cur_line != NULL)
+ && (cur_line->type == FILE_LINE_ACTION))
+ {
+ /* Not last section */
+ snprintf(buf, 50, "%d", line_number);
+ if (!err) err = map(section_exports, "s-next", 1, buf, 1);
+ if (!err) err = map_block_keep(section_exports, "s-next-exists");
+ }
+ else
+ {
+ /* Last section */
+ if (!err) err = map_block_killer(section_exports, "s-next-exists");
+ }
+
if (err)
{
free(sections);
return err;
}
- /* Could also do section-specific exports here, but it wouldn't be as fast */
-
if (NULL == (s = strdup(section_template)))
{
free(sections);
}
err = template_fill(&s, section_exports);
- err = err || string_append(§ions, s);
+ if (!err) err = string_append(§ions, s);
+
freez(s);
free_map(section_exports);
* 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
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
*
* CGI Parameters : None
*
return cgi_error_disabled(csp, rsp);
}
- err = get_number_param(csp, parameters, "section", §ionid);
+ err = get_number_param(csp, parameters, "s", §ionid);
if (err)
{
return err;
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 = map(exports, "f", 1, file->identifier, 1);
+ if (!err) err = map(exports, "v", 1, file->version_str, 1);
+ if (!err) err = map(exports, "s", 1, url_encode(lookup(parameters, "s")), 0);
- err = err || actions_to_radio(exports, cur_line->data.action);
+ if (!err) err = actions_to_radio(exports, cur_line->data.action);
edit_free_file(file);
* 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
+ * 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
*
int len;
struct editable_file * file;
struct file_line * cur_line;
- int line_number;
+ unsigned line_number;
char * target;
jb_err err;
return cgi_error_disabled(csp, rsp);
}
- err = get_number_param(csp, parameters, "section", §ionid);
+ err = get_number_param(csp, parameters, "s", §ionid);
if (err)
{
return err;
return err;
}
- target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ target = strdup(CGI_PREFIX "edit-actions-list?f=");
string_append(&target, file->identifier);
edit_free_file(file);
* 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
+ * 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
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;
return cgi_error_disabled(csp, rsp);
}
- err = get_number_param(csp, parameters, "section", §ionid);
- err = err || get_number_param(csp, parameters, "pattern", &patternid);
+ err = get_number_param(csp, parameters, "p", &patternid);
if (err)
{
return err;
}
-
- newval = lookup(parameters, "newval");
-
- if ((*newval == '\0') || (sectionid < 1U) || (patternid < 1U))
+ if (patternid < 1U)
{
return JB_ERR_CGI_PARAMS;
}
+ err = get_url_spec_param(csp, parameters, "u", &new_pattern);
+ 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. */
+ free(new_pattern);
return (err == JB_ERR_FILE ? JB_ERR_OK : err);
}
line_number = 1;
cur_line = file->lines;
- while ((cur_line != NULL) && (line_number < sectionid))
+ while ((cur_line != NULL) && (line_number < patternid))
{
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)
+ || (cur_line->type != FILE_LINE_URL))
{
/* Invalid "patternid" parameter */
+ free(new_pattern);
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;
return err;
}
- target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ target = strdup(CGI_PREFIX "edit-actions-list?f=");
string_append(&target, file->identifier);
edit_free_file(file);
* 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
+ * 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
const struct map *parameters)
{
unsigned sectionid;
- unsigned patternid;
- const char * newval;
char * new_pattern;
struct file_line * new_line;
struct editable_file * file;
return cgi_error_disabled(csp, rsp);
}
- err = get_number_param(csp, parameters, "section", §ionid);
+ err = get_number_param(csp, parameters, "s", §ionid);
if (err)
{
return err;
}
-
- newval = lookup(parameters, "newval");
-
- if ((*newval == '\0') || (sectionid < 1U) || (patternid < 1U))
+ if (sectionid < 1U)
{
return JB_ERR_CGI_PARAMS;
}
+ err = get_url_spec_param(csp, parameters, "u", &new_pattern);
+ 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. */
+ free(new_pattern);
return (err == JB_ERR_FILE ? JB_ERR_OK : err);
}
|| (cur_line->type != FILE_LINE_ACTION))
{
/* Invalid "sectionid" parameter */
+ free(new_pattern);
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)
return err;
}
- target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ target = strdup(CGI_PREFIX "edit-actions-list?f=");
string_append(&target, file->identifier);
edit_free_file(file);
* 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
+ * 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
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * p : (pattern) Line number of pattern to remove
*
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
struct http_response *rsp,
const struct map *parameters)
{
- unsigned sectionid;
unsigned patternid;
struct editable_file * file;
struct file_line * cur_line;
return cgi_error_disabled(csp, rsp);
}
- err = get_number_param(csp, parameters, "section", §ionid);
- err = err || get_number_param(csp, parameters, "pattern", &patternid);
+ err = get_number_param(csp, parameters, "p", &patternid);
if (err)
{
return err;
}
-
err = edit_read_actions_file(csp, rsp, parameters, 1, &file);
if (err)
{
}
line_number = 1;
+ prev_line = NULL;
cur_line = file->lines;
- while ((cur_line != NULL) && (line_number < sectionid))
+ while ((cur_line != NULL) && (line_number < patternid))
{
+ prev_line = cur_line;
cur_line = cur_line->next;
line_number++;
}
if ( (cur_line == NULL)
- || (cur_line->type != FILE_LINE_ACTION))
+ || (prev_line == NULL)
+ || (cur_line->type != FILE_LINE_URL))
{
- /* Invalid "sectionid" parameter */
+ /* Invalid "patternid" parameter */
edit_free_file(file);
return JB_ERR_CGI_PARAMS;
}
- prev_line = NULL;
- while (line_number < patternid)
- {
- 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 JB_ERR_CGI_PARAMS;
- }
-
- assert(prev_line);
-
- /* At this point, the line to remove is in cur_line, and the previous
- * one is in 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;
return err;
}
- target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ target = strdup(CGI_PREFIX "edit-actions-list?f=");
string_append(&target, file->identifier);
edit_free_file(file);
* (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
+ * 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
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * s : (section) Line number of section to edit
*
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
return cgi_error_disabled(csp, rsp);
}
- err = get_number_param(csp, parameters, "section", §ionid);
+ err = get_number_param(csp, parameters, "s", §ionid);
if (err)
{
return err;
return err;
}
- target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ target = strdup(CGI_PREFIX "edit-actions-list?f=");
string_append(&target, file->identifier);
edit_free_file(file);
* 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
+ * 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.
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * s : (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
return cgi_error_disabled(csp, rsp);
}
- err = get_number_param(csp, parameters, "section", §ionid);
+ err = get_number_param(csp, parameters, "s", §ionid);
if (err)
{
return err;
return err;
}
- target = strdup("http://ijbswa.sourceforge.net/config/edit-actions-list?filename=");
+ target = strdup(CGI_PREFIX "edit-actions-list?f=");
+ 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_section_swap
+ *
+ * Description : CGI function that swaps the order of two sections
+ * in the actions file. Note that this CGI can actually
+ * swap any two arbitrary sections, but the GUI interface
+ * currently only allows consecutive sections to be
+ * specified.
+ *
+ * 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 :
+ * f : (filename) Identifies the file to edit
+ * v : (version) File's last-modified time
+ * s1 : (section1) Line number of first section to swap
+ * s2 : (section2) Line number of second section to swap
+ *
+ * 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_swap(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ unsigned section1;
+ unsigned section2;
+ struct editable_file * file;
+ struct file_line * cur_line;
+ struct file_line * prev_line;
+ struct file_line * line_before_section1;
+ struct file_line * line_start_section1;
+ struct file_line * line_end_section1;
+ struct file_line * line_after_section1;
+ struct file_line * line_before_section2;
+ struct file_line * line_start_section2;
+ struct file_line * line_end_section2;
+ struct file_line * line_after_section2;
+ 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, "s1", §ion1);
+ if (!err) err = get_number_param(csp, parameters, "s2", §ion2);
+ if (err)
+ {
+ return err;
+ }
+
+ if (section1 > section2)
+ {
+ unsigned temp = section2;
+ section2 = section1;
+ section1 = temp;
+ }
+
+ 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);
+ }
+
+ /* Start at the beginning... */
+ line_number = 1;
+ cur_line = file->lines;
+ prev_line = NULL;
+
+ /* ... find section1 ... */
+ while ((cur_line != NULL) && (line_number < section1))
+ {
+ prev_line = cur_line;
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ( (cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION) )
+ {
+ /* Invalid "section1" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* If no-op, we've validated params and can skip the rest. */
+ if (section1 != section2)
+ {
+ /* ... find the end of section1 ... */
+ line_before_section1 = prev_line;
+ line_start_section1 = cur_line;
+ do
+ {
+ prev_line = cur_line;
+ cur_line = cur_line->next;
+ line_number++;
+ }
+ while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL));
+ line_end_section1 = prev_line;
+ line_after_section1 = cur_line;
+
+ /* ... find section2 ... */
+ while ((cur_line != NULL) && (line_number < section2))
+ {
+ prev_line = cur_line;
+ cur_line = cur_line->next;
+ line_number++;
+ }
+
+ if ( (cur_line == NULL)
+ || (cur_line->type != FILE_LINE_ACTION) )
+ {
+ /* Invalid "section2" parameter */
+ edit_free_file(file);
+ return JB_ERR_CGI_PARAMS;
+ }
+
+ /* ... find the end of section2 ... */
+ line_before_section2 = prev_line;
+ line_start_section2 = cur_line;
+ do
+ {
+ prev_line = cur_line;
+ cur_line = cur_line->next;
+ line_number++;
+ }
+ while ((cur_line != NULL) && (cur_line->type == FILE_LINE_URL));
+ line_end_section2 = prev_line;
+ line_after_section2 = cur_line;
+
+ /* Now have all the pointers we need. Do the swap. */
+
+ /* Change the pointer to section1 to point to section2 instead */
+ if (line_before_section1 == NULL)
+ {
+ file->lines = line_start_section2;
+ }
+ else
+ {
+ line_before_section1->next = line_start_section2;
+ }
+
+ if (line_before_section2 == line_end_section1)
+ {
+ /* Consecutive sections */
+ line_end_section2->next = line_start_section1;
+ }
+ else
+ {
+ line_end_section2->next = line_after_section1;
+ line_before_section2->next = line_start_section1;
+ }
+
+ /* Set the pointer from the end of section1 to the rest of the file */
+ line_end_section1->next = line_after_section2;
+
+ err = edit_write_file(file);
+ if (err)
+ {
+ /* Error writing file */
+ edit_free_file(file);
+ return err;
+ }
+ } /* END if (section1 != section2) */
+
+ target = strdup(CGI_PREFIX "edit-actions-list?f=");
string_append(&target, file->identifier);
edit_free_file(file);
* 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
+ * 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:
return template_fill_for_cgi(csp, template_name, exports, rsp);
}
+
+
+/*********************************************************************
+ *
+ * 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 jb_err actions_to_radio(struct map * exports,
+ const struct action_spec *action)
+{
+ unsigned mask = action->mask;
+ unsigned add = action->add;
+ int mapped_param;
+ int checked;
+ char current_mode;
+
+ assert(exports);
+ assert(action);
+
+ mask = action->mask;
+ add = action->add;
+
+ /* sanity - prevents "-feature +feature" */
+ mask |= add;
+
+
+#define DEFINE_ACTION_BOOL(name, bit) \
+ if (!(mask & bit)) \
+ { \
+ current_mode = 'n'; \
+ } \
+ else if (add & bit) \
+ { \
+ current_mode = 'y'; \
+ } \
+ else \
+ { \
+ current_mode = 'x'; \
+ } \
+ if (map_radio(exports, name, "ynx", current_mode)) \
+ { \
+ return JB_ERR_MEMORY; \
+ }
+
+#define DEFINE_ACTION_STRING(name, bit, index) \
+ DEFINE_ACTION_BOOL(name, bit); \
+ mapped_param = 0;
+
+#define DEFINE_CGI_PARAM_RADIO(name, bit, index, value, is_default) \
+ if (add & bit) \
+ { \
+ checked = !strcmp(action->string[index], value); \
+ } \
+ else \
+ { \
+ checked = is_default; \
+ } \
+ mapped_param |= checked; \
+ if (map(exports, name "-param-" value, 1, (checked ? "checked" : ""), 1)) \
+ { \
+ return JB_ERR_MEMORY; \
+ }
+
+#define DEFINE_CGI_PARAM_CUSTOM(name, bit, index, default_val) \
+ if (map(exports, name "-param-custom", 1, \
+ ((!mapped_param) ? "checked" : ""), 1)) \
+ { \
+ return JB_ERR_MEMORY; \
+ } \
+ if (map(exports, name "-param", 1, \
+ (((add & bit) && !mapped_param) ? \
+ action->string[index] : default_val), 1)) \
+ { \
+ return JB_ERR_MEMORY; \
+ }
+
+#define DEFINE_CGI_PARAM_NO_RADIO(name, bit, index, default_val) \
+ if (map(exports, name "-param", 1, \
+ ((add & bit) ? action->string[index] : default_val), 1)) \
+ { \
+ return JB_ERR_MEMORY; \
+ }
+
+#define DEFINE_ACTION_MULTI(name, index) \
+ if (action->multi_add[index]->first) \
+ { \
+ current_mode = 'y'; \
+ } \
+ else if (action->multi_remove_all[index]) \
+ { \
+ current_mode = 'n'; \
+ } \
+ else if (action->multi_remove[index]->first) \
+ { \
+ current_mode = 'y'; \
+ } \
+ else \
+ { \
+ current_mode = 'x'; \
+ } \
+ if (map_radio(exports, name, "ynx", current_mode)) \
+ { \
+ return JB_ERR_MEMORY; \
+ }
+
+#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
+
+#include "actionlist.h"
+
+#undef DEFINE_ACTION_MULTI
+#undef DEFINE_ACTION_STRING
+#undef DEFINE_ACTION_BOOL
+#undef DEFINE_ACTION_ALIAS
+#undef DEFINE_CGI_PARAM_CUSTOM
+#undef DEFINE_CGI_PARAM_RADIO
+#undef DEFINE_CGI_PARAM_NO_RADIO
+
+ return JB_ERR_OK;
+}
+
+
+/*********************************************************************
+ *
+ * Function : javascriptify
+ *
+ * Description : Converts a string into a form JavaScript will like.
+ *
+ * Netscape 4's JavaScript sucks - it doesn't use
+ * "id" parameters, so you have to set the "name"
+ * used to submit a form element to something JavaScript
+ * will like. (Or access the elements by index in an
+ * array. That array contains >60 elements and will
+ * be changed whenever we add a new action to the
+ * editor, so I'm NOT going to use indexes that have
+ * to be figured out by hand.)
+ *
+ * Currently the only thing we have to worry about
+ * is "-" ==> "_" conversion.
+ *
+ * This is a length-preserving operation so it is
+ * carried out in-place, no memory is allocated
+ * or freed.
+ *
+ * Parameters :
+ * 1 : identifier = String to make JavaScript-friendly.
+ *
+ * Returns : N/A
+ *
+ *********************************************************************/
+static void javascriptify(char * identifier)
+{
+ char * p = identifier;
+ while (NULL != (p = strchr(p, '-')))
+ {
+ *p++ = '_';
+ }
+}
+
+
+/*********************************************************************
+ *
+ * Function : actions_from_radio
+ *
+ * Description : Converts a map of parameters passed to a CGI function
+ * into an actionsfile entry.
+ *
+ * Parameters :
+ * 1 : parameters = parameters to the CGI call
+ * 2 : action = Action to change. Must be valid before
+ * the call, actions not specified will be
+ * left unchanged.
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory
+ *
+ *********************************************************************/
+static jb_err actions_from_radio(const struct map * parameters,
+ struct action_spec *action)
+{
+ static int first_time = 1;
+ const char * param;
+ char * param_dup;
+ char ch;
+ const char * js_name;
+
+ assert(parameters);
+ assert(action);
+
+ /* Statics are generally a potential race condition,
+ * but in this case we're safe and don't need semaphores.
+ * Be careful if you modify this function.
+ * - Jon
+ */
+
+#define JAVASCRIPTIFY(dest_var, string) \
+ { \
+ static char js_name_arr[] = string; \
+ if (first_time) \
+ { \
+ javascriptify(js_name_arr); \
+ } \
+ dest_var = js_name_arr; \
+ } \
+
+#define DEFINE_ACTION_BOOL(name, bit) \
+ JAVASCRIPTIFY(js_name, name); \
+ param = lookup(parameters, js_name); \
+ ch = ijb_toupper(param[0]); \
+ if (ch == 'Y') \
+ { \
+ action->add |= bit; \
+ action->mask |= bit; \
+ } \
+ else if (ch == 'N') \
+ { \
+ action->add &= ~bit; \
+ action->mask &= ~bit; \
+ } \
+ else if (ch == 'X') \
+ { \
+ action->add &= ~bit; \
+ action->mask |= bit; \
+ } \
+
+#define DEFINE_ACTION_STRING(name, bit, index) \
+ JAVASCRIPTIFY(js_name, name); \
+ param = lookup(parameters, js_name); \
+ ch = ijb_toupper(param[0]); \
+ if (ch == 'Y') \
+ { \
+ JAVASCRIPTIFY(js_name, name "-mode"); \
+ param = lookup(parameters, js_name); \
+ if ((*param == '\0') || (0 == strcmp(param, "CUSTOM"))) \
+ { \
+ JAVASCRIPTIFY(js_name, name "-param"); \
+ param = lookup(parameters, js_name); \
+ } \
+ if (*param != '\0') \
+ { \
+ if (NULL == (param_dup = strdup(param))) \
+ { \
+ return JB_ERR_MEMORY; \
+ } \
+ freez(action->string[index]); \
+ action->add |= bit; \
+ action->mask |= bit; \
+ action->string[index] = param_dup; \
+ } \
+ } \
+ else if (ch == 'N') \
+ { \
+ if (action->add & bit) \
+ { \
+ freez(action->string[index]); \
+ } \
+ action->add &= ~bit; \
+ action->mask &= ~bit; \
+ } \
+ else if (ch == 'X') \
+ { \
+ if (action->add & bit) \
+ { \
+ freez(action->string[index]); \
+ } \
+ action->add &= ~bit; \
+ action->mask |= bit; \
+ } \
+
+#define DEFINE_ACTION_MULTI(name, index) \
+ JAVASCRIPTIFY(js_name, name); \
+ param = lookup(parameters, js_name); \
+ ch = ijb_toupper((int)param[0]); \
+ if (ch == 'Y') \
+ { \
+ /* FIXME */ \
+ } \
+ else if (ch == 'N') \
+ { \
+ list_remove_all(action->multi_add[index]); \
+ list_remove_all(action->multi_remove[index]); \
+ action->multi_remove_all[index] = 1; \
+ } \
+ else if (ch == 'X') \
+ { \
+ list_remove_all(action->multi_add[index]); \
+ list_remove_all(action->multi_remove[index]); \
+ action->multi_remove_all[index] = 0; \
+ } \
+
+#define DEFINE_ACTION_ALIAS 0 /* No aliases for URL parsing */
+
+#include "actionlist.h"
+
+#undef DEFINE_ACTION_MULTI
+#undef DEFINE_ACTION_STRING
+#undef DEFINE_ACTION_BOOL
+#undef DEFINE_ACTION_ALIAS
+#undef JAVASCRIPTIFY
+
+ first_time = 0;
+
+ return JB_ERR_OK;
+}
+
+
#endif /* def FEATURE_CGI_EDIT_ACTIONS */
projects / privoxy.git / blobdiff