From ccedf2853b21370ecb456bda0551e7dbfa76aee9 Mon Sep 17 00:00:00 2001 From: jongfoster Date: Wed, 23 Jan 2002 00:22:59 +0000 Subject: [PATCH] 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): is now this: --- cgiedit.c | 1838 ++++++++++++++++++++++++++++------------------------- 1 file changed, 977 insertions(+), 861 deletions(-) diff --git a/cgiedit.c b/cgiedit.c index 789bc3b1..0e230eeb 100644 --- a/cgiedit.c +++ b/cgiedit.c @@ -1,12 +1,19 @@ -const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.8 2001/11/30 23:35:51 jongfoster Exp $"; +const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.9 2002/01/17 20:56:22 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 @@ -35,6 +42,10 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.8 2001/11/30 23:35:51 jongfoster * * Revisions : * $Log: cgiedit.c,v $ + * 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 * @@ -125,6 +136,7 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.8 2001/11/30 23:35:51 jongfoster #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" @@ -186,7 +198,9 @@ 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. */ + /* 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 @@ -194,6 +208,10 @@ struct editable_file * 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) */ @@ -232,10 +250,8 @@ 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); @@ -252,6 +268,10 @@ static jb_err get_number_param(struct client_state *csp, 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, @@ -381,11 +401,9 @@ static jb_err map_copy_parameter_url(struct map *out, * 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 - * oldval : Current value for pattern + * 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 @@ -397,7 +415,11 @@ jb_err cgi_edit_actions_url_form(struct client_state *csp, struct http_response *rsp, const struct map *parameters) { - struct map *exports; + struct map * exports; + unsigned patternid; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; jb_err err; assert(csp); @@ -409,16 +431,48 @@ jb_err cgi_edit_actions_url_form(struct client_state *csp, return cgi_error_disabled(csp, rsp); } + err = get_number_param(csp, parameters, "p", &patternid); + 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 < 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_copy_parameter_html(exports, parameters, "section"); - if (!err) err = map_copy_parameter_html(exports, parameters, "pattern"); - if (!err) err = map_copy_parameter_html(exports, parameters, "ver"); - if (!err) err = map_copy_parameter_html(exports, parameters, "filename"); - if (!err) err = map_copy_parameter_html(exports, parameters, "oldval"); + 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); + + edit_free_file(file); if (err) { @@ -443,9 +497,9 @@ jb_err cgi_edit_actions_url_form(struct client_state *csp, * 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 + * 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 @@ -474,9 +528,9 @@ jb_err cgi_edit_actions_add_url_form(struct client_state *csp, return JB_ERR_MEMORY; } - err = map_copy_parameter_html(exports, parameters, "section"); - if (!err) err = map_copy_parameter_html(exports, parameters, "ver"); - if (!err) err = map_copy_parameter_html(exports, parameters, "filename"); + 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"); if (err) { @@ -501,11 +555,9 @@ jb_err cgi_edit_actions_add_url_form(struct client_state *csp, * 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 - * oldval : Current value for pattern + * 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 @@ -517,7 +569,11 @@ jb_err cgi_edit_actions_remove_url_form(struct client_state *csp, struct http_response *rsp, const struct map *parameters) { - struct map *exports; + struct map * exports; + unsigned patternid; + struct editable_file * file; + struct file_line * cur_line; + unsigned line_number; jb_err err; assert(csp); @@ -529,341 +585,56 @@ jb_err cgi_edit_actions_remove_url_form(struct client_state *csp, return cgi_error_disabled(csp, rsp); } - if (NULL == (exports = default_exports(csp, NULL))) - { - return JB_ERR_MEMORY; - } - - err = map_copy_parameter_url(exports, parameters, "section"); - if (!err) err = map_copy_parameter_url(exports, parameters, "pattern"); - if (!err) err = map_copy_parameter_url(exports, parameters, "ver"); - if (!err) err = map_copy_parameter_url(exports, parameters, "filename"); - if (!err) err = map_copy_parameter_html(exports, parameters, "oldval"); - + err = get_number_param(csp, parameters, "p", &patternid); if (err) { - free_map(exports); return err; } - return template_fill_for_cgi(csp, "edit-actions-remove-url-form", exports, rsp); -} - - -/********************************************************************* - * - * 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. - * - * - * 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 - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory - * JB_ERR_FILE on EOF. - * - *********************************************************************/ -static jb_err simple_read_line(char **dest, FILE *fp) -{ - int len; - char * buf; - char * newbuf; - - assert(fp); - assert(dest); - - *dest = NULL; - - if (NULL == (buf = malloc(BUFFER_SIZE))) + err = edit_read_actions_file(csp, rsp, parameters, 1, &file); + if (err) { - return JB_ERR_MEMORY; + /* No filename specified, can't read file, modified, or out of memory. */ + return (err == JB_ERR_FILE ? JB_ERR_OK : err); } - *buf = '\0'; - len = 0; + cur_line = file->lines; - while (FOREVER) + for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++) { - 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; + cur_line = cur_line->next; } -} - - -/********************************************************************* - * - * 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. - * - * 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. - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory - * JB_ERR_FILE on EOF. - * - *********************************************************************/ -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 */ - 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; - - assert(fp); - /* Set output parameters to NULL */ - if (raw_out) - { - *raw_out = NULL; - } - if (prefix_out) - { - *prefix_out = NULL; - } - if (data_out) + if ( (cur_line == NULL) + || (line_number != patternid) + || (patternid < 1) + || (cur_line->type != FILE_LINE_URL)) { - *data_out = NULL; + /* Invalid "patternid" parameter */ + edit_free_file(file); + return JB_ERR_CGI_PARAMS; } - /* Set string variables to new, empty strings. */ - - raw = malloc(1); - prefix = malloc(1); - data = malloc(1); - - if ((raw == NULL) || (prefix == NULL) || (data == NULL)) + if (NULL == (exports = default_exports(csp, NULL))) { - freez(raw); - freez(prefix); - freez(data); + edit_free_file(file); return JB_ERR_MEMORY; } - *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)))) - { - if (string_append(&raw,linebuf)) - { - free(prefix); - free(data); - free(linebuf); - return JB_ERR_MEMORY; - } - - /* 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'; - - /* Line continuation? Trim escape and set flag. */ - contflag = ((p != linebuf) && (*--p == '\\')); - if (contflag) - { - *p = '\0'; - } - - /* 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++; - } - } - - /* 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'; - - /* ... and chop off the rest of the line */ - *p = '\0'; - } - } /* END while (there's a # character) */ - - /* Write to the buffer */ - if (*linestart) - { - if (string_append(&data, linestart)) - { - free(raw); - free(prefix); - free(linebuf); - return JB_ERR_MEMORY; - } - } - - free(linebuf); - } /* END while(we need more data) */ - - /* Handle simple_read_line() errors - ignore EOF */ - if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE)) - { - free(raw); - free(prefix); - free(data); - return rval; - } + 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 (*raw) + if (err) { - /* Got at least some data */ - - /* Remove trailing whitespace */ - chomp(data); - - 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; + free_map(exports); + return err; } - else - { - /* EOF and no data there. */ - free(raw); - free(prefix); - free(data); - - return JB_ERR_FILE; - } + return template_fill_for_cgi(csp, "edit-actions-remove-url-form", exports, rsp); } @@ -923,12 +694,72 @@ jb_err edit_write_file(struct editable_file * file) } 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; @@ -1510,7 +1341,7 @@ jb_err edit_parse_actions_file(struct editable_file * file) * 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 */ @@ -1530,7 +1361,7 @@ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) 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. */ @@ -1552,7 +1383,7 @@ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) 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 */ @@ -1623,6 +1454,7 @@ jb_err edit_read_file(struct client_state *csp, unsigned version = 0; struct stat statbuf[1]; char version_buf[22]; + int newline = NEWLINE_UNKNOWN; assert(csp); assert(parameters); @@ -1630,7 +1462,7 @@ jb_err edit_read_file(struct client_state *csp, *pfile = NULL; - err = get_file_name_param(csp, parameters, "filename", suffix, + err = get_file_name_param(csp, parameters, "f", suffix, &filename, &identifier); if (err) { @@ -1648,7 +1480,7 @@ jb_err edit_read_file(struct client_state *csp, 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); @@ -1667,7 +1499,7 @@ jb_err edit_read_file(struct client_state *csp, return JB_ERR_FILE; } - err = edit_read_file_lines(fp, &lines); + err = edit_read_file_lines(fp, &lines, &newline); fclose(fp); @@ -1686,9 +1518,10 @@ jb_err edit_read_file(struct client_state *csp, } 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) { @@ -1771,11 +1604,11 @@ jb_err edit_read_actions_file(struct client_state *csp, /* 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) { @@ -1835,10 +1668,11 @@ jb_err edit_read_actions_file(struct client_state *csp, * 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 + * 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. @@ -2004,39 +1838,166 @@ static jb_err get_number_param(struct client_state *csp, /********************************************************************* * - * Function : map_radio + * Function : get_url_spec_param * - * Description : Map a set of radio button values. E.g. if you have - * 3 radio buttons, declare them as: - *