1 const char cgi_rcs[] = "$Id: cgi.c,v 1.137 2011/07/03 17:55:23 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 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001-2004, 2006-2008
15 * the SourceForge Privoxy team. http://www.privoxy.org/
17 * Based on the Internet Junkbuster originally written
18 * by and Copyright (C) 1997 Anonymous Coders and
19 * Junkbusters Corporation. http://www.junkbusters.com
21 * This program is free software; you can redistribute it
22 * and/or modify it under the terms of the GNU General
23 * Public License as published by the Free Software
24 * Foundation; either version 2 of the License, or (at
25 * your option) any later version.
27 * This program is distributed in the hope that it will
28 * be useful, but WITHOUT ANY WARRANTY; without even the
29 * implied warranty of MERCHANTABILITY or FITNESS FOR A
30 * PARTICULAR PURPOSE. See the GNU General Public
31 * License for more details.
33 * The GNU General Public License should be included with
34 * this file. If not, you can view it at
35 * http://www.gnu.org/copyleft/gpl.html
36 * or write to the Free Software Foundation, Inc., 59
37 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
39 **********************************************************************/
45 #include <sys/types.h>
52 #ifdef FEATURE_COMPRESSION
64 #include "cgisimple.h"
65 #include "jbsockets.h"
66 #if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE)
68 #endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */
70 /* loadcfg.h is for global_toggle_state only */
72 /* jcc.h is for mutex semaphore globals only */
75 const char cgi_h_rcs[] = CGI_H_VERSION;
78 * List of CGI functions: name, handler, description
79 * Note: Do NOT use single quotes in the description;
80 * this will break the dynamic "blocked" template!
82 static const struct cgi_dispatcher cgi_dispatchers[] = {
87 #ifdef FEATURE_GRACEFUL_TERMINATION
90 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
91 "this is a one click Denial Of Service attack!!!</em>",
96 #ifdef FEATURE_CGI_EDIT_ACTIONS
97 "View & change the current configuration",
99 "View the current configuration",
104 "View the source code version numbers",
108 "View the request headers",
112 "Look up which actions apply to a URL and why",
114 #ifdef FEATURE_TOGGLE
117 "Toggle Privoxy on or off",
119 #endif /* def FEATURE_TOGGLE */
120 #ifdef FEATURE_CGI_EDIT_ACTIONS
121 { "edit-actions", /* Edit the actions list */
124 { "eaa", /* Shortcut for edit-actions-add-url-form */
125 cgi_edit_actions_add_url_form,
127 { "eau", /* Shortcut for edit-actions-url-form */
128 cgi_edit_actions_url_form,
130 { "ear", /* Shortcut for edit-actions-remove-url-form */
131 cgi_edit_actions_remove_url_form,
133 { "eal", /* Shortcut for edit-actions-list */
134 cgi_edit_actions_list,
136 { "eafu", /* Shortcut for edit-actions-for-url */
137 cgi_edit_actions_for_url,
139 { "eas", /* Shortcut for edit-actions-submit */
140 cgi_edit_actions_submit,
142 { "easa", /* Shortcut for edit-actions-section-add */
143 cgi_edit_actions_section_add,
145 { "easr", /* Shortcut for edit-actions-section-remove */
146 cgi_edit_actions_section_remove,
148 { "eass", /* Shortcut for edit-actions-section-swap */
149 cgi_edit_actions_section_swap,
151 { "edit-actions-for-url",
152 cgi_edit_actions_for_url,
153 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
154 { "edit-actions-list",
155 cgi_edit_actions_list,
156 NULL, TRUE /* Edit the actions list */ },
157 { "edit-actions-submit",
158 cgi_edit_actions_submit,
159 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
160 { "edit-actions-url",
161 cgi_edit_actions_url,
162 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
163 { "edit-actions-url-form",
164 cgi_edit_actions_url_form,
165 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
166 { "edit-actions-add-url",
167 cgi_edit_actions_add_url,
168 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
169 { "edit-actions-add-url-form",
170 cgi_edit_actions_add_url_form,
171 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
172 { "edit-actions-remove-url",
173 cgi_edit_actions_remove_url,
174 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
175 { "edit-actions-remove-url-form",
176 cgi_edit_actions_remove_url_form,
177 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
178 { "edit-actions-section-add",
179 cgi_edit_actions_section_add,
180 NULL, FALSE /* Remove a section from the actionsfile */ },
181 { "edit-actions-section-remove",
182 cgi_edit_actions_section_remove,
183 NULL, FALSE /* Remove a section from the actionsfile */ },
184 { "edit-actions-section-swap",
185 cgi_edit_actions_section_swap,
186 NULL, FALSE /* Swap two sections in the actionsfile */ },
187 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
188 { "error-favicon.ico",
189 cgi_send_error_favicon,
190 NULL, TRUE /* Sends the favicon image for error pages. */ },
192 cgi_send_default_favicon,
193 NULL, TRUE /* Sends the default favicon image. */ },
196 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
199 NULL, TRUE /* Send a built-in image */ },
202 NULL, FALSE /* Send templates/cgi-style.css */ },
204 cgi_transparent_image,
205 NULL, TRUE /* Send a transparent image (short name) */ },
206 { "url-info-osd.xml",
207 cgi_send_url_info_osd,
208 NULL, TRUE /* Send templates/url-info-osd.xml */ },
210 cgi_send_user_manual,
211 NULL, TRUE /* Send user-manual */ },
212 { NULL, /* NULL Indicates end of list and default page */
214 NULL, TRUE /* Unknown CGI page */ }
219 * Built-in images for ad replacement
221 * Hint: You can encode your own images like this:
222 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
225 #ifdef FEATURE_NO_GIFS
228 * Checkerboard pattern, as a PNG.
230 const char image_pattern_data[] =
231 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
232 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
233 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
234 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
235 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
236 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
237 "\000\000\000\000\111\105\116\104\256\102\140\202";
240 * 1x1 transparant PNG.
242 const char image_blank_data[] =
243 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
244 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
245 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
246 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
247 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
248 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
249 "\000\000\000\000\111\105\116\104\256\102\140\202";
253 * Checkerboard pattern, as a GIF.
255 const char image_pattern_data[] =
256 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
257 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
258 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
259 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
263 * 1x1 transparant GIF.
265 const char image_blank_data[] =
266 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
267 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
268 "\000\001\000\000\002\002D\001\000;";
271 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
272 const size_t image_blank_length = sizeof(image_blank_data) - 1;
274 #ifdef FEATURE_COMPRESSION
276 * Minimum length which a buffer has to reach before
277 * we bother to (re-)compress it. Completely arbitrary.
279 const size_t LOWER_LENGTH_LIMIT_FOR_COMPRESSION = 1024U;
282 static struct http_response cgi_error_memory_response[1];
284 static struct http_response *dispatch_known_cgi(struct client_state * csp,
286 static struct map *parse_cgi_parameters(char *argstring);
289 /*********************************************************************
291 * Function : dispatch_cgi
293 * Description : Checks if a request URL has either the magical
294 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
295 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
296 * http://config.privoxy.org/). If so, it passes
297 * the (rest of the) path onto dispatch_known_cgi, which
298 * calls the relevant CGI handler function.
301 * 1 : csp = Current client state (buffers, headers, etc...)
303 * Returns : http_response if match, NULL if nonmatch or handler fail
305 *********************************************************************/
306 struct http_response *dispatch_cgi(struct client_state *csp)
308 const char *host = csp->http->host;
309 const char *path = csp->http->path;
312 * Should we intercept ?
315 /* Note: "example.com" and "example.com." are equivalent hostnames. */
317 /* Either the host matches CGI_SITE_1_HOST ..*/
318 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
319 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
320 && (path[0] == '/') )
322 /* ..then the path will all be for us. Remove leading '/' */
325 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
326 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
327 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
328 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
330 /* take everything following CGI_SITE_2_PATH */
331 path += strlen(CGI_SITE_2_PATH);
334 /* skip the forward slash after CGI_SITE_2_PATH */
337 else if (*path != '\0')
340 * weirdness: URL is /configXXX, where XXX is some string
341 * Do *NOT* intercept.
353 * This is a CGI call.
356 return dispatch_known_cgi(csp, path);
360 /*********************************************************************
362 * Function : grep_cgi_referrer
364 * Description : Ugly provisorical fix that greps the value of the
365 * referer HTTP header field out of a linked list of
366 * strings like found at csp->headers. Will disappear
369 * FIXME: csp->headers ought to be csp->http->headers
370 * FIXME: Parsing all client header lines should
371 * happen right after the request is received!
374 * 1 : csp = Current client state (buffers, headers, etc...)
376 * Returns : pointer to value (no copy!), or NULL if none found.
378 *********************************************************************/
379 static char *grep_cgi_referrer(const struct client_state *csp)
381 struct list_entry *p;
383 for (p = csp->headers->first; p != NULL; p = p->next)
385 if (p->str == NULL) continue;
386 if (strncmpic(p->str, "Referer: ", 9) == 0)
388 return ((p->str) + 9);
396 /*********************************************************************
398 * Function : referrer_is_safe
400 * Description : Decides whether we trust the Referer for
401 * CGI pages which are only meant to be reachable
402 * through Privoxy's web interface directly.
405 * 1 : csp = Current client state (buffers, headers, etc...)
407 * Returns : TRUE if the referrer is safe, or
408 * FALSE if the referrer is unsafe or not set.
410 *********************************************************************/
411 static int referrer_is_safe(const struct client_state *csp)
414 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
416 referrer = grep_cgi_referrer(csp);
418 if (NULL == referrer)
420 /* No referrer, no access */
421 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
424 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
425 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
427 /* Trustworthy referrer */
428 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
429 csp->http->url, referrer);
435 /* Untrustworthy referrer */
436 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
437 csp->http->url, referrer);
444 /*********************************************************************
446 * Function : dispatch_known_cgi
448 * Description : Processes a CGI once dispatch_cgi has determined that
449 * it matches one of the magic prefixes. Parses the path
450 * as a cgi name plus query string, prepares a map that
451 * maps CGI parameter names to their values, initializes
452 * the http_response struct, and calls the relevant CGI
456 * 1 : csp = Current client state (buffers, headers, etc...)
457 * 2 : path = Path of CGI, with the CGI prefix removed.
458 * Should not have a leading "/".
460 * Returns : http_response, or NULL on handler failure or out of
463 *********************************************************************/
464 static struct http_response *dispatch_known_cgi(struct client_state * csp,
467 const struct cgi_dispatcher *d;
468 struct map *param_list;
469 struct http_response *rsp;
470 char *query_args_start;
474 if (NULL == (path_copy = strdup(path)))
476 return cgi_error_memory();
478 query_args_start = path_copy;
479 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
483 if (*query_args_start == '/')
485 *query_args_start++ = '\0';
486 if ((param_list = new_map()))
488 map(param_list, "file", 1, url_decode(query_args_start), 0);
493 if (*query_args_start == '?')
495 *query_args_start++ = '\0';
497 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
500 return cgi_error_memory();
506 * path_copy = CGI call name
507 * param_list = CGI params, as map
510 /* Get mem for response or fail*/
511 if (NULL == (rsp = alloc_http_response()))
514 free_map(param_list);
515 return cgi_error_memory();
519 * Find and start the right CGI function
524 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
527 * If the called CGI is either harmless, or referred
528 * from a trusted source, start it.
530 if (d->harmless || referrer_is_safe(csp))
532 err = (d->handler)(csp, rsp, param_list);
537 * Else, modify toggle calls so that they only display
538 * the status, and deny all other calls.
540 if (0 == strcmp(path_copy, "toggle"))
542 unmap(param_list, "set");
543 err = (d->handler)(csp, rsp, param_list);
547 err = cgi_error_disabled(csp, rsp);
552 free_map(param_list);
554 if (err == JB_ERR_CGI_PARAMS)
556 err = cgi_error_bad_param(csp, rsp);
558 if (err && (err != JB_ERR_MEMORY))
560 /* Unexpected error! Shouldn't get here */
561 log_error(LOG_LEVEL_ERROR,
562 "Unexpected CGI error %d in top-level handler. "
563 "Please file a bug report!", err);
564 err = cgi_error_unknown(csp, rsp, err);
569 rsp->crunch_reason = CGI_CALL;
570 return finish_http_response(csp, rsp);
574 /* Error in handler, probably out-of-memory */
575 free_http_response(rsp);
576 return cgi_error_memory();
584 /*********************************************************************
586 * Function : parse_cgi_parameters
588 * Description : Parse a URL-encoded argument string into name/value
589 * pairs and store them in a struct map list.
592 * 1 : argstring = string to be parsed. Will be trashed.
594 * Returns : pointer to param list, or NULL if out of memory.
596 *********************************************************************/
597 static struct map *parse_cgi_parameters(char *argstring)
600 char *vector[BUFFER_SIZE];
602 struct map *cgi_params;
604 if (NULL == (cgi_params = new_map()))
610 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
611 * the fragment identifier along with the request, so we must
612 * cut it off here, so it won't pollute the CGI params:
614 if (NULL != (p = strchr(argstring, '#')))
619 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
621 for (i = 0; i < pairs; i++)
623 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
626 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
628 free_map(cgi_params);
639 /*********************************************************************
641 * Function : get_char_param
643 * Description : Get a single-character parameter passed to a CGI
647 * 1 : parameters = map of cgi parameters
648 * 2 : param_name = The name of the parameter to read
650 * Returns : Uppercase character on success, '\0' on error.
652 *********************************************************************/
653 char get_char_param(const struct map *parameters,
654 const char *param_name)
661 ch = *(lookup(parameters, param_name));
662 if ((ch >= 'a') && (ch <= 'z'))
664 ch = (char)(ch - 'a' + 'A');
671 /*********************************************************************
673 * Function : get_string_param
675 * Description : Get a string paramater, to be used as an
676 * ACTION_STRING or ACTION_MULTI paramater.
677 * Validates the input to prevent stupid/malicious
678 * users from corrupting their action file.
681 * 1 : parameters = map of cgi parameters
682 * 2 : param_name = The name of the parameter to read
683 * 3 : pparam = destination for paramater. Allocated as
684 * part of the map "parameters", so don't free it.
685 * Set to NULL if not specified.
687 * Returns : JB_ERR_OK on success, or if the paramater
689 * JB_ERR_MEMORY on out-of-memory.
690 * JB_ERR_CGI_PARAMS if the paramater is not valid.
692 *********************************************************************/
693 jb_err get_string_param(const struct map *parameters,
694 const char *param_name,
707 param = lookup(parameters, param_name);
713 if (strlen(param) >= CGI_PARAM_LEN_MAX)
718 * Note that the length limit is arbitrary, it just seems
719 * sensible to limit it to *something*. There's no
720 * technical reason for any limit at all.
722 return JB_ERR_CGI_PARAMS;
725 /* Check every character to see if it's legal */
727 while ((ch = *s++) != '\0')
729 if ( ((unsigned char)ch < (unsigned char)' ')
732 /* Probable hack attempt, or user accidentally used '}'. */
733 return JB_ERR_CGI_PARAMS;
744 /*********************************************************************
746 * Function : get_number_param
748 * Description : Get a non-negative integer from the parameters
749 * passed to a CGI function.
752 * 1 : csp = Current client state (buffers, headers, etc...)
753 * 2 : parameters = map of cgi parameters
754 * 3 : name = Name of CGI parameter to read
755 * 4 : pvalue = destination for value.
756 * Set to -1 on error.
758 * Returns : JB_ERR_OK on success
759 * JB_ERR_MEMORY on out-of-memory
760 * JB_ERR_CGI_PARAMS if the parameter was not specified
763 *********************************************************************/
764 jb_err get_number_param(struct client_state *csp,
765 const struct map *parameters,
780 param = lookup(parameters, name);
783 return JB_ERR_CGI_PARAMS;
786 /* We don't use atoi because I want to check this carefully... */
789 while ((ch = *param++) != '\0')
791 if ((ch < '0') || (ch > '9'))
793 return JB_ERR_CGI_PARAMS;
796 ch = (char)(ch - '0');
800 * <limits.h> defines UINT_MAX
802 * (UINT_MAX - ch) / 10 is the largest number that
803 * can be safely multiplied by 10 then have ch added.
805 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
807 return JB_ERR_CGI_PARAMS;
810 value = value * 10 + (unsigned)ch;
821 /*********************************************************************
823 * Function : error_response
825 * Description : returns an http_response that explains the reason
826 * why a request failed.
829 * 1 : csp = Current client state (buffers, headers, etc...)
830 * 2 : templatename = Which template should be used for the answer
832 * Returns : A http_response. If we run out of memory, this
833 * will be cgi_error_memory().
835 *********************************************************************/
836 struct http_response *error_response(struct client_state *csp,
837 const char *templatename)
840 struct http_response *rsp;
841 struct map *exports = default_exports(csp, NULL);
846 return cgi_error_memory();
849 if (NULL == (rsp = alloc_http_response()))
852 return cgi_error_memory();
855 #ifdef FEATURE_FORCE_LOAD
856 if (csp->flags & CSP_FLAG_FORCED)
858 path = strdup(FORCE_PREFIX);
861 #endif /* def FEATURE_FORCE_LOAD */
865 err = string_append(&path, csp->http->path);
867 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
868 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
869 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
870 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
873 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
876 /* Some failures, like "404 no such domain", don't have an IP address. */
877 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
885 free_http_response(rsp);
886 return cgi_error_memory();
889 if (!strcmp(templatename, "no-such-domain"))
891 rsp->status = strdup("404 No such domain");
892 rsp->crunch_reason = NO_SUCH_DOMAIN;
894 else if (!strcmp(templatename, "forwarding-failed"))
896 const struct forward_spec *fwd = forward_url(csp, csp->http);
897 char *socks_type = NULL;
900 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
901 /* Never get here - LOG_LEVEL_FATAL causes program exit */
905 * XXX: While the template is called forwarding-failed,
906 * it currently only handles socks forwarding failures.
909 assert(fwd->type != SOCKS_NONE);
912 * Map failure reason, forwarding type and forwarder.
914 if (NULL == csp->error_message)
917 * Either we forgot to record the failure reason,
918 * or the memory allocation failed.
920 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
921 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
923 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
926 * XXX: this is almost the same code as in cgi_show_url_info()
927 * and thus should be factored out and shared.
932 socks_type = "socks4-";
935 socks_type = "socks4a-";
938 socks_type = "socks5-";
941 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
944 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
945 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
946 if ((NULL == csp->error_message) || err)
949 free_http_response(rsp);
950 return cgi_error_memory();
953 rsp->status = strdup("503 Forwarding failure");
954 rsp->crunch_reason = FORWARDING_FAILED;
956 else if (!strcmp(templatename, "connect-failed"))
958 rsp->status = strdup("503 Connect failed");
959 rsp->crunch_reason = CONNECT_FAILED;
961 else if (!strcmp(templatename, "connection-timeout"))
963 rsp->status = strdup("504 Connection timeout");
964 rsp->crunch_reason = CONNECTION_TIMEOUT;
966 else if (!strcmp(templatename, "no-server-data"))
968 rsp->status = strdup("502 No data received from server or forwarder");
969 rsp->crunch_reason = NO_SERVER_DATA;
972 if (rsp->status == NULL)
975 free_http_response(rsp);
976 return cgi_error_memory();
979 err = template_fill_for_cgi(csp, templatename, exports, rsp);
982 free_http_response(rsp);
983 return cgi_error_memory();
986 return finish_http_response(csp, rsp);
990 /*********************************************************************
992 * Function : cgi_error_disabled
994 * Description : CGI function that is called to generate an error
995 * response if the actions editor or toggle CGI are
996 * accessed despite having being disabled at compile-
997 * or run-time, or if the user followed an untrusted link
998 * to access a unsafe CGI feature that is only reachable
999 * through Privoxy directly.
1002 * 1 : csp = Current client state (buffers, headers, etc...)
1003 * 2 : rsp = http_response data structure for output
1005 * CGI Parameters : none
1007 * Returns : JB_ERR_OK on success
1008 * JB_ERR_MEMORY on out-of-memory error.
1010 *********************************************************************/
1011 jb_err cgi_error_disabled(const struct client_state *csp,
1012 struct http_response *rsp)
1014 struct map *exports;
1019 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1021 return JB_ERR_MEMORY;
1023 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1025 /* Not important enough to do anything */
1026 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1029 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1033 /*********************************************************************
1035 * Function : cgi_init_error_messages
1037 * Description : Call at the start of the program to initialize
1038 * the error message used by cgi_error_memory().
1044 *********************************************************************/
1045 void cgi_init_error_messages(void)
1047 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1048 cgi_error_memory_response->head =
1049 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1050 "Content-Type: text/html\r\n"
1052 cgi_error_memory_response->body =
1055 " <title>500 Internal Privoxy Error</title>\n"
1056 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1059 "<h1>500 Internal Privoxy Error</h1>\n"
1060 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\n"
1061 "<p>Please contact your proxy administrator, or try again later</p>\n"
1065 cgi_error_memory_response->head_length =
1066 strlen(cgi_error_memory_response->head);
1067 cgi_error_memory_response->content_length =
1068 strlen(cgi_error_memory_response->body);
1069 cgi_error_memory_response->crunch_reason = OUT_OF_MEMORY;
1073 /*********************************************************************
1075 * Function : cgi_error_memory
1077 * Description : Called if a CGI function runs out of memory.
1078 * Returns a statically-allocated error response.
1082 * Returns : http_response data structure for output. This is
1083 * statically allocated, for obvious reasons.
1085 *********************************************************************/
1086 struct http_response *cgi_error_memory(void)
1088 /* assert that it's been initialized. */
1089 assert(cgi_error_memory_response->head);
1091 return cgi_error_memory_response;
1095 /*********************************************************************
1097 * Function : cgi_error_no_template
1099 * Description : Almost-CGI function that is called if a template
1100 * cannot be loaded. Note this is not a true CGI,
1101 * it takes a template name rather than a map of
1105 * 1 : csp = Current client state (buffers, headers, etc...)
1106 * 2 : rsp = http_response data structure for output
1107 * 3 : template_name = Name of template that could not
1110 * Returns : JB_ERR_OK on success
1111 * JB_ERR_MEMORY on out-of-memory error.
1113 *********************************************************************/
1114 jb_err cgi_error_no_template(const struct client_state *csp,
1115 struct http_response *rsp,
1116 const char *template_name)
1118 static const char status[] =
1119 "500 Internal Privoxy Error";
1120 static const char body_prefix[] =
1123 " <title>500 Internal Privoxy Error</title>\n"
1124 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1127 "<h1>500 Internal Privoxy Error</h1>\n"
1128 "<p>Privoxy encountered an error while processing your request:</p>\n"
1129 "<p><b>Could not load template file <code>";
1130 static const char body_suffix[] =
1131 "</code> or one of its included components.</b></p>\n"
1132 "<p>Please contact your proxy administrator.</p>\n"
1133 "<p>If you are the proxy administrator, please put the required file(s)"
1134 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1135 "location of the <code><i>(confdir)</i></code> directory "
1136 "is specified in the main Privoxy <code>config</code> "
1137 "file. (It's typically the Privoxy install directory"
1139 ", or <code>/etc/privoxy/</code>"
1140 #endif /* ndef _WIN32 */
1144 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1148 assert(template_name);
1150 /* Reset rsp, if needed */
1154 rsp->content_length = 0;
1155 rsp->head_length = 0;
1158 rsp->body = malloc(body_size);
1159 if (rsp->body == NULL)
1161 return JB_ERR_MEMORY;
1163 strlcpy(rsp->body, body_prefix, body_size);
1164 strlcat(rsp->body, template_name, body_size);
1165 strlcat(rsp->body, body_suffix, body_size);
1167 rsp->status = strdup(status);
1168 if (rsp->status == NULL)
1170 return JB_ERR_MEMORY;
1177 /*********************************************************************
1179 * Function : cgi_error_unknown
1181 * Description : Almost-CGI function that is called if an unexpected
1182 * error occurs in the top-level CGI dispatcher.
1183 * In this context, "unexpected" means "anything other
1184 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1185 * expected to handle all other errors internally,
1186 * since they can give more relavent error messages
1189 * Note this is not a true CGI, it takes an error
1190 * code rather than a map of parameters.
1193 * 1 : csp = Current client state (buffers, headers, etc...)
1194 * 2 : rsp = http_response data structure for output
1195 * 3 : error_to_report = Error code to report.
1197 * Returns : JB_ERR_OK on success
1198 * JB_ERR_MEMORY on out-of-memory error.
1200 *********************************************************************/
1201 jb_err cgi_error_unknown(const struct client_state *csp,
1202 struct http_response *rsp,
1203 jb_err error_to_report)
1205 static const char status[] =
1206 "500 Internal Privoxy Error";
1207 static const char body_prefix[] =
1210 " <title>500 Internal Privoxy Error</title>\n"
1211 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1214 "<h1>500 Internal Privoxy Error</h1>\n"
1215 "<p>Privoxy encountered an error while processing your request:</p>\n"
1216 "<p><b>Unexpected internal error: ";
1217 static const char body_suffix[] =
1220 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1221 "file a bug report</a>.</p>\n"
1224 /* Includes room for larger error numbers in the future. */
1225 const size_t body_size = sizeof(body_prefix) + sizeof(body_suffix) + 5;
1229 /* Reset rsp, if needed */
1233 rsp->content_length = 0;
1234 rsp->head_length = 0;
1236 rsp->crunch_reason = INTERNAL_ERROR;
1238 rsp->body = malloc(body_size);
1239 if (rsp->body == NULL)
1241 return JB_ERR_MEMORY;
1244 snprintf(rsp->body, body_size, "%s%d%s", body_prefix, error_to_report, body_suffix);
1246 rsp->status = strdup(status);
1247 if (rsp->status == NULL)
1249 return JB_ERR_MEMORY;
1256 /*********************************************************************
1258 * Function : cgi_error_bad_param
1260 * Description : CGI function that is called if the parameters
1261 * (query string) for a CGI were wrong.
1264 * 1 : csp = Current client state (buffers, headers, etc...)
1265 * 2 : rsp = http_response data structure for output
1267 * CGI Parameters : none
1269 * Returns : JB_ERR_OK on success
1270 * JB_ERR_MEMORY on out-of-memory error.
1272 *********************************************************************/
1273 jb_err cgi_error_bad_param(const struct client_state *csp,
1274 struct http_response *rsp)
1276 struct map *exports;
1281 if (NULL == (exports = default_exports(csp, NULL)))
1283 return JB_ERR_MEMORY;
1286 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1290 /*********************************************************************
1292 * Function : cgi_redirect
1294 * Description : CGI support function to generate a HTTP redirect
1298 * 1 : rsp = http_response data structure for output
1299 * 2 : target = string with the target URL
1301 * CGI Parameters : None
1303 * Returns : JB_ERR_OK on success
1304 * JB_ERR_MEMORY on out-of-memory error.
1306 *********************************************************************/
1307 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1314 err = enlist_unique_header(rsp->headers, "Location", target);
1316 rsp->status = strdup("302 Local Redirect from Privoxy");
1317 if (rsp->status == NULL)
1319 return JB_ERR_MEMORY;
1326 /*********************************************************************
1328 * Function : add_help_link
1330 * Description : Produce a copy of the string given as item,
1331 * embedded in an HTML link to its corresponding
1332 * section (item name in uppercase) in the actions
1333 * chapter of the user manual, (whose URL is given in
1334 * the config and defaults to our web site).
1336 * FIXME: I currently only work for actions, and would
1337 * like to be generalized for other topics.
1340 * 1 : item = item (will NOT be free()d.)
1341 * It is assumed to be HTML-safe.
1342 * 2 : config = The current configuration.
1344 * Returns : String with item embedded in link, or NULL on
1347 *********************************************************************/
1348 char *add_help_link(const char *item,
1349 struct configuration_spec *config)
1353 if (!item) return NULL;
1355 result = strdup("<a href=\"");
1356 if (!strncmpic(config->usermanual, "file://", 7) ||
1357 !strncmpic(config->usermanual, "http", 4))
1359 string_append(&result, config->usermanual);
1363 string_append(&result, "http://");
1364 string_append(&result, CGI_SITE_2_HOST);
1365 string_append(&result, "/user-manual/");
1367 string_append(&result, ACTIONS_HELP_PREFIX);
1368 string_join (&result, string_toupper(item));
1369 string_append(&result, "\">");
1370 string_append(&result, item);
1371 string_append(&result, "</a>");
1377 /*********************************************************************
1379 * Function : get_http_time
1381 * Description : Get the time in a format suitable for use in a
1382 * HTTP header - e.g.:
1383 * "Sun, 06 Nov 1994 08:49:37 GMT"
1386 * 1 : time_offset = Time returned will be current time
1387 * plus this number of seconds.
1388 * 2 : buf = Destination for result.
1389 * 3 : buffer_size = Size of the buffer above. Must be big
1390 * enough to hold 29 characters plus a
1395 *********************************************************************/
1396 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1398 static const char day_names[7][4] =
1399 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1400 static const char month_names[12][4] =
1401 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1402 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1405 time_t current_time;
1406 #if defined(HAVE_GMTIME_R)
1411 assert(buffer_size > (size_t)29);
1413 time(¤t_time);
1415 current_time += time_offset;
1417 /* get and save the gmt */
1419 t = gmtime_r(¤t_time, &dummy);
1420 #elif defined(MUTEX_LOCKS_AVAILABLE)
1421 privoxy_mutex_lock(&gmtime_mutex);
1422 t = gmtime(¤t_time);
1423 privoxy_mutex_unlock(&gmtime_mutex);
1425 t = gmtime(¤t_time);
1428 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1429 snprintf(buf, buffer_size,
1430 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1431 day_names[t->tm_wday],
1433 month_names[t->tm_mon],
1442 /*********************************************************************
1444 * Function : get_locale_time
1446 * Description : Get the time in a date(1)-like format
1447 * according to the current locale - e.g.:
1448 * "Fri Aug 29 19:37:12 CEST 2008"
1450 * XXX: Should we allow the user to change the format?
1453 * 1 : buf = Destination for result.
1454 * 2 : buffer_size = Size of the buffer above. Must be big
1455 * enough to hold 29 characters plus a
1460 *********************************************************************/
1461 static void get_locale_time(char *buf, size_t buffer_size)
1464 time_t current_time;
1465 #if defined(HAVE_LOCALTIME_R)
1470 assert(buffer_size > (size_t)29);
1472 time(¤t_time);
1474 #if HAVE_LOCALTIME_R
1475 timeptr = localtime_r(¤t_time, &dummy);
1476 #elif defined(MUTEX_LOCKS_AVAILABLE)
1477 privoxy_mutex_lock(&localtime_mutex);
1478 timeptr = localtime(¤t_time);
1479 privoxy_mutex_unlock(&localtime_mutex);
1481 timeptr = localtime(¤t_time);
1484 strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
1489 #ifdef FEATURE_COMPRESSION
1490 /*********************************************************************
1492 * Function : compress_buffer
1494 * Description : Compresses the content of a buffer with zlib's deflate
1495 * Allocates a new buffer for the result, free'ing it is
1499 * 1 : buffer = buffer whose content should be compressed
1500 * 2 : buffer_length = length of the buffer
1501 * 3 : compression_level = compression level for compress2()
1503 * Returns : NULL on error, otherwise a pointer to the compressed
1504 * content of the input buffer.
1506 *********************************************************************/
1507 char *compress_buffer(char *buffer, size_t *buffer_length, int compression_level)
1509 char *compressed_buffer;
1510 size_t new_length = *buffer_length;
1511 assert(-1 <= compression_level && compression_level <= 9);
1513 compressed_buffer = malloc(new_length);
1514 if (NULL == compressed_buffer)
1516 log_error(LOG_LEVEL_FATAL,
1517 "Out of memory allocation compression buffer.");
1520 if (Z_OK != compress2((Bytef *)compressed_buffer, &new_length,
1521 (Bytef *)buffer, *buffer_length, compression_level))
1523 log_error(LOG_LEVEL_ERROR, "Error in compress2()");
1524 freez(compressed_buffer);
1528 log_error(LOG_LEVEL_RE_FILTER,
1529 "Compressed content from %d to %d bytes. Compression level: %d",
1530 *buffer_length, new_length, compression_level);
1532 *buffer_length = new_length;
1534 return compressed_buffer;
1540 /*********************************************************************
1542 * Function : finish_http_response
1544 * Description : Fill in the missing headers in an http response,
1545 * and flatten the headers to an http head.
1546 * For HEAD requests the body is freed once
1547 * the Content-Length header is set.
1550 * 1 : rsp = pointer to http_response to be processed
1552 * Returns : A http_response, usually the rsp parameter.
1553 * On error, free()s rsp and returns cgi_error_memory()
1555 *********************************************************************/
1556 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
1558 char buf[BUFFER_SIZE];
1561 /* Special case - do NOT change this statically allocated response,
1562 * which is ready for output anyway.
1564 if (rsp == cgi_error_memory_response)
1570 * Fill in the HTTP Status, using HTTP/1.1
1571 * unless the client asked for HTTP/1.0.
1573 snprintf(buf, sizeof(buf), "%s %s",
1574 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
1575 rsp->status ? rsp->status : "200 OK");
1576 err = enlist_first(rsp->headers, buf);
1579 * Set the Content-Length
1581 if (rsp->content_length == 0)
1583 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1586 #ifdef FEATURE_COMPRESSION
1587 if (!err && (csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
1588 && (rsp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
1590 char *compressed_content;
1592 compressed_content = compress_buffer(rsp->body, &rsp->content_length,
1593 csp->config->compression_level);
1594 if (NULL != compressed_content)
1597 rsp->body = compressed_content;
1598 err = enlist_unique_header(rsp->headers, "Content-Encoding", "deflate");
1605 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1606 err = enlist(rsp->headers, buf);
1609 if (0 == strcmpic(csp->http->gpc, "head"))
1612 * The client only asked for the head. Dispose
1613 * the body and log an offensive message.
1615 * While it may seem to be a bit inefficient to
1616 * prepare the body if it isn't needed, it's the
1617 * only way to get the Content-Length right for
1618 * dynamic pages. We could have disposed the body
1619 * earlier, but not without duplicating the
1620 * Content-Length setting code above.
1622 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
1624 rsp->content_length = 0;
1627 if (strncmpic(rsp->status, "302", 3))
1630 * If it's not a redirect without any content,
1631 * set the Content-Type to text/html if it's
1632 * not already specified.
1634 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1638 * Fill in the rest of the default headers:
1640 * Date: set to current date/time.
1641 * Last-Modified: set to date/time the page was last changed.
1642 * Expires: set to date/time page next needs reloading.
1643 * Cache-Control: set to "no-cache" if applicable.
1645 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1650 * Set Expires to about 10 min into the future so it'll get reloaded
1651 * occasionally, e.g. if Privoxy gets upgraded.
1656 get_http_time(0, buf, sizeof(buf));
1657 err = enlist_unique_header(rsp->headers, "Date", buf);
1660 /* Some date in the past. */
1661 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1665 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
1666 err = enlist_unique_header(rsp->headers, "Expires", buf);
1669 else if (!strncmpic(rsp->status, "302", 3))
1671 get_http_time(0, buf, sizeof(buf));
1672 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1677 * Setting "Cache-Control" to "no-cache" and "Expires" to
1678 * the current time doesn't exactly forbid caching, it just
1679 * requires the client to revalidate the cached copy.
1681 * If a temporary problem occurs and the user tries again after
1682 * getting Privoxy's error message, a compliant browser may set the
1683 * If-Modified-Since header with the content of the error page's
1684 * Last-Modified header. More often than not, the document on the server
1685 * is older than Privoxy's error message, the server would send status code
1686 * 304 and the browser would display the outdated error message again and again.
1688 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
1689 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1690 * and can be safely used to "revalidate" without getting a status code 304.
1692 * There is no need to let the useless If-Modified-Since header reach the
1693 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1695 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1697 get_http_time(0, buf, sizeof(buf));
1698 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1699 if (!strncmpic(rsp->status, "403", 3)
1700 || !strncmpic(rsp->status, "404", 3)
1701 || !strncmpic(rsp->status, "502", 3)
1702 || !strncmpic(rsp->status, "503", 3)
1703 || !strncmpic(rsp->status, "504", 3))
1705 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1709 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1711 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1712 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1715 if (!err && !(csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
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;
2133 char *hostname = NULL;
2137 exports = new_map();
2138 if (exports == NULL)
2143 if (csp->config->hostname)
2145 get_host_information(csp->cfd, &ip_address, NULL);
2146 hostname = strdup(csp->config->hostname);
2150 get_host_information(csp->cfd, &ip_address, &hostname);
2153 err = map(exports, "version", 1, html_encode(VERSION), 0);
2154 get_locale_time(buf, sizeof(buf));
2155 if (!err) err = map(exports, "time", 1, html_encode(buf), 0);
2156 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2158 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2160 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2161 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2162 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2163 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2164 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2165 !strncmpic(csp->config->usermanual, "http", 4))
2167 /* Manual is located somewhere else, just link to it. */
2168 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2172 /* Manual is delivered by Privoxy. */
2173 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2175 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2176 #ifdef FEATURE_TOGGLE
2177 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2179 if (!err) err = map_block_killer(exports, "can-toggle");
2182 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2183 if (!err) err = map(exports, "my-port", 1, buf, 1);
2185 if(!strcmp(CODE_STATUS, "stable"))
2187 if (!err) err = map_block_killer(exports, "unstable");
2190 if (csp->config->admin_address != NULL)
2192 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2193 local_help_exists = 1;
2197 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2200 if (csp->config->proxy_info_url != NULL)
2202 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2203 local_help_exists = 1;
2207 if (!err) err = map_block_killer(exports, "have-proxy-info");
2210 if (local_help_exists == 0)
2212 if (!err) err = map_block_killer(exports, "have-help-info");
2225 /*********************************************************************
2227 * Function : map_block_killer
2229 * Description : Convenience function.
2230 * Adds a "killer" for the conditional HTML-template
2231 * block <name>, i.e. a substitution of the regex
2232 * "if-<name>-start.*if-<name>-end" to the given
2236 * 1 : exports = map to extend
2237 * 2 : name = name of conditional block
2239 * Returns : JB_ERR_OK on success
2240 * JB_ERR_MEMORY on out-of-memory error.
2242 *********************************************************************/
2243 jb_err map_block_killer(struct map *exports, const char *name)
2245 char buf[1000]; /* Will do, since the names are hardwired */
2249 assert(strlen(name) < (size_t)490);
2251 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2252 return map(exports, buf, 1, "", 1);
2256 /*********************************************************************
2258 * Function : map_block_keep
2260 * Description : Convenience function. Removes the markers used
2261 * by map-block-killer, to save a few bytes.
2262 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2265 * 1 : exports = map to extend
2266 * 2 : name = name of conditional block
2268 * Returns : JB_ERR_OK on success
2269 * JB_ERR_MEMORY on out-of-memory error.
2271 *********************************************************************/
2272 jb_err map_block_keep(struct map *exports, const char *name)
2275 char buf[500]; /* Will do, since the names are hardwired */
2279 assert(strlen(name) < (size_t)490);
2281 snprintf(buf, sizeof(buf), "if-%s-start", name);
2282 err = map(exports, buf, 1, "", 1);
2289 snprintf(buf, sizeof(buf), "if-%s-end", name);
2290 return map(exports, buf, 1, "", 1);
2294 /*********************************************************************
2296 * Function : map_conditional
2298 * Description : Convenience function.
2299 * Adds an "if-then-else" for the conditional HTML-template
2300 * block <name>, i.e. a substitution of the form:
2307 * The control structure and one of the alternatives
2311 * 1 : exports = map to extend
2312 * 2 : name = name of conditional block
2313 * 3 : choose_first = nonzero for first, zero for second.
2315 * Returns : JB_ERR_OK on success
2316 * JB_ERR_MEMORY on out-of-memory error.
2318 *********************************************************************/
2319 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2321 char buf[1000]; /* Will do, since the names are hardwired */
2326 assert(strlen(name) < (size_t)480);
2328 snprintf(buf, sizeof(buf), (choose_first
2329 ? "else-not-%s@.*@endif-%s"
2330 : "if-%s-then@.*@else-not-%s"),
2333 err = map(exports, buf, 1, "", 1);
2339 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2340 return map(exports, buf, 1, "", 1);
2344 /*********************************************************************
2346 * Function : make_menu
2348 * Description : Returns an HTML-formatted menu of the available
2349 * unhidden CGIs, excluding the one given in <self>
2350 * and the toggle CGI if toggling is disabled.
2353 * 1 : self = name of CGI to leave out, can be NULL for
2355 * 2 : feature_flags = feature bitmap from csp->config
2358 * Returns : menu string, or NULL on out-of-memory error.
2360 *********************************************************************/
2361 char *make_menu(const char *self, const unsigned feature_flags)
2363 const struct cgi_dispatcher *d;
2364 char *result = strdup("");
2368 self = "NO-SUCH-CGI!";
2371 /* List available unhidden CGI's and export as "other-cgis" */
2372 for (d = cgi_dispatchers; d->name; d++)
2375 #ifdef FEATURE_TOGGLE
2376 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2379 * Suppress the toggle link if remote toggling is disabled.
2383 #endif /* def FEATURE_TOGGLE */
2385 if (d->description && strcmp(d->name, self))
2387 char *html_encoded_prefix;
2390 * Line breaks would be great, but break
2391 * the "blocked" template's JavaScript.
2393 string_append(&result, "<li><a href=\"");
2394 html_encoded_prefix = html_encode(CGI_PREFIX);
2395 if (html_encoded_prefix == NULL)
2401 string_append(&result, html_encoded_prefix);
2402 free(html_encoded_prefix);
2404 string_append(&result, d->name);
2405 string_append(&result, "\">");
2406 string_append(&result, d->description);
2407 string_append(&result, "</a></li>");
2415 /*********************************************************************
2417 * Function : dump_map
2419 * Description : HTML-dump a map for debugging (as table)
2422 * 1 : the_map = map to dump
2424 * Returns : string with HTML
2426 *********************************************************************/
2427 char *dump_map(const struct map *the_map)
2429 struct map_entry *cur_entry;
2430 char *ret = strdup("");
2432 string_append(&ret, "<table>\n");
2434 for (cur_entry = the_map->first;
2435 (cur_entry != NULL) && (ret != NULL);
2436 cur_entry = cur_entry->next)
2438 string_append(&ret, "<tr><td><b>");
2439 string_join (&ret, html_encode(cur_entry->name));
2440 string_append(&ret, "</b></td><td>");
2441 string_join (&ret, html_encode(cur_entry->value));
2442 string_append(&ret, "</td></tr>\n");
2445 string_append(&ret, "</table>\n");