1 const char cgi_rcs[] = "$Id: cgi.c,v 1.160 2014/10/18 11:31:52 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
6 * Purpose : Declares functions to intercept request, generate
7 * html or gif answers, and to compose HTTP resonses.
8 * This only contains the framework functions, the
9 * actual handler functions are declared elsewhere.
11 * Copyright : Written by and Copyright (C) 2001-2004, 2006-2008
12 * the SourceForge Privoxy team. http://www.privoxy.org/
14 * Based on the Internet Junkbuster originally written
15 * by and Copyright (C) 1997 Anonymous Coders and
16 * Junkbusters Corporation. http://www.junkbusters.com
18 * This program is free software; you can redistribute it
19 * and/or modify it under the terms of the GNU General
20 * Public License as published by the Free Software
21 * Foundation; either version 2 of the License, or (at
22 * your option) any later version.
24 * This program is distributed in the hope that it will
25 * be useful, but WITHOUT ANY WARRANTY; without even the
26 * implied warranty of MERCHANTABILITY or FITNESS FOR A
27 * PARTICULAR PURPOSE. See the GNU General Public
28 * License for more details.
30 * The GNU General Public License should be included with
31 * this file. If not, you can view it at
32 * http://www.gnu.org/copyleft/gpl.html
33 * or write to the Free Software Foundation, Inc., 59
34 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
36 **********************************************************************/
42 #include <sys/types.h>
49 #ifdef FEATURE_COMPRESSION
61 #include "cgisimple.h"
62 #include "jbsockets.h"
63 #if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE)
65 #endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */
67 /* loadcfg.h is for global_toggle_state only */
69 /* jcc.h is for mutex semaphore globals only */
72 const char cgi_h_rcs[] = CGI_H_VERSION;
75 * List of CGI functions: name, handler, description
76 * Note: Do NOT use single quotes in the description;
77 * this will break the dynamic "blocked" template!
79 static const struct cgi_dispatcher cgi_dispatchers[] = {
84 #ifdef FEATURE_GRACEFUL_TERMINATION
87 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
88 "this is a one click Denial Of Service attack!!!</em>",
93 #ifdef FEATURE_CGI_EDIT_ACTIONS
94 "View & change the current configuration",
96 "View the current configuration",
101 "View the source code version numbers",
105 "View the request headers",
109 "Look up which actions apply to a URL and why",
111 #ifdef FEATURE_TOGGLE
114 "Toggle Privoxy on or off",
116 #endif /* def FEATURE_TOGGLE */
117 #ifdef FEATURE_CGI_EDIT_ACTIONS
118 { "edit-actions", /* Edit the actions list */
121 { "eaa", /* Shortcut for edit-actions-add-url-form */
122 cgi_edit_actions_add_url_form,
124 { "eau", /* Shortcut for edit-actions-url-form */
125 cgi_edit_actions_url_form,
127 { "ear", /* Shortcut for edit-actions-remove-url-form */
128 cgi_edit_actions_remove_url_form,
130 { "eal", /* Shortcut for edit-actions-list */
131 cgi_edit_actions_list,
133 { "eafu", /* Shortcut for edit-actions-for-url */
134 cgi_edit_actions_for_url,
136 { "eas", /* Shortcut for edit-actions-submit */
137 cgi_edit_actions_submit,
139 { "easa", /* Shortcut for edit-actions-section-add */
140 cgi_edit_actions_section_add,
142 { "easr", /* Shortcut for edit-actions-section-remove */
143 cgi_edit_actions_section_remove,
145 { "eass", /* Shortcut for edit-actions-section-swap */
146 cgi_edit_actions_section_swap,
148 { "edit-actions-for-url",
149 cgi_edit_actions_for_url,
150 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
151 { "edit-actions-list",
152 cgi_edit_actions_list,
153 NULL, TRUE /* Edit the actions list */ },
154 { "edit-actions-submit",
155 cgi_edit_actions_submit,
156 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
157 { "edit-actions-url",
158 cgi_edit_actions_url,
159 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
160 { "edit-actions-url-form",
161 cgi_edit_actions_url_form,
162 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
163 { "edit-actions-add-url",
164 cgi_edit_actions_add_url,
165 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
166 { "edit-actions-add-url-form",
167 cgi_edit_actions_add_url_form,
168 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
169 { "edit-actions-remove-url",
170 cgi_edit_actions_remove_url,
171 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
172 { "edit-actions-remove-url-form",
173 cgi_edit_actions_remove_url_form,
174 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
175 { "edit-actions-section-add",
176 cgi_edit_actions_section_add,
177 NULL, FALSE /* Remove a section from the actionsfile */ },
178 { "edit-actions-section-remove",
179 cgi_edit_actions_section_remove,
180 NULL, FALSE /* Remove a section from the actionsfile */ },
181 { "edit-actions-section-swap",
182 cgi_edit_actions_section_swap,
183 NULL, FALSE /* Swap two sections in the actionsfile */ },
184 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
185 { "error-favicon.ico",
186 cgi_send_error_favicon,
187 NULL, TRUE /* Sends the favicon image for error pages. */ },
189 cgi_send_default_favicon,
190 NULL, TRUE /* Sends the default favicon image. */ },
193 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
196 NULL, TRUE /* Send a built-in image */ },
199 NULL, FALSE /* Send templates/cgi-style.css */ },
201 cgi_transparent_image,
202 NULL, TRUE /* Send a transparent image (short name) */ },
203 { "url-info-osd.xml",
204 cgi_send_url_info_osd,
205 NULL, TRUE /* Send templates/url-info-osd.xml */ },
207 cgi_send_user_manual,
208 NULL, TRUE /* Send user-manual */ },
209 { NULL, /* NULL Indicates end of list and default page */
211 NULL, TRUE /* Unknown CGI page */ }
216 * Built-in images for ad replacement
218 * Hint: You can encode your own images like this:
219 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
222 #ifdef FEATURE_NO_GIFS
225 * Checkerboard pattern, as a PNG.
227 const char image_pattern_data[] =
228 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
229 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
230 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
231 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
232 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
233 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
234 "\000\000\000\000\111\105\116\104\256\102\140\202";
237 * 1x1 transparant PNG.
239 const char image_blank_data[] =
240 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
241 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
242 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
243 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
244 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
245 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
246 "\000\000\000\000\111\105\116\104\256\102\140\202";
250 * Checkerboard pattern, as a GIF.
252 const char image_pattern_data[] =
253 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
254 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
255 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
256 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
260 * 1x1 transparant GIF.
262 const char image_blank_data[] =
263 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
264 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
265 "\000\001\000\000\002\002D\001\000;";
268 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
269 const size_t image_blank_length = sizeof(image_blank_data) - 1;
271 #ifdef FEATURE_COMPRESSION
273 * Minimum length which a buffer has to reach before
274 * we bother to (re-)compress it. Completely arbitrary.
276 const size_t LOWER_LENGTH_LIMIT_FOR_COMPRESSION = 1024U;
279 static struct http_response cgi_error_memory_response[1];
281 static struct http_response *dispatch_known_cgi(struct client_state * csp,
283 static struct map *parse_cgi_parameters(char *argstring);
286 /*********************************************************************
288 * Function : dispatch_cgi
290 * Description : Checks if a request URL has either the magical
291 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
292 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
293 * http://config.privoxy.org/). If so, it passes
294 * the (rest of the) path onto dispatch_known_cgi, which
295 * calls the relevant CGI handler function.
298 * 1 : csp = Current client state (buffers, headers, etc...)
300 * Returns : http_response if match, NULL if nonmatch or handler fail
302 *********************************************************************/
303 struct http_response *dispatch_cgi(struct client_state *csp)
305 const char *host = csp->http->host;
306 const char *path = csp->http->path;
309 * Should we intercept ?
312 /* Note: "example.com" and "example.com." are equivalent hostnames. */
314 /* Either the host matches CGI_SITE_1_HOST ..*/
315 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
316 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
319 /* ..then the path will all be for us. Remove leading '/' */
322 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
323 else if (( (0 == strcmpic(host, CGI_SITE_2_HOST))
324 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
325 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))))
327 /* take everything following CGI_SITE_2_PATH */
328 path += strlen(CGI_SITE_2_PATH);
331 /* skip the forward slash after CGI_SITE_2_PATH */
334 else if (*path != '\0')
337 * weirdness: URL is /configXXX, where XXX is some string
338 * Do *NOT* intercept.
349 if (strcmpic(csp->http->gpc, "GET")
350 && strcmpic(csp->http->gpc, "HEAD"))
352 log_error(LOG_LEVEL_ERROR,
353 "CGI request with unsupported method received: %s", csp->http->gpc);
355 * The CGI pages currently only support GET and HEAD requests.
357 * If the client used a different method, ditch any data following
358 * the current headers to reduce the likelihood of parse errors
359 * with the following request.
361 csp->client_iob->eod = csp->client_iob->cur;
365 * This is a CGI call.
368 return dispatch_known_cgi(csp, path);
372 /*********************************************************************
374 * Function : grep_cgi_referrer
376 * Description : Ugly provisorical fix that greps the value of the
377 * referer HTTP header field out of a linked list of
378 * strings like found at csp->headers. Will disappear
381 * FIXME: csp->headers ought to be csp->http->headers
382 * FIXME: Parsing all client header lines should
383 * happen right after the request is received!
386 * 1 : csp = Current client state (buffers, headers, etc...)
388 * Returns : pointer to value (no copy!), or NULL if none found.
390 *********************************************************************/
391 static char *grep_cgi_referrer(const struct client_state *csp)
393 struct list_entry *p;
395 for (p = csp->headers->first; p != NULL; p = p->next)
397 if (p->str == NULL) continue;
398 if (strncmpic(p->str, "Referer: ", 9) == 0)
400 return ((p->str) + 9);
408 /*********************************************************************
410 * Function : referrer_is_safe
412 * Description : Decides whether we trust the Referer for
413 * CGI pages which are only meant to be reachable
414 * through Privoxy's web interface directly.
417 * 1 : csp = Current client state (buffers, headers, etc...)
419 * Returns : TRUE if the referrer is safe, or
420 * FALSE if the referrer is unsafe or not set.
422 *********************************************************************/
423 static int referrer_is_safe(const struct client_state *csp)
426 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
428 referrer = grep_cgi_referrer(csp);
430 if (NULL == referrer)
432 /* No referrer, no access */
433 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
436 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
437 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
439 /* Trustworthy referrer */
440 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
441 csp->http->url, referrer);
447 /* Untrustworthy referrer */
448 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
449 csp->http->url, referrer);
456 /*********************************************************************
458 * Function : dispatch_known_cgi
460 * Description : Processes a CGI once dispatch_cgi has determined that
461 * it matches one of the magic prefixes. Parses the path
462 * as a cgi name plus query string, prepares a map that
463 * maps CGI parameter names to their values, initializes
464 * the http_response struct, and calls the relevant CGI
468 * 1 : csp = Current client state (buffers, headers, etc...)
469 * 2 : path = Path of CGI, with the CGI prefix removed.
470 * Should not have a leading "/".
472 * Returns : http_response, or NULL on handler failure or out of
475 *********************************************************************/
476 static struct http_response *dispatch_known_cgi(struct client_state * csp,
479 const struct cgi_dispatcher *d;
480 struct map *param_list;
481 struct http_response *rsp;
482 char *query_args_start;
486 if (NULL == (path_copy = strdup(path)))
488 return cgi_error_memory();
490 query_args_start = path_copy;
491 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
495 if (*query_args_start == '/')
497 *query_args_start++ = '\0';
498 param_list = new_map();
499 err = map(param_list, "file", 1, url_decode(query_args_start), 0);
500 if (JB_ERR_OK != err) {
503 return cgi_error_memory();
508 if (*query_args_start == '?')
510 *query_args_start++ = '\0';
512 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
515 return cgi_error_memory();
521 * path_copy = CGI call name
522 * param_list = CGI params, as map
525 /* Get mem for response or fail*/
526 if (NULL == (rsp = alloc_http_response()))
529 free_map(param_list);
530 return cgi_error_memory();
534 * Find and start the right CGI function
539 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
542 * If the called CGI is either harmless, or referred
543 * from a trusted source, start it.
545 if (d->harmless || referrer_is_safe(csp))
547 err = (d->handler)(csp, rsp, param_list);
552 * Else, modify toggle calls so that they only display
553 * the status, and deny all other calls.
555 if (0 == strcmp(path_copy, "toggle"))
557 unmap(param_list, "set");
558 err = (d->handler)(csp, rsp, param_list);
562 err = cgi_error_disabled(csp, rsp);
567 free_map(param_list);
569 if (err == JB_ERR_CGI_PARAMS)
571 err = cgi_error_bad_param(csp, rsp);
573 if (err && (err != JB_ERR_MEMORY))
575 /* Unexpected error! Shouldn't get here */
576 log_error(LOG_LEVEL_ERROR,
577 "Unexpected CGI error %d in top-level handler. "
578 "Please file a bug report!", err);
579 err = cgi_error_unknown(csp, rsp, err);
584 rsp->crunch_reason = CGI_CALL;
585 return finish_http_response(csp, rsp);
589 /* Error in handler, probably out-of-memory */
590 free_http_response(rsp);
591 return cgi_error_memory();
599 /*********************************************************************
601 * Function : parse_cgi_parameters
603 * Description : Parse a URL-encoded argument string into name/value
604 * pairs and store them in a struct map list.
607 * 1 : argstring = string to be parsed. Will be trashed.
609 * Returns : pointer to param list, or NULL if out of memory.
611 *********************************************************************/
612 static struct map *parse_cgi_parameters(char *argstring)
617 struct map *cgi_params;
620 * XXX: This estimate is guaranteed to be high enough as we
621 * let ssplit() ignore empty fields, but also a bit wasteful.
622 * The same hack is used in get_last_url() so it looks like
623 * a real solution is needed.
625 size_t max_segments = strlen(argstring) / 2;
626 if (max_segments == 0)
629 * XXX: If the argstring is empty, there's really
630 * no point in creating a param list, but currently
631 * other parts of Privoxy depend on the list's existence.
635 vector = malloc_or_die(max_segments * sizeof(char *));
637 cgi_params = new_map();
640 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
641 * the fragment identifier along with the request, so we must
642 * cut it off here, so it won't pollute the CGI params:
644 if (NULL != (p = strchr(argstring, '#')))
649 pairs = ssplit(argstring, "&", vector, max_segments);
654 free_map(cgi_params);
658 for (i = 0; i < pairs; i++)
660 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
663 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
666 free_map(cgi_params);
679 /*********************************************************************
681 * Function : get_char_param
683 * Description : Get a single-character parameter passed to a CGI
687 * 1 : parameters = map of cgi parameters
688 * 2 : param_name = The name of the parameter to read
690 * Returns : Uppercase character on success, '\0' on error.
692 *********************************************************************/
693 char get_char_param(const struct map *parameters,
694 const char *param_name)
701 ch = *(lookup(parameters, param_name));
702 if ((ch >= 'a') && (ch <= 'z'))
704 ch = (char)(ch - 'a' + 'A');
711 /*********************************************************************
713 * Function : get_string_param
715 * Description : Get a string paramater, to be used as an
716 * ACTION_STRING or ACTION_MULTI paramater.
717 * Validates the input to prevent stupid/malicious
718 * users from corrupting their action file.
721 * 1 : parameters = map of cgi parameters
722 * 2 : param_name = The name of the parameter to read
723 * 3 : pparam = destination for paramater. Allocated as
724 * part of the map "parameters", so don't free it.
725 * Set to NULL if not specified.
727 * Returns : JB_ERR_OK on success, or if the paramater
729 * JB_ERR_MEMORY on out-of-memory.
730 * JB_ERR_CGI_PARAMS if the paramater is not valid.
732 *********************************************************************/
733 jb_err get_string_param(const struct map *parameters,
734 const char *param_name,
747 param = lookup(parameters, param_name);
753 if (strlen(param) >= CGI_PARAM_LEN_MAX)
758 * Note that the length limit is arbitrary, it just seems
759 * sensible to limit it to *something*. There's no
760 * technical reason for any limit at all.
762 return JB_ERR_CGI_PARAMS;
765 /* Check every character to see if it's legal */
767 while ((ch = *s++) != '\0')
769 if (((unsigned char)ch < (unsigned char)' ')
772 /* Probable hack attempt, or user accidentally used '}'. */
773 return JB_ERR_CGI_PARAMS;
784 /*********************************************************************
786 * Function : get_number_param
788 * Description : Get a non-negative integer from the parameters
789 * passed to a CGI function.
792 * 1 : csp = Current client state (buffers, headers, etc...)
793 * 2 : parameters = map of cgi parameters
794 * 3 : name = Name of CGI parameter to read
795 * 4 : pvalue = destination for value.
796 * Set to -1 on error.
798 * Returns : JB_ERR_OK on success
799 * JB_ERR_MEMORY on out-of-memory
800 * JB_ERR_CGI_PARAMS if the parameter was not specified
803 *********************************************************************/
804 jb_err get_number_param(struct client_state *csp,
805 const struct map *parameters,
819 param = lookup(parameters, name);
822 return JB_ERR_CGI_PARAMS;
825 *pvalue = (unsigned int)strtol(param, &endptr, 0);
828 return JB_ERR_CGI_PARAMS;
836 /*********************************************************************
838 * Function : error_response
840 * Description : returns an http_response that explains the reason
841 * why a request failed.
844 * 1 : csp = Current client state (buffers, headers, etc...)
845 * 2 : templatename = Which template should be used for the answer
847 * Returns : A http_response. If we run out of memory, this
848 * will be cgi_error_memory().
850 *********************************************************************/
851 struct http_response *error_response(struct client_state *csp,
852 const char *templatename)
855 struct http_response *rsp;
856 struct map *exports = default_exports(csp, NULL);
861 return cgi_error_memory();
864 if (NULL == (rsp = alloc_http_response()))
867 return cgi_error_memory();
870 #ifdef FEATURE_FORCE_LOAD
871 if (csp->flags & CSP_FLAG_FORCED)
873 path = strdup(FORCE_PREFIX);
876 #endif /* def FEATURE_FORCE_LOAD */
880 err = string_append(&path, csp->http->path);
882 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
883 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
884 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
885 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
888 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
891 /* Some failures, like "404 no such domain", don't have an IP address. */
892 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
900 free_http_response(rsp);
901 return cgi_error_memory();
904 if (!strcmp(templatename, "no-such-domain"))
906 rsp->status = strdup("404 No such domain");
907 rsp->crunch_reason = NO_SUCH_DOMAIN;
909 else if (!strcmp(templatename, "forwarding-failed"))
911 const struct forward_spec *fwd = forward_url(csp, csp->http);
912 char *socks_type = NULL;
915 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
916 /* Never get here - LOG_LEVEL_FATAL causes program exit */
920 * XXX: While the template is called forwarding-failed,
921 * it currently only handles socks forwarding failures.
924 assert(fwd->type != SOCKS_NONE);
927 * Map failure reason, forwarding type and forwarder.
929 if (NULL == csp->error_message)
932 * Either we forgot to record the failure reason,
933 * or the memory allocation failed.
935 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
936 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
938 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
941 * XXX: this is almost the same code as in cgi_show_url_info()
942 * and thus should be factored out and shared.
947 socks_type = "socks4-";
950 socks_type = "socks4a-";
953 socks_type = "socks5-";
956 socks_type = "socks5t-";
959 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
962 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
963 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
964 if ((NULL == csp->error_message) || err)
967 free_http_response(rsp);
968 return cgi_error_memory();
971 rsp->status = strdup("503 Forwarding failure");
972 rsp->crunch_reason = FORWARDING_FAILED;
974 else if (!strcmp(templatename, "connect-failed"))
976 rsp->status = strdup("503 Connect failed");
977 rsp->crunch_reason = CONNECT_FAILED;
979 else if (!strcmp(templatename, "connection-timeout"))
981 rsp->status = strdup("504 Connection timeout");
982 rsp->crunch_reason = CONNECTION_TIMEOUT;
984 else if (!strcmp(templatename, "no-server-data"))
986 rsp->status = strdup("502 No data received from server or forwarder");
987 rsp->crunch_reason = NO_SERVER_DATA;
990 if (rsp->status == NULL)
993 free_http_response(rsp);
994 return cgi_error_memory();
997 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1000 free_http_response(rsp);
1001 return cgi_error_memory();
1004 return finish_http_response(csp, rsp);
1008 /*********************************************************************
1010 * Function : cgi_error_disabled
1012 * Description : CGI function that is called to generate an error
1013 * response if the actions editor or toggle CGI are
1014 * accessed despite having being disabled at compile-
1015 * or run-time, or if the user followed an untrusted link
1016 * to access a unsafe CGI feature that is only reachable
1017 * through Privoxy directly.
1020 * 1 : csp = Current client state (buffers, headers, etc...)
1021 * 2 : rsp = http_response data structure for output
1023 * CGI Parameters : none
1025 * Returns : JB_ERR_OK on success
1026 * JB_ERR_MEMORY on out-of-memory error.
1028 *********************************************************************/
1029 jb_err cgi_error_disabled(const struct client_state *csp,
1030 struct http_response *rsp)
1032 struct map *exports;
1037 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1039 return JB_ERR_MEMORY;
1041 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1043 /* Not important enough to do anything */
1044 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1047 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1051 /*********************************************************************
1053 * Function : cgi_init_error_messages
1055 * Description : Call at the start of the program to initialize
1056 * the error message used by cgi_error_memory().
1062 *********************************************************************/
1063 void cgi_init_error_messages(void)
1065 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1066 cgi_error_memory_response->head =
1067 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1068 "Content-Type: text/html\r\n"
1070 cgi_error_memory_response->body =
1073 " <title>500 Internal Privoxy Error</title>\n"
1074 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1077 "<h1>500 Internal Privoxy Error</h1>\n"
1078 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\n"
1079 "<p>Please contact your proxy administrator, or try again later</p>\n"
1083 cgi_error_memory_response->head_length =
1084 strlen(cgi_error_memory_response->head);
1085 cgi_error_memory_response->content_length =
1086 strlen(cgi_error_memory_response->body);
1087 cgi_error_memory_response->crunch_reason = OUT_OF_MEMORY;
1091 /*********************************************************************
1093 * Function : cgi_error_memory
1095 * Description : Called if a CGI function runs out of memory.
1096 * Returns a statically-allocated error response.
1100 * Returns : http_response data structure for output. This is
1101 * statically allocated, for obvious reasons.
1103 *********************************************************************/
1104 struct http_response *cgi_error_memory(void)
1106 /* assert that it's been initialized. */
1107 assert(cgi_error_memory_response->head);
1109 return cgi_error_memory_response;
1113 /*********************************************************************
1115 * Function : cgi_error_no_template
1117 * Description : Almost-CGI function that is called if a template
1118 * cannot be loaded. Note this is not a true CGI,
1119 * it takes a template name rather than a map of
1123 * 1 : csp = Current client state (buffers, headers, etc...)
1124 * 2 : rsp = http_response data structure for output
1125 * 3 : template_name = Name of template that could not
1128 * Returns : JB_ERR_OK on success
1129 * JB_ERR_MEMORY on out-of-memory error.
1131 *********************************************************************/
1132 jb_err cgi_error_no_template(const struct client_state *csp,
1133 struct http_response *rsp,
1134 const char *template_name)
1136 static const char status[] =
1137 "500 Internal Privoxy Error";
1138 static const char body_prefix[] =
1141 " <title>500 Internal Privoxy Error</title>\n"
1142 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1145 "<h1>500 Internal Privoxy Error</h1>\n"
1146 "<p>Privoxy encountered an error while processing your request:</p>\n"
1147 "<p><b>Could not load template file <code>";
1148 static const char body_suffix[] =
1149 "</code> or one of its included components.</b></p>\n"
1150 "<p>Please contact your proxy administrator.</p>\n"
1151 "<p>If you are the proxy administrator, please put the required file(s)"
1152 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1153 "location of the <code><i>(confdir)</i></code> directory "
1154 "is specified in the main Privoxy <code>config</code> "
1155 "file. (It's typically the Privoxy install directory"
1157 ", or <code>/etc/privoxy/</code>"
1158 #endif /* ndef _WIN32 */
1162 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1166 assert(template_name);
1168 /* Reset rsp, if needed */
1172 rsp->content_length = 0;
1173 rsp->head_length = 0;
1176 rsp->body = malloc_or_die(body_size);
1177 strlcpy(rsp->body, body_prefix, body_size);
1178 strlcat(rsp->body, template_name, body_size);
1179 strlcat(rsp->body, body_suffix, body_size);
1181 rsp->status = strdup(status);
1182 if (rsp->status == NULL)
1184 return JB_ERR_MEMORY;
1191 /*********************************************************************
1193 * Function : cgi_error_unknown
1195 * Description : Almost-CGI function that is called if an unexpected
1196 * error occurs in the top-level CGI dispatcher.
1197 * In this context, "unexpected" means "anything other
1198 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1199 * expected to handle all other errors internally,
1200 * since they can give more relavent error messages
1203 * Note this is not a true CGI, it takes an error
1204 * code rather than a map of parameters.
1207 * 1 : csp = Current client state (buffers, headers, etc...)
1208 * 2 : rsp = http_response data structure for output
1209 * 3 : error_to_report = Error code to report.
1211 * Returns : JB_ERR_OK on success
1212 * JB_ERR_MEMORY on out-of-memory error.
1214 *********************************************************************/
1215 jb_err cgi_error_unknown(const struct client_state *csp,
1216 struct http_response *rsp,
1217 jb_err error_to_report)
1219 static const char status[] =
1220 "500 Internal Privoxy Error";
1221 static const char body_prefix[] =
1224 " <title>500 Internal Privoxy Error</title>\n"
1225 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1228 "<h1>500 Internal Privoxy Error</h1>\n"
1229 "<p>Privoxy encountered an error while processing your request:</p>\n"
1230 "<p><b>Unexpected internal error: ";
1231 static const char body_suffix[] =
1234 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1235 "file a bug report</a>.</p>\n"
1238 /* Includes room for larger error numbers in the future. */
1239 const size_t body_size = sizeof(body_prefix) + sizeof(body_suffix) + 5;
1243 /* Reset rsp, if needed */
1247 rsp->content_length = 0;
1248 rsp->head_length = 0;
1250 rsp->crunch_reason = INTERNAL_ERROR;
1252 rsp->body = malloc_or_die(body_size);
1254 snprintf(rsp->body, body_size, "%s%d%s", body_prefix, error_to_report, body_suffix);
1256 rsp->status = strdup(status);
1257 if (rsp->status == NULL)
1259 return JB_ERR_MEMORY;
1266 /*********************************************************************
1268 * Function : cgi_error_bad_param
1270 * Description : CGI function that is called if the parameters
1271 * (query string) for a CGI were wrong.
1274 * 1 : csp = Current client state (buffers, headers, etc...)
1275 * 2 : rsp = http_response data structure for output
1277 * CGI Parameters : none
1279 * Returns : JB_ERR_OK on success
1280 * JB_ERR_MEMORY on out-of-memory error.
1282 *********************************************************************/
1283 jb_err cgi_error_bad_param(const struct client_state *csp,
1284 struct http_response *rsp)
1286 struct map *exports;
1291 if (NULL == (exports = default_exports(csp, NULL)))
1293 return JB_ERR_MEMORY;
1296 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1300 /*********************************************************************
1302 * Function : cgi_redirect
1304 * Description : CGI support function to generate a HTTP redirect
1308 * 1 : rsp = http_response data structure for output
1309 * 2 : target = string with the target URL
1311 * CGI Parameters : None
1313 * Returns : JB_ERR_OK on success
1314 * JB_ERR_MEMORY on out-of-memory error.
1316 *********************************************************************/
1317 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1324 err = enlist_unique_header(rsp->headers, "Location", target);
1326 rsp->status = strdup("302 Local Redirect from Privoxy");
1327 if (rsp->status == NULL)
1329 return JB_ERR_MEMORY;
1336 /*********************************************************************
1338 * Function : add_help_link
1340 * Description : Produce a copy of the string given as item,
1341 * embedded in an HTML link to its corresponding
1342 * section (item name in uppercase) in the actions
1343 * chapter of the user manual, (whose URL is given in
1344 * the config and defaults to our web site).
1346 * FIXME: I currently only work for actions, and would
1347 * like to be generalized for other topics.
1350 * 1 : item = item (will NOT be free()d.)
1351 * It is assumed to be HTML-safe.
1352 * 2 : config = The current configuration.
1354 * Returns : String with item embedded in link, or NULL on
1357 *********************************************************************/
1358 char *add_help_link(const char *item,
1359 struct configuration_spec *config)
1363 if (!item) return NULL;
1365 result = strdup("<a href=\"");
1366 if (!strncmpic(config->usermanual, "file://", 7) ||
1367 !strncmpic(config->usermanual, "http", 4))
1369 string_append(&result, config->usermanual);
1373 string_append(&result, "http://");
1374 string_append(&result, CGI_SITE_2_HOST);
1375 string_append(&result, "/user-manual/");
1377 string_append(&result, ACTIONS_HELP_PREFIX);
1378 string_join (&result, string_toupper(item));
1379 string_append(&result, "\">");
1380 string_append(&result, item);
1381 string_append(&result, "</a>");
1387 /*********************************************************************
1389 * Function : get_http_time
1391 * Description : Get the time in a format suitable for use in a
1392 * HTTP header - e.g.:
1393 * "Sun, 06 Nov 1994 08:49:37 GMT"
1396 * 1 : time_offset = Time returned will be current time
1397 * plus this number of seconds.
1398 * 2 : buf = Destination for result.
1399 * 3 : buffer_size = Size of the buffer above. Must be big
1400 * enough to hold 29 characters plus a
1405 *********************************************************************/
1406 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1409 time_t current_time;
1410 #if defined(HAVE_GMTIME_R)
1415 assert(buffer_size > (size_t)29);
1417 time(¤t_time);
1419 current_time += time_offset;
1421 /* get and save the gmt */
1423 t = gmtime_r(¤t_time, &dummy);
1424 #elif defined(MUTEX_LOCKS_AVAILABLE)
1425 privoxy_mutex_lock(&gmtime_mutex);
1426 t = gmtime(¤t_time);
1427 privoxy_mutex_unlock(&gmtime_mutex);
1429 t = gmtime(¤t_time);
1432 strftime(buf, buffer_size, "%a, %d %b %Y %H:%M:%S GMT", t);
1436 /*********************************************************************
1438 * Function : get_locale_time
1440 * Description : Get the time in a date(1)-like format
1441 * according to the current locale - e.g.:
1442 * "Fri Aug 29 19:37:12 CEST 2008"
1444 * XXX: Should we allow the user to change the format?
1447 * 1 : buf = Destination for result.
1448 * 2 : buffer_size = Size of the buffer above. Must be big
1449 * enough to hold 29 characters plus a
1454 *********************************************************************/
1455 static void get_locale_time(char *buf, size_t buffer_size)
1458 time_t current_time;
1459 #if defined(HAVE_LOCALTIME_R)
1464 assert(buffer_size > (size_t)29);
1466 time(¤t_time);
1468 #if HAVE_LOCALTIME_R
1469 timeptr = localtime_r(¤t_time, &dummy);
1470 #elif defined(MUTEX_LOCKS_AVAILABLE)
1471 privoxy_mutex_lock(&localtime_mutex);
1472 timeptr = localtime(¤t_time);
1473 privoxy_mutex_unlock(&localtime_mutex);
1475 timeptr = localtime(¤t_time);
1478 strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
1483 #ifdef FEATURE_COMPRESSION
1484 /*********************************************************************
1486 * Function : compress_buffer
1488 * Description : Compresses the content of a buffer with zlib's deflate
1489 * Allocates a new buffer for the result, free'ing it is
1493 * 1 : buffer = buffer whose content should be compressed
1494 * 2 : buffer_length = length of the buffer
1495 * 3 : compression_level = compression level for compress2()
1497 * Returns : NULL on error, otherwise a pointer to the compressed
1498 * content of the input buffer.
1500 *********************************************************************/
1501 char *compress_buffer(char *buffer, size_t *buffer_length, int compression_level)
1503 char *compressed_buffer;
1505 assert(-1 <= compression_level && compression_level <= 9);
1507 /* Let zlib figure out the maximum length of the compressed data */
1508 new_length = compressBound((uLongf)*buffer_length);
1510 compressed_buffer = malloc_or_die(new_length);
1512 if (Z_OK != compress2((Bytef *)compressed_buffer, &new_length,
1513 (Bytef *)buffer, *buffer_length, compression_level))
1515 log_error(LOG_LEVEL_ERROR,
1516 "compress2() failed. Buffer size: %d, compression level: %d.",
1517 new_length, compression_level);
1518 freez(compressed_buffer);
1522 log_error(LOG_LEVEL_RE_FILTER,
1523 "Compressed content from %d to %d bytes. Compression level: %d",
1524 *buffer_length, new_length, compression_level);
1526 *buffer_length = (size_t)new_length;
1528 return compressed_buffer;
1534 /*********************************************************************
1536 * Function : finish_http_response
1538 * Description : Fill in the missing headers in an http response,
1539 * and flatten the headers to an http head.
1540 * For HEAD requests the body is freed once
1541 * the Content-Length header is set.
1544 * 1 : rsp = pointer to http_response to be processed
1546 * Returns : A http_response, usually the rsp parameter.
1547 * On error, free()s rsp and returns cgi_error_memory()
1549 *********************************************************************/
1550 struct http_response *finish_http_response(struct client_state *csp, struct http_response *rsp)
1552 char buf[BUFFER_SIZE];
1555 /* Special case - do NOT change this statically allocated response,
1556 * which is ready for output anyway.
1558 if (rsp == cgi_error_memory_response)
1564 * Fill in the HTTP Status, using HTTP/1.1
1565 * unless the client asked for HTTP/1.0.
1567 snprintf(buf, sizeof(buf), "%s %s",
1568 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
1569 rsp->status ? rsp->status : "200 OK");
1570 err = enlist_first(rsp->headers, buf);
1573 * Set the Content-Length
1575 if (rsp->content_length == 0)
1577 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1580 #ifdef FEATURE_COMPRESSION
1581 if (!err && (csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
1582 && (rsp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
1584 char *compressed_content;
1586 compressed_content = compress_buffer(rsp->body, &rsp->content_length,
1587 csp->config->compression_level);
1588 if (NULL != compressed_content)
1591 rsp->body = compressed_content;
1592 err = enlist_unique_header(rsp->headers, "Content-Encoding", "deflate");
1599 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1601 * Signal serve() that the client will be able to figure out
1602 * the end of the response without having to close the connection.
1604 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1605 err = enlist(rsp->headers, buf);
1608 if (0 == strcmpic(csp->http->gpc, "head"))
1611 * The client only asked for the head. Dispose
1612 * the body and log an offensive message.
1614 * While it may seem to be a bit inefficient to
1615 * prepare the body if it isn't needed, it's the
1616 * only way to get the Content-Length right for
1617 * dynamic pages. We could have disposed the body
1618 * earlier, but not without duplicating the
1619 * Content-Length setting code above.
1621 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
1623 rsp->content_length = 0;
1626 if (strncmpic(rsp->status, "302", 3))
1629 * If it's not a redirect without any content,
1630 * set the Content-Type to text/html if it's
1631 * not already specified.
1633 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1637 * Fill in the rest of the default headers:
1639 * Date: set to current date/time.
1640 * Last-Modified: set to date/time the page was last changed.
1641 * Expires: set to date/time page next needs reloading.
1642 * Cache-Control: set to "no-cache" if applicable.
1644 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1649 * Set Expires to about 10 min into the future so it'll get reloaded
1650 * occasionally, e.g. if Privoxy gets upgraded.
1655 get_http_time(0, buf, sizeof(buf));
1656 err = enlist_unique_header(rsp->headers, "Date", buf);
1659 /* Some date in the past. */
1660 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1664 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
1665 err = enlist_unique_header(rsp->headers, "Expires", buf);
1668 else if (!strncmpic(rsp->status, "302", 3))
1670 get_http_time(0, buf, sizeof(buf));
1671 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1676 * Setting "Cache-Control" to "no-cache" and "Expires" to
1677 * the current time doesn't exactly forbid caching, it just
1678 * requires the client to revalidate the cached copy.
1680 * If a temporary problem occurs and the user tries again after
1681 * getting Privoxy's error message, a compliant browser may set the
1682 * If-Modified-Since header with the content of the error page's
1683 * Last-Modified header. More often than not, the document on the server
1684 * is older than Privoxy's error message, the server would send status code
1685 * 304 and the browser would display the outdated error message again and again.
1687 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
1688 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1689 * and can be safely used to "revalidate" without getting a status code 304.
1691 * There is no need to let the useless If-Modified-Since header reach the
1692 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1694 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1696 get_http_time(0, buf, sizeof(buf));
1697 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1698 if (!strncmpic(rsp->status, "403", 3)
1699 || !strncmpic(rsp->status, "404", 3)
1700 || !strncmpic(rsp->status, "502", 3)
1701 || !strncmpic(rsp->status, "503", 3)
1702 || !strncmpic(rsp->status, "504", 3))
1704 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1708 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1710 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1711 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1714 if (!err && (!(csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
1715 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)))
1717 err = enlist_unique_header(rsp->headers, "Connection", "close");
1723 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1725 free_http_response(rsp);
1726 return cgi_error_memory();
1728 rsp->head_length = strlen(rsp->head);
1735 /*********************************************************************
1737 * Function : alloc_http_response
1739 * Description : Allocates a new http_response structure.
1743 * Returns : pointer to a new http_response, or NULL.
1745 *********************************************************************/
1746 struct http_response *alloc_http_response(void)
1748 return (struct http_response *) zalloc(sizeof(struct http_response));
1753 /*********************************************************************
1755 * Function : free_http_response
1757 * Description : Free the memory occupied by an http_response
1758 * and its depandant structures.
1761 * 1 : rsp = pointer to http_response to be freed
1765 *********************************************************************/
1766 void free_http_response(struct http_response *rsp)
1769 * Must special case cgi_error_memory_response, which is never freed.
1771 if (rsp && (rsp != cgi_error_memory_response))
1776 destroy_list(rsp->headers);
1783 /*********************************************************************
1785 * Function : template_load
1787 * Description : CGI support function that loads a given HTML
1788 * template, ignoring comment lines and following
1789 * #include statements up to a depth of 1.
1792 * 1 : csp = Current client state (buffers, headers, etc...)
1793 * 2 : template_ptr = Destination for pointer to loaded
1795 * 3 : templatename = name of the HTML template to be used
1796 * 4 : recursive = Flag set if this function calls itself
1797 * following an #include statament
1799 * Returns : JB_ERR_OK on success
1800 * JB_ERR_MEMORY on out-of-memory error.
1801 * JB_ERR_FILE if the template file cannot be read
1803 *********************************************************************/
1804 jb_err template_load(const struct client_state *csp, char **template_ptr,
1805 const char *templatename, int recursive)
1808 char *templates_dir_path;
1811 char *included_module;
1814 char buf[BUFFER_SIZE];
1817 assert(template_ptr);
1818 assert(templatename);
1820 *template_ptr = NULL;
1822 /* Validate template name. Paranoia. */
1823 for (p = templatename; *p != 0; p++)
1825 if ( ((*p < 'a') || (*p > 'z'))
1826 && ((*p < 'A') || (*p > 'Z'))
1827 && ((*p < '0') || (*p > '9'))
1831 /* Illegal character */
1837 * Generate full path using either templdir
1838 * or confdir/templates as base directory.
1840 if (NULL != csp->config->templdir)
1842 templates_dir_path = strdup(csp->config->templdir);
1846 templates_dir_path = make_path(csp->config->confdir, "templates");
1849 if (templates_dir_path == NULL)
1851 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
1853 return JB_ERR_MEMORY;
1856 full_path = make_path(templates_dir_path, templatename);
1857 free(templates_dir_path);
1858 if (full_path == NULL)
1860 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
1862 return JB_ERR_MEMORY;
1865 /* Allocate buffer */
1867 file_buffer = strdup("");
1868 if (file_buffer == NULL)
1870 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
1872 return JB_ERR_MEMORY;
1875 /* Open template file */
1877 if (NULL == (fp = fopen(full_path, "r")))
1879 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1887 * Read the file, ignoring comments, and honoring #include
1888 * statements, unless we're already called recursively.
1890 * XXX: The comment handling could break with lines lengths > sizeof(buf).
1891 * This is unlikely in practise.
1893 while (fgets(buf, sizeof(buf), fp))
1895 if (!recursive && !strncmp(buf, "#include ", 9))
1897 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1904 if (string_join(&file_buffer, included_module))
1907 return JB_ERR_MEMORY;
1913 /* skip lines starting with '#' */
1919 if (string_append(&file_buffer, buf))
1922 return JB_ERR_MEMORY;
1927 *template_ptr = file_buffer;
1933 /*********************************************************************
1935 * Function : template_fill
1937 * Description : CGI support function that fills in a pre-loaded
1938 * HTML template by replacing @name@ with value using
1939 * pcrs, for each item in the output map.
1941 * Note that a leading '$' character in the export map's
1942 * values will be stripped and toggle on backreference
1946 * 1 : template_ptr = IN: Template to be filled out.
1948 * OUT: Filled out template.
1949 * Caller must free().
1950 * 2 : exports = map with fill in symbol -> name pairs
1952 * Returns : JB_ERR_OK on success (and for uncritical errors)
1953 * JB_ERR_MEMORY on out-of-memory error
1955 *********************************************************************/
1956 jb_err template_fill(char **template_ptr, const struct map *exports)
1958 struct map_entry *m;
1960 char buf[BUFFER_SIZE];
1961 char *tmp_out_buffer;
1967 assert(template_ptr);
1968 assert(*template_ptr);
1971 file_buffer = *template_ptr;
1972 size = strlen(file_buffer) + 1;
1975 * Assemble pcrs joblist from exports map
1977 for (m = exports->first; m != NULL; m = m->next)
1979 if (*m->name == '$')
1982 * First character of name is '$', so remove this flag
1983 * character and allow backreferences ($1 etc) in the
1984 * "replace with" text.
1986 snprintf(buf, sizeof(buf), "%s", m->name + 1);
1992 * Treat the "replace with" text as a literal string -
1993 * no quoting needed, no backreferences allowed.
1994 * ("Trivial" ['T'] flag).
1998 /* Enclose name in @@ */
1999 snprintf(buf, sizeof(buf), "@%s@", m->name);
2002 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2004 /* Make and run job. */
2005 job = pcrs_compile(buf, m->value, flags, &error);
2008 if (error == PCRS_ERR_NOMEM)
2011 *template_ptr = NULL;
2012 return JB_ERR_MEMORY;
2016 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2017 /* Hope it wasn't important and silently ignore the invalid job */
2022 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2025 if (NULL == tmp_out_buffer)
2027 *template_ptr = NULL;
2028 return JB_ERR_MEMORY;
2034 * Substitution failed, keep the original buffer,
2035 * log the problem and ignore it.
2037 * The user might see some unresolved @CGI_VARIABLES@,
2038 * but returning a special CGI error page seems unreasonable
2039 * and could mask more important error messages.
2041 free(tmp_out_buffer);
2042 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2043 buf, m->value, flags, pcrs_strerror(error));
2047 /* Substitution succeeded, use modified buffer. */
2049 file_buffer = tmp_out_buffer;
2057 *template_ptr = file_buffer;
2062 /*********************************************************************
2064 * Function : template_fill_for_cgi
2066 * Description : CGI support function that loads a HTML template
2067 * and fills it in. Handles file-not-found errors
2068 * by sending a HTML error message. For convenience,
2069 * this function also frees the passed "exports" map.
2072 * 1 : csp = Client state
2073 * 2 : templatename = name of the HTML template to be used
2074 * 3 : exports = map with fill in symbol -> name pairs.
2075 * Will be freed by this function.
2076 * 4 : rsp = Response structure to fill in.
2078 * Returns : JB_ERR_OK on success
2079 * JB_ERR_MEMORY on out-of-memory error
2081 *********************************************************************/
2082 jb_err template_fill_for_cgi(const struct client_state *csp,
2083 const char *templatename,
2084 struct map *exports,
2085 struct http_response *rsp)
2090 assert(templatename);
2094 err = template_load(csp, &rsp->body, templatename, 0);
2095 if (err == JB_ERR_FILE)
2098 return cgi_error_no_template(csp, rsp, templatename);
2103 return err; /* JB_ERR_MEMORY */
2105 err = template_fill(&rsp->body, exports);
2111 /*********************************************************************
2113 * Function : default_exports
2115 * Description : returns a struct map list that contains exports
2116 * which are common to all CGI functions.
2119 * 1 : csp = Current client state (buffers, headers, etc...)
2120 * 2 : caller = name of CGI who calls us and which should
2121 * be excluded from the generated menu. May be
2123 * Returns : NULL if no memory, else a new map. Caller frees.
2125 *********************************************************************/
2126 struct map *default_exports(const struct client_state *csp, const char *caller)
2130 struct map * exports;
2131 int local_help_exists = 0;
2132 char *ip_address = NULL;
2134 char *hostname = NULL;
2138 exports = new_map();
2140 if (csp->config->hostname)
2142 get_host_information(csp->cfd, &ip_address, &port, NULL);
2143 hostname = strdup(csp->config->hostname);
2147 get_host_information(csp->cfd, &ip_address, &port, &hostname);
2150 err = map(exports, "version", 1, html_encode(VERSION), 0);
2151 get_locale_time(buf, sizeof(buf));
2152 if (!err) err = map(exports, "time", 1, html_encode(buf), 0);
2153 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2155 if (!err) err = map(exports, "my-port", 1, html_encode(port ? port : "unknown"), 0);
2157 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2159 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2160 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2161 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2162 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2163 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2164 !strncmpic(csp->config->usermanual, "http", 4))
2166 /* Manual is located somewhere else, just link to it. */
2167 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2171 /* Manual is delivered by Privoxy. */
2172 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2174 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2175 #ifdef FEATURE_TOGGLE
2176 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2178 if (!err) err = map_block_killer(exports, "can-toggle");
2181 if (!strcmp(CODE_STATUS, "stable"))
2183 if (!err) err = map_block_killer(exports, "unstable");
2186 if (csp->config->admin_address != NULL)
2188 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2189 local_help_exists = 1;
2193 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2196 if (csp->config->proxy_info_url != NULL)
2198 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2199 local_help_exists = 1;
2203 if (!err) err = map_block_killer(exports, "have-proxy-info");
2206 if (local_help_exists == 0)
2208 if (!err) err = map_block_killer(exports, "have-help-info");
2221 /*********************************************************************
2223 * Function : map_block_killer
2225 * Description : Convenience function.
2226 * Adds a "killer" for the conditional HTML-template
2227 * block <name>, i.e. a substitution of the regex
2228 * "if-<name>-start.*if-<name>-end" to the given
2232 * 1 : exports = map to extend
2233 * 2 : name = name of conditional block
2235 * Returns : JB_ERR_OK on success
2236 * JB_ERR_MEMORY on out-of-memory error.
2238 *********************************************************************/
2239 jb_err map_block_killer(struct map *exports, const char *name)
2241 char buf[1000]; /* Will do, since the names are hardwired */
2245 assert(strlen(name) < (size_t)490);
2247 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2248 return map(exports, buf, 1, "", 1);
2252 /*********************************************************************
2254 * Function : map_block_keep
2256 * Description : Convenience function. Removes the markers used
2257 * by map-block-killer, to save a few bytes.
2258 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2261 * 1 : exports = map to extend
2262 * 2 : name = name of conditional block
2264 * Returns : JB_ERR_OK on success
2265 * JB_ERR_MEMORY on out-of-memory error.
2267 *********************************************************************/
2268 jb_err map_block_keep(struct map *exports, const char *name)
2271 char buf[500]; /* Will do, since the names are hardwired */
2275 assert(strlen(name) < (size_t)490);
2277 snprintf(buf, sizeof(buf), "if-%s-start", name);
2278 err = map(exports, buf, 1, "", 1);
2285 snprintf(buf, sizeof(buf), "if-%s-end", name);
2286 return map(exports, buf, 1, "", 1);
2290 /*********************************************************************
2292 * Function : map_conditional
2294 * Description : Convenience function.
2295 * Adds an "if-then-else" for the conditional HTML-template
2296 * block <name>, i.e. a substitution of the form:
2303 * The control structure and one of the alternatives
2307 * 1 : exports = map to extend
2308 * 2 : name = name of conditional block
2309 * 3 : choose_first = nonzero for first, zero for second.
2311 * Returns : JB_ERR_OK on success
2312 * JB_ERR_MEMORY on out-of-memory error.
2314 *********************************************************************/
2315 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2317 char buf[1000]; /* Will do, since the names are hardwired */
2322 assert(strlen(name) < (size_t)480);
2324 snprintf(buf, sizeof(buf), (choose_first
2325 ? "else-not-%s@.*@endif-%s"
2326 : "if-%s-then@.*@else-not-%s"),
2329 err = map(exports, buf, 1, "", 1);
2335 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2336 return map(exports, buf, 1, "", 1);
2340 /*********************************************************************
2342 * Function : make_menu
2344 * Description : Returns an HTML-formatted menu of the available
2345 * unhidden CGIs, excluding the one given in <self>
2346 * and the toggle CGI if toggling is disabled.
2349 * 1 : self = name of CGI to leave out, can be NULL for
2351 * 2 : feature_flags = feature bitmap from csp->config
2354 * Returns : menu string, or NULL on out-of-memory error.
2356 *********************************************************************/
2357 char *make_menu(const char *self, const unsigned feature_flags)
2359 const struct cgi_dispatcher *d;
2360 char *result = strdup("");
2364 self = "NO-SUCH-CGI!";
2367 /* List available unhidden CGI's and export as "other-cgis" */
2368 for (d = cgi_dispatchers; d->name; d++)
2371 #ifdef FEATURE_TOGGLE
2372 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2375 * Suppress the toggle link if remote toggling is disabled.
2379 #endif /* def FEATURE_TOGGLE */
2381 if (d->description && strcmp(d->name, self))
2383 char *html_encoded_prefix;
2386 * Line breaks would be great, but break
2387 * the "blocked" template's JavaScript.
2389 string_append(&result, "<li><a href=\"");
2390 html_encoded_prefix = html_encode(CGI_PREFIX);
2391 if (html_encoded_prefix == NULL)
2397 string_append(&result, html_encoded_prefix);
2398 free(html_encoded_prefix);
2400 string_append(&result, d->name);
2401 string_append(&result, "\">");
2402 string_append(&result, d->description);
2403 string_append(&result, "</a></li>");
2411 /*********************************************************************
2413 * Function : dump_map
2415 * Description : HTML-dump a map for debugging (as table)
2418 * 1 : the_map = map to dump
2420 * Returns : string with HTML
2422 *********************************************************************/
2423 char *dump_map(const struct map *the_map)
2425 struct map_entry *cur_entry;
2426 char *ret = strdup("");
2428 string_append(&ret, "<table>\n");
2430 for (cur_entry = the_map->first;
2431 (cur_entry != NULL) && (ret != NULL);
2432 cur_entry = cur_entry->next)
2434 string_append(&ret, "<tr><td><b>");
2435 string_join (&ret, html_encode(cur_entry->name));
2436 string_append(&ret, "</b></td><td>");
2437 string_join (&ret, html_encode(cur_entry->value));
2438 string_append(&ret, "</td></tr>\n");
2441 string_append(&ret, "</table>\n");