From fc38802c68b57157c6e3c763d15dbd9f8e85e170 Mon Sep 17 00:00:00 2001 From: jongfoster Date: Tue, 23 Oct 2001 21:48:19 +0000 Subject: [PATCH] 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. --- cgi.c | 581 +++++- cgi.h | 31 +- cgiedit.c | 2887 ++++++++++++++++++++------- cgiedit.h | 55 +- cgisimple.c | 600 ++++-- cgisimple.h | 53 +- templates/cgi-error-bad-param | 157 ++ templates/cgi-error-disabled | 147 ++ templates/cgi-error-file | 143 ++ templates/cgi-error-modified | 162 ++ templates/cgi-error-parse | 180 ++ templates/edit-actions-for-url | 1 + templates/edit-actions-list | 53 +- templates/edit-actions-list-section | 13 +- templates/edit-actions-list-url | 7 +- templates/toggle | 186 ++ templates/toggle-mini | 90 + 17 files changed, 4297 insertions(+), 1049 deletions(-) create mode 100644 templates/cgi-error-bad-param create mode 100644 templates/cgi-error-disabled create mode 100644 templates/cgi-error-file create mode 100644 templates/cgi-error-modified create mode 100644 templates/cgi-error-parse create mode 100644 templates/toggle create mode 100644 templates/toggle-mini diff --git a/cgi.c b/cgi.c index d5f87703..7ad60170 100644 --- a/cgi.c +++ b/cgi.c @@ -1,4 +1,4 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.33 2001/10/14 22:28:41 jongfoster Exp $"; +const char cgi_rcs[] = "$Id: cgi.c,v 1.34 2001/10/18 22:22:09 david__schmidt Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ @@ -38,6 +38,11 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.33 2001/10/14 22:28:41 jongfoster Exp $"; * * Revisions : * $Log: cgi.c,v $ + * Revision 1.34 2001/10/18 22:22:09 david__schmidt + * Only show "Local support" on templates conditionally: + * - if either 'admin-address' or 'proxy-info-url' are uncommented in config + * - if not, no Local support section appears are removed automatically + * * Revision 1.33 2001/10/14 22:28:41 jongfoster * Fixing stupid typo. * @@ -265,6 +270,9 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { cgi_show_url_info, "Show which actions apply to a URL and why" }, #ifdef FEATURE_CGI_EDIT_ACTIONS + { "toggle", + cgi_toggle, + "Toggle JunkBuster on or off" }, { "edit-actions", cgi_edit_actions, "Edit the actions list" }, @@ -280,6 +288,21 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { { "edit-actions-submit", cgi_edit_actions_submit, NULL /* Change the actions for (a) specified URL(s) */ }, + { "edit-actions-url", + cgi_edit_actions_url, + NULL /* Change a URL pattern in the actionsfile */ }, + { "edit-actions-add-url", + cgi_edit_actions_add_url, + NULL /* Add a URL pattern to the actionsfile */ }, + { "edit-actions-remove-url", + cgi_edit_actions_remove_url, + NULL /* Add a URL pattern to the actionsfile */ }, + { "edit-actions-section-remove", + cgi_edit_actions_section_remove, + NULL /* Remove a section from the actionsfile */ }, + { "edit-actions-section-add", + cgi_edit_actions_section_add, + NULL /* Remove a section from the actionsfile */ }, #endif /* def FEATURE_CGI_EDIT_ACTIONS */ { "robots.txt", cgi_robots_txt, @@ -321,6 +344,9 @@ const char image_blank_gif_data[] = const int image_blank_gif_length = sizeof(image_blank_gif_data) - 1; +static struct http_response cgi_error_memory_response[1]; + + static struct http_response *dispatch_known_cgi(struct client_state * csp, const char * path); @@ -415,11 +441,11 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, struct http_response *rsp; char *query_args_start; char *path_copy; - int result; + jb_err err; if (NULL == (path_copy = strdup(path))) { - return NULL; + return cgi_error_memory(); } query_args_start = path_copy; @@ -435,7 +461,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, if (NULL == (param_list = parse_cgi_parameters(query_args_start))) { free(path_copy); - return(NULL); + return cgi_error_memory(); } @@ -450,7 +476,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, { free(path_copy); free_map(param_list); - return NULL; + return cgi_error_memory(); } log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path); @@ -462,19 +488,23 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, { if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0)) { - result = (d->handler)(csp, rsp, param_list); + err = (d->handler)(csp, rsp, param_list); free(path_copy); free_map(param_list); - if (result) + if (err == JB_ERR_CGI_PARAMS) { - /* Error in handler */ - free_http_response(rsp); - return(NULL); + err = cgi_error_bad_param(csp, rsp); } - else + if (!err) { /* It worked */ - return(finish_http_response(rsp)); + return finish_http_response(rsp); + } + else + { + /* Error in handler, probably out-of-memory */ + free_http_response(rsp); + return cgi_error_memory(); } } } @@ -513,11 +543,15 @@ static struct map *parse_cgi_parameters(char *argstring) if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0')) { *p = '\0'; - map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0); + if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0)) + { + free_map(cgi_params); + return NULL; + } } } - return(cgi_params); + return cgi_params; } @@ -532,44 +566,248 @@ static struct map *parse_cgi_parameters(char *argstring) * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) * 2 : templatename = Which template should be used for the answer - * 3 : errno = system error number + * 3 : sys_err = system error number * - * Returns : NULL if no memory, else http_response + * Returns : A http_response. If we run out of memory, this + * will be cgi_error_memory(). * *********************************************************************/ -struct http_response *error_response(struct client_state *csp, const char *templatename, int err) +struct http_response *error_response(struct client_state *csp, + const char *templatename, + int sys_err) { + jb_err err; struct http_response *rsp; struct map * exports = default_exports(csp, NULL); + if (exports == NULL) + { + return cgi_error_memory(); + } if (NULL == (rsp = alloc_http_response())) { - return NULL; + free_map(exports); + return cgi_error_memory(); } - map(exports, "host-html", 1, html_encode(csp->http->host), 0); - map(exports, "hostport", 1, csp->http->hostport, 1); - map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0); - map(exports, "path", 1, csp->http->path, 1); - map(exports, "path-html", 1, html_encode(csp->http->path), 0); - map(exports, "error", 1, safe_strerror(err), 0); - map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1); + err = map(exports, "host-html", 1, html_encode(csp->http->host), 0) + || map(exports, "hostport", 1, csp->http->hostport, 1) + || map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0) + || map(exports, "path", 1, csp->http->path, 1) + || map(exports, "path-html", 1, html_encode(csp->http->path), 0) + || map(exports, "error", 1, safe_strerror(sys_err), 0) + || map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1); - rsp->body = template_load(csp, templatename); - template_fill(&rsp->body, exports); - free_map(exports); + if (err) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } if (!strcmp(templatename, "no-such-domain")) { - rsp->status = strdup("404 No such domain"); + rsp->status = strdup("404 No such domain"); + if (rsp->status == NULL) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } } else if (!strcmp(templatename, "connect-failed")) { rsp->status = strdup("503 Connect failed"); + if (rsp->status == NULL) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } } - return(finish_http_response(rsp)); + err = template_fill_for_cgi(csp, templatename, exports, rsp); + if (err) + { + free_http_response(rsp); + return cgi_error_memory(); + } + return finish_http_response(rsp); +} + + +/********************************************************************* + * + * Function : cgi_init_error_messages + * + * Description : Call at the start of the program to initialize + * the error message used by cgi_error_memory(). + * + * Parameters : N/A + * + * Returns : N/A + * + *********************************************************************/ +void cgi_init_error_messages(void) +{ + memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response)); + cgi_error_memory_response->head = + "HTTP/1.0 500 Internal JunkBuster Proxy Error\r\n" + "Content-Type: text/html\r\n" + "\r\n"; + cgi_error_memory_response->body = + "\r\n" + "500 Internal JunkBuster Proxy Error\r\n" + "\r\n" + "

500 Internal JunkBuster Proxy Error

\r\n" + "

JunkBuster ran out of memory whilst processing your request.

\r\n" + "

Please contact your proxy administrator, or try again later

\r\n" + "\r\n" + "\r\n"; + + cgi_error_memory_response->head_length = + strlen(cgi_error_memory_response->head); + cgi_error_memory_response->content_length = + strlen(cgi_error_memory_response->body); +} + + +/********************************************************************* + * + * Function : cgi_error_memory + * + * Description : Called if a CGI function runs out of memory. + * Returns a statically-allocated error response. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : template_name = Name of template that could not + * be loaded. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +struct http_response *cgi_error_memory(void) +{ + /* assert that it's been initialized. */ + assert(cgi_error_memory_response->head); + + return cgi_error_memory_response; +} + + +/********************************************************************* + * + * Function : cgi_error_no_template + * + * Description : Almost-CGI function that is called if a templae + * cannot be loaded. Note this is not a true CGI, + * it takes a template name rather than a map of + * parameters. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : template_name = Name of template that could not + * be loaded. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_error_no_template(struct client_state *csp, + struct http_response *rsp, + const char *template_name) +{ + static const char status[] = + "500 Internal JunkBuster Proxy Error"; + static const char body_prefix[] = + "\r\n" + "500 Internal JunkBuster Proxy Error\r\n" + "\r\n" + "

500 Internal JunkBuster Proxy Error

\r\n" + "

JunkBuster encountered an error whilst processing your request:

\r\n" + "

Could not load template file "; + static const char body_suffix[] = + "

\r\n" + "

Please contact your proxy administrator.

\r\n" + "

If you are the proxy administrator, please put the required file " + "in the (confdir)/templates directory. The " + "location of the (confdir) directory " + "is specified in the main JunkBuster config " + "file. (It's typically the JunkBuster install directory" +#ifndef _WIN32 + ", or /etc/junkbuster/" +#endif /* ndef _WIN32 */ + ").

\r\n" + "\r\n" + "\r\n"; + + assert(csp); + assert(rsp); + assert(template_name); + + /* Reset rsp, if needed */ + freez(rsp->status); + freez(rsp->head); + freez(rsp->body); + rsp->content_length = 0; + rsp->head_length = 0; + rsp->is_static = 0; + + rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1); + if (rsp->body == NULL) + { + return JB_ERR_MEMORY; + } + strcpy(rsp->body, body_prefix); + strcat(rsp->body, template_name); + strcat(rsp->body, body_suffix); + + rsp->status = strdup(status); + if (rsp->body == NULL) + { + return JB_ERR_MEMORY; + } + + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : cgi_error_bad_param + * + * Description : CGI function that is called if the parameters + * (query string) for a CGI were wrong. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * + * CGI Parameters : none + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_error_bad_param(struct client_state *csp, + struct http_response *rsp) +{ + struct map *exports; + + assert(csp); + assert(rsp); + + if (NULL == (exports = default_exports(csp, NULL))) + { + return JB_ERR_MEMORY; + } + + return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp); } @@ -621,7 +859,6 @@ void get_http_time(int time_offset, char *buf) t->tm_min, t->tm_sec ); - buf[32] = '\0'; } @@ -636,18 +873,28 @@ void get_http_time(int time_offset, char *buf) * Parameters : * 1 : rsp = pointer to http_response to be processed * - * Returns : http_response, or NULL on failiure + * Returns : A http_response, usually the rsp parameter. + * On error, free()s rsp and returns cgi_error_memory() * *********************************************************************/ struct http_response *finish_http_response(struct http_response *rsp) { char buf[BUFFER_SIZE]; + jb_err err; + + /* Special case - do NOT change this statically allocated response, + * which is ready for output anyway. + */ + if (rsp == cgi_error_memory_response) + { + return rsp; + } /* * Fill in the HTTP Status */ sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK"); - enlist_first(rsp->headers, buf); + err = enlist_first(rsp->headers, buf); /* * Set the Content-Length @@ -657,7 +904,7 @@ struct http_response *finish_http_response(struct http_response *rsp) rsp->content_length = rsp->body ? strlen(rsp->body) : 0; } sprintf(buf, "Content-Length: %d", rsp->content_length); - enlist(rsp->headers, buf); + err = err || enlist(rsp->headers, buf); /* * Fill in the default headers: @@ -670,7 +917,7 @@ struct http_response *finish_http_response(struct http_response *rsp) * * See http://www.w3.org/Protocols/rfc2068/rfc2068 */ - enlist_unique(rsp->headers, "Content-Type: text/html", 13); + err = err || enlist_unique(rsp->headers, "Content-Type: text/html", 13); if (rsp->is_static) { @@ -680,13 +927,13 @@ struct http_response *finish_http_response(struct http_response *rsp) */ get_http_time(0, buf); - enlist_unique_header(rsp->headers, "Date", buf); + err = err || enlist_unique_header(rsp->headers, "Date", buf); /* Some date in the past. */ - enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT"); + err = err || enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT"); get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */ - enlist_unique_header(rsp->headers, "Expires", buf); + err = err || enlist_unique_header(rsp->headers, "Expires", buf); } else { @@ -695,28 +942,28 @@ struct http_response *finish_http_response(struct http_response *rsp) * setting. However, to be certain, we also set both "Last-Modified" * and "Expires" to the current time. */ - enlist_unique_header(rsp->headers, "Cache-Control", "no-cache"); + err = err || enlist_unique_header(rsp->headers, "Cache-Control", "no-cache"); get_http_time(0, buf); - enlist_unique_header(rsp->headers, "Date", buf); - enlist_unique_header(rsp->headers, "Last-Modified", buf); - enlist_unique_header(rsp->headers, "Expires", buf); + err = err || enlist_unique_header(rsp->headers, "Date", buf); + err = err || enlist_unique_header(rsp->headers, "Last-Modified", buf); + err = err || enlist_unique_header(rsp->headers, "Expires", buf); } /* * Write the head */ - if (NULL == (rsp->head = list_to_text(rsp->headers))) + if (err || (NULL == (rsp->head = list_to_text(rsp->headers)))) { free_http_response(rsp); - return(NULL); + return cgi_error_memory(); } rsp->head_length = strlen(rsp->head); - return(rsp); + return rsp; } - + /********************************************************************* * @@ -751,7 +998,10 @@ struct http_response *alloc_http_response(void) *********************************************************************/ void free_http_response(struct http_response *rsp) { - if (rsp) + /* + * Must special case cgi_error_memory_response, which is never freed. + */ + if (rsp && (rsp != cgi_error_memory_response)) { freez(rsp->status); freez(rsp->head); @@ -773,31 +1023,68 @@ void free_http_response(struct http_response *rsp) * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : template_ptr = Destination for pointer to loaded + * template text. * 3 : template = name of the HTML template to be used * - * Returns : char * with loaded template, or NULL if failure + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * JB_ERR_FILE if the template file cannot be read * *********************************************************************/ -char *template_load(struct client_state *csp, const char *templatename) +jb_err template_load(struct client_state *csp, char ** template_ptr, + const char *templatename) { - char buf[BUFFER_SIZE]; - char *file_buffer = NULL; + char *templates_dir_path; + char *full_path; + char *file_buffer; FILE *fp; + char buf[BUFFER_SIZE]; + + assert(csp); + assert(template_ptr); + assert(templatename); + + *template_ptr = NULL; /* * Open template file or fail */ - snprintf(buf, BUFFER_SIZE, "%s/templates/%s", csp->config->confdir, templatename); - if(NULL == (fp = fopen(buf, "r"))) + templates_dir_path = make_path(csp->config->confdir, "templates"); + if (templates_dir_path == NULL) { - log_error(LOG_LEVEL_FATAL, "error loading template %s: %E", buf); - return NULL; + return JB_ERR_MEMORY; + } + + full_path = make_path(templates_dir_path, templatename); + free(templates_dir_path); + if (full_path == NULL) + { + return JB_ERR_MEMORY; } - + + file_buffer = strdup(""); + if (file_buffer == NULL) + { + free(full_path); + return JB_ERR_MEMORY; + } + + if (NULL == (fp = fopen(full_path, "r"))) + { + log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path); + free(full_path); + free(file_buffer); + return JB_ERR_FILE; + } + free(full_path); /* - * Read the file, ignoring comments + * Read the file, ignoring comments. + * + * FIXME: The comment handling could break with lines >BUFFER_SIZE long. + * This is unlikely in practise. */ while (fgets(buf, BUFFER_SIZE, fp)) { @@ -806,19 +1093,24 @@ char *template_load(struct client_state *csp, const char *templatename) { continue; } - - file_buffer = strsav(file_buffer, buf); + + if (string_append(&file_buffer, buf)) + { + fclose(fp); + return JB_ERR_MEMORY; + } } fclose(fp); - return(file_buffer); + *template_ptr = file_buffer; + return JB_ERR_OK; } /********************************************************************* * - * Function : fill_template + * Function : template_fill * * Description : CGI support function that fills in a pre-loaded * HTML template by replacing @name@ with value using @@ -835,10 +1127,11 @@ char *template_load(struct client_state *csp, const char *templatename) * Caller must free(). * 2 : exports = map with fill in symbol -> name pairs * - * Returns : N/A + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error * *********************************************************************/ -void template_fill(char **template_ptr, struct map *exports) +jb_err template_fill(char **template_ptr, const struct map *exports) { struct map_entry *m; pcrs_job *job; @@ -891,17 +1184,29 @@ void template_fill(char **template_ptr, struct map *exports) job = pcrs_compile(buf, m->value, flags, &error); if (job == NULL) { - log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error); + if (error == PCRS_ERR_NOMEM) + { + free(file_buffer); + *template_ptr = NULL; + return JB_ERR_MEMORY; + } + else + { + log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error); + /* Hope it wasn't important and silently ignore the invalid job */ + } } else { pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size); - if (NULL != tmp_out_buffer) + free(file_buffer); + pcrs_free_job(job); + if (NULL == tmp_out_buffer) { - free(file_buffer); - file_buffer = tmp_out_buffer; + *template_ptr = NULL; + return JB_ERR_MEMORY; } - pcrs_free_job(job); + file_buffer = tmp_out_buffer; } } @@ -909,10 +1214,57 @@ void template_fill(char **template_ptr, struct map *exports) * Return */ *template_ptr = file_buffer; - + return JB_ERR_OK; } +/********************************************************************* + * + * Function : template_fill_for_cgi + * + * Description : CGI support function that loads a HTML template + * and fills it in. Handles file-not-found errors + * by sending a HTML error message. For convenience, + * this function also frees the passed "exports" map. + * + * Parameters : + * 1 : csp = Client state + * 2 : templatename = name of the HTML template to be used + * 3 : exports = map with fill in symbol -> name pairs. + * Will be freed by this function. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error + * + *********************************************************************/ +jb_err template_fill_for_cgi(struct client_state *csp, + const char *templatename, + struct map *exports, + struct http_response *rsp) +{ + jb_err err; + + assert(csp); + assert(templatename); + assert(exports); + assert(rsp); + + err = template_load(csp, &rsp->body, templatename); + if (err == JB_ERR_FILE) + { + free_map(exports); + return cgi_error_no_template(csp, rsp, templatename); + } + else if (err) + { + free_map(exports); + return err; /* JB_ERR_MEMORY */ + } + err = template_fill(&rsp->body, exports); + free_map(exports); + return err; +} + /********************************************************************* * * Function : default_exports @@ -921,62 +1273,77 @@ void template_fill(char **template_ptr, struct map *exports) * which are common to all CGI functions. * * Parameters : - * 1 : exports = Structure to write output to. This - * structure should be newly allocated and will be - * zeroed. * 1 : csp = Current client state (buffers, headers, etc...) * 2 : caller = name of CGI who calls us and which should - * be excluded from the generated menu. - * Returns : NULL if no memory, else map + * be excluded from the generated menu. May be + * NULL. + * Returns : NULL if no memory, else a new map. Caller frees. * *********************************************************************/ struct map *default_exports(const struct client_state *csp, const char *caller) { char buf[20]; + int err = 0; + struct map * exports; int local_help_exists = 0; - struct map * exports = new_map(); - map(exports, "version", 1, VERSION, 1); - map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1); - map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1); - map(exports, "homepage", 1, HOME_PAGE_URL, 1); - map(exports, "default-cgi", 1, HOME_PAGE_URL "/config", 1); - map(exports, "menu", 1, make_menu(caller), 0); - map(exports, "code-status", 1, CODE_STATUS, 1); + assert(csp); + + exports = new_map(); + if (exports == NULL) + { + return NULL; + } + + + err = map(exports, "version", 1, VERSION, 1) + || map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1) + || map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1) + || map(exports, "homepage", 1, HOME_PAGE_URL, 1) + || map(exports, "default-cgi", 1, HOME_PAGE_URL "/config", 1) + || map(exports, "menu", 1, make_menu(caller), 0) + || map(exports, "code-status", 1, CODE_STATUS, 1); snprintf(buf, 20, "%d", csp->config->hport); - map(exports, "my-port", 1, buf, 1); + err = err || map(exports, "my-port", 1, buf, 1); if(!strcmp(CODE_STATUS, "stable")) { - map_block_killer(exports, "unstable"); + err = err || map_block_killer(exports, "unstable"); } if(csp->config->admin_address != NULL) { - map(exports, "admin-address", 1, csp->config->admin_address, 1); + err = err || map(exports, "admin-address", 1, csp->config->admin_address, 1); local_help_exists = 1; } else { - map_block_killer(exports, "have-adminaddr-info"); + err = err || map_block_killer(exports, "have-adminaddr-info"); } if(csp->config->proxy_info_url != NULL) { - map(exports, "proxy-info-url", 1, csp->config->proxy_info_url, 1); + err = err || map(exports, "proxy-info-url", 1, csp->config->proxy_info_url, 1); local_help_exists = 1; } else { - map_block_killer(exports, "have-proxy-info"); - } + err = err || map_block_killer(exports, "have-proxy-info"); + } if (local_help_exists == 0) - map_block_killer(exports, "have-help-info"); + { + err = err || map_block_killer(exports, "have-help-info"); + } - return (exports); + if (err) + { + free_map(exports); + return NULL; + } + return exports; } @@ -994,16 +1361,20 @@ struct map *default_exports(const struct client_state *csp, const char *caller) * 1 : exports = map to extend * 2 : name = name of conditional block * - * Returns : extended map + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -void map_block_killer(struct map *exports, const char *name) +jb_err map_block_killer(struct map *exports, const char *name) { char buf[1000]; /* Will do, since the names are hardwired */ - snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name); - map(exports, buf, 1, "", 1); + assert(exports); + assert(name); + assert(strlen(name) < 490); + snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name); + return map(exports, buf, 1, "", 1); } @@ -1028,22 +1399,32 @@ void map_block_killer(struct map *exports, const char *name) * 2 : name = name of conditional block * 3 : choose_first = nonzero for first, zero for second. * - * Returns : extended map + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -void map_conditional(struct map *exports, const char *name, int choose_first) +jb_err map_conditional(struct map *exports, const char *name, int choose_first) { char buf[1000]; /* Will do, since the names are hardwired */ + jb_err err; + + assert(exports); + assert(name); + assert(strlen(name) < 480); snprintf(buf, 1000, (choose_first ? "else-not-%s@.*@endif-%s" : "if-%s-then@.*@else-not-%s"), name, name); - map(exports, buf, 1, "", 1); - snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name); - map(exports, buf, 1, "", 1); + err = map(exports, buf, 1, "", 1); + if (err) + { + return err; + } + snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name); + return map(exports, buf, 1, "", 1); } diff --git a/cgi.h b/cgi.h index 064c8b89..acc9cc45 100644 --- a/cgi.h +++ b/cgi.h @@ -1,6 +1,6 @@ #ifndef CGI_H_INCLUDED #define CGI_H_INCLUDED -#define CGI_H_VERSION "$Id: cgi.h,v 1.15 2001/09/16 15:02:35 jongfoster Exp $" +#define CGI_H_VERSION "$Id: cgi.h,v 1.16 2001/09/16 17:08:54 jongfoster Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.h,v $ @@ -38,6 +38,9 @@ * * Revisions : * $Log: cgi.h,v $ + * Revision 1.16 2001/09/16 17:08:54 jongfoster + * Moving simple CGI functions from cgi.c to new file cgisimple.c + * * Revision 1.15 2001/09/16 15:02:35 jongfoster * Adding i.j.b/robots.txt. * Inlining add_stats() since it's only ever called from one place. @@ -129,17 +132,29 @@ extern struct http_response *finish_http_response(struct http_response *rsp); extern struct map * default_exports(const struct client_state *csp, const char *caller); -extern void map_block_killer (struct map *exports, const char *name); -extern void map_conditional (struct map *exports, const char *name, int choose_first); - -extern char *template_load(struct client_state *csp, const char *templatename); -extern void template_fill(char ** template_ptr, struct map *exports); - -extern void get_http_time(int time_offset, char * buf); +extern jb_err map_block_killer (struct map *exports, const char *name); +extern jb_err map_conditional (struct map *exports, const char *name, int choose_first); + +extern jb_err template_load(struct client_state *csp, char ** template_ptr, + const char *templatename); +extern jb_err template_fill(char ** template_ptr, const struct map *exports); +extern jb_err template_fill_for_cgi(struct client_state *csp, + const char *templatename, + struct map *exports, + struct http_response *rsp); + +extern void cgi_init_error_messages(void); +extern struct http_response *cgi_error_memory(void); +extern jb_err cgi_error_no_template(struct client_state *csp, + struct http_response *rsp, + const char *template_name); +extern jb_err cgi_error_bad_param(struct client_state *csp, + struct http_response *rsp); /* * Text generators */ +extern void get_http_time(int time_offset, char * buf); extern char *make_menu(const char *self); extern char *dump_map(const struct map *map); diff --git a/cgiedit.c b/cgiedit.c index 22dc6932..bcba4250 100644 --- a/cgiedit.c +++ b/cgiedit.c @@ -1,4 +1,4 @@ -const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster Exp $"; +const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.3 2001/10/14 22:12:49 jongfoster Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $ @@ -35,6 +35,17 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster * * Revisions : * $Log: cgiedit.c,v $ + * Revision 1.3 2001/10/14 22:12:49 jongfoster + * New version of CGI-based actionsfile editor. + * Major changes, including: + * - Completely new file parser and file output routines + * - edit-actions CGI renamed edit-actions-for-url + * - All CGIs now need a filename parameter, except for... + * - New CGI edit-actions which doesn't need a filename, + * to allow you to start the editor up. + * - edit-actions-submit now works, and now automatically + * redirects you back to the main edit-actions-list handler. + * * Revision 1.2 2001/09/16 17:05:14 jongfoster * Removing unused #include showarg.h * @@ -62,6 +73,7 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster #include #include #include +#include #ifdef _WIN32 #define snprintf _snprintf @@ -76,6 +88,8 @@ const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.2 2001/09/16 17:05:14 jongfoster #include "actions.h" #include "miscutil.h" #include "errlog.h" +#include "loadcfg.h" +/* loadcfg.h is for g_bToggleIJB only */ const char cgiedit_h_rcs[] = CGIEDIT_H_VERSION; @@ -128,23 +142,86 @@ struct file_line #define FILE_LINE_DESCRIPTION_HEADER 9 #define FILE_LINE_DESCRIPTION_ENTRY 10 -/* FIXME: Following list of prototypes is not complete */ -/* FIXME: Following non-static functions should be prototyped in .h or made static */ -static int simple_read_line(char **dest, FILE *fp); -static int edit_read_line (FILE *fp, char **raw_out, char **prefix_out, char **data_out); - int edit_read_file (FILE *fp, struct file_line ** pfile); - int edit_write_file (const char * filename, const struct file_line * file); - void edit_free_file (struct file_line * file); +struct editable_file +{ + struct file_line * lines; + const char * filename; /* Full pathname - e.g. "/etc/junkbuster/wibble.action" */ + const char * identifier; /* Filename stub - e.g. "wibble". Use for CGI param. */ + const char * version_str; /* Last modification time, as a string. For CGI param */ + unsigned version; /* Last modification time - prevents chaos with + * the browser's "back" button. Note that this is a + * time_t cast to an unsigned. When comparing, always + * cast the time_t to an unsigned, and *NOT* vice-versa. + * This may lose the top few bits, but they're not + * significant anyway. + */ + struct file_line * parse_error; /* On parse error, this is the offending line. */ + const char * parse_error_text; /* On parse error, this is the problem. + * (Statically allocated) */ +}; + +/* FIXME: Following non-static functions should be prototyped in .h or made static */ -/* FIXME: This should be in project.h and used everywhere */ -#define JB_ERR_OK 0 /* Success, no error */ -#define JB_ERR_MEMORY 1 /* Out of memory */ -#define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */ -#define JB_ERR_FILE 3 /* Error opening, reading or writing a file */ -#define JB_ERR_PARSE 4 /* Error parsing file */ -#define JB_ERR_MODIFIED 5 /* File has been modified outside of the */ - /* CGI actions editor. */ +/* Functions to read and write arbitrary config files */ +jb_err edit_read_file(struct client_state *csp, + const struct map *parameters, + int require_version, + const char *suffix, + struct editable_file **pfile); +jb_err edit_write_file(struct editable_file * file); +void edit_free_file(struct editable_file * file); + +/* Functions to read and write actions files */ +jb_err edit_parse_actions_file(struct editable_file * file); +jb_err edit_read_actions_file(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters, + int require_version, + struct editable_file **pfile); + +/* Error handlers */ +jb_err cgi_error_modified(struct client_state *csp, + struct http_response *rsp, + const char *filename); +jb_err cgi_error_parse(struct client_state *csp, + struct http_response *rsp, + struct editable_file *file); +jb_err cgi_error_file(struct client_state *csp, + struct http_response *rsp, + const char *filename); + +/* Internal arbitrary config file support functions */ +static jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile); +static void edit_free_file_lines(struct file_line * first_line); +static jb_err simple_read_line(char **dest, FILE *fp); +static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out); + +/* Internal actions file support functions */ +static int match_actions_file_header_line(const char * line, const char * name); +static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue); + +/* Internal parameter parsing functions */ +static jb_err get_file_name_param(struct client_state *csp, + const struct map *parameters, + const char *param_name, + const char *suffix, + char **pfilename, + const char **pparam); +static jb_err get_number_param(struct client_state *csp, + const struct map *parameters, + char *name, + unsigned *pvalue); + +/* Internal actionsfile <==> HTML conversion functions */ +static jb_err map_radio(struct map * exports, + const char * optionname, + const char * values, + char value); +static jb_err actions_to_radio(struct map * exports, + const struct action_spec *action); +static jb_err actions_from_radio(const struct map * parameters, + struct action_spec *action); /********************************************************************* @@ -170,7 +247,7 @@ static int edit_read_line (FILE *fp, char **raw_out, char **prefix_out, char * * JB_ERR_FILE on EOF. * *********************************************************************/ -static int simple_read_line(char **dest, FILE *fp) +static jb_err simple_read_line(char **dest, FILE *fp) { int len; char * buf; @@ -261,7 +338,7 @@ static int simple_read_line(char **dest, FILE *fp) * JB_ERR_FILE on EOF. * *********************************************************************/ -static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out) +static jb_err edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **data_out) { char *p; /* Temporary pointer */ char *linebuf; /* Line read from file */ @@ -271,7 +348,7 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da char *raw; /* String to be stored in raw_out */ char *prefix; /* String to be stored in prefix_out */ char *data; /* String to be stored in data_out */ - int rval = JB_ERR_OK; + jb_err rval = JB_ERR_OK; assert(fp); @@ -449,7 +526,7 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da { free(data); } - return(0); + return JB_ERR_OK; } else { @@ -464,86 +541,6 @@ static int edit_read_line(FILE *fp, char **raw_out, char **prefix_out, char **da } -/********************************************************************* - * - * Function : edit_read_file - * - * Description : Read a complete file into memory. - * Handles whitespace, comments and line continuation. - * - * Parameters : - * 1 : fp = File to read from - * 2 : pfile = Destination for a linked list of file_lines. - * Will be set to NULL on error. - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory - * - *********************************************************************/ -int edit_read_file(FILE *fp, struct file_line ** pfile) -{ - struct file_line * first_line; /* Keep for return value or to free */ - struct file_line * cur_line; /* Current line */ - struct file_line * prev_line; /* Entry with prev_line->next = cur_line */ - int rval; - - assert(fp); - assert(pfile); - - *pfile = NULL; - - cur_line = first_line = zalloc(sizeof(struct file_line)); - if (cur_line == NULL) - { - return JB_ERR_MEMORY; - } - - cur_line->type = FILE_LINE_UNPROCESSED; - - rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); - if (rval) - { - /* Out of memory or empty file. */ - /* Note that empty file is not an error we propogate up */ - free(cur_line); - return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval); - } - - do - { - prev_line = cur_line; - cur_line = prev_line->next = zalloc(sizeof(struct file_line)); - if (cur_line == NULL) - { - /* Out of memory */ - edit_free_file(first_line); - return JB_ERR_MEMORY; - } - - cur_line->type = FILE_LINE_UNPROCESSED; - - rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); - if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE)) - { - /* Out of memory */ - edit_free_file(first_line); - return JB_ERR_MEMORY; - } - - } - while (rval != JB_ERR_FILE); - - /* EOF */ - - /* We allocated one too many - free it */ - prev_line->next = NULL; - free(cur_line); - - *pfile = first_line; - return JB_ERR_OK; -} - - /********************************************************************* * * Function : edit_write_file @@ -556,24 +553,33 @@ int edit_read_file(FILE *fp, struct file_line ** pfile) * * Returns : JB_ERR_OK on success * JB_ERR_FILE on error writing to file. + * JB_ERR_MEMORY on out of memory * *********************************************************************/ -int edit_write_file(const char * filename, const struct file_line * file) +jb_err edit_write_file(struct editable_file * file) { FILE * fp; + struct file_line * cur_line; + struct stat statbuf[1]; + char version_buf[22]; /* 22 = ceil(log10(2^64)) + 2 = max number of + digits in time_t, assuming this is a 64-bit + machine, plus null terminator, plus one + for paranoia */ - assert(filename); + assert(file); + assert(file->filename); - if (NULL == (fp = fopen(filename, "wt"))) + if (NULL == (fp = fopen(file->filename, "wt"))) { return JB_ERR_FILE; } - while (file != NULL) + cur_line = file->lines; + while (cur_line != NULL) { - if (file->raw) + if (cur_line->raw) { - if (fputs(file->raw, fp) < 0) + if (fputs(cur_line->raw, fp) < 0) { fclose(fp); return JB_ERR_FILE; @@ -581,17 +587,17 @@ int edit_write_file(const char * filename, const struct file_line * file) } else { - if (file->prefix) + if (cur_line->prefix) { - if (fputs(file->prefix, fp) < 0) + if (fputs(cur_line->prefix, fp) < 0) { fclose(fp); return JB_ERR_FILE; } } - if (file->unprocessed) + if (cur_line->unprocessed) { - if (fputs(file->unprocessed, fp) < 0) + if (fputs(cur_line->unprocessed, fp) < 0) { fclose(fp); return JB_ERR_FILE; @@ -608,10 +614,32 @@ int edit_write_file(const char * filename, const struct file_line * file) assert(0); } } - file = file->next; + cur_line = cur_line->next; } fclose(fp); + + + /* Update the version stamp in the file structure, since we just + * wrote to the file & changed it's date. + */ + if (stat(file->filename, statbuf) < 0) + { + /* Error, probably file not found. */ + return JB_ERR_FILE; + } + file->version = (unsigned)statbuf->st_mtime; + + /* Correct file->version_str */ + freez((char *)file->version_str); + snprintf(version_buf, 22, "%u", file->version); + version_buf[21] = '\0'; + file->version_str = strdup(version_buf); + if (version_buf == NULL) + { + return JB_ERR_MEMORY; + } + return JB_ERR_OK; } @@ -628,18 +656,50 @@ int edit_write_file(const char * filename, const struct file_line * file) * Returns : N/A * *********************************************************************/ -void edit_free_file(struct file_line * file) +void edit_free_file(struct editable_file * file) { - struct file_line * next; + if (!file) + { + /* Silently ignore NULL pointer */ + return; + } + + edit_free_file_lines(file->lines); + freez((char *)file->filename); + freez((char *)file->identifier); + freez((char *)file->version_str); + file->version = 0; + file->parse_error_text = NULL; /* Statically allocated */ + file->parse_error = NULL; + + free(file); +} + + +/********************************************************************* + * + * Function : edit_free_file + * + * Description : Free an entire linked list of file lines. + * + * Parameters : + * 1 : first_line = Data structure to free. + * + * Returns : N/A + * + *********************************************************************/ +static void edit_free_file_lines(struct file_line * first_line) +{ + struct file_line * next_line; - while (file != NULL) + while (first_line != NULL) { - next = file->next; - file->next = NULL; - freez(file->raw); - freez(file->prefix); - freez(file->unprocessed); - switch(file->type) + next_line = first_line->next; + first_line->next = NULL; + freez(first_line->raw); + freez(first_line->prefix); + freez(first_line->unprocessed); + switch(first_line->type) { case 0: /* special case if memory zeroed */ case FILE_LINE_UNPROCESSED: @@ -654,21 +714,21 @@ void edit_free_file(struct file_line * file) break; case FILE_LINE_ACTION: - free_action(file->data.action); + free_action(first_line->data.action); break; case FILE_LINE_SETTINGS_ENTRY: - freez(file->data.setting.name); - freez(file->data.setting.svalue); + freez(first_line->data.setting.name); + freez(first_line->data.setting.svalue); break; default: /* Should never happen */ assert(0); break; } - file->type = 0; /* paranoia */ - free(file); - file = next; + first_line->type = 0; /* paranoia */ + free(first_line); + first_line = next_line; } } @@ -750,7 +810,7 @@ static int match_actions_file_header_line(const char * line, const char * name) * values *after* the "=" sign are legal). * *********************************************************************/ -static int split_line_on_equals(const char * line, char ** pname, char ** pvalue) +static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue) { const char * name_end; const char * value_start; @@ -831,7 +891,7 @@ static int split_line_on_equals(const char * line, char ** pname, char ** pvalue * JB_ERR_PARSE on error * *********************************************************************/ -int edit_parse_actions_file(struct file_line * file) +jb_err edit_parse_actions_file(struct editable_file * file) { struct file_line * cur_line; int len; @@ -839,14 +899,14 @@ int edit_parse_actions_file(struct file_line * file) char * name; /* For lines of the form name=value */ char * value; /* For lines of the form name=value */ struct action_alias * alias_list = NULL; - int rval = JB_ERR_OK; + jb_err err = JB_ERR_OK; /* alias_list contains the aliases defined in this file. * It might be better to use the "file_line.data" fields * in the relavent places instead. */ - cur_line = file; + cur_line = file->lines; /* A note about blank line support: Blank lines should only * ever occur as the last line in the file. This function @@ -869,6 +929,8 @@ int edit_parse_actions_file(struct file_line * file) && (cur_line->unprocessed[0] != '{') ) { /* File doesn't start with a header */ + file->parse_error = cur_line; + file->parse_error_text = "First (non-comment) line of the file must contain a header."; return JB_ERR_PARSE; } @@ -884,13 +946,19 @@ int edit_parse_actions_file(struct file_line * file) { cur_line->type = FILE_LINE_SETTINGS_ENTRY; - rval = split_line_on_equals(cur_line->unprocessed, + err = split_line_on_equals(cur_line->unprocessed, &cur_line->data.setting.name, &cur_line->data.setting.svalue); - if (rval != JB_ERR_OK) + if (err == JB_ERR_MEMORY) + { + return err; + } + else if (err != JB_ERR_OK) { - /* Line does not contain a name=value pair, or out-of-memory */ - return rval; + /* Line does not contain a name=value pair */ + file->parse_error = cur_line; + file->parse_error_text = "Expected a name=value pair on this {{description}} line, but couldn't find one."; + return JB_ERR_PARSE; } } else @@ -936,11 +1004,17 @@ int edit_parse_actions_file(struct file_line * file) cur_line->type = FILE_LINE_ALIAS_ENTRY; - rval = split_line_on_equals(cur_line->unprocessed, &name, &value); - if (rval != JB_ERR_OK) + err = split_line_on_equals(cur_line->unprocessed, &name, &value); + if (err == JB_ERR_MEMORY) + { + return err; + } + else if (err != JB_ERR_OK) { - /* Line does not contain a name=value pair, or out-of-memory */ - return rval; + /* Line does not contain a name=value pair */ + file->parse_error = cur_line; + file->parse_error_text = "Expected a name=value pair on this {{alias}} line, but couldn't find one."; + return JB_ERR_PARSE; } if ((new_alias = zalloc(sizeof(*new_alias))) == NULL) @@ -952,14 +1026,25 @@ int edit_parse_actions_file(struct file_line * file) return JB_ERR_MEMORY; } - if (get_actions(value, alias_list, new_alias->action)) + err = get_actions(value, alias_list, new_alias->action); + if (err) { /* Invalid action or out of memory */ free(name); free(value); free(new_alias); free_alias_list(alias_list); - return JB_ERR_PARSE; /* FIXME: or JB_ERR_MEMORY */ + if (err == JB_ERR_MEMORY) + { + return err; + } + else + { + /* Line does not contain a name=value pair */ + file->parse_error = cur_line; + file->parse_error_text = "This alias does not specify a valid set of actions."; + return JB_ERR_PARSE; + } } free(value); @@ -989,6 +1074,10 @@ int edit_parse_actions_file(struct file_line * file) { /* No closing } on header */ free_alias_list(alias_list); + file->parse_error = cur_line; + file->parse_error_text = "Headers starting with '{' must have a " + "closing bracket ('}'). Headers starting with two brackets ('{{') " + "must close with two brackets ('}}')."; return JB_ERR_PARSE; } @@ -996,6 +1085,12 @@ int edit_parse_actions_file(struct file_line * file) { /* An invalid {{ header. */ free_alias_list(alias_list); + file->parse_error = cur_line; + file->parse_error_text = "Unknown or unexpected two-bracket header. " + "Please remember that the system (two-bracket) headers must " + "appear in the order {{settings}}, {{description}}, {{alias}}, " + "and must appear before any actions (one-bracket) headers. " + "Also note that system headers may not be repeated."; return JB_ERR_PARSE; } @@ -1010,12 +1105,6 @@ int edit_parse_actions_file(struct file_line * file) { len--; } - if (len <= 0) - { - /* A line containing just { } */ - free_alias_list(alias_list); - return JB_ERR_PARSE; - } cur_line->type = FILE_LINE_ACTION; @@ -1030,12 +1119,23 @@ int edit_parse_actions_file(struct file_line * file) value[len] = '\0'; /* Get actions */ - if (get_actions(value, alias_list, cur_line->data.action)) + err = get_actions(value, alias_list, cur_line->data.action); + if (err) { /* Invalid action or out of memory */ free(value); free_alias_list(alias_list); - return JB_ERR_PARSE; /* FIXME: or JB_ERR_MEMORY */ + if (err == JB_ERR_MEMORY) + { + return err; + } + else + { + /* Line does not contain a name=value pair */ + file->parse_error = cur_line; + file->parse_error_text = "This header does not specify a valid set of actions."; + return JB_ERR_PARSE; + } } /* Done with string - it was clobbered anyway */ @@ -1069,152 +1169,416 @@ int edit_parse_actions_file(struct file_line * file) /********************************************************************* * - * Function : edit_read_file + * Function : edit_read_file_lines * - * Description : Read a complete actions file into memory and - * parses it. + * Description : Read all the lines of a file into memory. + * Handles whitespace, comments and line continuation. * * Parameters : - * 1 : filename = Path to file to read from + * 1 : fp = File to read from. On return, this will be + * at EOF but it will not have been closed. * 2 : pfile = Destination for a linked list of file_lines. * Will be set to NULL on error. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory - * JB_ERR_FILE if the file cannot be opened or - * contains no data * *********************************************************************/ -int edit_read_actions_file(const char * filename, struct file_line ** pfile) +jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile) { - struct file_line * file; - FILE * fp; - int rval; + struct file_line * first_line; /* Keep for return value or to free */ + struct file_line * cur_line; /* Current line */ + struct file_line * prev_line; /* Entry with prev_line->next = cur_line */ + jb_err rval; - assert(filename); + assert(fp); assert(pfile); *pfile = NULL; - if (NULL == (fp = fopen(filename,"rt"))) + cur_line = first_line = zalloc(sizeof(struct file_line)); + if (cur_line == NULL) { - return JB_ERR_FILE; + return JB_ERR_MEMORY; } - rval = edit_read_file(fp, &file); - - fclose(fp); + cur_line->type = FILE_LINE_UNPROCESSED; - if (JB_ERR_OK != rval) + rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); + if (rval) { - return rval; + /* Out of memory or empty file. */ + /* Note that empty file is not an error we propogate up */ + free(cur_line); + return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval); } - if (JB_ERR_OK != (rval = edit_parse_actions_file(file))) + do { - edit_free_file(file); - return rval; + prev_line = cur_line; + cur_line = prev_line->next = zalloc(sizeof(struct file_line)); + if (cur_line == NULL) + { + /* Out of memory */ + edit_free_file_lines(first_line); + return JB_ERR_MEMORY; + } + + cur_line->type = FILE_LINE_UNPROCESSED; + + rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed); + if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE)) + { + /* Out of memory */ + edit_free_file_lines(first_line); + return JB_ERR_MEMORY; + } + } + while (rval != JB_ERR_FILE); - *pfile = file; + /* EOF */ + + /* We allocated one too many - free it */ + prev_line->next = NULL; + free(cur_line); + + *pfile = first_line; return JB_ERR_OK; } /********************************************************************* * - * Function : get_file_name_param - * - * Description : Get the name of the file to edit from the parameters - * passed to a CGI function. This function handles - * security checks such as blocking urls containing - * "/" or ".", prepending the config file directory, - * and adding the specified suffix. - * - * (This is an essential security check, otherwise - * users may be able to pass "../../../etc/passwd" - * and overwrite the password file [linux], "prn:" - * and print random data [Windows], etc...) + * Function : edit_read_file * - * This function only allows filenames contining the - * characters '-', '_', 'A'-'Z', 'a'-'z', and '0'-'9'. - * That's probably too restrictive but at least it's - * secure. + * Description : Read a complete file into memory. + * Handles CGI parameter parsing. If requested, also + * checks the file's modification timestamp. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : parameters = map of cgi parameters - * 3 : suffix = File extension, e.g. ".actions" - * 4 : pfilename = destination for full filename. Caller - * free()s. Set to NULL on error. - * 5 : pparam = destination for partial filename, - * suitable for use in another URL. Allocated as part - * of the map "parameters", so don't free it. - * Set to NULL if not specified. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : parameters = map of cgi parameters. + * 3 : require_version = true to check "ver" parameter. + * 4 : suffix = File extension, e.g. ".action". + * 5 : pfile = Destination for the file. Will be set + * to NULL on error. + * + * CGI Parameters : + * filename : The name of the file to read, without the + * path or ".action" extension. + * ver : (Only if require_version is nonzero) + * Timestamp of the actions file. If wrong, this + * function fails with JB_ERR_MODIFIED. * - * CGI Parameters : None - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if "filename" was not specified * or is not valid. + * JB_ERR_FILE if the file cannot be opened or + * contains no data + * JB_ERR_MODIFIED if version checking was requested and + * failed - the file was modified outside + * of this CGI editor instance. * *********************************************************************/ -static int get_file_name_param(struct client_state *csp, - struct map *parameters, - char *suffix, - char **pfilename, - const char **pparam) +jb_err edit_read_file(struct client_state *csp, + const struct map *parameters, + int require_version, + const char *suffix, + struct editable_file **pfile) { - const char *param; - const char *s; - char *name; - char *fullpath; - char ch; - int len; + struct file_line * lines; + FILE * fp; + jb_err err; + char * filename; + const char * identifier; + struct editable_file * file; + unsigned version = 0; + struct stat statbuf[1]; + char version_buf[22]; assert(csp); assert(parameters); - assert(suffix); - assert(pfilename); - assert(pparam); + assert(pfile); - *pfilename = NULL; - *pparam = NULL; + *pfile = NULL; - param = lookup(parameters, "filename"); - if (!*param) + err = get_file_name_param(csp, parameters, "filename", suffix, + &filename, &identifier); + if (err) { - return JB_ERR_CGI_PARAMS; + return err; } - *pparam = param; - - len = strlen(param); - if (len >= FILENAME_MAX) + if (stat(filename, statbuf) < 0) { - /* Too long. */ - return JB_ERR_CGI_PARAMS; + /* Error, probably file not found. */ + free(filename); + return JB_ERR_FILE; } + version = (unsigned) statbuf->st_mtime; - /* Check every character to see if it's legal */ - s = param; - while ((ch = *s++) != '\0') + if (require_version) { - if ( ((ch < 'A') || (ch > 'Z')) - && ((ch < 'a') || (ch > 'z')) - && ((ch < '0') || (ch > '9')) - && (ch != '-') - && (ch != '_') ) + unsigned specified_version; + err = get_number_param(csp, parameters, "ver", &specified_version); + if (err) { - /* Probable hack attempt. */ - return JB_ERR_CGI_PARAMS; + free(filename); + return err; + } + + if (version != specified_version) + { + return JB_ERR_MODIFIED; } } - /* Append extension */ - name = malloc(len + strlen(suffix) + 1); - if (name == NULL) + if (NULL == (fp = fopen(filename,"rt"))) + { + free(filename); + return JB_ERR_FILE; + } + + err = edit_read_file_lines(fp, &lines); + + fclose(fp); + + if (err) + { + free(filename); + return err; + } + + file = (struct editable_file *) zalloc(sizeof(*file)); + if (err) + { + free(filename); + edit_free_file_lines(lines); + return err; + } + + file->lines = lines; + file->filename = filename; + file->version = version; + file->identifier = strdup(identifier); + + if (file->identifier == NULL) + { + edit_free_file(file); + return JB_ERR_MEMORY; + } + + /* Correct file->version_str */ + freez((char *)file->version_str); + snprintf(version_buf, 22, "%u", file->version); + version_buf[21] = '\0'; + file->version_str = strdup(version_buf); + if (version_buf == NULL) + { + edit_free_file(file); + return JB_ERR_MEMORY; + } + + *pfile = file; + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : edit_read_actions_file + * + * Description : Read a complete actions file into memory. + * Handles CGI parameter parsing. If requested, also + * checks the file's modification timestamp. + * + * If this function detects an error in the categories + * JB_ERR_FILE, JB_ERR_MODIFIED, or JB_ERR_PARSE, + * then it handles it by filling in the specified + * response structure and returning JB_ERR_FILE. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = HTTP response. Only filled in on error. + * 2 : parameters = map of cgi parameters. + * 3 : require_version = true to check "ver" parameter. + * 4 : pfile = Destination for the file. Will be set + * to NULL on error. + * + * CGI Parameters : + * filename : The name of the actions file to read, without the + * path or ".action" extension. + * ver : (Only if require_version is nonzero) + * Timestamp of the actions file. If wrong, this + * function fails with JB_ERR_MODIFIED. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if "filename" was not specified + * or is not valid. + * JB_ERR_FILE if the file does not contain valid data, + * or if file cannot be opened or + * contains no data, or if version + * checking was requested and failed. + * + *********************************************************************/ +jb_err edit_read_actions_file(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters, + int require_version, + struct editable_file **pfile) +{ + jb_err err; + struct editable_file *file; + + assert(csp); + assert(parameters); + assert(pfile); + + *pfile = NULL; + + err = edit_read_file(csp, parameters, require_version, ".action", &file); + if (err) + { + /* Try to handle if possible */ + if (err == JB_ERR_FILE) + { + err = cgi_error_file(csp, rsp, lookup(parameters, "filename")); + } + else if (err == JB_ERR_MODIFIED) + { + err = cgi_error_modified(csp, rsp, lookup(parameters, "filename")); + } + if (err == JB_ERR_OK) + { + /* + * Signal to higher-level CGI code that there was a problem but we + * handled it, they should just return JB_ERR_OK. + */ + err = JB_ERR_FILE; + } + return err; + } + + err = edit_parse_actions_file(file); + if (err) + { + if (err == JB_ERR_PARSE) + { + err = cgi_error_parse(csp, rsp, file); + if (err == JB_ERR_OK) + { + /* + * Signal to higher-level CGI code that there was a problem but we + * handled it, they should just return JB_ERR_OK. + */ + err = JB_ERR_FILE; + } + } + edit_free_file(file); + return err; + } + + *pfile = file; + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : get_file_name_param + * + * Description : Get the name of the file to edit from the parameters + * passed to a CGI function. This function handles + * security checks such as blocking urls containing + * "/" or ".", prepending the config file directory, + * and adding the specified suffix. + * + * (This is an essential security check, otherwise + * users may be able to pass "../../../etc/passwd" + * and overwrite the password file [linux], "prn:" + * and print random data [Windows], etc...) + * + * This function only allows filenames contining the + * characters '-', '_', 'A'-'Z', 'a'-'z', and '0'-'9'. + * That's probably too restrictive but at least it's + * secure. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : parameters = map of cgi parameters + * 3 : suffix = File extension, e.g. ".actions" + * 4 : pfilename = destination for full filename. Caller + * free()s. Set to NULL on error. + * 5 : pparam = destination for partial filename, + * suitable for use in another URL. Allocated as part + * of the map "parameters", so don't free it. + * Set to NULL if not specified. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if "filename" was not specified + * or is not valid. + * + *********************************************************************/ +static jb_err get_file_name_param(struct client_state *csp, + const struct map *parameters, + const char *param_name, + const char *suffix, + char **pfilename, + const char **pparam) +{ + const char *param; + const char *s; + char *name; + char *fullpath; + char ch; + int len; + + assert(csp); + assert(parameters); + assert(suffix); + assert(pfilename); + assert(pparam); + + *pfilename = NULL; + *pparam = NULL; + + param = lookup(parameters, param_name); + if (!*param) + { + return JB_ERR_CGI_PARAMS; + } + + *pparam = param; + + len = strlen(param); + if (len >= FILENAME_MAX) + { + /* Too long. */ + return JB_ERR_CGI_PARAMS; + } + + /* Check every character to see if it's legal */ + s = param; + while ((ch = *s++) != '\0') + { + if ( ((ch < 'A') || (ch > 'Z')) + && ((ch < 'a') || (ch > 'z')) + && ((ch < '0') || (ch > '9')) + && (ch != '-') + && (ch != '_') ) + { + /* Probable hack attempt. */ + return JB_ERR_CGI_PARAMS; + } + } + + /* Append extension */ + name = malloc(len + strlen(suffix) + 1); + if (name == NULL) { return JB_ERR_MEMORY; } @@ -1250,22 +1614,20 @@ static int get_file_name_param(struct client_state *csp, * 4 : pvalue = destination for value. * Set to -1 on error. * - * CGI Parameters : None - * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory - * JB_ERR_CGI_PARAMS if "filename" was not specified + * JB_ERR_CGI_PARAMS if the parameter was not specified * or is not valid. * *********************************************************************/ -static int get_number_param(struct client_state *csp, - struct map *parameters, - char *name, - int *pvalue) +static jb_err get_number_param(struct client_state *csp, + const struct map *parameters, + char *name, + unsigned *pvalue) { const char *param; char ch; - int value; + unsigned value; assert(csp); assert(parameters); @@ -1294,12 +1656,12 @@ static int get_number_param(struct client_state *csp, /* Note: * - * 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,313 +1678,97 @@ static int get_number_param(struct client_state *csp, /********************************************************************* * - * Function : cgi_edit_actions + * Function : map_radio * - * Description : CGI function that allows the user to choose which - * actions file to edit. + * Description : Map a set of radio button values. E.g. if you have + * 3 radio buttons, declare them as: + *