X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgisimple.c;h=5099a579e765d43ca1e3219fa5bb34e4d02f45ac;hp=ad449664da99f580f90ffea52d5340f054546150;hb=23445442f4bf0aa0bcf6e35df09daf8ef0d69d99;hpb=be9c9c82770c0ce30fe0230fe1125a5eecaca95f diff --git a/cgisimple.c b/cgisimple.c index ad449664..5099a579 100644 --- a/cgisimple.c +++ b/cgisimple.c @@ -1,4 +1,3 @@ -const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.134 2016/02/26 12:32:09 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $ @@ -6,8 +5,8 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.134 2016/02/26 12:32:09 fabia * Purpose : Simple CGIs to get information about Privoxy's * status. * - * Copyright : Written by and Copyright (C) 2001-2016 the - * Privoxy team. http://www.privoxy.org/ + * Copyright : Written by and Copyright (C) 2001-2020 the + * Privoxy team. https://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -60,10 +59,10 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.134 2016/02/26 12:32:09 fabia #include "parsers.h" #include "urlmatch.h" #include "errlog.h" +#ifdef FEATURE_CLIENT_TAGS +#include "client-tags.h" +#endif -const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION; - -static char *show_rcs(void); static jb_err show_defines(struct map *exports); static jb_err cgi_show_file(struct client_state *csp, struct http_response *rsp, @@ -261,7 +260,13 @@ jb_err cgi_show_request(struct client_state *csp, } if (map(exports, "processed-request", 1, - html_encode_and_free_original(list_to_text(csp->headers)), 0)) + html_encode_and_free_original( +#ifdef FEATURE_HTTPS_INSPECTION + csp->http->ssl ? + list_to_text(csp->https_headers) : +#endif + list_to_text(csp->headers) + ), 0)) { free_map(exports); return JB_ERR_MEMORY; @@ -271,6 +276,244 @@ jb_err cgi_show_request(struct client_state *csp, } +#ifdef FEATURE_CLIENT_TAGS +/********************************************************************* + * + * Function : cgi_create_client_tag_form + * + * Description : Creates a HTML form to enable or disable a given + * client tag. + * XXX: Could use a template. + * + * Parameters : + * 1 : form = Buffer to fill with the generated form + * 2 : size = Size of the form buffer + * 3 : tag = Name of the tag this form should affect + * 4 : toggle_state = Desired state after the button pressed 0 + * 5 : expires = Whether or not the tag should be enabled. + * Only checked if toggle_state is 1. + * + * Returns : void + * + *********************************************************************/ +static void cgi_create_client_tag_form(char *form, size_t size, + const char *tag, int toggle_state, int expires) +{ + char *button_name; + + if (toggle_state == 1) + { + button_name = (expires == 1) ? "Enable" : "Enable temporarily"; + } + else + { + assert(toggle_state == 0); + button_name = "Disable"; + } + + snprintf(form, size, + "
\n" + " \n" + " \n" + " \n" + " \n" + "
", tag, toggle_state, !expires, button_name); +} + +/********************************************************************* + * + * Function : cgi_show_client_tags + * + * Description : Shows the tags that can be set based on the client + * address (opt-in). + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters + * + * CGI Parameters : none + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_show_client_tags(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + struct map *exports; + struct client_tag_spec *this_tag; + jb_err err = JB_ERR_OK; + char *client_tag_status; + char buf[1000]; + time_t refresh_delay; + + assert(csp); + assert(rsp); + assert(parameters); + + if (NULL == (exports = default_exports(csp, "client-tags"))) + { + return JB_ERR_MEMORY; + } + assert(csp->client_address != NULL); + + this_tag = csp->config->client_tags; + if (this_tag->name == NULL) + { + client_tag_status = strdup_or_die("

No tags have been configured.

\n"); + } + else + { + client_tag_status = strdup_or_die("\n" + "\n" + "\n"); + while ((this_tag != NULL) && (this_tag->name != NULL)) + { + int tag_state; + + privoxy_mutex_lock(&client_tags_mutex); + tag_state = client_has_requested_tag(csp->client_address, this_tag->name); + privoxy_mutex_unlock(&client_tags_mutex); + if (!err) err = string_append(&client_tag_status, "\n"); + if (err) + { + break; + } + this_tag = this_tag->next; + } + if (!err) err = string_append(&client_tag_status, "
Tag nameCurrent stateChange stateDescription
"); + if (!err) err = string_append(&client_tag_status, this_tag->name); + if (!err) err = string_append(&client_tag_status, ""); + if (!err) err = string_append(&client_tag_status, tag_state == 1 ? "Enabled" : "Disabled"); + if (!err) err = string_append(&client_tag_status, ""); + cgi_create_client_tag_form(buf, sizeof(buf), this_tag->name, !tag_state, 1); + if (!err) err = string_append(&client_tag_status, buf); + if (tag_state == 0) + { + cgi_create_client_tag_form(buf, sizeof(buf), this_tag->name, !tag_state, 0); + if (!err) err = string_append(&client_tag_status, buf); + } + if (!err) err = string_append(&client_tag_status, ""); + if (!err) err = string_append(&client_tag_status, this_tag->description); + if (!err) err = string_append(&client_tag_status, "
\n"); + if (err) + { + free_map(exports); + return JB_ERR_MEMORY; + } + } + refresh_delay = get_next_tag_timeout_for_client(csp->client_address); + if (refresh_delay != 0) + { + snprintf(buf, sizeof(buf), "%u", csp->config->client_tag_lifetime); + if (map(exports, "refresh-delay", 1, buf, 1)) + { + freez(client_tag_status); + free_map(exports); + return JB_ERR_MEMORY; + } + } + else + { + err = map_block_killer(exports, "tags-expire"); + if (err != JB_ERR_OK) + { + freez(client_tag_status); + return err; + } + } + + if (map(exports, "client-tags", 1, client_tag_status, 0)) + { + free_map(exports); + return JB_ERR_MEMORY; + } + + if (map(exports, "client-ip-addr", 1, csp->client_address, 1)) + { + free_map(exports); + return JB_ERR_MEMORY; + } + + return template_fill_for_cgi(csp, "client-tags", exports, rsp); +} + + +/********************************************************************* + * + * Function : cgi_toggle_client_tag + * + * Description : Toggles a client tag and redirects to the show-tags + * page + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters + * + * CGI Parameters : none + * 1 : tag = Name of the tag to enable or disable + * 2 : toggle-state = How to toggle the tag (0/1) + * 3 : expires = Set to 1 if the tag should be enabled + * temporarily, otherwise set to 0 + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_toggle_client_tag(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + const char *toggled_tag; + const char *toggle_state; + const char *tag_expires; + time_t time_to_live; + + assert(csp); + assert(rsp); + assert(parameters); + + toggled_tag = lookup(parameters, "tag"); + if (*toggled_tag == '\0') + { + log_error(LOG_LEVEL_ERROR, "Received tag toggle request without tag"); + } + else + { + tag_expires = lookup(parameters, "expires"); + if (*tag_expires == '0') + { + time_to_live = 0; + } + else + { + time_to_live = csp->config->client_tag_lifetime; + } + toggle_state = lookup(parameters, "toggle-state"); + if (*toggle_state == '1') + { + enable_client_specific_tag(csp, toggled_tag, time_to_live); + } + else + { + disable_client_specific_tag(csp, toggled_tag); + } + } + rsp->status = strdup_or_die("302 Done dealing with toggle request"); + if (enlist_unique_header(rsp->headers, + "Location", CGI_PREFIX "client-tags")) + { + return JB_ERR_MEMORY; + } + return JB_ERR_OK; + +} +#endif /* def FEATURE_CLIENT_TAGS */ + + /********************************************************************* * * Function : cgi_send_banner @@ -796,47 +1039,140 @@ jb_err cgi_send_user_manual(struct client_state *csp, } +#ifdef FEATURE_EXTENDED_STATISTICS /********************************************************************* * - * Function : cgi_show_version + * Function : get_block_reason_statistics_table * - * Description : CGI function that returns a a web page describing the - * file versions of Privoxy. + * Description : Produces the block reason statistic table content. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters * - * CGI Parameters : none - * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error. + * Returns : Pointer to the HTML statistic table content or + * NULL on out of memory * *********************************************************************/ -jb_err cgi_show_version(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +static char *get_block_reason_statistics_table(const struct client_state *csp) { - struct map *exports; + char buf[BUFFER_SIZE]; + char *statistics; + int i; + struct file_list *fl; + jb_err err = JB_ERR_OK; - assert(csp); - assert(rsp); - assert(parameters); + statistics = strdup_or_die(""); - if (NULL == (exports = default_exports(csp, "show-version"))) + /* Run through all action files. */ + for (i = 0; i < MAX_AF_FILES; i++) { - return JB_ERR_MEMORY; + struct url_actions *b; + struct action_spec *last_action = NULL; + + if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL)) + { + /* Skip empty files */ + continue; + } + + /* Go through all the actions. */ + for (b = b->next; NULL != b; b = b->next) + { + if (last_action == b->action) + { + continue; + } + if ((b->action->add & ACTION_BLOCK)) + { + unsigned long long count; + const char *block_reason = b->action->string[ACTION_STRING_BLOCK]; + const char *encoded_block_reason = html_encode(block_reason); + + if (encoded_block_reason == NULL) + { + freez(statistics); + return NULL; + } + get_block_reason_count(block_reason, &count); + snprintf(buf, sizeof(buf), + "%s%llu\n", + encoded_block_reason, count); + freez(encoded_block_reason); + + if (!err) err = string_append(&statistics, buf); + } + last_action = b->action; + } } - if (map(exports, "sourceversions", 1, show_rcs(), 0)) + return statistics; + +} + + +/********************************************************************* + * + * Function : get_filter_statistics_table + * + * Description : Produces the filter statistic table content. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * + * Returns : Pointer to the HTML statistic table content or + * NULL on out of memory + * + *********************************************************************/ +static char *get_filter_statistics_table(const struct client_state *csp) +{ + char buf[BUFFER_SIZE]; + char *statistics; + int i; + struct file_list *fl; + struct re_filterfile_spec *b; + jb_err err = JB_ERR_OK; + + statistics = strdup_or_die(""); + + for (i = 0; i < MAX_AF_FILES; i++) { - free_map(exports); - return JB_ERR_MEMORY; + fl = csp->rlist[i]; + if ((NULL == fl) || (NULL == fl->f)) + { + /* + * Either there are no filter files left or this + * filter file just contains no valid filters. + * + * Continue to be sure we don't miss valid filter + * files that are chained after empty or invalid ones. + */ + continue; + } + + for (b = fl->f; b != NULL; b = b->next) + { + if (b->type == FT_CONTENT_FILTER) + { + unsigned long long executions; + unsigned long long response_bodies_modified; + unsigned long long hits; + + get_filter_statistics(b->name, &executions, &response_bodies_modified, &hits); + snprintf(buf, sizeof(buf), + "%s%llu" + "%llu" + "%llu\n", + b->name, executions, response_bodies_modified, hits); + + if (!err) err = string_append(&statistics, buf); + } + } } - return template_fill_for_cgi(csp, "show-version", exports, rsp); + return statistics; + } +#endif /* def FEATURE_EXTENDED_STATISTICS */ /********************************************************************* @@ -951,6 +1287,35 @@ jb_err cgi_show_status(struct client_state *csp, if (!err) err = map_block_killer(exports, "statistics"); #endif /* ndef FEATURE_STATISTICS */ +#ifdef FEATURE_EXTENDED_STATISTICS + if (!err) + { + char *block_reason_statistics = get_block_reason_statistics_table(csp); + if (block_reason_statistics != NULL) + { + err = map(exports, "block-reason-statistics", 1, block_reason_statistics, 0); + } + else + { + err = map_block_killer(exports, "extended-statistics"); + } + } + if (!err) + { + char *filter_statistics = get_filter_statistics_table(csp); + if (filter_statistics != NULL) + { + err = map(exports, "filter-statistics", 1, filter_statistics, 0); + } + else + { + err = map_block_killer(exports, "extended-statistics"); + } + } +#else /* ndef FEATURE_EXTENDED_STATISTICS */ + if (!err) err = map_block_killer(exports, "extended-statistics"); +#endif /* def FEATURE_EXTENDED_STATISTICS */ + /* * List all action files in use, together with view and edit links, * except for standard.action, which should only be viewable. (Not @@ -991,13 +1356,14 @@ jb_err cgi_show_status(struct client_state *csp, if (!err) err = string_append(&s, "\n"); } } - if (*s != '\0') + if (!err && *s != '\0') { - if (!err) err = map(exports, "actions-filenames", 1, s, 0); + err = map(exports, "actions-filenames", 1, s, 0); } else { if (!err) err = map(exports, "actions-filenames", 1, "None specified", 1); + freez(s); } /* @@ -1017,14 +1383,15 @@ jb_err cgi_show_status(struct client_state *csp, if (!err) err = string_append(&s, "\n"); } } - if (*s != '\0') + if (!err && *s != '\0') { - if (!err) err = map(exports, "re-filter-filenames", 1, s, 0); + err = map(exports, "re-filter-filenames", 1, s, 0); } else { if (!err) err = map(exports, "re-filter-filenames", 1, "None specified", 1); if (!err) err = map_block_killer(exports, "have-filterfile"); + freez(s); } #ifdef FEATURE_TRUST @@ -1173,7 +1540,7 @@ jb_err cgi_show_url_info(struct client_state *csp, if (url_param[0] == '\0') { - /* URL paramater not specified, display query form only. */ + /* URL parameter not specified, display query form only. */ free(url_param); if (map_block_killer(exports, "url-given") || map(exports, "url", 1, "", 1)) @@ -1246,11 +1613,14 @@ jb_err cgi_show_url_info(struct client_state *csp, } /* - * We have a warning about SSL paths. Hide it for unencrypted sites. + * We have a warning about SSL paths. Hide it for unencrypted sites + * and unconditionally if https inspection is enabled. */ +#ifndef FEATURE_HTTPS_INSPECTION if (!url_to_query->ssl) +#endif { - if (map_block_killer(exports, "https")) + if (map_block_killer(exports, "https-and-no-https-inspection")) { free_current_action(action); free_map(exports); @@ -1522,7 +1892,7 @@ jb_err cgi_robots_txt(struct client_state *csp, * * Function : show_defines * - * Description : Add to a map the state od all conditional #defines + * Description : Add to a map the state of all conditional #defines * used when building * * Parameters : @@ -1542,6 +1912,14 @@ static jb_err show_defines(struct map *exports) }; static const struct feature features[] = { + { + "FEATURE_64_BIT_TIME_T", +#if (SIZEOF_TIME_T == 8) + 1, +#else + 0, +#endif + }, { "FEATURE_ACCEPT_FILTER", #ifdef FEATURE_ACCEPT_FILTER @@ -1556,6 +1934,14 @@ static jb_err show_defines(struct map *exports) 1, #else 0, +#endif + }, + { + "FEATURE_BROTLI", +#ifdef FEATURE_BROTLI + 1, +#else + 0, #endif }, { @@ -1564,6 +1950,14 @@ static jb_err show_defines(struct map *exports) 1, #else 0, +#endif + }, + { + "FEATURE_CLIENT_TAGS", +#ifdef FEATURE_CLIENT_TAGS + 1, +#else + 0, #endif }, { @@ -1588,6 +1982,14 @@ static jb_err show_defines(struct map *exports) 1, #else 0, +#endif + }, + { + "FEATURE_EXTERNAL_FILTERS", +#ifdef FEATURE_EXTERNAL_FILTERS + 1, +#else + 0, #endif }, { @@ -1615,16 +2017,16 @@ static jb_err show_defines(struct map *exports) #endif }, { - "FEATURE_IMAGE_BLOCKING", -#ifdef FEATURE_IMAGE_BLOCKING + "FEATURE_HTTPS_INSPECTION", +#ifdef FEATURE_HTTPS_INSPECTION 1, #else 0, #endif }, { - "FEATURE_IMAGE_DETECT_MSIE", -#ifdef FEATURE_IMAGE_DETECT_MSIE + "FEATURE_IMAGE_BLOCKING", +#ifdef FEATURE_IMAGE_BLOCKING 1, #else 0, @@ -1700,6 +2102,22 @@ static jb_err show_defines(struct map *exports) 1, #else 0, +#endif + }, + { + "FEATURE_EXTENDED_STATISTICS", +#ifdef FEATURE_EXTENDED_STATISTICS + 1, +#else + 0, +#endif + }, + { + "FEATURE_PCRE_HOST_PATTERNS", +#ifdef FEATURE_PCRE_HOST_PATTERNS + 1, +#else + 0, #endif } }; @@ -1718,102 +2136,6 @@ static jb_err show_defines(struct map *exports) } -/********************************************************************* - * - * Function : show_rcs - * - * Description : Create a string with the rcs info for all sourcefiles - * - * Parameters : None - * - * Returns : A string, or NULL on out-of-memory. - * - *********************************************************************/ -static char *show_rcs(void) -{ - char *result = strdup_or_die(""); - char buf[BUFFER_SIZE]; - - /* Instead of including *all* dot h's in the project (thus creating a - * tremendous amount of dependencies), I will concede to declaring them - * as extern's. This forces the developer to add to this list, but oh well. - */ - -#define SHOW_RCS(__x) \ - { \ - extern const char __x[]; \ - snprintf(buf, sizeof(buf), " %s\n", __x); \ - string_append(&result, buf); \ - } - - /* In alphabetical order */ - SHOW_RCS(actions_h_rcs) - SHOW_RCS(actions_rcs) -#ifdef AMIGA - SHOW_RCS(amiga_h_rcs) - SHOW_RCS(amiga_rcs) -#endif /* def AMIGA */ - SHOW_RCS(cgi_h_rcs) - SHOW_RCS(cgi_rcs) -#ifdef FEATURE_CGI_EDIT_ACTIONS - SHOW_RCS(cgiedit_h_rcs) - SHOW_RCS(cgiedit_rcs) -#endif /* def FEATURE_CGI_EDIT_ACTIONS */ - SHOW_RCS(cgisimple_h_rcs) - SHOW_RCS(cgisimple_rcs) -#ifdef __MINGW32__ - SHOW_RCS(cygwin_h_rcs) -#endif - SHOW_RCS(deanimate_h_rcs) - SHOW_RCS(deanimate_rcs) - SHOW_RCS(encode_h_rcs) - SHOW_RCS(encode_rcs) - SHOW_RCS(errlog_h_rcs) - SHOW_RCS(errlog_rcs) - SHOW_RCS(filters_h_rcs) - SHOW_RCS(filters_rcs) - SHOW_RCS(gateway_h_rcs) - SHOW_RCS(gateway_rcs) - SHOW_RCS(jbsockets_h_rcs) - SHOW_RCS(jbsockets_rcs) - SHOW_RCS(jcc_h_rcs) - SHOW_RCS(jcc_rcs) - SHOW_RCS(list_h_rcs) - SHOW_RCS(list_rcs) - SHOW_RCS(loadcfg_h_rcs) - SHOW_RCS(loadcfg_rcs) - SHOW_RCS(loaders_h_rcs) - SHOW_RCS(loaders_rcs) - SHOW_RCS(miscutil_h_rcs) - SHOW_RCS(miscutil_rcs) - SHOW_RCS(parsers_h_rcs) - SHOW_RCS(parsers_rcs) - SHOW_RCS(pcrs_rcs) - SHOW_RCS(pcrs_h_rcs) - SHOW_RCS(project_h_rcs) - SHOW_RCS(ssplit_h_rcs) - SHOW_RCS(ssplit_rcs) - SHOW_RCS(urlmatch_h_rcs) - SHOW_RCS(urlmatch_rcs) -#ifdef _WIN32 -#ifndef _WIN_CONSOLE - SHOW_RCS(w32log_h_rcs) - SHOW_RCS(w32log_rcs) - SHOW_RCS(w32res_h_rcs) - SHOW_RCS(w32taskbar_h_rcs) - SHOW_RCS(w32taskbar_rcs) -#endif /* ndef _WIN_CONSOLE */ - SHOW_RCS(win32_h_rcs) - SHOW_RCS(win32_rcs) -#endif /* def _WIN32 */ - -#undef SHOW_RCS - - return result; - -} - - /********************************************************************* * * Function : cgi_show_file