X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgiedit.c;h=789bc3b1eb106ddafefceeadfece3642155f96c7;hp=22dc693217852a122081247beb1049723b74347d;hb=45ddb73f3bd8f46d5216a6980475b85891b876db;hpb=cf3501494c49f38c413762a6b679c4a08fa1e314 diff --git a/cgiedit.c b/cgiedit.c index 22dc6932..789bc3b1 100644 --- a/cgiedit.c +++ b/cgiedit.c @@ -1,21 +1,21 @@ -const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster Exp $"; +const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.8 2001/11/30 23:35:51 jongfoster Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $ * * Purpose : CGI-based actionsfile editor. - * + * * Functions declared include: - * + * * * Copyright : Written by and Copyright (C) 2001 the SourceForge * IJBSWA team. http://ijbswa.sourceforge.net * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General * Public License as published by the Free Software * Foundation; either version 2 of the License, or (at @@ -35,6 +35,55 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster * * Revisions : * $Log: cgiedit.c,v $ + * 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 + * potential source of "denial of service" attacks). + * + * CGI actions file editor that works and is actually useful. + * + * Ability to toggle JunkBuster remotely using a CGI call. + * + * You can turn off both the above features in the main configuration + * file, e.g. if you are running a multi-user proxy. + * + * Revision 1.3 2001/10/14 22:12:49 jongfoster + * New version of CGI-based actionsfile editor. + * Major changes, including: + * - Completely new file parser and file output routines + * - edit-actions CGI renamed edit-actions-for-url + * - All CGIs now need a filename parameter, except for... + * - New CGI edit-actions which doesn't need a filename, + * to allow you to start the editor up. + * - edit-actions-submit now works, and now automatically + * redirects you back to the main edit-actions-list handler. + * * Revision 1.2 2001/09/16 17:05:14 jongfoster * Removing unused #include showarg.h * @@ -57,11 +106,11 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster #include #include #include -#include #include #include #include #include +#include #ifdef _WIN32 #define snprintf _snprintf @@ -76,6 +125,9 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster #include "actions.h" #include "miscutil.h" #include "errlog.h" +#include "loadcfg.h" +/* loadcfg.h is for g_bToggleIJB only */ +#include "urlmatch.h" const char cgiedit_h_rcs[] = CGIEDIT_H_VERSION; @@ -89,7 +141,7 @@ struct file_line char * prefix; char * unprocessed; int type; - + union { struct action_spec action[1]; @@ -128,23 +180,374 @@ struct file_line #define FILE_LINE_DESCRIPTION_HEADER 9 #define FILE_LINE_DESCRIPTION_ENTRY 10 -/* FIXME: Following list of prototypes is not complete */ + +struct editable_file +{ + struct file_line * lines; + const char * filename; /* Full pathname - e.g. "/etc/junkbuster/wibble.action" */ + const char * identifier; /* Filename stub - e.g. "wibble". Use for CGI param. */ + const char * version_str; /* Last modification time, as a string. For CGI param */ + unsigned version; /* Last modification time - prevents chaos with + * the browser's "back" button. Note that this is a + * time_t cast to an unsigned. When comparing, always + * cast the time_t to an unsigned, and *NOT* vice-versa. + * This may lose the top few bits, but they're not + * significant anyway. + */ + struct file_line * parse_error; /* On parse error, this is the offending line. */ + const char * parse_error_text; /* On parse error, this is the problem. + * (Statically allocated) */ +}; + /* FIXME: Following non-static functions should be prototyped in .h or made static */ -static int simple_read_line(char **dest, FILE *fp); -static int edit_read_line (FILE *fp, char **raw_out, char **prefix_out, char **data_out); - int edit_read_file (FILE *fp, struct file_line ** pfile); - int edit_write_file (const char * filename, const struct file_line * file); - void edit_free_file (struct file_line * file); + +/* Functions to read and write arbitrary config files */ +jb_err edit_read_file(struct client_state *csp, + const struct map *parameters, + int require_version, + const char *suffix, + struct editable_file **pfile); +jb_err edit_write_file(struct editable_file * file); +void edit_free_file(struct editable_file * file); + +/* Functions to read and write actions files */ +jb_err edit_parse_actions_file(struct editable_file * file); +jb_err edit_read_actions_file(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters, + int require_version, + struct editable_file **pfile); + +/* Error handlers */ +jb_err cgi_error_modified(struct client_state *csp, + struct http_response *rsp, + const char *filename); +jb_err cgi_error_parse(struct client_state *csp, + struct http_response *rsp, + struct editable_file *file); +jb_err cgi_error_file(struct client_state *csp, + struct http_response *rsp, + const char *filename); +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 void edit_free_file_lines(struct file_line * first_line); +static jb_err simple_read_line(char **dest, FILE *fp); +static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out); + +/* Internal actions file support functions */ +static int match_actions_file_header_line(const char * line, const char * name); +static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue); + +/* Internal parameter parsing functions */ +static jb_err get_file_name_param(struct client_state *csp, + const struct map *parameters, + const char *param_name, + const char *suffix, + char **pfilename, + const char **pparam); +static jb_err get_number_param(struct client_state *csp, + const struct map *parameters, + char *name, + unsigned *pvalue); + +/* Internal actionsfile <==> HTML conversion functions */ +static jb_err map_radio(struct map * exports, + const char * optionname, + const char * values, + char value); +static jb_err actions_to_radio(struct map * exports, + const struct action_spec *action); +static jb_err actions_from_radio(const struct map * parameters, + struct action_spec *action); + + +static jb_err map_copy_parameter_html(struct map *out, + const struct map *in, + const char *name); +static jb_err map_copy_parameter_url(struct map *out, + const struct map *in, + const char *name); + + +/********************************************************************* + * + * Function : map_copy_parameter_html + * + * Description : Copy a CGI parameter from one map to another, HTML + * encoding it. + * + * Parameters : + * 1 : out = target map + * 2 : in = source map + * 3 : name = name of cgi parameter to copy + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the parameter doesn't exist + * in the source map + * + *********************************************************************/ +static jb_err map_copy_parameter_html(struct map *out, + const struct map *in, + const char *name) +{ + const char * value; + jb_err err; + + assert(out); + assert(in); + assert(name); + + value = lookup(in, name); + err = map(out, name, 1, html_encode(value), 0); + + if (err) + { + /* Out of memory */ + return err; + } + else if (*value == '\0') + { + return JB_ERR_CGI_PARAMS; + } + else + { + return JB_ERR_OK; + } +} + + +/********************************************************************* + * + * Function : map_copy_parameter_html + * + * Description : Copy a CGI parameter from one map to another, URL + * encoding it. + * + * Parameters : + * 1 : out = target map + * 2 : in = source map + * 3 : name = name of cgi parameter to copy + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the parameter doesn't exist + * in the source map + * + *********************************************************************/ +static jb_err map_copy_parameter_url(struct map *out, + const struct map *in, + const char *name) +{ + const char * value; + jb_err err; + + assert(out); + assert(in); + assert(name); + + value = lookup(in, name); + err = map(out, name, 1, url_encode(value), 0); + + if (err) + { + /* Out of memory */ + return err; + } + else if (*value == '\0') + { + return JB_ERR_CGI_PARAMS; + } + else + { + return JB_ERR_OK; + } +} + + +/********************************************************************* + * + * 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 + * 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 + * + * 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; + jb_err err; + + assert(csp); + assert(rsp); + assert(parameters); + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } + + if (NULL == (exports = default_exports(csp, NULL))) + { + 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"); + + if (err) + { + free_map(exports); + return err; + } + + return template_fill_for_cgi(csp, "edit-actions-url-form", exports, rsp); +} + + +/********************************************************************* + * + * 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 : + * filename : Identifies the file to edit + * ver : File's last-modified time + * 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; + + assert(csp); + assert(rsp); + assert(parameters); + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + return cgi_error_disabled(csp, rsp); + } + + if (NULL == (exports = default_exports(csp, NULL))) + { + 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"); + + if (err) + { + free_map(exports); + return err; + } + + return template_fill_for_cgi(csp, "edit-actions-add-url-form", exports, rsp); +} -/* FIXME: This should be in project.h and used everywhere */ -#define JB_ERR_OK 0 /* Success, no error */ -#define JB_ERR_MEMORY 1 /* Out of memory */ -#define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */ -#define JB_ERR_FILE 3 /* Error opening, reading or writing a file */ -#define JB_ERR_PARSE 4 /* Error parsing file */ -#define JB_ERR_MODIFIED 5 /* File has been modified outside of the */ - /* CGI actions editor. */ +/********************************************************************* + * + * Function : cgi_edit_actions_remove_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 : + * 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 + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the CGI parameters are not + * specified or not valid. + * + *********************************************************************/ +jb_err cgi_edit_actions_remove_url_form(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + struct map *exports; + jb_err err; + + assert(csp); + assert(rsp); + assert(parameters); + + if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + 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"); + + if (err) + { + free_map(exports); + return err; + } + + return template_fill_for_cgi(csp, "edit-actions-remove-url-form", exports, rsp); +} /********************************************************************* @@ -170,7 +573,7 @@ static int edit_read_line (FILE *fp, char **raw_out, char **prefix_out, char * * JB_ERR_FILE on EOF. * *********************************************************************/ -static int simple_read_line(char **dest, FILE *fp) +static jb_err simple_read_line(char **dest, FILE *fp) { int len; char * buf; @@ -185,7 +588,7 @@ static int simple_read_line(char **dest, FILE *fp) { return JB_ERR_MEMORY; } - + *buf = '\0'; len = 0; @@ -212,7 +615,7 @@ static int simple_read_line(char **dest, FILE *fp) *dest = buf; return JB_ERR_OK; } - + if (NULL == (newbuf = realloc(buf, len + BUFFER_SIZE))) { free(buf); @@ -232,7 +635,7 @@ static int simple_read_line(char **dest, FILE *fp) * 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 + * - 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 @@ -261,7 +664,7 @@ static int simple_read_line(char **dest, FILE *fp) * JB_ERR_FILE on EOF. * *********************************************************************/ -static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out) +static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out) { char *p; /* Temporary pointer */ char *linebuf; /* Line read from file */ @@ -271,7 +674,7 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da char *raw; /* String to be stored in raw_out */ char *prefix; /* String to be stored in prefix_out */ char *data; /* String to be stored in data_out */ - int rval = JB_ERR_OK; + jb_err rval = JB_ERR_OK; assert(fp); @@ -319,7 +722,7 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da free(linebuf); return JB_ERR_MEMORY; } - + /* Trim off newline */ p = linebuf + strlen(linebuf); if ((p != linebuf) && ((p[-1] == '\r') || (p[-1] == '\n'))) @@ -422,7 +825,7 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da { /* Got at least some data */ - /* Remove trailing whitespace */ + /* Remove trailing whitespace */ chomp(data); if (raw_out) @@ -449,7 +852,7 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da { free(data); } - return(0); + return JB_ERR_OK; } else { @@ -464,86 +867,6 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da } -/********************************************************************* - * - * Function : edit_read_file - * - * Description : Read a complete file into memory. - * Handles whitespace, comments and line continuation. - * - * Parameters : - * 1 : fp = File to read from - * 2 : pfile = Destination for a linked list of file_lines. - * Will be set to NULL on error. - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory - * - *********************************************************************/ -int edit_read_file(FILE *fp, struct file_line ** pfile) -{ - struct file_line * first_line; /* Keep for return value or to free */ - struct file_line * cur_line; /* Current line */ - struct file_line * prev_line; /* Entry with prev_line->next = cur_line */ - int rval; - - assert(fp); - assert(pfile); - - *pfile = NULL; - - cur_line = first_line = zalloc(sizeof(struct file_line)); - if (cur_line == NULL) - { - return JB_ERR_MEMORY; - } - - cur_line->type = FILE_LINE_UNPROCESSED; - - rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); - if (rval) - { - /* Out of memory or empty file. */ - /* Note that empty file is not an error we propogate up */ - free(cur_line); - return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval); - } - - do - { - prev_line = cur_line; - cur_line = prev_line->next = zalloc(sizeof(struct file_line)); - if (cur_line == NULL) - { - /* Out of memory */ - edit_free_file(first_line); - return JB_ERR_MEMORY; - } - - cur_line->type = FILE_LINE_UNPROCESSED; - - rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); - if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE)) - { - /* Out of memory */ - edit_free_file(first_line); - return JB_ERR_MEMORY; - } - - } - while (rval != JB_ERR_FILE); - - /* EOF */ - - /* We allocated one too many - free it */ - prev_line->next = NULL; - free(cur_line); - - *pfile = first_line; - return JB_ERR_OK; -} - - /********************************************************************* * * Function : edit_write_file @@ -556,24 +879,33 @@ int edit_read_file(FILE *fp, struct file_line ** pfile) * * Returns : JB_ERR_OK on success * JB_ERR_FILE on error writing to file. + * JB_ERR_MEMORY on out of memory * *********************************************************************/ -int edit_write_file(const char * filename, const struct file_line * file) +jb_err edit_write_file(struct editable_file * file) { FILE * fp; + struct file_line * cur_line; + struct stat statbuf[1]; + char version_buf[22]; /* 22 = ceil(log10(2^64)) + 2 = max number of + digits in time_t, assuming this is a 64-bit + machine, plus null terminator, plus one + for paranoia */ - assert(filename); + assert(file); + assert(file->filename); - if (NULL == (fp = fopen(filename, "wt"))) + if (NULL == (fp = fopen(file->filename, "wt"))) { return JB_ERR_FILE; } - while (file != NULL) + cur_line = file->lines; + while (cur_line != NULL) { - if (file->raw) + if (cur_line->raw) { - if (fputs(file->raw, fp) < 0) + if (fputs(cur_line->raw, fp) < 0) { fclose(fp); return JB_ERR_FILE; @@ -581,17 +913,17 @@ int edit_write_file(const char * filename, const struct file_line * file) } else { - if (file->prefix) + if (cur_line->prefix) { - if (fputs(file->prefix, fp) < 0) + if (fputs(cur_line->prefix, fp) < 0) { fclose(fp); return JB_ERR_FILE; } } - if (file->unprocessed) + if (cur_line->unprocessed) { - if (fputs(file->unprocessed, fp) < 0) + if (fputs(cur_line->unprocessed, fp) < 0) { fclose(fp); return JB_ERR_FILE; @@ -608,10 +940,32 @@ int edit_write_file(const char * filename, const struct file_line * file) assert(0); } } - file = file->next; + cur_line = cur_line->next; } fclose(fp); + + + /* Update the version stamp in the file structure, since we just + * wrote to the file & changed it's date. + */ + if (stat(file->filename, statbuf) < 0) + { + /* Error, probably file not found. */ + return JB_ERR_FILE; + } + file->version = (unsigned)statbuf->st_mtime; + + /* Correct file->version_str */ + freez(file->version_str); + snprintf(version_buf, 22, "%u", file->version); + version_buf[21] = '\0'; + file->version_str = strdup(version_buf); + if (version_buf == NULL) + { + return JB_ERR_MEMORY; + } + return JB_ERR_OK; } @@ -620,7 +974,7 @@ int edit_write_file(const char * filename, const struct file_line * file) * * Function : edit_free_file * - * Description : Free a complete file in memory. + * Description : Free a complete file in memory. * * Parameters : * 1 : file = Data structure to free. @@ -628,20 +982,52 @@ int edit_write_file(const char * filename, const struct file_line * file) * Returns : N/A * *********************************************************************/ -void edit_free_file(struct file_line * file) +void edit_free_file(struct editable_file * file) { - struct file_line * next; - - while (file != NULL) + if (!file) { - next = file->next; - file->next = NULL; - freez(file->raw); - freez(file->prefix); - freez(file->unprocessed); - switch(file->type) - { - case 0: /* special case if memory zeroed */ + /* Silently ignore NULL pointer */ + return; + } + + edit_free_file_lines(file->lines); + freez(file->filename); + freez(file->identifier); + freez(file->version_str); + file->version = 0; + file->parse_error_text = NULL; /* Statically allocated */ + file->parse_error = NULL; + + free(file); +} + + +/********************************************************************* + * + * Function : edit_free_file + * + * Description : Free an entire linked list of file lines. + * + * Parameters : + * 1 : first_line = Data structure to free. + * + * Returns : N/A + * + *********************************************************************/ +static void edit_free_file_lines(struct file_line * first_line) +{ + struct file_line * next_line; + + while (first_line != NULL) + { + next_line = first_line->next; + first_line->next = NULL; + freez(first_line->raw); + freez(first_line->prefix); + freez(first_line->unprocessed); + switch(first_line->type) + { + case 0: /* special case if memory zeroed */ case FILE_LINE_UNPROCESSED: case FILE_LINE_BLANK: case FILE_LINE_ALIAS_HEADER: @@ -654,21 +1040,21 @@ void edit_free_file(struct file_line * file) break; case FILE_LINE_ACTION: - free_action(file->data.action); + free_action(first_line->data.action); break; case FILE_LINE_SETTINGS_ENTRY: - freez(file->data.setting.name); - freez(file->data.setting.svalue); + freez(first_line->data.setting.name); + freez(first_line->data.setting.svalue); break; default: /* Should never happen */ assert(0); break; } - file->type = 0; /* paranoia */ - free(file); - file = next; + first_line->type = 0; /* paranoia */ + free(first_line); + first_line = next_line; } } @@ -677,7 +1063,7 @@ void edit_free_file(struct file_line * file) * * Function : match_actions_file_header_line * - * Description : Match an actions file {{header}} line + * Description : Match an actions file {{header}} line * * Parameters : * 1 : line - String from file @@ -735,7 +1121,7 @@ static int match_actions_file_header_line(const char * line, const char * name) * * Function : match_actions_file_header_line * - * Description : Match an actions file {{header}} line + * Description : Match an actions file {{header}} line * * Parameters : * 1 : line - String from file. Must not start with @@ -750,7 +1136,7 @@ static int match_actions_file_header_line(const char * line, const char * name) * values *after* the "=" sign are legal). * *********************************************************************/ -static int split_line_on_equals(const char * line, char ** pname, char ** pvalue) +static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue) { const char * name_end; const char * value_start; @@ -813,7 +1199,7 @@ static int split_line_on_equals(const char * line, char ** pname, char ** pvalue * * Function : edit_parse_actions_file * - * Description : Parse an actions file in memory. + * Description : Parse an actions file in memory. * * Passed linked list must have the "data" member * zeroed, and must contain valid "next" and @@ -831,7 +1217,7 @@ static int split_line_on_equals(const char * line, char ** pname, char ** pvalue * JB_ERR_PARSE on error * *********************************************************************/ -int edit_parse_actions_file(struct file_line * file) +jb_err edit_parse_actions_file(struct editable_file * file) { struct file_line * cur_line; int len; @@ -839,16 +1225,16 @@ int edit_parse_actions_file(struct file_line * file) char * name; /* For lines of the form name=value */ char * value; /* For lines of the form name=value */ struct action_alias * alias_list = NULL; - int rval = JB_ERR_OK; + jb_err err = JB_ERR_OK; /* alias_list contains the aliases defined in this file. * It might be better to use the "file_line.data" fields * in the relavent places instead. */ - cur_line = file; + cur_line = file->lines; - /* A note about blank line support: Blank lines should only + /* A note about blank line support: Blank lines should only * ever occur as the last line in the file. This function * is more forgiving than that - FILE_LINE_BLANK can occur * anywhere. @@ -869,6 +1255,8 @@ int edit_parse_actions_file(struct file_line * file) && (cur_line->unprocessed[0] != '{') ) { /* File doesn't start with a header */ + file->parse_error = cur_line; + file->parse_error_text = "First (non-comment) line of the file must contain a header."; return JB_ERR_PARSE; } @@ -884,13 +1272,19 @@ int edit_parse_actions_file(struct file_line * file) { cur_line->type = FILE_LINE_SETTINGS_ENTRY; - rval = split_line_on_equals(cur_line->unprocessed, + err = split_line_on_equals(cur_line->unprocessed, &cur_line->data.setting.name, &cur_line->data.setting.svalue); - if (rval != JB_ERR_OK) + if (err == JB_ERR_MEMORY) + { + return err; + } + else if (err != JB_ERR_OK) { - /* Line does not contain a name=value pair, or out-of-memory */ - return rval; + /* Line does not contain a name=value pair */ + file->parse_error = cur_line; + file->parse_error_text = "Expected a name=value pair on this {{description}} line, but couldn't find one."; + return JB_ERR_PARSE; } } else @@ -936,11 +1330,17 @@ int edit_parse_actions_file(struct file_line * file) cur_line->type = FILE_LINE_ALIAS_ENTRY; - rval = split_line_on_equals(cur_line->unprocessed, &name, &value); - if (rval != JB_ERR_OK) + err = split_line_on_equals(cur_line->unprocessed, &name, &value); + if (err == JB_ERR_MEMORY) + { + return err; + } + else if (err != JB_ERR_OK) { - /* Line does not contain a name=value pair, or out-of-memory */ - return rval; + /* Line does not contain a name=value pair */ + file->parse_error = cur_line; + file->parse_error_text = "Expected a name=value pair on this {{alias}} line, but couldn't find one."; + return JB_ERR_PARSE; } if ((new_alias = zalloc(sizeof(*new_alias))) == NULL) @@ -952,14 +1352,25 @@ int edit_parse_actions_file(struct file_line * file) return JB_ERR_MEMORY; } - if (get_actions(value, alias_list, new_alias->action)) + err = get_actions(value, alias_list, new_alias->action); + if (err) { /* Invalid action or out of memory */ free(name); free(value); free(new_alias); free_alias_list(alias_list); - return JB_ERR_PARSE; /* FIXME: or JB_ERR_MEMORY */ + if (err == JB_ERR_MEMORY) + { + return err; + } + else + { + /* Line does not contain a name=value pair */ + file->parse_error = cur_line; + file->parse_error_text = "This alias does not specify a valid set of actions."; + return JB_ERR_PARSE; + } } free(value); @@ -989,6 +1400,10 @@ int edit_parse_actions_file(struct file_line * file) { /* No closing } on header */ free_alias_list(alias_list); + file->parse_error = cur_line; + file->parse_error_text = "Headers starting with '{' must have a " + "closing bracket ('}'). Headers starting with two brackets ('{{') " + "must close with two brackets ('}}')."; return JB_ERR_PARSE; } @@ -996,6 +1411,12 @@ int edit_parse_actions_file(struct file_line * file) { /* An invalid {{ header. */ free_alias_list(alias_list); + file->parse_error = cur_line; + file->parse_error_text = "Unknown or unexpected two-bracket header. " + "Please remember that the system (two-bracket) headers must " + "appear in the order {{settings}}, {{description}}, {{alias}}, " + "and must appear before any actions (one-bracket) headers. " + "Also note that system headers may not be repeated."; return JB_ERR_PARSE; } @@ -1010,12 +1431,6 @@ int edit_parse_actions_file(struct file_line * file) { len--; } - if (len <= 0) - { - /* A line containing just { } */ - free_alias_list(alias_list); - return JB_ERR_PARSE; - } cur_line->type = FILE_LINE_ACTION; @@ -1030,12 +1445,23 @@ int edit_parse_actions_file(struct file_line * file) value[len] = '\0'; /* Get actions */ - if (get_actions(value, alias_list, cur_line->data.action)) + err = get_actions(value, alias_list, cur_line->data.action); + if (err) { /* Invalid action or out of memory */ free(value); free_alias_list(alias_list); - return JB_ERR_PARSE; /* FIXME: or JB_ERR_MEMORY */ + if (err == JB_ERR_MEMORY) + { + return err; + } + else + { + /* Line does not contain a name=value pair */ + file->parse_error = cur_line; + file->parse_error_text = "This header does not specify a valid set of actions."; + return JB_ERR_PARSE; + } } /* Done with string - it was clobbered anyway */ @@ -1069,51 +1495,316 @@ int edit_parse_actions_file(struct file_line * file) /********************************************************************* * - * Function : edit_read_file + * Function : edit_read_file_lines * - * Description : Read a complete actions file into memory and - * parses it. + * Description : Read all the lines of a file into memory. + * Handles whitespace, comments and line continuation. * * Parameters : - * 1 : filename = Path to file to read from + * 1 : fp = File to read from. On return, this will be + * at EOF but it will not have been closed. * 2 : pfile = Destination for a linked list of file_lines. * Will be set to NULL on error. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory + * + *********************************************************************/ +jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) +{ + struct file_line * first_line; /* Keep for return value or to free */ + struct file_line * cur_line; /* Current line */ + struct file_line * prev_line; /* Entry with prev_line->next = cur_line */ + jb_err rval; + + assert(fp); + assert(pfile); + + *pfile = NULL; + + cur_line = first_line = zalloc(sizeof(struct file_line)); + if (cur_line == NULL) + { + return JB_ERR_MEMORY; + } + + cur_line->type = FILE_LINE_UNPROCESSED; + + rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); + if (rval) + { + /* Out of memory or empty file. */ + /* Note that empty file is not an error we propogate up */ + free(cur_line); + return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval); + } + + do + { + prev_line = cur_line; + cur_line = prev_line->next = zalloc(sizeof(struct file_line)); + if (cur_line == NULL) + { + /* Out of memory */ + edit_free_file_lines(first_line); + return JB_ERR_MEMORY; + } + + cur_line->type = FILE_LINE_UNPROCESSED; + + rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); + if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE)) + { + /* Out of memory */ + edit_free_file_lines(first_line); + return JB_ERR_MEMORY; + } + + } + while (rval != JB_ERR_FILE); + + /* EOF */ + + /* We allocated one too many - free it */ + prev_line->next = NULL; + free(cur_line); + + *pfile = first_line; + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : edit_read_file + * + * Description : Read a complete file into memory. + * Handles CGI parameter parsing. If requested, also + * checks the file's modification timestamp. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : parameters = map of cgi parameters. + * 3 : require_version = true to check "ver" parameter. + * 4 : suffix = File extension, e.g. ".action". + * 5 : pfile = Destination for the file. Will be set + * to NULL on error. + * + * CGI Parameters : + * filename : The name of the file to read, without the + * path or ".action" extension. + * ver : (Only if require_version is nonzero) + * Timestamp of the actions file. If wrong, this + * function fails with JB_ERR_MODIFIED. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if "filename" was not specified + * or is not valid. * JB_ERR_FILE if the file cannot be opened or * contains no data + * JB_ERR_MODIFIED if version checking was requested and + * failed - the file was modified outside + * of this CGI editor instance. * *********************************************************************/ -int edit_read_actions_file(const char * filename, struct file_line ** pfile) +jb_err edit_read_file(struct client_state *csp, + const struct map *parameters, + int require_version, + const char *suffix, + struct editable_file **pfile) { - struct file_line * file; + struct file_line * lines; FILE * fp; - int rval; + jb_err err; + char * filename; + const char * identifier; + struct editable_file * file; + unsigned version = 0; + struct stat statbuf[1]; + char version_buf[22]; - assert(filename); + assert(csp); + assert(parameters); assert(pfile); *pfile = NULL; + err = get_file_name_param(csp, parameters, "filename", suffix, + &filename, &identifier); + if (err) + { + return err; + } + + if (stat(filename, statbuf) < 0) + { + /* Error, probably file not found. */ + free(filename); + return JB_ERR_FILE; + } + version = (unsigned) statbuf->st_mtime; + + if (require_version) + { + unsigned specified_version; + err = get_number_param(csp, parameters, "ver", &specified_version); + if (err) + { + free(filename); + return err; + } + + if (version != specified_version) + { + return JB_ERR_MODIFIED; + } + } + if (NULL == (fp = fopen(filename,"rt"))) { + free(filename); return JB_ERR_FILE; } - rval = edit_read_file(fp, &file); + err = edit_read_file_lines(fp, &lines); fclose(fp); - if (JB_ERR_OK != rval) + if (err) { - return rval; + free(filename); + return err; + } + + file = (struct editable_file *) zalloc(sizeof(*file)); + if (err) + { + free(filename); + edit_free_file_lines(lines); + return err; } - if (JB_ERR_OK != (rval = edit_parse_actions_file(file))) + file->lines = lines; + file->filename = filename; + file->version = version; + file->identifier = strdup(identifier); + + if (file->identifier == NULL) { edit_free_file(file); - return rval; + return JB_ERR_MEMORY; + } + + /* Correct file->version_str */ + freez(file->version_str); + snprintf(version_buf, 22, "%u", file->version); + version_buf[21] = '\0'; + file->version_str = strdup(version_buf); + if (version_buf == NULL) + { + edit_free_file(file); + return JB_ERR_MEMORY; + } + + *pfile = file; + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : edit_read_actions_file + * + * Description : Read a complete actions file into memory. + * Handles CGI parameter parsing. If requested, also + * checks the file's modification timestamp. + * + * If this function detects an error in the categories + * JB_ERR_FILE, JB_ERR_MODIFIED, or JB_ERR_PARSE, + * then it handles it by filling in the specified + * response structure and returning JB_ERR_FILE. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = HTTP response. Only filled in on error. + * 2 : parameters = map of cgi parameters. + * 3 : require_version = true to check "ver" parameter. + * 4 : pfile = Destination for the file. Will be set + * to NULL on error. + * + * CGI Parameters : + * filename : The name of the actions file to read, without the + * path or ".action" extension. + * ver : (Only if require_version is nonzero) + * Timestamp of the actions file. If wrong, this + * function fails with JB_ERR_MODIFIED. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if "filename" was not specified + * or is not valid. + * JB_ERR_FILE if the file does not contain valid data, + * or if file cannot be opened or + * contains no data, or if version + * checking was requested and failed. + * + *********************************************************************/ +jb_err edit_read_actions_file(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters, + int require_version, + struct editable_file **pfile) +{ + jb_err err; + struct editable_file *file; + + assert(csp); + assert(parameters); + assert(pfile); + + *pfile = NULL; + + err = edit_read_file(csp, parameters, require_version, ".action", &file); + if (err) + { + /* Try to handle if possible */ + if (err == JB_ERR_FILE) + { + err = cgi_error_file(csp, rsp, lookup(parameters, "filename")); + } + else if (err == JB_ERR_MODIFIED) + { + err = cgi_error_modified(csp, rsp, lookup(parameters, "filename")); + } + if (err == JB_ERR_OK) + { + /* + * Signal to higher-level CGI code that there was a problem but we + * handled it, they should just return JB_ERR_OK. + */ + err = JB_ERR_FILE; + } + return err; + } + + err = edit_parse_actions_file(file); + if (err) + { + if (err == JB_ERR_PARSE) + { + err = cgi_error_parse(csp, rsp, file); + if (err == JB_ERR_OK) + { + /* + * Signal to higher-level CGI code that there was a problem but we + * handled it, they should just return JB_ERR_OK. + */ + err = JB_ERR_FILE; + } + } + edit_free_file(file); + return err; } *pfile = file; @@ -1152,19 +1843,18 @@ int edit_read_actions_file(const char * filename, struct file_line ** pfile) * of the map "parameters", so don't free it. * Set to NULL if not specified. * - * CGI Parameters : None - * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if "filename" was not specified * or is not valid. * *********************************************************************/ -static int get_file_name_param(struct client_state *csp, - struct map *parameters, - char *suffix, - char **pfilename, - const char **pparam) +static jb_err get_file_name_param(struct client_state *csp, + const struct map *parameters, + const char *param_name, + const char *suffix, + char **pfilename, + const char **pparam) { const char *param; const char *s; @@ -1182,7 +1872,7 @@ static int get_file_name_param(struct client_state *csp, *pfilename = NULL; *pparam = NULL; - param = lookup(parameters, "filename"); + param = lookup(parameters, param_name); if (!*param) { return JB_ERR_CGI_PARAMS; @@ -1250,22 +1940,20 @@ static int get_file_name_param(struct client_state *csp, * 4 : pvalue = destination for value. * Set to -1 on error. * - * CGI Parameters : None - * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory - * JB_ERR_CGI_PARAMS if "filename" was not specified + * JB_ERR_CGI_PARAMS if the parameter was not specified * or is not valid. * *********************************************************************/ -static int get_number_param(struct client_state *csp, - struct map *parameters, - char *name, - int *pvalue) +static jb_err get_number_param(struct client_state *csp, + const struct map *parameters, + char *name, + unsigned *pvalue) { const char *param; char ch; - int value; + unsigned value; assert(csp); assert(parameters); @@ -1294,12 +1982,12 @@ static int get_number_param(struct client_state *csp, /* Note: * - * defines INT_MAX + * defines UINT_MAX * - * (INT_MAX - ch) / 10 is the largest number that + * (UINT_MAX - ch) / 10 is the largest number that * can be safely multiplied by 10 then have ch added. */ - if (value > ((INT_MAX - ch) / 10)) + if (value > ((UINT_MAX - (unsigned)ch) / 10U)) { return JB_ERR_CGI_PARAMS; } @@ -1316,300 +2004,83 @@ static int get_number_param(struct client_state *csp, /********************************************************************* * - * Function : cgi_edit_actions + * Function : map_radio * - * Description : CGI function that allows the user to choose which - * actions file to edit. + * Description : Map a set of radio button values. E.g. if you have + * 3 radio buttons, declare them as: + *