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 resonses.
7 * This only contains the framework functions, the
8 * actual handler functions are declared elsewhere.
10 * Copyright : Written by and Copyright (C) 2001-2017
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) */
66 /* loadcfg.h is for global_toggle_state only */
68 /* jcc.h is for mutex semaphore globals only */
72 * List of CGI functions: name, handler, description
73 * Note: Do NOT use single quotes in the description;
74 * this will break the dynamic "blocked" template!
76 static const struct cgi_dispatcher cgi_dispatchers[] = {
81 #ifdef FEATURE_GRACEFUL_TERMINATION
84 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
85 "this is a one click Denial Of Service attack!!!</em>",
90 #ifdef FEATURE_CGI_EDIT_ACTIONS
91 "View & change the current configuration",
93 "View the current configuration",
96 #ifdef FEATURE_CLIENT_TAGS
98 * This is marked as harmless because despite the description
99 * used in the menu the actual toggling is done through another
100 * path ("/toggle-client-tag").
103 cgi_show_client_tags,
104 "View or toggle the tags that can be set based on the clients address",
109 "View the request headers",
113 "Look up which actions apply to a URL and why",
115 #ifdef FEATURE_TOGGLE
118 "Toggle Privoxy on or off",
120 #endif /* def FEATURE_TOGGLE */
121 #ifdef FEATURE_CLIENT_TAGS
122 { "toggle-client-tag",
123 cgi_toggle_client_tag,
127 #ifdef FEATURE_CGI_EDIT_ACTIONS
128 { "edit-actions", /* Edit the actions list */
131 { "eaa", /* Shortcut for edit-actions-add-url-form */
132 cgi_edit_actions_add_url_form,
134 { "eau", /* Shortcut for edit-actions-url-form */
135 cgi_edit_actions_url_form,
137 { "ear", /* Shortcut for edit-actions-remove-url-form */
138 cgi_edit_actions_remove_url_form,
140 { "eal", /* Shortcut for edit-actions-list */
141 cgi_edit_actions_list,
143 { "eafu", /* Shortcut for edit-actions-for-url */
144 cgi_edit_actions_for_url,
146 { "eas", /* Shortcut for edit-actions-submit */
147 cgi_edit_actions_submit,
149 { "easa", /* Shortcut for edit-actions-section-add */
150 cgi_edit_actions_section_add,
152 { "easr", /* Shortcut for edit-actions-section-remove */
153 cgi_edit_actions_section_remove,
155 { "eass", /* Shortcut for edit-actions-section-swap */
156 cgi_edit_actions_section_swap,
158 { "edit-actions-for-url",
159 cgi_edit_actions_for_url,
160 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
161 { "edit-actions-list",
162 cgi_edit_actions_list,
163 NULL, TRUE /* Edit the actions list */ },
164 { "edit-actions-submit",
165 cgi_edit_actions_submit,
166 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
167 { "edit-actions-url",
168 cgi_edit_actions_url,
169 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
170 { "edit-actions-url-form",
171 cgi_edit_actions_url_form,
172 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
173 { "edit-actions-add-url",
174 cgi_edit_actions_add_url,
175 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
176 { "edit-actions-add-url-form",
177 cgi_edit_actions_add_url_form,
178 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
179 { "edit-actions-remove-url",
180 cgi_edit_actions_remove_url,
181 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
182 { "edit-actions-remove-url-form",
183 cgi_edit_actions_remove_url_form,
184 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
185 { "edit-actions-section-add",
186 cgi_edit_actions_section_add,
187 NULL, FALSE /* Remove a section from the actionsfile */ },
188 { "edit-actions-section-remove",
189 cgi_edit_actions_section_remove,
190 NULL, FALSE /* Remove a section from the actionsfile */ },
191 { "edit-actions-section-swap",
192 cgi_edit_actions_section_swap,
193 NULL, FALSE /* Swap two sections in the actionsfile */ },
194 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
195 { "error-favicon.ico",
196 cgi_send_error_favicon,
197 NULL, TRUE /* Sends the favicon image for error pages. */ },
199 cgi_send_default_favicon,
200 NULL, TRUE /* Sends the default favicon image. */ },
203 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
206 NULL, TRUE /* Send a built-in image */ },
209 NULL, FALSE /* Send templates/cgi-style.css */ },
211 cgi_transparent_image,
212 NULL, TRUE /* Send a transparent image (short name) */ },
213 { "url-info-osd.xml",
214 cgi_send_url_info_osd,
215 NULL, TRUE /* Send templates/url-info-osd.xml */ },
217 cgi_send_user_manual,
218 NULL, TRUE /* Send user-manual */ },
219 { NULL, /* NULL Indicates end of list and default page */
221 NULL, TRUE /* Unknown CGI page */ }
226 * Built-in images for ad replacement
228 * Hint: You can encode your own images like this:
229 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
232 #ifdef FEATURE_NO_GIFS
235 * Checkerboard pattern, as a PNG.
237 const char image_pattern_data[] =
238 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
239 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
240 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
241 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
242 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
243 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
244 "\000\000\000\000\111\105\116\104\256\102\140\202";
247 * 1x1 transparant PNG.
249 const char image_blank_data[] =
250 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
251 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
252 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
253 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
254 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
255 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
256 "\000\000\000\000\111\105\116\104\256\102\140\202";
260 * Checkerboard pattern, as a GIF.
262 const char image_pattern_data[] =
263 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
264 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
265 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
266 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
270 * 1x1 transparant GIF.
272 const char image_blank_data[] =
273 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
274 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
275 "\000\001\000\000\002\002D\001\000;";
278 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
279 const size_t image_blank_length = sizeof(image_blank_data) - 1;
281 #ifdef FEATURE_COMPRESSION
283 * Minimum length which a buffer has to reach before
284 * we bother to (re-)compress it. Completely arbitrary.
286 const size_t LOWER_LENGTH_LIMIT_FOR_COMPRESSION = 1024U;
289 static struct http_response cgi_error_memory_response[1];
291 static struct http_response *dispatch_known_cgi(struct client_state * csp,
293 static struct map *parse_cgi_parameters(char *argstring);
296 /*********************************************************************
298 * Function : dispatch_cgi
300 * Description : Checks if a request URL has either the magical
301 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
302 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
303 * http://config.privoxy.org/). If so, it passes
304 * the (rest of the) path onto dispatch_known_cgi, which
305 * calls the relevant CGI handler function.
308 * 1 : csp = Current client state (buffers, headers, etc...)
310 * Returns : http_response if match, NULL if nonmatch or handler fail
312 *********************************************************************/
313 struct http_response *dispatch_cgi(struct client_state *csp)
315 const char *host = csp->http->host;
316 const char *path = csp->http->path;
319 * Should we intercept ?
322 /* Note: "example.com" and "example.com." are equivalent hostnames. */
324 /* Either the host matches CGI_SITE_1_HOST ..*/
325 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
326 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
329 /* ..then the path will all be for us. Remove leading '/' */
332 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
333 else if (( (0 == strcmpic(host, CGI_SITE_2_HOST))
334 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
335 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))))
337 /* take everything following CGI_SITE_2_PATH */
338 path += strlen(CGI_SITE_2_PATH);
341 /* skip the forward slash after CGI_SITE_2_PATH */
344 else if (*path != '\0')
347 * weirdness: URL is /configXXX, where XXX is some string
348 * Do *NOT* intercept.
359 if (strcmpic(csp->http->gpc, "GET")
360 && strcmpic(csp->http->gpc, "HEAD"))
362 log_error(LOG_LEVEL_ERROR,
363 "CGI request with unsupported method received: %s", csp->http->gpc);
365 * The CGI pages currently only support GET and HEAD requests.
367 * If the client used a different method, ditch any data following
368 * the current headers to reduce the likelihood of parse errors
369 * with the following request.
371 csp->client_iob->eod = csp->client_iob->cur;
375 * This is a CGI call.
378 return dispatch_known_cgi(csp, path);
382 /*********************************************************************
384 * Function : grep_cgi_referrer
386 * Description : Ugly provisorical fix that greps the value of the
387 * referer HTTP header field out of a linked list of
388 * strings like found at csp->headers. Will disappear
391 * FIXME: csp->headers ought to be csp->http->headers
392 * FIXME: Parsing all client header lines should
393 * happen right after the request is received!
396 * 1 : csp = Current client state (buffers, headers, etc...)
398 * Returns : pointer to value (no copy!), or NULL if none found.
400 *********************************************************************/
401 static char *grep_cgi_referrer(const struct client_state *csp)
403 struct list_entry *p;
405 for (p = csp->headers->first; p != NULL; p = p->next)
407 if (p->str == NULL) continue;
408 if (strncmpic(p->str, "Referer: ", 9) == 0)
410 return ((p->str) + 9);
418 /*********************************************************************
420 * Function : referrer_is_safe
422 * Description : Decides whether we trust the Referer for
423 * CGI pages which are only meant to be reachable
424 * through Privoxy's web interface directly.
427 * 1 : csp = Current client state (buffers, headers, etc...)
429 * Returns : TRUE if the referrer is safe, or
430 * FALSE if the referrer is unsafe or not set.
432 *********************************************************************/
433 static int referrer_is_safe(const struct client_state *csp)
436 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
437 const char *trusted_cgi_referrer = csp->config->trusted_cgi_referrer;
439 referrer = grep_cgi_referrer(csp);
441 if (NULL == referrer)
443 /* No referrer, no access */
444 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
447 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
448 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
450 /* Trustworthy referrer */
451 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
452 csp->http->url, referrer);
456 else if ((trusted_cgi_referrer != NULL) && (0 == strncmp(referrer,
457 trusted_cgi_referrer, strlen(trusted_cgi_referrer))))
460 * After some more testing this block should be merged with
461 * the previous one or the log level should bedowngraded.
463 log_error(LOG_LEVEL_INFO, "Granting access to %s based on trusted referrer %s",
464 csp->http->url, referrer);
470 /* Untrustworthy referrer */
471 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
472 csp->http->url, referrer);
479 /*********************************************************************
481 * Function : dispatch_known_cgi
483 * Description : Processes a CGI once dispatch_cgi has determined that
484 * it matches one of the magic prefixes. Parses the path
485 * as a cgi name plus query string, prepares a map that
486 * maps CGI parameter names to their values, initializes
487 * the http_response struct, and calls the relevant CGI
491 * 1 : csp = Current client state (buffers, headers, etc...)
492 * 2 : path = Path of CGI, with the CGI prefix removed.
493 * Should not have a leading "/".
495 * Returns : http_response, or NULL on handler failure or out of
498 *********************************************************************/
499 static struct http_response *dispatch_known_cgi(struct client_state * csp,
502 const struct cgi_dispatcher *d;
503 struct map *param_list;
504 struct http_response *rsp;
505 char *query_args_start;
509 if (NULL == (path_copy = strdup(path)))
511 return cgi_error_memory();
513 query_args_start = path_copy;
514 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
518 if (*query_args_start == '/')
520 *query_args_start++ = '\0';
521 param_list = new_map();
522 err = map(param_list, "file", 1, url_decode(query_args_start), 0);
523 if (JB_ERR_OK != err) {
526 return cgi_error_memory();
531 if (*query_args_start == '?')
533 *query_args_start++ = '\0';
535 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
538 return cgi_error_memory();
544 * path_copy = CGI call name
545 * param_list = CGI params, as map
548 /* Get mem for response or fail*/
549 if (NULL == (rsp = alloc_http_response()))
552 free_map(param_list);
553 return cgi_error_memory();
557 * Find and start the right CGI function
562 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
565 * If the called CGI is either harmless, or referred
566 * from a trusted source, start it.
568 if (d->harmless || referrer_is_safe(csp))
570 err = (d->handler)(csp, rsp, param_list);
575 * Else, modify toggle calls so that they only display
576 * the status, and deny all other calls.
578 if (0 == strcmp(path_copy, "toggle"))
580 unmap(param_list, "set");
581 err = (d->handler)(csp, rsp, param_list);
585 err = cgi_error_disabled(csp, rsp);
590 free_map(param_list);
592 if (err == JB_ERR_CGI_PARAMS)
594 err = cgi_error_bad_param(csp, rsp);
596 if (err && (err != JB_ERR_MEMORY))
598 /* Unexpected error! Shouldn't get here */
599 log_error(LOG_LEVEL_ERROR,
600 "Unexpected CGI error %d in top-level handler. "
601 "Please file a bug report!", err);
602 err = cgi_error_unknown(csp, rsp, err);
607 rsp->crunch_reason = CGI_CALL;
608 return finish_http_response(csp, rsp);
612 /* Error in handler, probably out-of-memory */
613 free_http_response(rsp);
614 return cgi_error_memory();
622 /*********************************************************************
624 * Function : parse_cgi_parameters
626 * Description : Parse a URL-encoded argument string into name/value
627 * pairs and store them in a struct map list.
630 * 1 : argstring = string to be parsed. Will be trashed.
632 * Returns : pointer to param list, or NULL if out of memory.
634 *********************************************************************/
635 static struct map *parse_cgi_parameters(char *argstring)
640 struct map *cgi_params;
643 * XXX: This estimate is guaranteed to be high enough as we
644 * let ssplit() ignore empty fields, but also a bit wasteful.
645 * The same hack is used in get_last_url() so it looks like
646 * a real solution is needed.
648 size_t max_segments = strlen(argstring) / 2;
649 if (max_segments == 0)
652 * XXX: If the argstring is empty, there's really
653 * no point in creating a param list, but currently
654 * other parts of Privoxy depend on the list's existence.
658 vector = malloc_or_die(max_segments * sizeof(char *));
660 cgi_params = new_map();
663 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
664 * the fragment identifier along with the request, so we must
665 * cut it off here, so it won't pollute the CGI params:
667 if (NULL != (p = strchr(argstring, '#')))
672 pairs = ssplit(argstring, "&", vector, max_segments);
677 free_map(cgi_params);
681 for (i = 0; i < pairs; i++)
683 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
686 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
689 free_map(cgi_params);
702 /*********************************************************************
704 * Function : get_char_param
706 * Description : Get a single-character parameter passed to a CGI
710 * 1 : parameters = map of cgi parameters
711 * 2 : param_name = The name of the parameter to read
713 * Returns : Uppercase character on success, '\0' on error.
715 *********************************************************************/
716 char get_char_param(const struct map *parameters,
717 const char *param_name)
724 ch = *(lookup(parameters, param_name));
725 if ((ch >= 'a') && (ch <= 'z'))
727 ch = (char)(ch - 'a' + 'A');
734 /*********************************************************************
736 * Function : get_string_param
738 * Description : Get a string paramater, to be used as an
739 * ACTION_STRING or ACTION_MULTI paramater.
740 * Validates the input to prevent stupid/malicious
741 * users from corrupting their action file.
744 * 1 : parameters = map of cgi parameters
745 * 2 : param_name = The name of the parameter to read
746 * 3 : pparam = destination for paramater. Allocated as
747 * part of the map "parameters", so don't free it.
748 * Set to NULL if not specified.
750 * Returns : JB_ERR_OK on success, or if the paramater
752 * JB_ERR_MEMORY on out-of-memory.
753 * JB_ERR_CGI_PARAMS if the paramater is not valid.
755 *********************************************************************/
756 jb_err get_string_param(const struct map *parameters,
757 const char *param_name,
770 param = lookup(parameters, param_name);
776 if (strlen(param) >= CGI_PARAM_LEN_MAX)
781 * Note that the length limit is arbitrary, it just seems
782 * sensible to limit it to *something*. There's no
783 * technical reason for any limit at all.
785 return JB_ERR_CGI_PARAMS;
788 /* Check every character to see if it's legal */
790 while ((ch = *s++) != '\0')
792 if (((unsigned char)ch < (unsigned char)' ')
795 /* Probable hack attempt, or user accidentally used '}'. */
796 return JB_ERR_CGI_PARAMS;
807 /*********************************************************************
809 * Function : get_number_param
811 * Description : Get a non-negative integer from the parameters
812 * passed to a CGI function.
815 * 1 : csp = Current client state (buffers, headers, etc...)
816 * 2 : parameters = map of cgi parameters
817 * 3 : name = Name of CGI parameter to read
818 * 4 : pvalue = destination for value.
819 * Set to -1 on error.
821 * Returns : JB_ERR_OK on success
822 * JB_ERR_MEMORY on out-of-memory
823 * JB_ERR_CGI_PARAMS if the parameter was not specified
826 *********************************************************************/
827 jb_err get_number_param(struct client_state *csp,
828 const struct map *parameters,
842 param = lookup(parameters, name);
845 return JB_ERR_CGI_PARAMS;
848 *pvalue = (unsigned int)strtol(param, &endptr, 0);
851 return JB_ERR_CGI_PARAMS;
859 /*********************************************************************
861 * Function : error_response
863 * Description : returns an http_response that explains the reason
864 * why a request failed.
867 * 1 : csp = Current client state (buffers, headers, etc...)
868 * 2 : templatename = Which template should be used for the answer
870 * Returns : A http_response. If we run out of memory, this
871 * will be cgi_error_memory().
873 *********************************************************************/
874 struct http_response *error_response(struct client_state *csp,
875 const char *templatename)
878 struct http_response *rsp;
879 struct map *exports = default_exports(csp, NULL);
884 return cgi_error_memory();
887 if (NULL == (rsp = alloc_http_response()))
890 return cgi_error_memory();
893 #ifdef FEATURE_FORCE_LOAD
894 if (csp->flags & CSP_FLAG_FORCED)
896 path = strdup(FORCE_PREFIX);
899 #endif /* def FEATURE_FORCE_LOAD */
903 err = string_append(&path, csp->http->path);
905 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
906 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
907 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
908 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
911 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
914 /* Some failures, like "404 no such domain", don't have an IP address. */
915 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
923 free_http_response(rsp);
924 return cgi_error_memory();
927 if (!strcmp(templatename, "no-such-domain"))
929 rsp->status = strdup("404 No such domain");
930 rsp->crunch_reason = NO_SUCH_DOMAIN;
932 else if (!strcmp(templatename, "forwarding-failed"))
934 const struct forward_spec *fwd = forward_url(csp, csp->http);
935 char *socks_type = NULL;
938 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
939 /* Never get here - LOG_LEVEL_FATAL causes program exit */
943 * XXX: While the template is called forwarding-failed,
944 * it currently only handles socks forwarding failures.
947 assert(fwd->type != SOCKS_NONE);
950 * Map failure reason, forwarding type and forwarder.
952 if (NULL == csp->error_message)
955 * Either we forgot to record the failure reason,
956 * or the memory allocation failed.
958 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
959 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
961 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
964 * XXX: this is almost the same code as in cgi_show_url_info()
965 * and thus should be factored out and shared.
970 socks_type = "socks4-";
973 socks_type = "socks4a-";
976 socks_type = "socks5-";
979 socks_type = "socks5t-";
981 case FORWARD_WEBSERVER:
982 socks_type = "webserver-";
985 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
988 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
989 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
990 if ((NULL == csp->error_message) || err)
993 free_http_response(rsp);
994 return cgi_error_memory();
997 rsp->status = strdup("503 Forwarding failure");
998 rsp->crunch_reason = FORWARDING_FAILED;
1000 else if (!strcmp(templatename, "connect-failed"))
1002 rsp->status = strdup("503 Connect failed");
1003 rsp->crunch_reason = CONNECT_FAILED;
1005 else if (!strcmp(templatename, "connection-timeout"))
1007 rsp->status = strdup("504 Connection timeout");
1008 rsp->crunch_reason = CONNECTION_TIMEOUT;
1010 else if (!strcmp(templatename, "no-server-data"))
1012 rsp->status = strdup("502 No data received from server or forwarder");
1013 rsp->crunch_reason = NO_SERVER_DATA;
1016 if (rsp->status == NULL)
1019 free_http_response(rsp);
1020 return cgi_error_memory();
1023 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1026 free_http_response(rsp);
1027 return cgi_error_memory();
1030 return finish_http_response(csp, rsp);
1034 /*********************************************************************
1036 * Function : cgi_error_disabled
1038 * Description : CGI function that is called to generate an error
1039 * response if the actions editor or toggle CGI are
1040 * accessed despite having being disabled at compile-
1041 * or run-time, or if the user followed an untrusted link
1042 * to access a unsafe CGI feature that is only reachable
1043 * through Privoxy directly.
1046 * 1 : csp = Current client state (buffers, headers, etc...)
1047 * 2 : rsp = http_response data structure for output
1049 * CGI Parameters : none
1051 * Returns : JB_ERR_OK on success
1052 * JB_ERR_MEMORY on out-of-memory error.
1054 *********************************************************************/
1055 jb_err cgi_error_disabled(const struct client_state *csp,
1056 struct http_response *rsp)
1058 struct map *exports;
1063 rsp->status = strdup_or_die("403 Request not trusted or feature disabled");
1065 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1067 return JB_ERR_MEMORY;
1069 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1071 /* Not important enough to do anything */
1072 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1075 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1079 /*********************************************************************
1081 * Function : cgi_init_error_messages
1083 * Description : Call at the start of the program to initialize
1084 * the error message used by cgi_error_memory().
1090 *********************************************************************/
1091 void cgi_init_error_messages(void)
1093 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1094 cgi_error_memory_response->head =
1095 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1096 "Content-Type: text/html\r\n"
1098 cgi_error_memory_response->body =
1101 " <title>500 Internal Privoxy Error</title>\n"
1102 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1105 "<h1>500 Internal Privoxy Error</h1>\n"
1106 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\n"
1107 "<p>Please contact your proxy administrator, or try again later</p>\n"
1111 cgi_error_memory_response->head_length =
1112 strlen(cgi_error_memory_response->head);
1113 cgi_error_memory_response->content_length =
1114 strlen(cgi_error_memory_response->body);
1115 cgi_error_memory_response->crunch_reason = OUT_OF_MEMORY;
1119 /*********************************************************************
1121 * Function : cgi_error_memory
1123 * Description : Called if a CGI function runs out of memory.
1124 * Returns a statically-allocated error response.
1128 * Returns : http_response data structure for output. This is
1129 * statically allocated, for obvious reasons.
1131 *********************************************************************/
1132 struct http_response *cgi_error_memory(void)
1134 /* assert that it's been initialized. */
1135 assert(cgi_error_memory_response->head);
1137 return cgi_error_memory_response;
1141 /*********************************************************************
1143 * Function : cgi_error_no_template
1145 * Description : Almost-CGI function that is called if a template
1146 * cannot be loaded. Note this is not a true CGI,
1147 * it takes a template name rather than a map of
1151 * 1 : csp = Current client state (buffers, headers, etc...)
1152 * 2 : rsp = http_response data structure for output
1153 * 3 : template_name = Name of template that could not
1156 * Returns : JB_ERR_OK on success
1157 * JB_ERR_MEMORY on out-of-memory error.
1159 *********************************************************************/
1160 jb_err cgi_error_no_template(const struct client_state *csp,
1161 struct http_response *rsp,
1162 const char *template_name)
1164 static const char status[] =
1165 "500 Internal Privoxy Error";
1166 static const char body_prefix[] =
1169 " <title>500 Internal Privoxy Error</title>\n"
1170 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1173 "<h1>500 Internal Privoxy Error</h1>\n"
1174 "<p>Privoxy encountered an error while processing your request:</p>\n"
1175 "<p><b>Could not load template file <code>";
1176 static const char body_suffix[] =
1177 "</code> or one of its included components.</b></p>\n"
1178 "<p>Please contact your proxy administrator.</p>\n"
1179 "<p>If you are the proxy administrator, please put the required file(s)"
1180 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1181 "location of the <code><i>(confdir)</i></code> directory "
1182 "is specified in the main Privoxy <code>config</code> "
1183 "file. (It's typically the Privoxy install directory"
1185 ", or <code>/etc/privoxy/</code>"
1186 #endif /* ndef _WIN32 */
1190 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1194 assert(template_name);
1196 /* Reset rsp, if needed */
1200 rsp->content_length = 0;
1201 rsp->head_length = 0;
1204 rsp->body = malloc_or_die(body_size);
1205 strlcpy(rsp->body, body_prefix, body_size);
1206 strlcat(rsp->body, template_name, body_size);
1207 strlcat(rsp->body, body_suffix, body_size);
1209 rsp->status = strdup(status);
1210 if (rsp->status == NULL)
1212 return JB_ERR_MEMORY;
1219 /*********************************************************************
1221 * Function : cgi_error_unknown
1223 * Description : Almost-CGI function that is called if an unexpected
1224 * error occurs in the top-level CGI dispatcher.
1225 * In this context, "unexpected" means "anything other
1226 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1227 * expected to handle all other errors internally,
1228 * since they can give more relavent error messages
1231 * Note this is not a true CGI, it takes an error
1232 * code rather than a map of parameters.
1235 * 1 : csp = Current client state (buffers, headers, etc...)
1236 * 2 : rsp = http_response data structure for output
1237 * 3 : error_to_report = Error code to report.
1239 * Returns : JB_ERR_OK on success
1240 * JB_ERR_MEMORY on out-of-memory error.
1242 *********************************************************************/
1243 jb_err cgi_error_unknown(const struct client_state *csp,
1244 struct http_response *rsp,
1245 jb_err error_to_report)
1247 static const char status[] =
1248 "500 Internal Privoxy Error";
1249 static const char body_prefix[] =
1252 " <title>500 Internal Privoxy Error</title>\n"
1253 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1256 "<h1>500 Internal Privoxy Error</h1>\n"
1257 "<p>Privoxy encountered an error while processing your request:</p>\n"
1258 "<p><b>Unexpected internal error: ";
1259 static const char body_suffix[] =
1262 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1263 "file a bug report</a>.</p>\n"
1266 /* Includes room for larger error numbers in the future. */
1267 const size_t body_size = sizeof(body_prefix) + sizeof(body_suffix) + 5;
1271 /* Reset rsp, if needed */
1275 rsp->content_length = 0;
1276 rsp->head_length = 0;
1278 rsp->crunch_reason = INTERNAL_ERROR;
1280 rsp->body = malloc_or_die(body_size);
1282 snprintf(rsp->body, body_size, "%s%d%s", body_prefix, error_to_report, body_suffix);
1284 rsp->status = strdup(status);
1285 if (rsp->status == NULL)
1287 return JB_ERR_MEMORY;
1294 /*********************************************************************
1296 * Function : cgi_error_bad_param
1298 * Description : CGI function that is called if the parameters
1299 * (query string) for a CGI were wrong.
1302 * 1 : csp = Current client state (buffers, headers, etc...)
1303 * 2 : rsp = http_response data structure for output
1305 * CGI Parameters : none
1307 * Returns : JB_ERR_OK on success
1308 * JB_ERR_MEMORY on out-of-memory error.
1310 *********************************************************************/
1311 jb_err cgi_error_bad_param(const struct client_state *csp,
1312 struct http_response *rsp)
1314 struct map *exports;
1319 if (NULL == (exports = default_exports(csp, NULL)))
1321 return JB_ERR_MEMORY;
1324 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1328 /*********************************************************************
1330 * Function : cgi_redirect
1332 * Description : CGI support function to generate a HTTP redirect
1336 * 1 : rsp = http_response data structure for output
1337 * 2 : target = string with the target URL
1339 * CGI Parameters : None
1341 * Returns : JB_ERR_OK on success
1342 * JB_ERR_MEMORY on out-of-memory error.
1344 *********************************************************************/
1345 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1352 err = enlist_unique_header(rsp->headers, "Location", target);
1354 rsp->status = strdup("302 Local Redirect from Privoxy");
1355 if (rsp->status == NULL)
1357 return JB_ERR_MEMORY;
1364 /*********************************************************************
1366 * Function : add_help_link
1368 * Description : Produce a copy of the string given as item,
1369 * embedded in an HTML link to its corresponding
1370 * section (item name in uppercase) in the actions
1371 * chapter of the user manual, (whose URL is given in
1372 * the config and defaults to our web site).
1374 * FIXME: I currently only work for actions, and would
1375 * like to be generalized for other topics.
1378 * 1 : item = item (will NOT be free()d.)
1379 * It is assumed to be HTML-safe.
1380 * 2 : config = The current configuration.
1382 * Returns : String with item embedded in link, or NULL on
1385 *********************************************************************/
1386 char *add_help_link(const char *item,
1387 struct configuration_spec *config)
1391 if (!item) return NULL;
1393 result = strdup("<a href=\"");
1394 if (!strncmpic(config->usermanual, "file://", 7) ||
1395 !strncmpic(config->usermanual, "http", 4))
1397 string_append(&result, config->usermanual);
1401 string_append(&result, "http://");
1402 string_append(&result, CGI_SITE_2_HOST);
1403 string_append(&result, "/user-manual/");
1405 string_append(&result, ACTIONS_HELP_PREFIX);
1406 string_join (&result, string_toupper(item));
1407 string_append(&result, "\">");
1408 string_append(&result, item);
1409 string_append(&result, "</a>");
1415 /*********************************************************************
1417 * Function : get_http_time
1419 * Description : Get the time in a format suitable for use in a
1420 * HTTP header - e.g.:
1421 * "Sun, 06 Nov 1994 08:49:37 GMT"
1424 * 1 : time_offset = Time returned will be current time
1425 * plus this number of seconds.
1426 * 2 : buf = Destination for result.
1427 * 3 : buffer_size = Size of the buffer above. Must be big
1428 * enough to hold 29 characters plus a
1433 *********************************************************************/
1434 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1437 time_t current_time;
1438 #if defined(HAVE_GMTIME_R)
1443 assert(buffer_size > (size_t)29);
1445 time(¤t_time);
1447 current_time += time_offset;
1449 /* get and save the gmt */
1451 t = gmtime_r(¤t_time, &dummy);
1452 #elif defined(MUTEX_LOCKS_AVAILABLE)
1453 privoxy_mutex_lock(&gmtime_mutex);
1454 t = gmtime(¤t_time);
1455 privoxy_mutex_unlock(&gmtime_mutex);
1457 t = gmtime(¤t_time);
1460 strftime(buf, buffer_size, "%a, %d %b %Y %H:%M:%S GMT", t);
1464 /*********************************************************************
1466 * Function : get_locale_time
1468 * Description : Get the time in a date(1)-like format
1469 * according to the current locale - e.g.:
1470 * "Fri Aug 29 19:37:12 CEST 2008"
1472 * XXX: Should we allow the user to change the format?
1475 * 1 : buf = Destination for result.
1476 * 2 : buffer_size = Size of the buffer above. Must be big
1477 * enough to hold 29 characters plus a
1482 *********************************************************************/
1483 static void get_locale_time(char *buf, size_t buffer_size)
1486 time_t current_time;
1487 #if defined(HAVE_LOCALTIME_R)
1492 assert(buffer_size > (size_t)29);
1494 time(¤t_time);
1496 #if HAVE_LOCALTIME_R
1497 timeptr = localtime_r(¤t_time, &dummy);
1498 #elif defined(MUTEX_LOCKS_AVAILABLE)
1499 privoxy_mutex_lock(&localtime_mutex);
1500 timeptr = localtime(¤t_time);
1501 privoxy_mutex_unlock(&localtime_mutex);
1503 timeptr = localtime(¤t_time);
1506 strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
1511 #ifdef FEATURE_COMPRESSION
1512 /*********************************************************************
1514 * Function : compress_buffer
1516 * Description : Compresses the content of a buffer with zlib's deflate
1517 * Allocates a new buffer for the result, free'ing it is
1521 * 1 : buffer = buffer whose content should be compressed
1522 * 2 : buffer_length = length of the buffer
1523 * 3 : compression_level = compression level for compress2()
1525 * Returns : NULL on error, otherwise a pointer to the compressed
1526 * content of the input buffer.
1528 *********************************************************************/
1529 char *compress_buffer(char *buffer, size_t *buffer_length, int compression_level)
1531 char *compressed_buffer;
1533 assert(-1 <= compression_level && compression_level <= 9);
1535 /* Let zlib figure out the maximum length of the compressed data */
1536 new_length = compressBound((uLongf)*buffer_length);
1538 compressed_buffer = malloc_or_die(new_length);
1540 if (Z_OK != compress2((Bytef *)compressed_buffer, &new_length,
1541 (Bytef *)buffer, *buffer_length, compression_level))
1543 log_error(LOG_LEVEL_ERROR,
1544 "compress2() failed. Buffer size: %d, compression level: %d.",
1545 new_length, compression_level);
1546 freez(compressed_buffer);
1550 log_error(LOG_LEVEL_RE_FILTER,
1551 "Compressed content from %d to %d bytes. Compression level: %d",
1552 *buffer_length, new_length, compression_level);
1554 *buffer_length = (size_t)new_length;
1556 return compressed_buffer;
1562 /*********************************************************************
1564 * Function : finish_http_response
1566 * Description : Fill in the missing headers in an http response,
1567 * and flatten the headers to an http head.
1568 * For HEAD requests the body is freed once
1569 * the Content-Length header is set.
1572 * 1 : rsp = pointer to http_response to be processed
1574 * Returns : A http_response, usually the rsp parameter.
1575 * On error, free()s rsp and returns cgi_error_memory()
1577 *********************************************************************/
1578 struct http_response *finish_http_response(struct client_state *csp, struct http_response *rsp)
1580 char buf[BUFFER_SIZE];
1583 /* Special case - do NOT change this statically allocated response,
1584 * which is ready for output anyway.
1586 if (rsp == cgi_error_memory_response)
1592 * Add "Cross-origin resource sharing" (CORS) headers if enabled
1594 if (NULL != csp->config->cors_allowed_origin)
1596 enlist_unique_header(rsp->headers, "Access-Control-Allow-Origin",
1597 csp->config->cors_allowed_origin);
1598 enlist_unique_header(rsp->headers, "Access-Control-Allow-Methods", "GET,POST");
1599 enlist_unique_header(rsp->headers, "Access-Control-Allow-Headers", "X-Requested-With");
1600 enlist_unique_header(rsp->headers, "Access-Control-Max-Age", "86400");
1604 * Fill in the HTTP Status, using HTTP/1.1
1605 * unless the client asked for HTTP/1.0.
1607 snprintf(buf, sizeof(buf), "%s %s",
1608 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
1609 rsp->status ? rsp->status : "200 OK");
1610 err = enlist_first(rsp->headers, buf);
1613 * Set the Content-Length
1615 if (rsp->content_length == 0)
1617 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1620 #ifdef FEATURE_COMPRESSION
1621 if (!err && (csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
1622 && (rsp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
1624 char *compressed_content;
1626 compressed_content = compress_buffer(rsp->body, &rsp->content_length,
1627 csp->config->compression_level);
1628 if (NULL != compressed_content)
1631 rsp->body = compressed_content;
1632 err = enlist_unique_header(rsp->headers, "Content-Encoding", "deflate");
1639 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1641 * Signal serve() that the client will be able to figure out
1642 * the end of the response without having to close the connection.
1644 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1645 err = enlist(rsp->headers, buf);
1648 if (0 == strcmpic(csp->http->gpc, "head"))
1651 * The client only asked for the head. Dispose
1652 * the body and log an offensive message.
1654 * While it may seem to be a bit inefficient to
1655 * prepare the body if it isn't needed, it's the
1656 * only way to get the Content-Length right for
1657 * dynamic pages. We could have disposed the body
1658 * earlier, but not without duplicating the
1659 * Content-Length setting code above.
1661 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
1663 rsp->content_length = 0;
1666 if (strncmpic(rsp->status, "302", 3))
1669 * If it's not a redirect without any content,
1670 * set the Content-Type to text/html if it's
1671 * not already specified.
1673 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1677 * Fill in the rest of the default headers:
1679 * Date: set to current date/time.
1680 * Last-Modified: set to date/time the page was last changed.
1681 * Expires: set to date/time page next needs reloading.
1682 * Cache-Control: set to "no-cache" if applicable.
1684 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1689 * Set Expires to about 10 min into the future so it'll get reloaded
1690 * occasionally, e.g. if Privoxy gets upgraded.
1695 get_http_time(0, buf, sizeof(buf));
1696 err = enlist_unique_header(rsp->headers, "Date", buf);
1699 /* Some date in the past. */
1700 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1704 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
1705 err = enlist_unique_header(rsp->headers, "Expires", buf);
1708 else if (!strncmpic(rsp->status, "302", 3))
1710 get_http_time(0, buf, sizeof(buf));
1711 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1716 * Setting "Cache-Control" to "no-cache" and "Expires" to
1717 * the current time doesn't exactly forbid caching, it just
1718 * requires the client to revalidate the cached copy.
1720 * If a temporary problem occurs and the user tries again after
1721 * getting Privoxy's error message, a compliant browser may set the
1722 * If-Modified-Since header with the content of the error page's
1723 * Last-Modified header. More often than not, the document on the server
1724 * is older than Privoxy's error message, the server would send status code
1725 * 304 and the browser would display the outdated error message again and again.
1727 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
1728 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1729 * and can be safely used to "revalidate" without getting a status code 304.
1731 * There is no need to let the useless If-Modified-Since header reach the
1732 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1734 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1736 get_http_time(0, buf, sizeof(buf));
1737 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1738 if (!strncmpic(rsp->status, "403", 3)
1739 || !strncmpic(rsp->status, "404", 3)
1740 || !strncmpic(rsp->status, "502", 3)
1741 || !strncmpic(rsp->status, "503", 3)
1742 || !strncmpic(rsp->status, "504", 3))
1744 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1748 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1750 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1751 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1754 if (!err && (!(csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
1755 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)))
1757 err = enlist_unique_header(rsp->headers, "Connection", "close");
1763 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1765 free_http_response(rsp);
1766 return cgi_error_memory();
1768 rsp->head_length = strlen(rsp->head);
1775 /*********************************************************************
1777 * Function : alloc_http_response
1779 * Description : Allocates a new http_response structure.
1783 * Returns : pointer to a new http_response, or NULL.
1785 *********************************************************************/
1786 struct http_response *alloc_http_response(void)
1788 return (struct http_response *) zalloc(sizeof(struct http_response));
1793 /*********************************************************************
1795 * Function : free_http_response
1797 * Description : Free the memory occupied by an http_response
1798 * and its depandant structures.
1801 * 1 : rsp = pointer to http_response to be freed
1805 *********************************************************************/
1806 void free_http_response(struct http_response *rsp)
1809 * Must special case cgi_error_memory_response, which is never freed.
1811 if (rsp && (rsp != cgi_error_memory_response))
1816 destroy_list(rsp->headers);
1823 /*********************************************************************
1825 * Function : template_load
1827 * Description : CGI support function that loads a given HTML
1828 * template, ignoring comment lines and following
1829 * #include statements up to a depth of 1.
1832 * 1 : csp = Current client state (buffers, headers, etc...)
1833 * 2 : template_ptr = Destination for pointer to loaded
1835 * 3 : templatename = name of the HTML template to be used
1836 * 4 : recursive = Flag set if this function calls itself
1837 * following an #include statament
1839 * Returns : JB_ERR_OK on success
1840 * JB_ERR_MEMORY on out-of-memory error.
1841 * JB_ERR_FILE if the template file cannot be read
1843 *********************************************************************/
1844 jb_err template_load(const struct client_state *csp, char **template_ptr,
1845 const char *templatename, int recursive)
1848 char *templates_dir_path;
1851 char *included_module;
1854 char buf[BUFFER_SIZE];
1857 assert(template_ptr);
1858 assert(templatename);
1860 *template_ptr = NULL;
1862 /* Validate template name. Paranoia. */
1863 for (p = templatename; *p != 0; p++)
1865 if ( ((*p < 'a') || (*p > 'z'))
1866 && ((*p < 'A') || (*p > 'Z'))
1867 && ((*p < '0') || (*p > '9'))
1871 /* Illegal character */
1877 * Generate full path using either templdir
1878 * or confdir/templates as base directory.
1880 if (NULL != csp->config->templdir)
1882 templates_dir_path = strdup(csp->config->templdir);
1886 templates_dir_path = make_path(csp->config->confdir, "templates");
1889 if (templates_dir_path == NULL)
1891 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
1893 return JB_ERR_MEMORY;
1896 full_path = make_path(templates_dir_path, templatename);
1897 free(templates_dir_path);
1898 if (full_path == NULL)
1900 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
1902 return JB_ERR_MEMORY;
1905 /* Allocate buffer */
1907 file_buffer = strdup("");
1908 if (file_buffer == NULL)
1910 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
1912 return JB_ERR_MEMORY;
1915 /* Open template file */
1917 if (NULL == (fp = fopen(full_path, "r")))
1919 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1927 * Read the file, ignoring comments, and honoring #include
1928 * statements, unless we're already called recursively.
1930 * XXX: The comment handling could break with lines lengths > sizeof(buf).
1931 * This is unlikely in practise.
1933 while (fgets(buf, sizeof(buf), fp))
1935 if (!recursive && !strncmp(buf, "#include ", 9))
1937 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1944 if (string_join(&file_buffer, included_module))
1947 return JB_ERR_MEMORY;
1953 /* skip lines starting with '#' */
1959 if (string_append(&file_buffer, buf))
1962 return JB_ERR_MEMORY;
1967 *template_ptr = file_buffer;
1973 /*********************************************************************
1975 * Function : template_fill
1977 * Description : CGI support function that fills in a pre-loaded
1978 * HTML template by replacing @name@ with value using
1979 * pcrs, for each item in the output map.
1981 * Note that a leading '$' character in the export map's
1982 * values will be stripped and toggle on backreference
1986 * 1 : template_ptr = IN: Template to be filled out.
1988 * OUT: Filled out template.
1989 * Caller must free().
1990 * 2 : exports = map with fill in symbol -> name pairs
1992 * Returns : JB_ERR_OK on success (and for uncritical errors)
1993 * JB_ERR_MEMORY on out-of-memory error
1995 *********************************************************************/
1996 jb_err template_fill(char **template_ptr, const struct map *exports)
1998 struct map_entry *m;
2000 char buf[BUFFER_SIZE];
2001 char *tmp_out_buffer;
2007 assert(template_ptr);
2008 assert(*template_ptr);
2011 file_buffer = *template_ptr;
2012 size = strlen(file_buffer) + 1;
2015 * Assemble pcrs joblist from exports map
2017 for (m = exports->first; m != NULL; m = m->next)
2019 if (*m->name == '$')
2022 * First character of name is '$', so remove this flag
2023 * character and allow backreferences ($1 etc) in the
2024 * "replace with" text.
2026 snprintf(buf, sizeof(buf), "%s", m->name + 1);
2032 * Treat the "replace with" text as a literal string -
2033 * no quoting needed, no backreferences allowed.
2034 * ("Trivial" ['T'] flag).
2038 /* Enclose name in @@ */
2039 snprintf(buf, sizeof(buf), "@%s@", m->name);
2042 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2044 /* Make and run job. */
2045 job = pcrs_compile(buf, m->value, flags, &error);
2048 if (error == PCRS_ERR_NOMEM)
2051 *template_ptr = NULL;
2052 return JB_ERR_MEMORY;
2056 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2057 /* Hope it wasn't important and silently ignore the invalid job */
2062 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2065 if (NULL == tmp_out_buffer)
2067 *template_ptr = NULL;
2068 return JB_ERR_MEMORY;
2074 * Substitution failed, keep the original buffer,
2075 * log the problem and ignore it.
2077 * The user might see some unresolved @CGI_VARIABLES@,
2078 * but returning a special CGI error page seems unreasonable
2079 * and could mask more important error messages.
2081 free(tmp_out_buffer);
2082 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2083 buf, m->value, flags, pcrs_strerror(error));
2087 /* Substitution succeeded, use modified buffer. */
2089 file_buffer = tmp_out_buffer;
2097 *template_ptr = file_buffer;
2102 /*********************************************************************
2104 * Function : template_fill_for_cgi
2106 * Description : CGI support function that loads a HTML template
2107 * and fills it in. Handles file-not-found errors
2108 * by sending a HTML error message. For convenience,
2109 * this function also frees the passed "exports" map.
2112 * 1 : csp = Client state
2113 * 2 : templatename = name of the HTML template to be used
2114 * 3 : exports = map with fill in symbol -> name pairs.
2115 * Will be freed by this function.
2116 * 4 : rsp = Response structure to fill in.
2118 * Returns : JB_ERR_OK on success
2119 * JB_ERR_MEMORY on out-of-memory error
2121 *********************************************************************/
2122 jb_err template_fill_for_cgi(const struct client_state *csp,
2123 const char *templatename,
2124 struct map *exports,
2125 struct http_response *rsp)
2130 assert(templatename);
2134 err = template_load(csp, &rsp->body, templatename, 0);
2135 if (err == JB_ERR_FILE)
2137 err = cgi_error_no_template(csp, rsp, templatename);
2139 else if (err == JB_ERR_OK)
2141 err = template_fill(&rsp->body, exports);
2148 /*********************************************************************
2150 * Function : default_exports
2152 * Description : returns a struct map list that contains exports
2153 * which are common to all CGI functions.
2156 * 1 : csp = Current client state (buffers, headers, etc...)
2157 * 2 : caller = name of CGI who calls us and which should
2158 * be excluded from the generated menu. May be
2160 * Returns : NULL if no memory, else a new map. Caller frees.
2162 *********************************************************************/
2163 struct map *default_exports(const struct client_state *csp, const char *caller)
2167 struct map * exports;
2168 int local_help_exists = 0;
2169 char *ip_address = NULL;
2171 char *hostname = NULL;
2175 exports = new_map();
2177 if (csp->config->hostname)
2179 get_host_information(csp->cfd, &ip_address, &port, NULL);
2180 hostname = strdup(csp->config->hostname);
2184 get_host_information(csp->cfd, &ip_address, &port, &hostname);
2187 err = map(exports, "version", 1, html_encode(VERSION), 0);
2188 get_locale_time(buf, sizeof(buf));
2189 if (!err) err = map(exports, "time", 1, html_encode(buf), 0);
2190 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2192 if (!err) err = map(exports, "my-port", 1, html_encode(port ? port : "unknown"), 0);
2194 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2196 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2197 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2198 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2199 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2200 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2201 !strncmpic(csp->config->usermanual, "http", 4))
2203 /* Manual is located somewhere else, just link to it. */
2204 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2208 /* Manual is delivered by Privoxy. */
2209 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2211 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2212 #ifdef FEATURE_TOGGLE
2213 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2215 if (!err) err = map_block_killer(exports, "can-toggle");
2218 if (!strcmp(CODE_STATUS, "stable"))
2220 if (!err) err = map_block_killer(exports, "unstable");
2223 if (csp->config->admin_address != NULL)
2225 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2226 local_help_exists = 1;
2230 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2233 if (csp->config->proxy_info_url != NULL)
2235 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2236 local_help_exists = 1;
2240 if (!err) err = map_block_killer(exports, "have-proxy-info");
2243 if (local_help_exists == 0)
2245 if (!err) err = map_block_killer(exports, "have-help-info");
2258 /*********************************************************************
2260 * Function : map_block_killer
2262 * Description : Convenience function.
2263 * Adds a "killer" for the conditional HTML-template
2264 * block <name>, i.e. a substitution of the regex
2265 * "if-<name>-start.*if-<name>-end" to the given
2269 * 1 : exports = map to extend
2270 * 2 : name = name of conditional block
2272 * Returns : JB_ERR_OK on success
2273 * JB_ERR_MEMORY on out-of-memory error.
2275 *********************************************************************/
2276 jb_err map_block_killer(struct map *exports, const char *name)
2278 char buf[1000]; /* Will do, since the names are hardwired */
2282 assert(strlen(name) < (size_t)490);
2284 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2285 return map(exports, buf, 1, "", 1);
2289 /*********************************************************************
2291 * Function : map_block_keep
2293 * Description : Convenience function. Removes the markers used
2294 * by map-block-killer, to save a few bytes.
2295 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
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_keep(struct map *exports, const char *name)
2308 char buf[500]; /* Will do, since the names are hardwired */
2312 assert(strlen(name) < (size_t)490);
2314 snprintf(buf, sizeof(buf), "if-%s-start", name);
2315 err = map(exports, buf, 1, "", 1);
2322 snprintf(buf, sizeof(buf), "if-%s-end", name);
2323 return map(exports, buf, 1, "", 1);
2327 /*********************************************************************
2329 * Function : map_conditional
2331 * Description : Convenience function.
2332 * Adds an "if-then-else" for the conditional HTML-template
2333 * block <name>, i.e. a substitution of the form:
2340 * The control structure and one of the alternatives
2344 * 1 : exports = map to extend
2345 * 2 : name = name of conditional block
2346 * 3 : choose_first = nonzero for first, zero for second.
2348 * Returns : JB_ERR_OK on success
2349 * JB_ERR_MEMORY on out-of-memory error.
2351 *********************************************************************/
2352 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2354 char buf[1000]; /* Will do, since the names are hardwired */
2359 assert(strlen(name) < (size_t)480);
2361 snprintf(buf, sizeof(buf), (choose_first
2362 ? "else-not-%s@.*@endif-%s"
2363 : "if-%s-then@.*@else-not-%s"),
2366 err = map(exports, buf, 1, "", 1);
2372 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2373 return map(exports, buf, 1, "", 1);
2377 /*********************************************************************
2379 * Function : make_menu
2381 * Description : Returns an HTML-formatted menu of the available
2382 * unhidden CGIs, excluding the one given in <self>
2383 * and the toggle CGI if toggling is disabled.
2386 * 1 : self = name of CGI to leave out, can be NULL for
2388 * 2 : feature_flags = feature bitmap from csp->config
2391 * Returns : menu string, or NULL on out-of-memory error.
2393 *********************************************************************/
2394 char *make_menu(const char *self, const unsigned feature_flags)
2396 const struct cgi_dispatcher *d;
2397 char *result = strdup("");
2401 self = "NO-SUCH-CGI!";
2404 /* List available unhidden CGI's and export as "other-cgis" */
2405 for (d = cgi_dispatchers; d->name; d++)
2408 #ifdef FEATURE_TOGGLE
2409 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2412 * Suppress the toggle link if remote toggling is disabled.
2416 #endif /* def FEATURE_TOGGLE */
2418 if (d->description && strcmp(d->name, self))
2420 char *html_encoded_prefix;
2423 * Line breaks would be great, but break
2424 * the "blocked" template's JavaScript.
2426 string_append(&result, "<li><a href=\"");
2427 html_encoded_prefix = html_encode(CGI_PREFIX);
2428 if (html_encoded_prefix == NULL)
2434 string_append(&result, html_encoded_prefix);
2435 free(html_encoded_prefix);
2437 string_append(&result, d->name);
2438 string_append(&result, "\">");
2439 string_append(&result, d->description);
2440 string_append(&result, "</a></li>");
2448 /*********************************************************************
2450 * Function : dump_map
2452 * Description : HTML-dump a map for debugging (as table)
2455 * 1 : the_map = map to dump
2457 * Returns : string with HTML
2459 *********************************************************************/
2460 char *dump_map(const struct map *the_map)
2462 struct map_entry *cur_entry;
2463 char *ret = strdup("");
2465 string_append(&ret, "<table>\n");
2467 for (cur_entry = the_map->first;
2468 (cur_entry != NULL) && (ret != NULL);
2469 cur_entry = cur_entry->next)
2471 string_append(&ret, "<tr><td><b>");
2472 string_join (&ret, html_encode(cur_entry->name));
2473 string_append(&ret, "</b></td><td>");
2474 string_join (&ret, html_encode(cur_entry->value));
2475 string_append(&ret, "</td></tr>\n");
2478 string_append(&ret, "</table>\n");