1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
5 * Purpose : Declares functions to intercept request, generate
6 * html or gif answers, and to compose HTTP responses.
7 * This only contains the framework functions, the
8 * actual handler functions are declared elsewhere.
10 * Copyright : Written by and Copyright (C) 2001-2020
11 * members of the Privoxy team. https://www.privoxy.org/
13 * Based on the Internet Junkbuster originally written
14 * by and Copyright (C) 1997 Anonymous Coders and
15 * Junkbusters Corporation. http://www.junkbusters.com
17 * This program is free software; you can redistribute it
18 * and/or modify it under the terms of the GNU General
19 * Public License as published by the Free Software
20 * Foundation; either version 2 of the License, or (at
21 * your option) any later version.
23 * This program is distributed in the hope that it will
24 * be useful, but WITHOUT ANY WARRANTY; without even the
25 * implied warranty of MERCHANTABILITY or FITNESS FOR A
26 * PARTICULAR PURPOSE. See the GNU General Public
27 * License for more details.
29 * The GNU General Public License should be included with
30 * this file. If not, you can view it at
31 * http://www.gnu.org/copyleft/gpl.html
32 * or write to the Free Software Foundation, Inc., 59
33 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
35 **********************************************************************/
41 #include <sys/types.h>
48 #ifdef FEATURE_COMPRESSION
60 #include "cgisimple.h"
61 #include "jbsockets.h"
62 #if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE)
64 #endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */
65 #ifdef FEATURE_HTTPS_INSPECTION
69 /* loadcfg.h is for global_toggle_state only */
71 /* jcc.h is for mutex semaphore globals only */
74 static char *make_menu(const struct client_state *csp, const char *self);
77 * List of CGI functions: name, handler, description
78 * Note: Do NOT use single quotes in the description;
79 * this will break the dynamic "blocked" template!
81 static const struct cgi_dispatcher cgi_dispatchers[] = {
86 #ifdef FEATURE_GRACEFUL_TERMINATION
89 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
90 "this is a one click Denial Of Service attack!!!</em>",
95 #ifdef FEATURE_CGI_EDIT_ACTIONS
96 "View & change the current configuration",
98 "View the current configuration",
101 #ifdef FEATURE_CLIENT_TAGS
103 * This is marked as harmless because despite the description
104 * used in the menu the actual toggling is done through another
105 * path ("/toggle-client-tag").
108 cgi_show_client_tags,
109 "View or toggle the tags that can be set based on the client's address",
114 "View the request headers",
118 "Look up which actions apply to a URL and why",
120 #ifdef FEATURE_TOGGLE
123 "Toggle Privoxy on or off",
125 #endif /* def FEATURE_TOGGLE */
126 #ifdef FEATURE_CLIENT_TAGS
127 { "toggle-client-tag",
128 cgi_toggle_client_tag,
132 #ifdef FEATURE_CGI_EDIT_ACTIONS
133 { "edit-actions", /* Edit the actions list */
136 { "eaa", /* Shortcut for edit-actions-add-url-form */
137 cgi_edit_actions_add_url_form,
139 { "eau", /* Shortcut for edit-actions-url-form */
140 cgi_edit_actions_url_form,
142 { "ear", /* Shortcut for edit-actions-remove-url-form */
143 cgi_edit_actions_remove_url_form,
145 { "eal", /* Shortcut for edit-actions-list */
146 cgi_edit_actions_list,
148 { "eafu", /* Shortcut for edit-actions-for-url */
149 cgi_edit_actions_for_url,
151 { "eas", /* Shortcut for edit-actions-submit */
152 cgi_edit_actions_submit,
154 { "easa", /* Shortcut for edit-actions-section-add */
155 cgi_edit_actions_section_add,
157 { "easr", /* Shortcut for edit-actions-section-remove */
158 cgi_edit_actions_section_remove,
160 { "eass", /* Shortcut for edit-actions-section-swap */
161 cgi_edit_actions_section_swap,
163 { "edit-actions-for-url",
164 cgi_edit_actions_for_url,
165 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
166 { "edit-actions-list",
167 cgi_edit_actions_list,
168 NULL, TRUE /* Edit the actions list */ },
169 { "edit-actions-submit",
170 cgi_edit_actions_submit,
171 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
172 { "edit-actions-url",
173 cgi_edit_actions_url,
174 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
175 { "edit-actions-url-form",
176 cgi_edit_actions_url_form,
177 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
178 { "edit-actions-add-url",
179 cgi_edit_actions_add_url,
180 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
181 { "edit-actions-add-url-form",
182 cgi_edit_actions_add_url_form,
183 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
184 { "edit-actions-remove-url",
185 cgi_edit_actions_remove_url,
186 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
187 { "edit-actions-remove-url-form",
188 cgi_edit_actions_remove_url_form,
189 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
190 { "edit-actions-section-add",
191 cgi_edit_actions_section_add,
192 NULL, FALSE /* Remove a section from the actionsfile */ },
193 { "edit-actions-section-remove",
194 cgi_edit_actions_section_remove,
195 NULL, FALSE /* Remove a section from the actionsfile */ },
196 { "edit-actions-section-swap",
197 cgi_edit_actions_section_swap,
198 NULL, FALSE /* Swap two sections in the actionsfile */ },
199 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
200 { "error-favicon.ico",
201 cgi_send_error_favicon,
202 NULL, TRUE /* Sends the favicon image for error pages. */ },
204 cgi_send_default_favicon,
205 NULL, TRUE /* Sends the default favicon image. */ },
208 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
211 NULL, TRUE /* Send a built-in image */ },
214 NULL, FALSE /* Send templates/cgi-style.css */ },
216 cgi_transparent_image,
217 NULL, TRUE /* Send a transparent image (short name) */ },
218 { "url-info-osd.xml",
219 cgi_send_url_info_osd,
220 NULL, TRUE /* Send templates/url-info-osd.xml */ },
222 cgi_send_user_manual,
223 NULL, TRUE /* Send user-manual */ },
226 NULL, TRUE /* Send wpad.dat proxy autoconfiguration file */ },
227 { NULL, /* NULL Indicates end of list and default page */
229 NULL, TRUE /* Unknown CGI page */ }
234 * Built-in images for ad replacement
236 * Hint: You can encode your own images like this:
237 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
240 #ifdef FEATURE_NO_GIFS
243 * Checkerboard pattern, as a PNG.
245 const char image_pattern_data[] =
246 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
247 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
248 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
249 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
250 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
251 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
252 "\000\000\000\000\111\105\116\104\256\102\140\202";
255 * 1x1 transparent PNG.
257 const char image_blank_data[] =
258 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
259 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
260 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
261 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
262 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
263 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
264 "\000\000\000\000\111\105\116\104\256\102\140\202";
268 * Checkerboard pattern, as a GIF.
270 const char image_pattern_data[] =
271 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
272 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
273 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
274 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
278 * 1x1 transparent GIF.
280 const char image_blank_data[] =
281 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
282 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
283 "\000\001\000\000\002\002D\001\000;";
286 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
287 const size_t image_blank_length = sizeof(image_blank_data) - 1;
289 #ifdef FEATURE_COMPRESSION
291 * Minimum length which a buffer has to reach before
292 * we bother to (re-)compress it. Completely arbitrary.
294 const size_t LOWER_LENGTH_LIMIT_FOR_COMPRESSION = 1024U;
297 static struct http_response cgi_error_memory_response[1];
299 static struct http_response *dispatch_known_cgi(struct client_state * csp,
301 static struct map *parse_cgi_parameters(char *argstring);
304 /*********************************************************************
306 * Function : dispatch_cgi
308 * Description : Checks if a request URL has either the magical
309 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
310 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
311 * http://config.privoxy.org/). If so, it passes
312 * the (rest of the) path onto dispatch_known_cgi, which
313 * calls the relevant CGI handler function.
316 * 1 : csp = Current client state (buffers, headers, etc...)
318 * Returns : http_response if match, NULL if nonmatch or handler fail
320 *********************************************************************/
321 struct http_response *dispatch_cgi(struct client_state *csp)
323 const char *host = csp->http->host;
324 const char *path = csp->http->path;
327 * Should we intercept ?
330 /* Note: "example.com" and "example.com." are equivalent hostnames. */
332 /* Either the host matches CGI_SITE_1_HOST ..*/
333 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
334 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
337 /* ..then the path will all be for us. Remove leading '/' */
340 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
341 else if (( (0 == strcmpic(host, CGI_SITE_2_HOST))
342 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
343 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))))
345 /* take everything following CGI_SITE_2_PATH */
346 path += strlen(CGI_SITE_2_PATH);
349 /* skip the forward slash after CGI_SITE_2_PATH */
352 else if (*path != '\0')
355 * weirdness: URL is /configXXX, where XXX is some string
356 * Do *NOT* intercept.
367 if (strcmpic(csp->http->gpc, "GET")
368 && strcmpic(csp->http->gpc, "HEAD"))
370 log_error(LOG_LEVEL_ERROR,
371 "CGI request with unsupported method received: %s", csp->http->gpc);
373 * The CGI pages currently only support GET and HEAD requests.
375 * If the client used a different method, ditch any data following
376 * the current headers to reduce the likelihood of parse errors
377 * with the following request.
379 csp->client_iob->eod = csp->client_iob->cur;
383 * This is a CGI call.
386 return dispatch_known_cgi(csp, path);
390 /*********************************************************************
392 * Function : grep_cgi_referrer
394 * Description : Ugly provisorical fix that greps the value of the
395 * referer HTTP header field out of a linked list of
396 * strings like found at csp->headers. Will disappear
399 * FIXME: csp->headers ought to be csp->http->headers
400 * FIXME: Parsing all client header lines should
401 * happen right after the request is received!
404 * 1 : csp = Current client state (buffers, headers, etc...)
406 * Returns : pointer to value (no copy!), or NULL if none found.
408 *********************************************************************/
409 static char *grep_cgi_referrer(const struct client_state *csp)
411 struct list_entry *p;
412 struct list_entry *first_header =
413 #ifdef FEATURE_HTTPS_INSPECTION
414 client_use_ssl(csp) ? csp->https_headers->first :
418 for (p = first_header; p != NULL; p = p->next)
420 if (p->str == NULL) continue;
421 if (strncmpic(p->str, "Referer: ", 9) == 0)
423 return ((p->str) + 9);
431 /*********************************************************************
433 * Function : referrer_is_safe
435 * Description : Decides whether we trust the Referer for
436 * CGI pages which are only meant to be reachable
437 * through Privoxy's web interface directly.
440 * 1 : csp = Current client state (buffers, headers, etc...)
442 * Returns : TRUE if the referrer is safe, or
443 * FALSE if the referrer is unsafe or not set.
445 *********************************************************************/
446 static int referrer_is_safe(const struct client_state *csp)
449 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
450 #ifdef FEATURE_HTTPS_INSPECTION
451 static const char alt_prefix_https[] = "https://" CGI_SITE_1_HOST "/";
453 const char *trusted_cgi_referrer = csp->config->trusted_cgi_referrer;
455 referrer = grep_cgi_referrer(csp);
457 if (NULL == referrer)
459 /* No referrer, no access */
460 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
463 else if ((0 == strncmp(referrer, CGI_PREFIX_HTTP, sizeof(CGI_PREFIX_HTTP)-1))
464 #ifdef FEATURE_HTTPS_INSPECTION
465 || (0 == strncmp(referrer, CGI_PREFIX_HTTPS, sizeof(CGI_PREFIX_HTTPS)-1))
466 || (0 == strncmp(referrer, alt_prefix_https, strlen(alt_prefix_https)))
468 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix))))
470 /* Trustworthy referrer */
471 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
472 csp->http->url, referrer);
476 else if ((trusted_cgi_referrer != NULL) && (0 == strncmp(referrer,
477 trusted_cgi_referrer, strlen(trusted_cgi_referrer))))
480 * After some more testing this block should be merged with
481 * the previous one or the log level should bedowngraded.
483 log_error(LOG_LEVEL_INFO, "Granting access to %s based on trusted referrer %s",
484 csp->http->url, referrer);
490 /* Untrustworthy referrer */
491 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
492 csp->http->url, referrer);
499 /*********************************************************************
501 * Function : dispatch_known_cgi
503 * Description : Processes a CGI once dispatch_cgi has determined that
504 * it matches one of the magic prefixes. Parses the path
505 * as a cgi name plus query string, prepares a map that
506 * maps CGI parameter names to their values, initializes
507 * the http_response struct, and calls the relevant CGI
511 * 1 : csp = Current client state (buffers, headers, etc...)
512 * 2 : path = Path of CGI, with the CGI prefix removed.
513 * Should not have a leading "/".
515 * Returns : http_response, or NULL on handler failure or out of
518 *********************************************************************/
519 static struct http_response *dispatch_known_cgi(struct client_state * csp,
522 const struct cgi_dispatcher *d;
523 struct map *param_list;
524 struct http_response *rsp;
525 char *query_args_start;
529 if (NULL == (path_copy = strdup(path)))
531 return cgi_error_memory();
533 query_args_start = path_copy;
534 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
538 if (*query_args_start == '/')
540 *query_args_start++ = '\0';
541 param_list = new_map();
542 err = map(param_list, "file", 1, url_decode(query_args_start), 0);
543 if (JB_ERR_OK != err)
547 return cgi_error_memory();
552 if (*query_args_start == '?')
554 *query_args_start++ = '\0';
556 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
559 return cgi_error_memory();
565 * path_copy = CGI call name
566 * param_list = CGI params, as map
569 /* Get mem for response or fail*/
570 if (NULL == (rsp = alloc_http_response()))
573 free_map(param_list);
574 return cgi_error_memory();
578 * Find and start the right CGI function
583 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
586 * If the called CGI is either harmless, or referred
587 * from a trusted source, start it.
589 if (d->harmless || referrer_is_safe(csp))
591 err = (d->handler)(csp, rsp, param_list);
596 * Else, modify toggle calls so that they only display
597 * the status, and deny all other calls.
599 if (0 == strcmp(path_copy, "toggle"))
601 unmap(param_list, "set");
602 err = (d->handler)(csp, rsp, param_list);
606 err = cgi_error_disabled(csp, rsp);
611 free_map(param_list);
613 if (err == JB_ERR_CGI_PARAMS)
615 err = cgi_error_bad_param(csp, rsp);
617 if (err && (err != JB_ERR_MEMORY))
619 /* Unexpected error! Shouldn't get here */
620 log_error(LOG_LEVEL_ERROR,
621 "Unexpected CGI error %d in top-level handler. "
622 "Please file a bug report!", err);
623 err = cgi_error_unknown(csp, rsp, err);
628 rsp->crunch_reason = CGI_CALL;
629 return finish_http_response(csp, rsp);
633 /* Error in handler, probably out-of-memory */
634 free_http_response(rsp);
635 return cgi_error_memory();
643 /*********************************************************************
645 * Function : parse_cgi_parameters
647 * Description : Parse a URL-encoded argument string into name/value
648 * pairs and store them in a struct map list.
651 * 1 : argstring = string to be parsed. Will be trashed.
653 * Returns : pointer to param list, or NULL if out of memory.
655 *********************************************************************/
656 static struct map *parse_cgi_parameters(char *argstring)
661 struct map *cgi_params;
664 * XXX: This estimate is guaranteed to be high enough as we
665 * let ssplit() ignore empty fields, but also a bit wasteful.
666 * The same hack is used in get_last_url() so it looks like
667 * a real solution is needed.
669 size_t max_segments = strlen(argstring) / 2 + 1;
670 vector = malloc_or_die(max_segments * sizeof(char *));
672 cgi_params = new_map();
675 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
676 * the fragment identifier along with the request, so we must
677 * cut it off here, so it won't pollute the CGI params:
679 if (NULL != (p = strchr(argstring, '#')))
684 pairs = ssplit(argstring, "&", vector, max_segments);
689 free_map(cgi_params);
693 for (i = 0; i < pairs; i++)
695 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
698 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
701 free_map(cgi_params);
714 /*********************************************************************
716 * Function : get_char_param
718 * Description : Get a single-character parameter passed to a CGI
722 * 1 : parameters = map of cgi parameters
723 * 2 : param_name = The name of the parameter to read
725 * Returns : Uppercase character on success, '\0' on error.
727 *********************************************************************/
728 char get_char_param(const struct map *parameters,
729 const char *param_name)
736 ch = *(lookup(parameters, param_name));
737 if ((ch >= 'a') && (ch <= 'z'))
739 ch = (char)(ch - 'a' + 'A');
746 /*********************************************************************
748 * Function : get_string_param
750 * Description : Get a string parameter, to be used as an
751 * ACTION_STRING or ACTION_MULTI parameter.
752 * Validates the input to prevent stupid/malicious
753 * users from corrupting their action file.
756 * 1 : parameters = map of cgi parameters
757 * 2 : param_name = The name of the parameter to read
758 * 3 : pparam = destination for parameter. Allocated as
759 * part of the map "parameters", so don't free it.
760 * Set to NULL if not specified.
762 * Returns : JB_ERR_OK on success, or if the parameter
764 * JB_ERR_MEMORY on out-of-memory.
765 * JB_ERR_CGI_PARAMS if the parameter is not valid.
767 *********************************************************************/
768 jb_err get_string_param(const struct map *parameters,
769 const char *param_name,
782 param = lookup(parameters, param_name);
788 if (strlen(param) >= CGI_PARAM_LEN_MAX)
793 * Note that the length limit is arbitrary, it just seems
794 * sensible to limit it to *something*. There's no
795 * technical reason for any limit at all.
797 return JB_ERR_CGI_PARAMS;
800 /* Check every character to see if it's legal */
802 while ((ch = *s++) != '\0')
804 if (((unsigned char)ch < (unsigned char)' ')
807 /* Probable hack attempt, or user accidentally used '}'. */
808 return JB_ERR_CGI_PARAMS;
819 /*********************************************************************
821 * Function : get_number_param
823 * Description : Get a non-negative integer from the parameters
824 * passed to a CGI function.
827 * 1 : csp = Current client state (buffers, headers, etc...)
828 * 2 : parameters = map of cgi parameters
829 * 3 : name = Name of CGI parameter to read
830 * 4 : pvalue = destination for value.
831 * Set to -1 on error.
833 * Returns : JB_ERR_OK on success
834 * JB_ERR_MEMORY on out-of-memory
835 * JB_ERR_CGI_PARAMS if the parameter was not specified
838 *********************************************************************/
839 jb_err get_number_param(struct client_state *csp,
840 const struct map *parameters,
854 param = lookup(parameters, name);
857 return JB_ERR_CGI_PARAMS;
860 *pvalue = (unsigned int)strtol(param, &endptr, 0);
863 return JB_ERR_CGI_PARAMS;
871 /*********************************************************************
873 * Function : error_response
875 * Description : returns an http_response that explains the reason
876 * why a request failed.
879 * 1 : csp = Current client state (buffers, headers, etc...)
880 * 2 : templatename = Which template should be used for the answer
882 * Returns : A http_response. If we run out of memory, this
883 * will be cgi_error_memory().
885 *********************************************************************/
886 struct http_response *error_response(struct client_state *csp,
887 const char *templatename)
890 struct http_response *rsp;
891 struct map *exports = default_exports(csp, NULL);
896 return cgi_error_memory();
899 if (NULL == (rsp = alloc_http_response()))
902 return cgi_error_memory();
905 #ifdef FEATURE_FORCE_LOAD
906 if (csp->flags & CSP_FLAG_FORCED)
908 path = strdup(FORCE_PREFIX);
911 #endif /* def FEATURE_FORCE_LOAD */
915 err = string_append(&path, csp->http->path);
917 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
918 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
919 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
920 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
923 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
926 /* Some failures, like "404 no such domain", don't have an IP address. */
927 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
935 free_http_response(rsp);
936 return cgi_error_memory();
939 if (!strcmp(templatename, "no-such-domain"))
941 rsp->status = strdup("404 No such domain");
942 rsp->crunch_reason = NO_SUCH_DOMAIN;
944 else if (!strcmp(templatename, "forwarding-failed"))
946 const struct forward_spec *fwd = forward_url(csp, csp->http);
947 char *socks_type = NULL;
950 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
951 /* Never get here - LOG_LEVEL_FATAL causes program exit */
955 * XXX: While the template is called forwarding-failed,
956 * it currently only handles socks forwarding failures.
959 assert(fwd->type != SOCKS_NONE);
962 * Map failure reason, forwarding type and forwarder.
964 if (NULL == csp->error_message)
967 * Either we forgot to record the failure reason,
968 * or the memory allocation failed.
970 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
971 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
973 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
976 * XXX: this is almost the same code as in cgi_show_url_info()
977 * and thus should be factored out and shared.
982 socks_type = "socks4-";
985 socks_type = "socks4a-";
988 socks_type = "socks5-";
991 socks_type = "socks5t-";
993 case FORWARD_WEBSERVER:
994 socks_type = "webserver-";
997 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1000 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1001 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1002 if ((NULL == csp->error_message) || err)
1005 free_http_response(rsp);
1006 return cgi_error_memory();
1009 rsp->status = strdup("503 Forwarding failure");
1010 rsp->crunch_reason = FORWARDING_FAILED;
1012 else if (!strcmp(templatename, "connect-failed"))
1014 rsp->status = strdup("503 Connect failed");
1015 rsp->crunch_reason = CONNECT_FAILED;
1017 else if (!strcmp(templatename, "connection-timeout"))
1019 rsp->status = strdup("504 Connection timeout");
1020 rsp->crunch_reason = CONNECTION_TIMEOUT;
1022 else if (!strcmp(templatename, "no-server-data"))
1024 rsp->status = strdup("502 No data received from server or forwarder");
1025 rsp->crunch_reason = NO_SERVER_DATA;
1028 if (rsp->status == NULL)
1031 free_http_response(rsp);
1032 return cgi_error_memory();
1035 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1038 free_http_response(rsp);
1039 return cgi_error_memory();
1042 return finish_http_response(csp, rsp);
1046 /*********************************************************************
1048 * Function : cgi_error_disabled
1050 * Description : CGI function that is called to generate an error
1051 * response if the actions editor or toggle CGI are
1052 * accessed despite having being disabled at compile-
1053 * or run-time, or if the user followed an untrusted link
1054 * to access a unsafe CGI feature that is only reachable
1055 * through Privoxy directly.
1058 * 1 : csp = Current client state (buffers, headers, etc...)
1059 * 2 : rsp = http_response data structure for output
1061 * CGI Parameters : none
1063 * Returns : JB_ERR_OK on success
1064 * JB_ERR_MEMORY on out-of-memory error.
1066 *********************************************************************/
1067 jb_err cgi_error_disabled(const struct client_state *csp,
1068 struct http_response *rsp)
1070 struct map *exports;
1075 rsp->status = strdup_or_die("403 Request not trusted or feature disabled");
1077 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1079 return JB_ERR_MEMORY;
1081 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1083 /* Not important enough to do anything */
1084 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1087 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1091 /*********************************************************************
1093 * Function : cgi_init_error_messages
1095 * Description : Call at the start of the program to initialize
1096 * the error message used by cgi_error_memory().
1102 *********************************************************************/
1103 void cgi_init_error_messages(void)
1105 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1106 cgi_error_memory_response->head =
1107 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1108 "Content-Type: text/html\r\n"
1110 cgi_error_memory_response->body =
1113 " <title>500 Internal Privoxy Error</title>\n"
1114 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1117 "<h1>500 Internal Privoxy Error</h1>\n"
1118 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\n"
1119 "<p>Please contact your proxy administrator, or try again later</p>\n"
1123 cgi_error_memory_response->head_length =
1124 strlen(cgi_error_memory_response->head);
1125 cgi_error_memory_response->content_length =
1126 strlen(cgi_error_memory_response->body);
1127 cgi_error_memory_response->crunch_reason = OUT_OF_MEMORY;
1131 /*********************************************************************
1133 * Function : cgi_error_memory
1135 * Description : Called if a CGI function runs out of memory.
1136 * Returns a statically-allocated error response.
1140 * Returns : http_response data structure for output. This is
1141 * statically allocated, for obvious reasons.
1143 *********************************************************************/
1144 struct http_response *cgi_error_memory(void)
1146 /* assert that it's been initialized. */
1147 assert(cgi_error_memory_response->head);
1149 return cgi_error_memory_response;
1153 /*********************************************************************
1155 * Function : cgi_error_no_template
1157 * Description : Almost-CGI function that is called if a template
1158 * cannot be loaded. Note this is not a true CGI,
1159 * it takes a template name rather than a map of
1163 * 1 : csp = Current client state (buffers, headers, etc...)
1164 * 2 : rsp = http_response data structure for output
1165 * 3 : template_name = Name of template that could not
1168 * Returns : JB_ERR_OK on success
1169 * JB_ERR_MEMORY on out-of-memory error.
1171 *********************************************************************/
1172 jb_err cgi_error_no_template(const struct client_state *csp,
1173 struct http_response *rsp,
1174 const char *template_name)
1176 static const char status[] =
1177 "500 Internal Privoxy Error";
1178 static const char body_prefix[] =
1181 " <title>500 Internal Privoxy Error</title>\n"
1182 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1185 "<h1>500 Internal Privoxy Error</h1>\n"
1186 "<p>Privoxy encountered an error while processing your request:</p>\n"
1187 "<p><b>Could not load template file <code>";
1188 static const char body_suffix[] =
1189 "</code> or one of its included components.</b></p>\n"
1190 "<p>Please contact your proxy administrator.</p>\n"
1191 "<p>If you are the proxy administrator, please put the required file(s)"
1192 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1193 "location of the <code><i>(confdir)</i></code> directory "
1194 "is specified in the main Privoxy <code>config</code> "
1195 "file. (It's typically the Privoxy install directory"
1197 ", or <code>/etc/privoxy/</code>"
1198 #endif /* ndef _WIN32 */
1202 size_t body_size = strlen(body_prefix) + strlen(body_suffix) + 1;
1203 const char *encoded_template_name;
1207 assert(template_name);
1209 /* Reset rsp, if needed */
1213 rsp->content_length = 0;
1214 rsp->head_length = 0;
1217 encoded_template_name = html_encode(template_name);
1218 if (encoded_template_name == NULL)
1220 return JB_ERR_MEMORY;
1223 body_size += strlen(encoded_template_name);
1224 rsp->body = malloc_or_die(body_size);
1225 strlcpy(rsp->body, body_prefix, body_size);
1226 strlcat(rsp->body, encoded_template_name, body_size);
1227 freez(encoded_template_name);
1228 strlcat(rsp->body, body_suffix, body_size);
1230 rsp->status = strdup(status);
1231 if (rsp->status == NULL)
1233 return JB_ERR_MEMORY;
1240 /*********************************************************************
1242 * Function : cgi_error_unknown
1244 * Description : Almost-CGI function that is called if an unexpected
1245 * error occurs in the top-level CGI dispatcher.
1246 * In this context, "unexpected" means "anything other
1247 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1248 * expected to handle all other errors internally,
1249 * since they can give more relevant error messages
1252 * Note this is not a true CGI, it takes an error
1253 * code rather than a map of parameters.
1256 * 1 : csp = Current client state (buffers, headers, etc...)
1257 * 2 : rsp = http_response data structure for output
1258 * 3 : error_to_report = Error code to report.
1260 * Returns : JB_ERR_OK on success
1261 * JB_ERR_MEMORY on out-of-memory error.
1263 *********************************************************************/
1264 jb_err cgi_error_unknown(const struct client_state *csp,
1265 struct http_response *rsp,
1266 jb_err error_to_report)
1268 static const char status[] =
1269 "500 Internal Privoxy Error";
1270 static const char body_prefix[] =
1273 " <title>500 Internal Privoxy Error</title>\n"
1274 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1277 "<h1>500 Internal Privoxy Error</h1>\n"
1278 "<p>Privoxy encountered an error while processing your request:</p>\n"
1279 "<p><b>Unexpected internal error: ";
1280 static const char body_suffix[] =
1283 "<a href=\"https://sourceforge.net/p/ijbswa/bugs/\">"
1284 "file a bug report</a>.</p>\n"
1287 /* Includes room for larger error numbers in the future. */
1288 const size_t body_size = sizeof(body_prefix) + sizeof(body_suffix) + 5;
1292 /* Reset rsp, if needed */
1296 rsp->content_length = 0;
1297 rsp->head_length = 0;
1299 rsp->crunch_reason = INTERNAL_ERROR;
1301 rsp->body = malloc_or_die(body_size);
1303 snprintf(rsp->body, body_size, "%s%d%s", body_prefix, error_to_report, body_suffix);
1305 rsp->status = strdup(status);
1306 if (rsp->status == NULL)
1308 return JB_ERR_MEMORY;
1315 /*********************************************************************
1317 * Function : cgi_error_bad_param
1319 * Description : CGI function that is called if the parameters
1320 * (query string) for a CGI were wrong.
1323 * 1 : csp = Current client state (buffers, headers, etc...)
1324 * 2 : rsp = http_response data structure for output
1326 * CGI Parameters : none
1328 * Returns : JB_ERR_OK on success
1329 * JB_ERR_MEMORY on out-of-memory error.
1331 *********************************************************************/
1332 jb_err cgi_error_bad_param(const struct client_state *csp,
1333 struct http_response *rsp)
1335 struct map *exports;
1340 if (NULL == (exports = default_exports(csp, NULL)))
1342 return JB_ERR_MEMORY;
1345 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1349 /*********************************************************************
1351 * Function : cgi_redirect
1353 * Description : CGI support function to generate a HTTP redirect
1357 * 1 : rsp = http_response data structure for output
1358 * 2 : target = string with the target URL
1360 * CGI Parameters : None
1362 * Returns : JB_ERR_OK on success
1363 * JB_ERR_MEMORY on out-of-memory error.
1365 *********************************************************************/
1366 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1373 err = enlist_unique_header(rsp->headers, "Location", target);
1375 rsp->status = strdup("302 Local Redirect from Privoxy");
1376 if (rsp->status == NULL)
1378 return JB_ERR_MEMORY;
1385 /*********************************************************************
1387 * Function : add_help_link
1389 * Description : Produce a copy of the string given as item,
1390 * embedded in an HTML link to its corresponding
1391 * section (item name in uppercase) in the actions
1392 * chapter of the user manual, (whose URL is given in
1393 * the config and defaults to our web site).
1395 * FIXME: I currently only work for actions, and would
1396 * like to be generalized for other topics.
1399 * 1 : item = item (will NOT be free()d.)
1400 * It is assumed to be HTML-safe.
1401 * 2 : config = The current configuration.
1403 * Returns : String with item embedded in link, or NULL on
1406 *********************************************************************/
1407 char *add_help_link(const char *item,
1408 struct configuration_spec *config)
1412 if (!item) return NULL;
1414 result = strdup("<a href=\"");
1415 if (!strncmpic(config->usermanual, "file://", 7) ||
1416 !strncmpic(config->usermanual, "http", 4))
1418 string_append(&result, config->usermanual);
1422 string_append(&result, "http://");
1423 string_append(&result, CGI_SITE_2_HOST);
1424 string_append(&result, "/user-manual/");
1426 string_append(&result, ACTIONS_HELP_PREFIX);
1427 string_join (&result, string_toupper(item));
1428 string_append(&result, "\">");
1429 string_append(&result, item);
1430 string_append(&result, "</a>");
1436 /*********************************************************************
1438 * Function : get_http_time
1440 * Description : Get the time in a format suitable for use in a
1441 * HTTP header - e.g.:
1442 * "Sun, 06 Nov 1994 08:49:37 GMT"
1445 * 1 : time_offset = Time returned will be current time
1446 * plus this number of seconds.
1447 * 2 : buf = Destination for result.
1448 * 3 : buffer_size = Size of the buffer above. Must be big
1449 * enough to hold 29 characters plus a
1454 *********************************************************************/
1455 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1458 time_t current_time;
1459 #if defined(HAVE_GMTIME_R)
1464 assert(buffer_size > (size_t)29);
1466 time(¤t_time);
1468 current_time += time_offset;
1470 /* get and save the gmt */
1472 t = gmtime_r(¤t_time, &dummy);
1473 #elif defined(MUTEX_LOCKS_AVAILABLE)
1474 privoxy_mutex_lock(&gmtime_mutex);
1475 t = gmtime(¤t_time);
1476 privoxy_mutex_unlock(&gmtime_mutex);
1478 t = gmtime(¤t_time);
1481 strftime(buf, buffer_size, "%a, %d %b %Y %H:%M:%S GMT", t);
1485 /*********************************************************************
1487 * Function : get_locale_time
1489 * Description : Get the time in a date(1)-like format
1490 * according to the current locale - e.g.:
1491 * "Fri Aug 29 19:37:12 CEST 2008"
1493 * XXX: Should we allow the user to change the format?
1496 * 1 : buf = Destination for result.
1497 * 2 : buffer_size = Size of the buffer above. Must be big
1498 * enough to hold 29 characters plus a
1503 *********************************************************************/
1504 static void get_locale_time(char *buf, size_t buffer_size)
1507 time_t current_time;
1508 #if defined(HAVE_LOCALTIME_R)
1513 assert(buffer_size > (size_t)29);
1515 time(¤t_time);
1517 #if HAVE_LOCALTIME_R
1518 timeptr = localtime_r(¤t_time, &dummy);
1519 #elif defined(MUTEX_LOCKS_AVAILABLE)
1520 privoxy_mutex_lock(&localtime_mutex);
1521 timeptr = localtime(¤t_time);
1523 timeptr = localtime(¤t_time);
1526 strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
1528 #if !defined(HAVE_LOCALTIME_R) && defined(MUTEX_LOCKS_AVAILABLE)
1529 privoxy_mutex_unlock(&localtime_mutex);
1534 #ifdef FEATURE_COMPRESSION
1535 /*********************************************************************
1537 * Function : compress_buffer
1539 * Description : Compresses the content of a buffer with zlib's deflate
1540 * Allocates a new buffer for the result, free'ing it is
1544 * 1 : buffer = buffer whose content should be compressed
1545 * 2 : buffer_length = length of the buffer
1546 * 3 : compression_level = compression level for compress2()
1548 * Returns : NULL on error, otherwise a pointer to the compressed
1549 * content of the input buffer.
1551 *********************************************************************/
1552 char *compress_buffer(char *buffer, size_t *buffer_length, int compression_level)
1554 char *compressed_buffer;
1556 assert(-1 <= compression_level && compression_level <= 9);
1558 /* Let zlib figure out the maximum length of the compressed data */
1559 new_length = compressBound((uLongf)*buffer_length);
1561 compressed_buffer = malloc_or_die(new_length);
1563 if (Z_OK != compress2((Bytef *)compressed_buffer, &new_length,
1564 (Bytef *)buffer, *buffer_length, compression_level))
1566 log_error(LOG_LEVEL_ERROR,
1567 "compress2() failed. Buffer size: %lu, compression level: %d.",
1568 new_length, compression_level);
1569 freez(compressed_buffer);
1573 log_error(LOG_LEVEL_RE_FILTER,
1574 "Compressed content from %lu to %lu bytes. Compression level: %d",
1575 *buffer_length, new_length, compression_level);
1577 *buffer_length = (size_t)new_length;
1579 return compressed_buffer;
1585 /*********************************************************************
1587 * Function : finish_http_response
1589 * Description : Fill in the missing headers in an http response,
1590 * and flatten the headers to an http head.
1591 * For HEAD requests the body is freed once
1592 * the Content-Length header is set.
1595 * 1 : rsp = pointer to http_response to be processed
1597 * Returns : A http_response, usually the rsp parameter.
1598 * On error, free()s rsp and returns cgi_error_memory()
1600 *********************************************************************/
1601 struct http_response *finish_http_response(struct client_state *csp, struct http_response *rsp)
1603 char buf[BUFFER_SIZE];
1606 /* Special case - do NOT change this statically allocated response,
1607 * which is ready for output anyway.
1609 if (rsp == cgi_error_memory_response)
1615 * Add "Cross-origin resource sharing" (CORS) headers if enabled
1617 if (NULL != csp->config->cors_allowed_origin)
1619 enlist_unique_header(rsp->headers, "Access-Control-Allow-Origin",
1620 csp->config->cors_allowed_origin);
1621 enlist_unique_header(rsp->headers, "Access-Control-Allow-Methods", "GET,POST");
1622 enlist_unique_header(rsp->headers, "Access-Control-Allow-Headers", "X-Requested-With");
1623 enlist_unique_header(rsp->headers, "Access-Control-Max-Age", "86400");
1627 * Fill in the HTTP Status, using HTTP/1.1
1628 * unless the client asked for HTTP/1.0.
1630 snprintf(buf, sizeof(buf), "%s %s",
1631 strcmpic(csp->http->version, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
1632 rsp->status ? rsp->status : "200 OK");
1633 err = enlist_first(rsp->headers, buf);
1636 * Set the Content-Length
1638 if (rsp->content_length == 0)
1640 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1643 #ifdef FEATURE_COMPRESSION
1644 if (!err && (csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
1645 && (rsp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
1647 char *compressed_content;
1649 compressed_content = compress_buffer(rsp->body, &rsp->content_length,
1650 csp->config->compression_level);
1651 if (NULL != compressed_content)
1654 rsp->body = compressed_content;
1655 err = enlist_unique_header(rsp->headers, "Content-Encoding", "deflate");
1662 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1664 * Signal serve() that the client will be able to figure out
1665 * the end of the response without having to close the connection.
1667 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1668 err = enlist(rsp->headers, buf);
1671 if (0 == strcmpic(csp->http->gpc, "head"))
1674 * The client only asked for the head. Dispose
1675 * the body and log an offensive message.
1677 * While it may seem to be a bit inefficient to
1678 * prepare the body if it isn't needed, it's the
1679 * only way to get the Content-Length right for
1680 * dynamic pages. We could have disposed the body
1681 * earlier, but not without duplicating the
1682 * Content-Length setting code above.
1684 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
1686 rsp->content_length = 0;
1689 if (strncmpic(rsp->status, "302", 3))
1692 * If it's not a redirect without any content,
1693 * set the Content-Type to text/html if it's
1694 * not already specified.
1696 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1700 * Fill in the rest of the default headers:
1702 * Date: set to current date/time.
1703 * Last-Modified: set to date/time the page was last changed.
1704 * Expires: set to date/time page next needs reloading.
1705 * Cache-Control: set to "no-cache" if applicable.
1707 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1712 * Set Expires to about 10 min into the future so it'll get reloaded
1713 * occasionally, e.g. if Privoxy gets upgraded.
1718 get_http_time(0, buf, sizeof(buf));
1719 err = enlist_unique_header(rsp->headers, "Date", buf);
1722 /* Some date in the past. */
1723 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1727 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
1728 err = enlist_unique_header(rsp->headers, "Expires", buf);
1731 else if (!strncmpic(rsp->status, "302", 3))
1733 get_http_time(0, buf, sizeof(buf));
1734 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1739 * Setting "Cache-Control" to "no-cache" and "Expires" to
1740 * the current time doesn't exactly forbid caching, it just
1741 * requires the client to revalidate the cached copy.
1743 * If a temporary problem occurs and the user tries again after
1744 * getting Privoxy's error message, a compliant browser may set the
1745 * If-Modified-Since header with the content of the error page's
1746 * Last-Modified header. More often than not, the document on the server
1747 * is older than Privoxy's error message, the server would send status code
1748 * 304 and the browser would display the outdated error message again and again.
1750 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
1751 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1752 * and can be safely used to "revalidate" without getting a status code 304.
1754 * There is no need to let the useless If-Modified-Since header reach the
1755 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1757 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1759 get_http_time(0, buf, sizeof(buf));
1760 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1761 if (!strncmpic(rsp->status, "403", 3)
1762 || !strncmpic(rsp->status, "404", 3)
1763 || !strncmpic(rsp->status, "502", 3)
1764 || !strncmpic(rsp->status, "503", 3)
1765 || !strncmpic(rsp->status, "504", 3))
1767 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1771 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1773 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1774 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1777 if (!err && (!(csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
1778 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)))
1780 err = enlist_unique_header(rsp->headers, "Connection", "close");
1786 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1788 free_http_response(rsp);
1789 return cgi_error_memory();
1791 rsp->head_length = strlen(rsp->head);
1798 /*********************************************************************
1800 * Function : alloc_http_response
1802 * Description : Allocates a new http_response structure.
1806 * Returns : pointer to a new http_response, or NULL.
1808 *********************************************************************/
1809 struct http_response *alloc_http_response(void)
1811 return (struct http_response *) zalloc(sizeof(struct http_response));
1816 /*********************************************************************
1818 * Function : free_http_response
1820 * Description : Free the memory occupied by an http_response
1821 * and its depandant structures.
1824 * 1 : rsp = pointer to http_response to be freed
1828 *********************************************************************/
1829 void free_http_response(struct http_response *rsp)
1832 * Must special case cgi_error_memory_response, which is never freed.
1834 if (rsp && (rsp != cgi_error_memory_response))
1839 destroy_list(rsp->headers);
1846 /*********************************************************************
1848 * Function : template_load
1850 * Description : CGI support function that loads a given HTML
1851 * template, ignoring comment lines and following
1852 * #include statements up to a depth of 1.
1855 * 1 : csp = Current client state (buffers, headers, etc...)
1856 * 2 : template_ptr = Destination for pointer to loaded
1858 * 3 : templatename = name of the HTML template to be used
1859 * 4 : recursive = Flag set if this function calls itself
1860 * following an #include statament
1862 * Returns : JB_ERR_OK on success
1863 * JB_ERR_MEMORY on out-of-memory error.
1864 * JB_ERR_FILE if the template file cannot be read
1866 *********************************************************************/
1867 jb_err template_load(const struct client_state *csp, char **template_ptr,
1868 const char *templatename, int recursive)
1871 char *templates_dir_path;
1874 char *included_module;
1877 char buf[BUFFER_SIZE];
1880 assert(template_ptr);
1881 assert(templatename);
1883 *template_ptr = NULL;
1885 /* Validate template name. Paranoia. */
1886 for (p = templatename; *p != 0; p++)
1888 if ( ((*p < 'a') || (*p > 'z'))
1889 && ((*p < 'A') || (*p > 'Z'))
1890 && ((*p < '0') || (*p > '9'))
1894 /* Illegal character */
1900 * Generate full path using either templdir
1901 * or confdir/templates as base directory.
1903 if (NULL != csp->config->templdir)
1905 templates_dir_path = strdup(csp->config->templdir);
1909 templates_dir_path = make_path(csp->config->confdir, "templates");
1912 if (templates_dir_path == NULL)
1914 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
1916 return JB_ERR_MEMORY;
1919 full_path = make_path(templates_dir_path, templatename);
1920 free(templates_dir_path);
1921 if (full_path == NULL)
1923 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
1925 return JB_ERR_MEMORY;
1928 /* Allocate buffer */
1930 file_buffer = strdup("");
1931 if (file_buffer == NULL)
1933 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
1935 return JB_ERR_MEMORY;
1938 /* Open template file */
1940 if (NULL == (fp = fopen(full_path, "r")))
1942 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1950 * Read the file, ignoring comments, and honoring #include
1951 * statements, unless we're already called recursively.
1953 * XXX: The comment handling could break with lines lengths > sizeof(buf).
1954 * This is unlikely in practise.
1956 while (fgets(buf, sizeof(buf), fp))
1958 if (!recursive && !strncmp(buf, "#include ", 9))
1960 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1967 if (string_join(&file_buffer, included_module))
1970 return JB_ERR_MEMORY;
1976 /* skip lines starting with '#' */
1982 if (string_append(&file_buffer, buf))
1985 return JB_ERR_MEMORY;
1990 *template_ptr = file_buffer;
1996 /*********************************************************************
1998 * Function : template_fill
2000 * Description : CGI support function that fills in a pre-loaded
2001 * HTML template by replacing @name@ with value using
2002 * pcrs, for each item in the output map.
2004 * Note that a leading '$' character in the export map's
2005 * values will be stripped and toggle on backreference
2009 * 1 : template_ptr = IN: Template to be filled out.
2011 * OUT: Filled out template.
2012 * Caller must free().
2013 * 2 : exports = map with fill in symbol -> name pairs
2015 * Returns : JB_ERR_OK on success (and for uncritical errors)
2016 * JB_ERR_MEMORY on out-of-memory error
2018 *********************************************************************/
2019 jb_err template_fill(char **template_ptr, const struct map *exports)
2021 struct map_entry *m;
2023 char buf[BUFFER_SIZE];
2024 char *tmp_out_buffer;
2030 assert(template_ptr);
2031 assert(*template_ptr);
2034 file_buffer = *template_ptr;
2035 size = strlen(file_buffer) + 1;
2038 * Assemble pcrs joblist from exports map
2040 for (m = exports->first; m != NULL; m = m->next)
2042 if (*m->name == '$')
2045 * First character of name is '$', so remove this flag
2046 * character and allow backreferences ($1 etc) in the
2047 * "replace with" text.
2049 snprintf(buf, sizeof(buf), "%s", m->name + 1);
2055 * Treat the "replace with" text as a literal string -
2056 * no quoting needed, no backreferences allowed.
2057 * ("Trivial" ['T'] flag).
2061 /* Enclose name in @@ */
2062 snprintf(buf, sizeof(buf), "@%s@", m->name);
2065 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2067 /* Make and run job. */
2068 job = pcrs_compile(buf, m->value, flags, &error);
2071 if (error == PCRS_ERR_NOMEM)
2074 *template_ptr = NULL;
2075 return JB_ERR_MEMORY;
2079 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2080 /* Hope it wasn't important and silently ignore the invalid job */
2085 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2088 if (NULL == tmp_out_buffer)
2090 *template_ptr = NULL;
2091 return JB_ERR_MEMORY;
2097 * Substitution failed, keep the original buffer,
2098 * log the problem and ignore it.
2100 * The user might see some unresolved @CGI_VARIABLES@,
2101 * but returning a special CGI error page seems unreasonable
2102 * and could mask more important error messages.
2104 free(tmp_out_buffer);
2105 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2106 buf, m->value, flags, pcrs_strerror(error));
2110 /* Substitution succeeded, use modified buffer. */
2112 file_buffer = tmp_out_buffer;
2120 *template_ptr = file_buffer;
2125 /*********************************************************************
2127 * Function : template_fill_for_cgi
2129 * Description : CGI support function that loads a HTML template
2130 * and fills it in. Handles file-not-found errors
2131 * by sending a HTML error message. For convenience,
2132 * this function also frees the passed "exports" map.
2135 * 1 : csp = Client state
2136 * 2 : templatename = name of the HTML template to be used
2137 * 3 : exports = map with fill in symbol -> name pairs.
2138 * Will be freed by this function.
2139 * 4 : rsp = Response structure to fill in.
2141 * Returns : JB_ERR_OK on success
2142 * JB_ERR_MEMORY on out-of-memory error
2144 *********************************************************************/
2145 jb_err template_fill_for_cgi(const struct client_state *csp,
2146 const char *templatename,
2147 struct map *exports,
2148 struct http_response *rsp)
2153 assert(templatename);
2157 err = template_load(csp, &rsp->body, templatename, 0);
2158 if (err == JB_ERR_FILE)
2160 err = cgi_error_no_template(csp, rsp, templatename);
2162 else if (err == JB_ERR_OK)
2164 err = template_fill(&rsp->body, exports);
2171 /*********************************************************************
2173 * Function : default_exports
2175 * Description : returns a struct map list that contains exports
2176 * which are common to all CGI functions.
2179 * 1 : csp = Current client state (buffers, headers, etc...)
2180 * 2 : caller = name of CGI who calls us and which should
2181 * be excluded from the generated menu. May be
2183 * Returns : NULL if no memory, else a new map. Caller frees.
2185 *********************************************************************/
2186 struct map *default_exports(const struct client_state *csp, const char *caller)
2190 struct map * exports;
2191 int local_help_exists = 0;
2192 char *ip_address = NULL;
2194 char *hostname = NULL;
2198 exports = new_map();
2200 if (csp->config->hostname)
2202 get_host_information(csp->cfd, &ip_address, &port, NULL);
2203 hostname = strdup(csp->config->hostname);
2207 get_host_information(csp->cfd, &ip_address, &port, &hostname);
2210 err = map(exports, "version", 1, html_encode(VERSION), 0);
2211 get_locale_time(buf, sizeof(buf));
2212 if (!err) err = map(exports, "time", 1, html_encode(buf), 0);
2213 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2215 if (!err) err = map(exports, "my-port", 1, html_encode(port ? port : "unknown"), 0);
2217 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2219 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2222 err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2224 if (!err) err = map(exports, "menu", 1, make_menu(csp, caller), 0);
2225 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2226 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2227 !strncmpic(csp->config->usermanual, "http", 4))
2229 /* Manual is located somewhere else, just link to it. */
2230 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2234 /* Manual is delivered by Privoxy. */
2237 err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2240 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2241 #ifdef FEATURE_TOGGLE
2242 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2244 if (!err) err = map_block_killer(exports, "can-toggle");
2247 if (!strcmp(CODE_STATUS, "stable"))
2249 if (!err) err = map_block_killer(exports, "unstable");
2252 if (csp->config->admin_address != NULL)
2254 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2255 local_help_exists = 1;
2259 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2262 if (csp->config->proxy_info_url != NULL)
2264 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2265 local_help_exists = 1;
2269 if (!err) err = map_block_killer(exports, "have-proxy-info");
2272 if (local_help_exists == 0)
2274 if (!err) err = map_block_killer(exports, "have-help-info");
2287 /*********************************************************************
2289 * Function : map_block_killer
2291 * Description : Convenience function.
2292 * Adds a "killer" for the conditional HTML-template
2293 * block <name>, i.e. a substitution of the regex
2294 * "if-<name>-start.*if-<name>-end" to the given
2298 * 1 : exports = map to extend
2299 * 2 : name = name of conditional block
2301 * Returns : JB_ERR_OK on success
2302 * JB_ERR_MEMORY on out-of-memory error.
2304 *********************************************************************/
2305 jb_err map_block_killer(struct map *exports, const char *name)
2307 char buf[1000]; /* Will do, since the names are hardwired */
2311 assert(strlen(name) < (size_t)490);
2313 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2314 return map(exports, buf, 1, "", 1);
2318 /*********************************************************************
2320 * Function : map_block_keep
2322 * Description : Convenience function. Removes the markers used
2323 * by map-block-killer, to save a few bytes.
2324 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2327 * 1 : exports = map to extend
2328 * 2 : name = name of conditional block
2330 * Returns : JB_ERR_OK on success
2331 * JB_ERR_MEMORY on out-of-memory error.
2333 *********************************************************************/
2334 jb_err map_block_keep(struct map *exports, const char *name)
2337 char buf[500]; /* Will do, since the names are hardwired */
2341 assert(strlen(name) < (size_t)490);
2343 snprintf(buf, sizeof(buf), "if-%s-start", name);
2344 err = map(exports, buf, 1, "", 1);
2351 snprintf(buf, sizeof(buf), "if-%s-end", name);
2352 return map(exports, buf, 1, "", 1);
2356 /*********************************************************************
2358 * Function : map_conditional
2360 * Description : Convenience function.
2361 * Adds an "if-then-else" for the conditional HTML-template
2362 * block <name>, i.e. a substitution of the form:
2369 * The control structure and one of the alternatives
2373 * 1 : exports = map to extend
2374 * 2 : name = name of conditional block
2375 * 3 : choose_first = nonzero for first, zero for second.
2377 * Returns : JB_ERR_OK on success
2378 * JB_ERR_MEMORY on out-of-memory error.
2380 *********************************************************************/
2381 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2383 char buf[1000]; /* Will do, since the names are hardwired */
2388 assert(strlen(name) < (size_t)480);
2390 snprintf(buf, sizeof(buf), (choose_first
2391 ? "else-not-%s@.*@endif-%s"
2392 : "if-%s-then@.*@else-not-%s"),
2395 err = map(exports, buf, 1, "", 1);
2401 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2402 return map(exports, buf, 1, "", 1);
2406 /*********************************************************************
2408 * Function : make_menu
2410 * Description : Returns an HTML-formatted menu of the available
2411 * unhidden CGIs, excluding the one given in <self>
2412 * and the toggle CGI if toggling is disabled.
2415 * 1 : csp = Current client state (buffers, headers, etc...)
2416 * 2 : self = name of CGI to leave out, can be NULL for
2419 * Returns : menu string, or NULL on out-of-memory error.
2421 *********************************************************************/
2422 char *make_menu(const struct client_state *csp, const char *self)
2424 const struct cgi_dispatcher *d;
2425 char *result = strdup("");
2429 self = "NO-SUCH-CGI!";
2432 /* List available unhidden CGI's and export as "other-cgis" */
2433 for (d = cgi_dispatchers; d->name; d++)
2436 #ifdef FEATURE_TOGGLE
2437 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2440 * Suppress the toggle link if remote toggling is disabled.
2444 #endif /* def FEATURE_TOGGLE */
2446 if (d->description && strcmp(d->name, self))
2448 char *html_encoded_prefix;
2451 * Line breaks would be great, but break
2452 * the "blocked" template's JavaScript.
2454 string_append(&result, "<li><a href=\"");
2455 html_encoded_prefix = html_encode(CGI_PREFIX);
2456 if (html_encoded_prefix == NULL)
2462 string_append(&result, html_encoded_prefix);
2463 free(html_encoded_prefix);
2465 string_append(&result, d->name);
2466 string_append(&result, "\">");
2467 string_append(&result, d->description);
2468 string_append(&result, "</a></li>");
2476 /*********************************************************************
2478 * Function : dump_map
2480 * Description : HTML-dump a map for debugging (as table)
2483 * 1 : the_map = map to dump
2485 * Returns : string with HTML
2487 *********************************************************************/
2488 char *dump_map(const struct map *the_map)
2490 struct map_entry *cur_entry;
2491 char *ret = strdup("");
2493 string_append(&ret, "<table>\n");
2495 for (cur_entry = the_map->first;
2496 (cur_entry != NULL) && (ret != NULL);
2497 cur_entry = cur_entry->next)
2499 string_append(&ret, "<tr><td><b>");
2500 string_join (&ret, html_encode(cur_entry->name));
2501 string_append(&ret, "</b></td><td>");
2502 string_join (&ret, html_encode(cur_entry->value));
2503 string_append(&ret, "</td></tr>\n");
2506 string_append(&ret, "</table>\n");