1 const char cgi_rcs[] = "$Id: cgi.c,v 1.58 2002/03/29 03:33:13 david__schmidt 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 the SourceForge
15 * 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.
41 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
42 * Fix Mac OSX compiler warnings
44 * Revision 1.57 2002/03/26 22:29:54 swa
45 * we have a new homepage!
47 * Revision 1.56 2002/03/24 17:50:46 jongfoster
48 * Fixing compile error if actions file editor disabled
50 * Revision 1.55 2002/03/24 16:55:06 oes
51 * Making GIF checkerboard transparent
53 * Revision 1.54 2002/03/24 16:18:15 jongfoster
56 * Revision 1.53 2002/03/24 16:06:00 oes
57 * Correct transparency for checkerboard PNG. Thanks, Magnus!
59 * Revision 1.52 2002/03/24 15:23:33 jongfoster
62 * Revision 1.51 2002/03/24 13:25:43 swa
63 * name change related issues
65 * Revision 1.50 2002/03/16 23:54:06 jongfoster
66 * Adding graceful termination feature, to help look for memory leaks.
67 * If you enable this (which, by design, has to be done by hand
68 * editing config.h) and then go to http://i.j.b/die, then the program
69 * will exit cleanly after the *next* request. It should free all the
70 * memory that was used.
72 * Revision 1.49 2002/03/13 00:27:04 jongfoster
75 * Revision 1.48 2002/03/08 17:47:07 jongfoster
78 * Revision 1.47 2002/03/08 16:41:33 oes
79 * Added GIF images again
81 * Revision 1.46 2002/03/07 03:48:38 oes
82 * - Changed built-in images from GIF to PNG
83 * (with regard to Unisys patent issue)
84 * - Added a 4x4 pattern PNG which is less intrusive
85 * than the logo but also clearly marks the deleted banners
87 * Revision 1.45 2002/03/06 22:54:35 jongfoster
88 * Automated function-comment nitpicking.
90 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
91 * - Better error reporting on OS/2
92 * - Fix double-slash comment (oops)
94 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
95 * - Re-enable OS/2 building after new parms were added
96 * - Fix false out of memory report when resolving CGI templates when no IP
97 * address is available of failed attempt (a la no such domain)
99 * Revision 1.42 2002/01/21 00:33:20 jongfoster
100 * Replacing strsav() with the safer string_append() or string_join().
101 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
102 * Adding missing html_encode() to error message generators.
103 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
105 * Revision 1.41 2002/01/17 20:56:22 jongfoster
106 * Replacing hard references to the URL of the config interface
107 * with #defines from project.h
109 * Revision 1.40 2002/01/09 14:26:46 oes
110 * Added support for thread-safe gmtime_r call.
112 * Revision 1.39 2001/11/16 00:48:13 jongfoster
113 * Fixing a compiler warning
115 * Revision 1.38 2001/11/13 00:31:21 jongfoster
116 * - Adding new CGIs for use by non-JavaScript browsers:
117 * edit-actions-url-form
118 * edit-actions-add-url-form
119 * edit-actions-remove-url-form
120 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
123 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
124 * Show enablement/disablement status in almost all templates.
125 * There is a little trickiness here: apparent recursive resolution of
126 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
127 * the actual enablement status. So a similar construct,
128 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
131 * Revision 1.36 2001/10/26 17:33:27 oes
134 * Revision 1.35 2001/10/23 21:48:19 jongfoster
135 * Cleaning up error handling in CGI functions - they now send back
136 * a HTML error page and should never cause a FATAL error. (Fixes one
137 * potential source of "denial of service" attacks).
139 * CGI actions file editor that works and is actually useful.
141 * Ability to toggle JunkBuster remotely using a CGI call.
143 * You can turn off both the above features in the main configuration
144 * file, e.g. if you are running a multi-user proxy.
146 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
147 * Only show "Local support" on templates conditionally:
148 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
149 * - if not, no Local support section appears
151 * Revision 1.33 2001/10/14 22:28:41 jongfoster
152 * Fixing stupid typo.
154 * Revision 1.32 2001/10/14 22:20:18 jongfoster
155 * - Changes to CGI dispatching method to match CGI names exactly,
156 * rather than doing a prefix match.
157 * - No longer need to count the length of the CGI handler names by hand.
158 * - Adding new handler for 404 error when disptching a CGI, if none of
159 * the handlers match.
160 * - Adding new handlers for CGI actionsfile editor.
162 * Revision 1.31 2001/10/10 10:56:39 oes
163 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
165 * Revision 1.30 2001/10/02 15:30:57 oes
166 * Introduced show-request cgi
168 * Revision 1.29 2001/09/20 15:47:44 steudten
170 * Fix BUG: Modify int size to size_t size in fill_template()
171 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
173 * Revision 1.28 2001/09/19 18:00:37 oes
174 * - Deletef time() FIXME (Can't fail under Linux either, if
175 * the argument is guaranteed to be in out address space,
178 * - Pointer notation cosmetics
179 * - Fixed a minor bug in template_fill(): Failiure of
180 * pcrs_execute() now secure.
182 * Revision 1.27 2001/09/16 17:08:54 jongfoster
183 * Moving simple CGI functions from cgi.c to new file cgisimple.c
185 * Revision 1.26 2001/09/16 15:47:37 jongfoster
186 * First version of CGI-based edit interface. This is very much a
187 * work-in-progress, and you can't actually use it to edit anything
188 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
189 * to have any effect.
191 * Revision 1.25 2001/09/16 15:02:35 jongfoster
192 * Adding i.j.b/robots.txt.
193 * Inlining add_stats() since it's only ever called from one place.
195 * Revision 1.24 2001/09/16 11:38:01 jongfoster
196 * Splitting fill_template() into 2 functions:
197 * template_load() loads the file
198 * template_fill() performs the PCRS regexps.
199 * This is because the CGI edit interface has a "table row"
200 * template which is used many times in the page - this
201 * change means it's only loaded from disk once.
203 * Revision 1.23 2001/09/16 11:16:05 jongfoster
204 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
206 * Revision 1.22 2001/09/16 11:00:10 jongfoster
207 * New function alloc_http_response, for symmetry with free_http_response
209 * Revision 1.21 2001/09/13 23:53:03 jongfoster
210 * Support for both static and dynamically generated CGI pages.
211 * Correctly setting Last-Modified: and Expires: HTTP headers.
213 * Revision 1.20 2001/09/13 23:40:36 jongfoster
214 * (Cosmetic only) Indentation correction
216 * Revision 1.19 2001/09/13 23:31:25 jongfoster
217 * Moving image data to cgi.c rather than cgi.h.
219 * Revision 1.18 2001/08/05 16:06:20 jongfoster
220 * Modifiying "struct map" so that there are now separate header and
221 * "map_entry" structures. This means that functions which modify a
222 * map no longer need to return a pointer to the modified map.
223 * Also, it no longer reverses the order of the entries (which may be
224 * important with some advanced template substitutions).
226 * Revision 1.17 2001/08/05 15:57:38 oes
227 * Adapted finish_http_response to new list_to_text
229 * Revision 1.16 2001/08/01 21:33:18 jongfoster
230 * Changes to fill_template() that reduce memory usage without having
231 * an impact on performance. I also renamed some variables so as not
232 * to clash with the C++ keywords "new" and "template".
234 * Revision 1.15 2001/08/01 21:19:22 jongfoster
235 * Moving file version information to a separate CGI page.
237 * Revision 1.14 2001/08/01 00:19:03 jongfoster
238 * New function: map_conditional() for an if-then-else syntax.
239 * Changing to use new version of show_defines()
241 * Revision 1.13 2001/07/30 22:08:36 jongfoster
242 * Tidying up #defines:
243 * - All feature #defines are now of the form FEATURE_xxx
244 * - Permanently turned off WIN_GUI_EDIT
245 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
247 * Revision 1.12 2001/07/29 18:47:05 jongfoster
248 * Adding missing #include "loadcfg.h"
250 * Revision 1.11 2001/07/18 17:24:37 oes
251 * Changed to conform to new pcrs interface
253 * Revision 1.10 2001/07/13 13:53:13 oes
254 * Removed all #ifdef PCRS and related code
256 * Revision 1.9 2001/06/29 21:45:41 oes
257 * Indentation, CRLF->LF, Tab-> Space
259 * Revision 1.8 2001/06/29 13:21:46 oes
260 * - Cosmetics: renamed and reordered functions, variables,
261 * texts, improved comments etc
263 * - Removed ij_untrusted_url() The relevant
264 * info is now part of the "untrusted" page,
265 * which is generated by filters.c:trust_url()
267 * - Generators of content now call finish_http_response()
268 * themselves, making jcc.c:chat() a little less
271 * - Removed obsolete "Pragma: no-cache" from our headers
273 * - http_responses now know their head length
275 * - fill_template now uses the new interface to pcrs, so that
276 * - long jobs (like whole files) no longer have to be assembled
277 * in a fixed size buffer
278 * - the new T (trivial) option is used, and the replacement may
279 * contain Perl syntax backrefs without confusing pcrs
281 * - Introduced default_exports() which generates a set of exports
282 * common to all CGIs and other content generators
284 * - Introduced convenience function map_block_killer()
286 * - Introduced convenience function make_menu()
288 * - Introduced CGI-like function error_response() which generates
289 * the "No such domain" and "Connect failed" messages using the
292 * - cgi_show_url_info:
293 * - adapted to new CGI features
294 * - form and answers now generated from same template
295 * - http:// prefix in URL now OK
298 * - adapted to new CGI features
299 * - no longer uses csp->init_proxy_args
302 * - moved menu generation to make_menu()
304 * - add_stats now writes single export map entries instead
307 * - Moved redirect_url() to filters.c
309 * - Fixed mem leak in free_http_response(), map_block_killer(),
311 * - Removed logentry from cancelled commit
313 * Revision 1.7 2001/06/09 10:51:58 jongfoster
314 * Changing "show URL info" handler to new style.
315 * Changing BUFSIZ ==> BUFFER_SIZE
317 * Revision 1.6 2001/06/07 23:05:19 jongfoster
318 * Removing code related to old forward and ACL files.
320 * Revision 1.5 2001/06/05 19:59:16 jongfoster
321 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
323 * Revision 1.4 2001/06/04 10:41:52 swa
324 * show version string of cgi.h and cgi.c
326 * Revision 1.3 2001/06/03 19:12:16 oes
327 * introduced new cgi handling
329 * No revisions before 1.3
331 **********************************************************************/
337 #include <sys/types.h>
344 #define snprintf _snprintf
345 #endif /* def _WIN32 */
353 #include "miscutil.h"
354 #include "cgisimple.h"
355 #ifdef FEATURE_CGI_EDIT_ACTIONS
357 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
359 /* loadcfg.h is for g_bToggleIJB only */
361 const char cgi_h_rcs[] = CGI_H_VERSION;
364 * List of CGI functions: name, handler, description
365 * Note: Do NOT use single quotes in the description;
366 * this will break the dynamic "blocked" template!
368 static const struct cgi_dispatcher cgi_dispatchers[] = {
371 "Privoxy main page" },
372 #ifdef FEATURE_GRACEFUL_TERMINATION
375 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
376 "this is a one click Denial Of Service attack!!!</em>" },
380 "Show information about the current configuration" },
383 "Show the source code version numbers" },
386 "Show the request headers." },
389 "Show which actions apply to a URL and why" },
390 #ifdef FEATURE_CGI_EDIT_ACTIONS
393 "Toggle Privoxy on or off" },
396 "Edit the actions list" },
399 { "eaa", /* Shortcut for edit-actions-add-url-form */
400 cgi_edit_actions_add_url_form,
402 { "eau", /* Shortcut for edit-actions-url-form */
403 cgi_edit_actions_url_form,
405 { "ear", /* Shortcut for edit-actions-remove-url-form */
406 cgi_edit_actions_remove_url_form,
408 { "eas", /* Shortcut for edit-actions-for-url */
409 cgi_edit_actions_for_url,
411 { "easa", /* Shortcut for edit-actions-section-add */
412 cgi_edit_actions_section_add,
414 { "easr", /* Shortcut for edit-actions-section-remove */
415 cgi_edit_actions_section_remove,
417 { "eass", /* Shortcut for edit-actions-section-swap */
418 cgi_edit_actions_section_swap,
420 { "edit-actions-for-url",
421 cgi_edit_actions_for_url,
422 NULL /* Edit the actions for (a) specified URL(s) */ },
423 { "edit-actions-list",
424 cgi_edit_actions_list,
425 NULL /* Edit the actions list */ },
426 { "edit-actions-submit",
427 cgi_edit_actions_submit,
428 NULL /* Change the actions for (a) specified URL(s) */ },
429 { "edit-actions-url",
430 cgi_edit_actions_url,
431 NULL /* Change a URL pattern in the actionsfile */ },
432 { "edit-actions-url-form",
433 cgi_edit_actions_url_form,
434 NULL /* Form to change a URL pattern in the actionsfile */ },
435 { "edit-actions-add-url",
436 cgi_edit_actions_add_url,
437 NULL /* Add a URL pattern to the actionsfile */ },
438 { "edit-actions-add-url-form",
439 cgi_edit_actions_add_url_form,
440 NULL /* Form to add a URL pattern to the actionsfile */ },
441 { "edit-actions-remove-url",
442 cgi_edit_actions_remove_url,
443 NULL /* Remove a URL pattern from the actionsfile */ },
444 { "edit-actions-remove-url-form",
445 cgi_edit_actions_remove_url_form,
446 NULL /* Form to remove a URL pattern from the actionsfile */ },
447 { "edit-actions-section-add",
448 cgi_edit_actions_section_add,
449 NULL /* Remove a section from the actionsfile */ },
450 { "edit-actions-section-remove",
451 cgi_edit_actions_section_remove,
452 NULL /* Remove a section from the actionsfile */ },
453 { "edit-actions-section-swap",
454 cgi_edit_actions_section_swap,
455 NULL /* Swap two sections in the actionsfile */ },
456 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
459 NULL /* Sends a robots.txt file to tell robots to go away. */ },
462 NULL /* Send a built-in image */ },
465 NULL /* Send templates/cgi-style.css */ },
467 cgi_transparent_image,
468 NULL /* Send a transparent image (short name) */ },
469 { NULL, /* NULL Indicates end of list and default page */
471 NULL /* Unknown CGI page */ }
476 * Bulit-in images for ad replacement
478 * Hint: You can encode your own images like this:
479 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
482 #ifdef FEATURE_NO_GIFS
485 * Checkerboard pattern, as a PNG.
487 const char image_pattern_data[] =
488 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
489 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
490 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
491 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
492 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
493 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
494 "\000\000\000\111\105\116\104\256\102\140\202";
497 * 1x1 transparant PNG.
499 const char image_blank_data[] =
500 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
501 "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236"
502 "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070"
503 "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022"
504 "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115"
505 "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101"
506 "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006"
507 "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110"
508 "\000\000\000\000\111\105\116\104\256\102\140\202";
512 * Checkerboard pattern, as a GIF.
514 const char image_pattern_data[] =
515 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
516 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
517 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
518 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
522 * 1x1 transparant GIF.
524 const char image_blank_data[] =
525 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
526 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
527 "\000\001\000\000\002\002D\001\000;";
530 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
531 const size_t image_blank_length = sizeof(image_blank_data) - 1;
534 static struct http_response cgi_error_memory_response[1];
536 static struct http_response *dispatch_known_cgi(struct client_state * csp,
538 static struct map *parse_cgi_parameters(char *argstring);
541 /*********************************************************************
543 * Function : dispatch_cgi
545 * Description : Checks if a request URL has either the magical
546 * hostname CGI_SITE_1_HOST (usully http://i.j.b/) or
547 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
548 * http://ijbswa.sourceforge.net/config). If so, it passes
549 * the (rest of the) path onto dispatch_known_cgi, which
550 * calls the relevant CGI handler function.
553 * 1 : csp = Current client state (buffers, headers, etc...)
555 * Returns : http_response if match, NULL if nonmatch or handler fail
557 *********************************************************************/
558 struct http_response *dispatch_cgi(struct client_state *csp)
560 const char *host = csp->http->host;
561 const char *path = csp->http->path;
564 * Should we intercept ?
567 /* Note: "example.com" and "example.com." are equivalent hostnames. */
569 /* Either the host matches CGI_SITE_1_HOST ..*/
570 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
571 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
572 && (path[0] == '/') )
574 /* ..then the path will all be for us. Remove leading '/' */
577 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
578 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
579 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
580 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
582 /* take everything following CGI_SITE_2_PATH */
583 path += strlen(CGI_SITE_2_PATH);
586 /* skip the forward slash after CGI_SITE_2_PATH */
589 else if (*path != '\0')
592 * wierdness: URL is /configXXX, where XXX is some string
593 * Do *NOT* intercept.
605 * This is a CGI call.
608 return dispatch_known_cgi(csp, path);
612 /*********************************************************************
614 * Function : dispatch_known_cgi
616 * Description : Processes a CGI once dispatch_cgi has determined that
617 * it matches one of the magic prefixes. Parses the path
618 * as a cgi name plus query string, prepares a map that
619 * maps CGI parameter names to their values, initializes
620 * the http_response struct, and calls the relevant CGI
624 * 1 : csp = Current client state (buffers, headers, etc...)
625 * 2 : path = Path of CGI, with the CGI prefix removed.
626 * Should not have a leading "/".
628 * Returns : http_response, or NULL on handler failure or out of
631 *********************************************************************/
632 static struct http_response *dispatch_known_cgi(struct client_state * csp,
635 const struct cgi_dispatcher *d;
636 struct map *param_list;
637 struct http_response *rsp;
638 char *query_args_start;
642 if (NULL == (path_copy = strdup(path)))
644 return cgi_error_memory();
647 query_args_start = path_copy;
648 while (*query_args_start && *query_args_start != '?')
652 if (*query_args_start == '?')
654 *query_args_start++ = '\0';
657 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
660 return cgi_error_memory();
666 * path_copy = CGI call name
667 * param_list = CGI params, as map
670 /* Get mem for response or fail*/
671 if (NULL == (rsp = alloc_http_response()))
674 free_map(param_list);
675 return cgi_error_memory();
678 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
679 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
680 csp->ip_addr_str, csp->http->cmd);
682 /* Find and start the right CGI function*/
686 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
688 err = (d->handler)(csp, rsp, param_list);
690 free_map(param_list);
691 if (err == JB_ERR_CGI_PARAMS)
693 err = cgi_error_bad_param(csp, rsp);
698 return finish_http_response(rsp);
702 /* Error in handler, probably out-of-memory */
703 free_http_response(rsp);
704 return cgi_error_memory();
712 /*********************************************************************
714 * Function : parse_cgi_parameters
716 * Description : Parse a URL-encoded argument string into name/value
717 * pairs and store them in a struct map list.
720 * 1 : string = string to be parsed. Will be trashed.
722 * Returns : pointer to param list, or NULL if out of memory.
724 *********************************************************************/
725 static struct map *parse_cgi_parameters(char *argstring)
728 char *vector[BUFFER_SIZE];
730 struct map *cgi_params;
732 if (NULL == (cgi_params = new_map()))
737 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
739 for (i = 0; i < pairs; i++)
741 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
744 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
746 free_map(cgi_params);
757 /*********************************************************************
759 * Function : error_response
761 * Description : returns an http_response that explains the reason
762 * why a request failed.
765 * 1 : csp = Current client state (buffers, headers, etc...)
766 * 2 : templatename = Which template should be used for the answer
767 * 3 : sys_err = system error number
769 * Returns : A http_response. If we run out of memory, this
770 * will be cgi_error_memory().
772 *********************************************************************/
773 struct http_response *error_response(struct client_state *csp,
774 const char *templatename,
778 struct http_response *rsp;
779 struct map * exports = default_exports(csp, NULL);
782 return cgi_error_memory();
785 if (NULL == (rsp = alloc_http_response()))
788 return cgi_error_memory();
791 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
792 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
793 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
794 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
795 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
798 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
801 /* Some failures, like "404 no such domain", don't have an IP address. */
802 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
810 free_http_response(rsp);
811 return cgi_error_memory();
814 if (!strcmp(templatename, "no-such-domain"))
816 rsp->status = strdup("404 No such domain");
817 if (rsp->status == NULL)
820 free_http_response(rsp);
821 return cgi_error_memory();
824 else if (!strcmp(templatename, "connect-failed"))
826 rsp->status = strdup("503 Connect failed");
827 if (rsp->status == NULL)
830 free_http_response(rsp);
831 return cgi_error_memory();
835 err = template_fill_for_cgi(csp, templatename, exports, rsp);
838 free_http_response(rsp);
839 return cgi_error_memory();
842 return finish_http_response(rsp);
846 /*********************************************************************
848 * Function : cgi_init_error_messages
850 * Description : Call at the start of the program to initialize
851 * the error message used by cgi_error_memory().
857 *********************************************************************/
858 void cgi_init_error_messages(void)
860 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
861 cgi_error_memory_response->head =
862 "HTTP/1.0 500 Internal Privoxy Error\r\n"
863 "Content-Type: text/html\r\n"
865 cgi_error_memory_response->body =
867 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
869 "<h1>500 Internal Privoxy Error</h1>\r\n"
870 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
871 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
875 cgi_error_memory_response->head_length =
876 strlen(cgi_error_memory_response->head);
877 cgi_error_memory_response->content_length =
878 strlen(cgi_error_memory_response->body);
882 /*********************************************************************
884 * Function : cgi_error_memory
886 * Description : Called if a CGI function runs out of memory.
887 * Returns a statically-allocated error response.
890 * 1 : csp = Current client state (buffers, headers, etc...)
891 * 2 : rsp = http_response data structure for output
892 * 3 : template_name = Name of template that could not
895 * Returns : JB_ERR_OK on success
896 * JB_ERR_MEMORY on out-of-memory error.
898 *********************************************************************/
899 struct http_response *cgi_error_memory(void)
901 /* assert that it's been initialized. */
902 assert(cgi_error_memory_response->head);
904 return cgi_error_memory_response;
908 /*********************************************************************
910 * Function : cgi_error_no_template
912 * Description : Almost-CGI function that is called if a templae
913 * cannot be loaded. Note this is not a true CGI,
914 * it takes a template name rather than a map of
918 * 1 : csp = Current client state (buffers, headers, etc...)
919 * 2 : rsp = http_response data structure for output
920 * 3 : template_name = Name of template that could not
923 * Returns : JB_ERR_OK on success
924 * JB_ERR_MEMORY on out-of-memory error.
926 *********************************************************************/
927 jb_err cgi_error_no_template(struct client_state *csp,
928 struct http_response *rsp,
929 const char *template_name)
931 static const char status[] =
932 "500 Internal Privoxy Error";
933 static const char body_prefix[] =
935 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
937 "<h1>500 Internal Privoxy Error</h1>\r\n"
938 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
939 "<p><b>Could not load template file <code>";
940 static const char body_suffix[] =
941 "</code></b></p>\r\n"
942 "<p>Please contact your proxy administrator.</p>\r\n"
943 "<p>If you are the proxy administrator, please put the required file "
944 "in the <code><i>(confdir)</i>/templates</code> directory. The "
945 "location of the <code><i>(confdir)</i></code> directory "
946 "is specified in the main Privoxy <code>config</code> "
947 "file. (It's typically the Privoxy install directory"
949 ", or <code>/etc/privoxy/</code>"
950 #endif /* ndef _WIN32 */
957 assert(template_name);
959 /* Reset rsp, if needed */
963 rsp->content_length = 0;
964 rsp->head_length = 0;
967 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
968 if (rsp->body == NULL)
970 return JB_ERR_MEMORY;
972 strcpy(rsp->body, body_prefix);
973 strcat(rsp->body, template_name);
974 strcat(rsp->body, body_suffix);
976 rsp->status = strdup(status);
977 if (rsp->body == NULL)
979 return JB_ERR_MEMORY;
986 /*********************************************************************
988 * Function : cgi_error_bad_param
990 * Description : CGI function that is called if the parameters
991 * (query string) for a CGI were wrong.
994 * 1 : csp = Current client state (buffers, headers, etc...)
995 * 2 : rsp = http_response data structure for output
997 * CGI Parameters : none
999 * Returns : JB_ERR_OK on success
1000 * JB_ERR_MEMORY on out-of-memory error.
1002 *********************************************************************/
1003 jb_err cgi_error_bad_param(struct client_state *csp,
1004 struct http_response *rsp)
1006 struct map *exports;
1011 if (NULL == (exports = default_exports(csp, NULL)))
1013 return JB_ERR_MEMORY;
1016 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1020 /*********************************************************************
1022 * Function : get_http_time
1024 * Description : Get the time in a format suitable for use in a
1025 * HTTP header - e.g.:
1026 * "Sun, 06 Nov 1994 08:49:37 GMT"
1029 * 1 : time_offset = Time returned will be current time
1030 * plus this number of seconds.
1031 * 2 : buf = Destination for result. Must be long enough
1032 * to hold 29 characters plus a trailing zero.
1036 *********************************************************************/
1037 void get_http_time(int time_offset, char *buf)
1039 static const char day_names[7][4] =
1040 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1041 static const char month_names[12][4] =
1042 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1043 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1046 time_t current_time;
1050 time(¤t_time); /* get current time */
1052 current_time += time_offset;
1054 /* get and save the gmt */
1056 #ifdef HAVE_GMTIME_R
1058 t = gmtime_r(¤t_time, &dummy);
1060 t = gmtime(¤t_time);
1064 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1066 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1067 day_names[t->tm_wday],
1069 month_names[t->tm_mon],
1079 /*********************************************************************
1081 * Function : finish_http_response
1083 * Description : Fill in the missing headers in an http response,
1084 * and flatten the headers to an http head.
1087 * 1 : rsp = pointer to http_response to be processed
1089 * Returns : A http_response, usually the rsp parameter.
1090 * On error, free()s rsp and returns cgi_error_memory()
1092 *********************************************************************/
1093 struct http_response *finish_http_response(struct http_response *rsp)
1095 char buf[BUFFER_SIZE];
1098 /* Special case - do NOT change this statically allocated response,
1099 * which is ready for output anyway.
1101 if (rsp == cgi_error_memory_response)
1107 * Fill in the HTTP Status
1109 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1110 err = enlist_first(rsp->headers, buf);
1113 * Set the Content-Length
1115 if (rsp->content_length == 0)
1117 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1121 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1122 err = enlist(rsp->headers, buf);
1126 * Fill in the default headers:
1128 * Content-Type: default to text/html if not already specified.
1129 * Date: set to current date/time.
1130 * Last-Modified: set to date/time the page was last changed.
1131 * Expires: set to date/time page next needs reloading.
1132 * Cache-Control: set to "no-cache" if applicable.
1134 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1136 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1141 * Set Expires to about 10 min into the future so it'll get reloaded
1142 * occasionally, e.g. if Privoxy gets upgraded.
1147 get_http_time(0, buf);
1148 err = enlist_unique_header(rsp->headers, "Date", buf);
1151 /* Some date in the past. */
1152 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1156 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1157 err = enlist_unique_header(rsp->headers, "Expires", buf);
1163 * Compliant browsers should not cache this due to the "Cache-Control"
1164 * setting. However, to be certain, we also set both "Last-Modified"
1165 * and "Expires" to the current time.
1167 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1169 get_http_time(0, buf);
1170 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1171 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1172 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1179 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1181 free_http_response(rsp);
1182 return cgi_error_memory();
1184 rsp->head_length = strlen(rsp->head);
1191 /*********************************************************************
1193 * Function : alloc_http_response
1195 * Description : Allocates a new http_response structure.
1199 * Returns : pointer to a new http_response, or NULL.
1201 *********************************************************************/
1202 struct http_response *alloc_http_response(void)
1204 return (struct http_response *) zalloc(sizeof(struct http_response));
1209 /*********************************************************************
1211 * Function : free_http_response
1213 * Description : Free the memory occupied by an http_response
1214 * and its depandant structures.
1217 * 1 : rsp = pointer to http_response to be freed
1221 *********************************************************************/
1222 void free_http_response(struct http_response *rsp)
1225 * Must special case cgi_error_memory_response, which is never freed.
1227 if (rsp && (rsp != cgi_error_memory_response))
1232 destroy_list(rsp->headers);
1239 /*********************************************************************
1241 * Function : template_load
1243 * Description : CGI support function that loads a given HTML
1244 * template from the confdir, ignoring comment
1248 * 1 : csp = Current client state (buffers, headers, etc...)
1249 * 2 : template_ptr = Destination for pointer to loaded
1251 * 3 : template = name of the HTML template to be used
1253 * Returns : JB_ERR_OK on success
1254 * JB_ERR_MEMORY on out-of-memory error.
1255 * JB_ERR_FILE if the template file cannot be read
1257 *********************************************************************/
1258 jb_err template_load(struct client_state *csp, char **template_ptr,
1259 const char *templatename)
1261 char *templates_dir_path;
1265 char buf[BUFFER_SIZE];
1268 assert(template_ptr);
1269 assert(templatename);
1271 *template_ptr = NULL;
1274 * Open template file or fail
1277 templates_dir_path = make_path(csp->config->confdir, "templates");
1278 if (templates_dir_path == NULL)
1280 return JB_ERR_MEMORY;
1283 full_path = make_path(templates_dir_path, templatename);
1284 free(templates_dir_path);
1285 if (full_path == NULL)
1287 return JB_ERR_MEMORY;
1290 file_buffer = strdup("");
1291 if (file_buffer == NULL)
1294 return JB_ERR_MEMORY;
1297 if (NULL == (fp = fopen(full_path, "r")))
1299 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1307 * Read the file, ignoring comments.
1309 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1310 * This is unlikely in practise.
1312 while (fgets(buf, BUFFER_SIZE, fp))
1314 /* skip lines starting with '#' */
1320 if (string_append(&file_buffer, buf))
1323 return JB_ERR_MEMORY;
1328 *template_ptr = file_buffer;
1334 /*********************************************************************
1336 * Function : template_fill
1338 * Description : CGI support function that fills in a pre-loaded
1339 * HTML template by replacing @name@ with value using
1340 * pcrs, for each item in the output map.
1342 * Note that a leading '$' charachter in the export map's
1343 * values will be stripped and toggle on backreference
1347 * 1 : template_ptr = IN: Template to be filled out.
1349 * OUT: Filled out template.
1350 * Caller must free().
1351 * 2 : exports = map with fill in symbol -> name pairs
1353 * Returns : JB_ERR_OK on success
1354 * JB_ERR_MEMORY on out-of-memory error
1356 *********************************************************************/
1357 jb_err template_fill(char **template_ptr, const struct map *exports)
1359 struct map_entry *m;
1361 char buf[BUFFER_SIZE];
1362 char *tmp_out_buffer;
1368 assert(template_ptr);
1369 assert(*template_ptr);
1372 file_buffer = *template_ptr;
1373 size = strlen(file_buffer) + 1;
1376 * Assemble pcrs joblist from exports map
1378 for (m = exports->first; m != NULL; m = m->next)
1380 if (*m->name == '$')
1383 * First character of name is '$', so remove this flag
1384 * character and allow backreferences ($1 etc) in the
1385 * "replace with" text.
1387 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1393 * Treat the "replace with" text as a literal string -
1394 * no quoting needed, no backreferences allowed.
1395 * ("Trivial" ['T'] flag).
1399 /* Enclose name in @@ */
1400 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1404 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
1406 /* Make and run job. */
1407 job = pcrs_compile(buf, m->value, flags, &error);
1410 if (error == PCRS_ERR_NOMEM)
1413 *template_ptr = NULL;
1414 return JB_ERR_MEMORY;
1418 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
1419 /* Hope it wasn't important and silently ignore the invalid job */
1424 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
1427 if (NULL == tmp_out_buffer)
1429 *template_ptr = NULL;
1430 return JB_ERR_MEMORY;
1432 file_buffer = tmp_out_buffer;
1439 *template_ptr = file_buffer;
1444 /*********************************************************************
1446 * Function : template_fill_for_cgi
1448 * Description : CGI support function that loads a HTML template
1449 * and fills it in. Handles file-not-found errors
1450 * by sending a HTML error message. For convenience,
1451 * this function also frees the passed "exports" map.
1454 * 1 : csp = Client state
1455 * 2 : templatename = name of the HTML template to be used
1456 * 3 : exports = map with fill in symbol -> name pairs.
1457 * Will be freed by this function.
1459 * Returns : JB_ERR_OK on success
1460 * JB_ERR_MEMORY on out-of-memory error
1462 *********************************************************************/
1463 jb_err template_fill_for_cgi(struct client_state *csp,
1464 const char *templatename,
1465 struct map *exports,
1466 struct http_response *rsp)
1471 assert(templatename);
1475 err = template_load(csp, &rsp->body, templatename);
1476 if (err == JB_ERR_FILE)
1479 return cgi_error_no_template(csp, rsp, templatename);
1484 return err; /* JB_ERR_MEMORY */
1486 err = template_fill(&rsp->body, exports);
1492 /*********************************************************************
1494 * Function : default_exports
1496 * Description : returns a struct map list that contains exports
1497 * which are common to all CGI functions.
1500 * 1 : csp = Current client state (buffers, headers, etc...)
1501 * 2 : caller = name of CGI who calls us and which should
1502 * be excluded from the generated menu. May be
1504 * Returns : NULL if no memory, else a new map. Caller frees.
1506 *********************************************************************/
1507 struct map *default_exports(const struct client_state *csp, const char *caller)
1511 struct map * exports;
1512 int local_help_exists = 0;
1516 exports = new_map();
1517 if (exports == NULL)
1522 err = map(exports, "version", 1, html_encode(VERSION), 0);
1523 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
1524 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
1525 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
1526 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
1527 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
1528 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
1529 if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB);
1531 snprintf(buf, 20, "%d", csp->config->hport);
1532 if (!err) err = map(exports, "my-port", 1, buf, 1);
1534 if(!strcmp(CODE_STATUS, "stable"))
1536 if (!err) err = map_block_killer(exports, "unstable");
1539 if (csp->config->admin_address != NULL)
1541 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
1542 local_help_exists = 1;
1546 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
1549 if (csp->config->proxy_info_url != NULL)
1551 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
1552 local_help_exists = 1;
1556 if (!err) err = map_block_killer(exports, "have-proxy-info");
1559 if (local_help_exists == 0)
1561 if (!err) err = map_block_killer(exports, "have-help-info");
1574 /*********************************************************************
1576 * Function : map_block_killer
1578 * Description : Convenience function.
1579 * Adds a "killer" for the conditional HTML-template
1580 * block <name>, i.e. a substitution of the regex
1581 * "if-<name>-start.*if-<name>-end" to the given
1585 * 1 : exports = map to extend
1586 * 2 : name = name of conditional block
1588 * Returns : JB_ERR_OK on success
1589 * JB_ERR_MEMORY on out-of-memory error.
1591 *********************************************************************/
1592 jb_err map_block_killer(struct map *exports, const char *name)
1594 char buf[1000]; /* Will do, since the names are hardwired */
1598 assert(strlen(name) < 490);
1600 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
1601 return map(exports, buf, 1, "", 1);
1605 /*********************************************************************
1607 * Function : map_block_keep
1609 * Description : Convenience function. Removes the markers used
1610 * by map-block-killer, to save a few bytes.
1611 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
1614 * 1 : exports = map to extend
1615 * 2 : name = name of conditional block
1617 * Returns : JB_ERR_OK on success
1618 * JB_ERR_MEMORY on out-of-memory error.
1620 *********************************************************************/
1621 jb_err map_block_keep(struct map *exports, const char *name)
1624 char buf[500]; /* Will do, since the names are hardwired */
1628 assert(strlen(name) < 490);
1630 snprintf(buf, 500, "if-%s-start", name);
1631 err = map(exports, buf, 1, "", 1);
1638 snprintf(buf, 500, "if-%s-end", name);
1639 return map(exports, buf, 1, "", 1);
1643 /*********************************************************************
1645 * Function : map_conditional
1647 * Description : Convenience function.
1648 * Adds an "if-then-else" for the conditional HTML-template
1649 * block <name>, i.e. a substitution of the form:
1656 * The control structure and one of the alternatives
1660 * 1 : exports = map to extend
1661 * 2 : name = name of conditional block
1662 * 3 : choose_first = nonzero for first, zero for second.
1664 * Returns : JB_ERR_OK on success
1665 * JB_ERR_MEMORY on out-of-memory error.
1667 *********************************************************************/
1668 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
1670 char buf[1000]; /* Will do, since the names are hardwired */
1675 assert(strlen(name) < 480);
1677 snprintf(buf, 1000, (choose_first
1678 ? "else-not-%s@.*@endif-%s"
1679 : "if-%s-then@.*@else-not-%s"),
1682 err = map(exports, buf, 1, "", 1);
1688 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
1689 return map(exports, buf, 1, "", 1);
1693 /*********************************************************************
1695 * Function : make_menu
1697 * Description : Returns an HTML-formatted menu of the available
1698 * unhidden CGIs, excluding the one given in <self>.
1700 * Parameters : self = name of CGI to leave out, can be NULL
1702 * Returns : menu string, or NULL on out-of-memory error.
1704 *********************************************************************/
1705 char *make_menu(const char *self)
1707 const struct cgi_dispatcher *d;
1708 char *result = strdup("");
1712 self = "NO-SUCH-CGI!";
1715 /* List available unhidden CGI's and export as "other-cgis" */
1716 for (d = cgi_dispatchers; d->name; d++)
1718 if (d->description && strcmp(d->name, self))
1720 string_append(&result, "<li><a href=\"" CGI_PREFIX);
1721 string_append(&result, d->name);
1722 string_append(&result, "\">");
1723 string_append(&result, d->description);
1724 string_append(&result, "</a></li>");
1732 /*********************************************************************
1734 * Function : dump_map
1736 * Description : HTML-dump a map for debugging
1739 * 1 : the_map = map to dump
1741 * Returns : string with HTML
1743 *********************************************************************/
1744 char *dump_map(const struct map *the_map)
1746 struct map_entry *cur_entry;
1747 char *ret = strdup("");
1749 string_append(&ret, "<table>\n");
1751 for (cur_entry = the_map->first;
1752 (cur_entry != NULL) && (ret != NULL);
1753 cur_entry = cur_entry->next)
1755 string_append(&ret, "<tr><td><b>");
1756 string_join (&ret, html_encode(cur_entry->name));
1757 string_append(&ret, "</b></td><td>");
1758 string_join (&ret, html_encode(cur_entry->value));
1759 string_append(&ret, "</td></tr>\n");
1762 string_append(&ret, "</table>\n");