1 const char cgi_rcs[] = "$Id: cgi.c,v 1.76 2006/09/07 14:06:38 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 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.76 2006/09/07 14:06:38 fabiankeil
42 * Only predate the Last-Modified header for cgi responses
43 * that are delivered with status code 404 or 503.
45 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
46 * Mark cgi_send_user_manual as harmless,
47 * to fix the access denied problem Hal spotted.
48 * The manual has no secret content, therefore we
49 * don't have to care about "secure" referrers.
51 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
52 * Incorporate modified version of Roland Rosenfeld's patch to
53 * optionally access the user-manual via Privoxy. Closes patch 679075.
55 * Formatting changed to Privoxy style, added call to
56 * cgi_error_no_template if the requested file doesn't
57 * exist and modified check whether or not Privoxy itself
58 * should serve the manual. Should work cross-platform now.
60 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
61 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
63 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
64 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
65 * with what was really the latest development (the v_3_0_branch branch)
67 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
68 * Moved cgi_error_disabled() from cgiedit.c to
69 * cgi.c to re-enable build with --disable-editor.
70 * Fixes Bug #892744. Thanks to Matthew Fischer
73 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
74 * - Added new function cgi_redirect to handle creation of
75 * HTTP redirect messages formerly repeated in the code.
76 * - Send cgi_error_disabled instead of cgi_error_404 when
77 * referrer check fails
78 * - Dynamic content now gets Expires header field with date
81 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
82 * Bugfix: Transparent PNG was not transparent. Thanks to
83 * Dan Razzell of Starfish Systems for notice and new PNG.
85 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
86 * Security fix: dspatch_known_cgi no longer considers an empty
87 * referrer safe for critical CGIs, since malicious links could
88 * reside on https:// locations which browsers don't advertize as
89 * referrers. Closes bug #749916, thanks to Jeff Epler for the
90 * hint. Goodbye One-Click[tm] toggling :-(
92 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
95 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
96 * Killed a compiler warning on OSX
98 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
99 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
100 * (fixes bug #710056)
101 * - Show toggle info only if we have it
103 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
104 * Move declaration of struct tm dummy outside of a control block so it is
105 * accessible later on during snprintf in get_http_time.
107 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
108 * Cosmetic: Renamed cryptic variable
110 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
111 * Wrapping all *_r functions (the non-_r versions of them) with mutex semaphores for OSX. Hopefully this will take care of all of those pesky crash reports.
113 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
114 * Disable access to critical CGIs via untrusted referrers.
115 * This prevents users from being tricked by malicious websites
116 * into making unintentional configuration changes:
118 * - Added flag to each cgi_dispatcher that allows or denies
120 * - Introduced proviorical function that greps for the
121 * referrer header before regular header parsing happens
122 * - Added safety check to dispatch_known_cgi. CGI is called
123 * if (cgi harmless || no referrer || we are referrer).
124 * Else a) toggle calls are modified not to change status and
125 * b) all other calls are denied.
127 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
128 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
130 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
131 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
133 * Revision 1.70 2002/05/19 11:33:20 jongfoster
134 * If a CGI error was not handled, and propogated back to
135 * dispatch_known_cgi(), then it was assumed to be "out of memory".
136 * This gave a very misleading error message.
138 * Now other errors will cause a simple message giving the error
139 * number and asking the user to report a bug.
142 * http://sourceforge.net/tracker/index.php?func=detail
143 * &aid=557905&group_id=11118&atid=111118
145 * Revision 1.69 2002/05/14 21:28:40 oes
146 * - Fixed add_help_link to link to the (now split) actions
147 * part of the config chapter
148 * - Renamed helplink export to actions-help-prefix
150 * Revision 1.68 2002/05/12 21:36:29 jongfoster
151 * Correcting function comments
153 * Revision 1.67 2002/04/30 12:02:07 oes
154 * Nit: updated a comment
156 * Revision 1.66 2002/04/26 18:32:57 jongfoster
157 * Fixing a memory leak on error
159 * Revision 1.65 2002/04/26 12:53:51 oes
160 * - New function add_help_link
161 * - default_exports now exports links to the user manual
162 * and a prefix for links into the config chapter
164 * Revision 1.64 2002/04/24 02:17:21 oes
165 * - Better descriptions for CGIs
166 * - Hide edit-actions, more shortcuts
167 * - Moved get_char_param, get_string_param and get_number_param here
170 * Revision 1.63 2002/04/15 19:06:43 jongfoster
173 * Revision 1.62 2002/04/10 19:59:46 jongfoster
174 * Fixes to #include in templates:
175 * - Didn't close main file if loading an included template fails.
176 * - I'm paranoid and want to disallow "#include /etc/passwd".
178 * Revision 1.61 2002/04/10 13:37:48 oes
179 * Made templates modular: template_load now recursive with max depth 1
181 * Revision 1.60 2002/04/08 20:50:25 swa
184 * Revision 1.59 2002/04/05 15:51:51 oes
185 * - added send-stylesheet CGI
186 * - bugfix: error-pages now get correct request protocol
188 * - kludged CGI descriptions and menu not to break JS syntax
190 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
191 * Fix Mac OSX compiler warnings
193 * Revision 1.57 2002/03/26 22:29:54 swa
194 * we have a new homepage!
196 * Revision 1.56 2002/03/24 17:50:46 jongfoster
197 * Fixing compile error if actions file editor disabled
199 * Revision 1.55 2002/03/24 16:55:06 oes
200 * Making GIF checkerboard transparent
202 * Revision 1.54 2002/03/24 16:18:15 jongfoster
205 * Revision 1.53 2002/03/24 16:06:00 oes
206 * Correct transparency for checkerboard PNG. Thanks, Magnus!
208 * Revision 1.52 2002/03/24 15:23:33 jongfoster
211 * Revision 1.51 2002/03/24 13:25:43 swa
212 * name change related issues
214 * Revision 1.50 2002/03/16 23:54:06 jongfoster
215 * Adding graceful termination feature, to help look for memory leaks.
216 * If you enable this (which, by design, has to be done by hand
217 * editing config.h) and then go to http://i.j.b/die, then the program
218 * will exit cleanly after the *next* request. It should free all the
219 * memory that was used.
221 * Revision 1.49 2002/03/13 00:27:04 jongfoster
224 * Revision 1.48 2002/03/08 17:47:07 jongfoster
227 * Revision 1.47 2002/03/08 16:41:33 oes
228 * Added GIF images again
230 * Revision 1.46 2002/03/07 03:48:38 oes
231 * - Changed built-in images from GIF to PNG
232 * (with regard to Unisys patent issue)
233 * - Added a 4x4 pattern PNG which is less intrusive
234 * than the logo but also clearly marks the deleted banners
236 * Revision 1.45 2002/03/06 22:54:35 jongfoster
237 * Automated function-comment nitpicking.
239 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
240 * - Better error reporting on OS/2
241 * - Fix double-slash comment (oops)
243 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
244 * - Re-enable OS/2 building after new parms were added
245 * - Fix false out of memory report when resolving CGI templates when no IP
246 * address is available of failed attempt (a la no such domain)
248 * Revision 1.42 2002/01/21 00:33:20 jongfoster
249 * Replacing strsav() with the safer string_append() or string_join().
250 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
251 * Adding missing html_encode() to error message generators.
252 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
254 * Revision 1.41 2002/01/17 20:56:22 jongfoster
255 * Replacing hard references to the URL of the config interface
256 * with #defines from project.h
258 * Revision 1.40 2002/01/09 14:26:46 oes
259 * Added support for thread-safe gmtime_r call.
261 * Revision 1.39 2001/11/16 00:48:13 jongfoster
262 * Fixing a compiler warning
264 * Revision 1.38 2001/11/13 00:31:21 jongfoster
265 * - Adding new CGIs for use by non-JavaScript browsers:
266 * edit-actions-url-form
267 * edit-actions-add-url-form
268 * edit-actions-remove-url-form
269 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
272 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
273 * Show enablement/disablement status in almost all templates.
274 * There is a little trickiness here: apparent recursive resolution of
275 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
276 * the actual enablement status. So a similar construct,
277 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
280 * Revision 1.36 2001/10/26 17:33:27 oes
283 * Revision 1.35 2001/10/23 21:48:19 jongfoster
284 * Cleaning up error handling in CGI functions - they now send back
285 * a HTML error page and should never cause a FATAL error. (Fixes one
286 * potential source of "denial of service" attacks).
288 * CGI actions file editor that works and is actually useful.
290 * Ability to toggle Junkbuster remotely using a CGI call.
292 * You can turn off both the above features in the main configuration
293 * file, e.g. if you are running a multi-user proxy.
295 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
296 * Only show "Local support" on templates conditionally:
297 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
298 * - if not, no Local support section appears
300 * Revision 1.33 2001/10/14 22:28:41 jongfoster
301 * Fixing stupid typo.
303 * Revision 1.32 2001/10/14 22:20:18 jongfoster
304 * - Changes to CGI dispatching method to match CGI names exactly,
305 * rather than doing a prefix match.
306 * - No longer need to count the length of the CGI handler names by hand.
307 * - Adding new handler for 404 error when disptching a CGI, if none of
308 * the handlers match.
309 * - Adding new handlers for CGI actionsfile editor.
311 * Revision 1.31 2001/10/10 10:56:39 oes
312 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
314 * Revision 1.30 2001/10/02 15:30:57 oes
315 * Introduced show-request cgi
317 * Revision 1.29 2001/09/20 15:47:44 steudten
319 * Fix BUG: Modify int size to size_t size in fill_template()
320 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
322 * Revision 1.28 2001/09/19 18:00:37 oes
323 * - Deletef time() FIXME (Can't fail under Linux either, if
324 * the argument is guaranteed to be in out address space,
327 * - Pointer notation cosmetics
328 * - Fixed a minor bug in template_fill(): Failiure of
329 * pcrs_execute() now secure.
331 * Revision 1.27 2001/09/16 17:08:54 jongfoster
332 * Moving simple CGI functions from cgi.c to new file cgisimple.c
334 * Revision 1.26 2001/09/16 15:47:37 jongfoster
335 * First version of CGI-based edit interface. This is very much a
336 * work-in-progress, and you can't actually use it to edit anything
337 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
338 * to have any effect.
340 * Revision 1.25 2001/09/16 15:02:35 jongfoster
341 * Adding i.j.b/robots.txt.
342 * Inlining add_stats() since it's only ever called from one place.
344 * Revision 1.24 2001/09/16 11:38:01 jongfoster
345 * Splitting fill_template() into 2 functions:
346 * template_load() loads the file
347 * template_fill() performs the PCRS regexps.
348 * This is because the CGI edit interface has a "table row"
349 * template which is used many times in the page - this
350 * change means it's only loaded from disk once.
352 * Revision 1.23 2001/09/16 11:16:05 jongfoster
353 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
355 * Revision 1.22 2001/09/16 11:00:10 jongfoster
356 * New function alloc_http_response, for symmetry with free_http_response
358 * Revision 1.21 2001/09/13 23:53:03 jongfoster
359 * Support for both static and dynamically generated CGI pages.
360 * Correctly setting Last-Modified: and Expires: HTTP headers.
362 * Revision 1.20 2001/09/13 23:40:36 jongfoster
363 * (Cosmetic only) Indentation correction
365 * Revision 1.19 2001/09/13 23:31:25 jongfoster
366 * Moving image data to cgi.c rather than cgi.h.
368 * Revision 1.18 2001/08/05 16:06:20 jongfoster
369 * Modifiying "struct map" so that there are now separate header and
370 * "map_entry" structures. This means that functions which modify a
371 * map no longer need to return a pointer to the modified map.
372 * Also, it no longer reverses the order of the entries (which may be
373 * important with some advanced template substitutions).
375 * Revision 1.17 2001/08/05 15:57:38 oes
376 * Adapted finish_http_response to new list_to_text
378 * Revision 1.16 2001/08/01 21:33:18 jongfoster
379 * Changes to fill_template() that reduce memory usage without having
380 * an impact on performance. I also renamed some variables so as not
381 * to clash with the C++ keywords "new" and "template".
383 * Revision 1.15 2001/08/01 21:19:22 jongfoster
384 * Moving file version information to a separate CGI page.
386 * Revision 1.14 2001/08/01 00:19:03 jongfoster
387 * New function: map_conditional() for an if-then-else syntax.
388 * Changing to use new version of show_defines()
390 * Revision 1.13 2001/07/30 22:08:36 jongfoster
391 * Tidying up #defines:
392 * - All feature #defines are now of the form FEATURE_xxx
393 * - Permanently turned off WIN_GUI_EDIT
394 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
396 * Revision 1.12 2001/07/29 18:47:05 jongfoster
397 * Adding missing #include "loadcfg.h"
399 * Revision 1.11 2001/07/18 17:24:37 oes
400 * Changed to conform to new pcrs interface
402 * Revision 1.10 2001/07/13 13:53:13 oes
403 * Removed all #ifdef PCRS and related code
405 * Revision 1.9 2001/06/29 21:45:41 oes
406 * Indentation, CRLF->LF, Tab-> Space
408 * Revision 1.8 2001/06/29 13:21:46 oes
409 * - Cosmetics: renamed and reordered functions, variables,
410 * texts, improved comments etc
412 * - Removed ij_untrusted_url() The relevant
413 * info is now part of the "untrusted" page,
414 * which is generated by filters.c:trust_url()
416 * - Generators of content now call finish_http_response()
417 * themselves, making jcc.c:chat() a little less
420 * - Removed obsolete "Pragma: no-cache" from our headers
422 * - http_responses now know their head length
424 * - fill_template now uses the new interface to pcrs, so that
425 * - long jobs (like whole files) no longer have to be assembled
426 * in a fixed size buffer
427 * - the new T (trivial) option is used, and the replacement may
428 * contain Perl syntax backrefs without confusing pcrs
430 * - Introduced default_exports() which generates a set of exports
431 * common to all CGIs and other content generators
433 * - Introduced convenience function map_block_killer()
435 * - Introduced convenience function make_menu()
437 * - Introduced CGI-like function error_response() which generates
438 * the "No such domain" and "Connect failed" messages using the
441 * - cgi_show_url_info:
442 * - adapted to new CGI features
443 * - form and answers now generated from same template
444 * - http:// prefix in URL now OK
447 * - adapted to new CGI features
448 * - no longer uses csp->init_proxy_args
451 * - moved menu generation to make_menu()
453 * - add_stats now writes single export map entries instead
456 * - Moved redirect_url() to filters.c
458 * - Fixed mem leak in free_http_response(), map_block_killer(),
460 * - Removed logentry from cancelled commit
462 * Revision 1.7 2001/06/09 10:51:58 jongfoster
463 * Changing "show URL info" handler to new style.
464 * Changing BUFSIZ ==> BUFFER_SIZE
466 * Revision 1.6 2001/06/07 23:05:19 jongfoster
467 * Removing code related to old forward and ACL files.
469 * Revision 1.5 2001/06/05 19:59:16 jongfoster
470 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
472 * Revision 1.4 2001/06/04 10:41:52 swa
473 * show version string of cgi.h and cgi.c
475 * Revision 1.3 2001/06/03 19:12:16 oes
476 * introduced new cgi handling
478 * No revisions before 1.3
480 **********************************************************************/
486 #include <sys/types.h>
494 #define snprintf _snprintf
495 #endif /* def _WIN32 */
503 #include "miscutil.h"
504 #include "cgisimple.h"
505 #ifdef FEATURE_CGI_EDIT_ACTIONS
507 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
509 /* loadcfg.h is for global_toggle_state only */
510 #ifdef FEATURE_PTHREAD
513 /* jcc.h is for mutex semaphore globals only */
514 #endif /* def FEATURE_PTHREAD */
515 const char cgi_h_rcs[] = CGI_H_VERSION;
518 * List of CGI functions: name, handler, description
519 * Note: Do NOT use single quotes in the description;
520 * this will break the dynamic "blocked" template!
522 static const struct cgi_dispatcher cgi_dispatchers[] = {
527 #ifdef FEATURE_GRACEFUL_TERMINATION
530 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
531 "this is a one click Denial Of Service attack!!!</em>",
536 #ifdef FEATURE_CGI_EDIT_ACTIONS
537 "View & change the current configuration",
539 "View the current configuration",
544 "View the source code version numbers",
548 "View the request headers.",
552 "Look up which actions apply to a URL and why",
554 #ifdef FEATURE_CGI_EDIT_ACTIONS
557 "Toggle Privoxy on or off",
559 { "edit-actions", /* Edit the actions list */
562 { "eaa", /* Shortcut for edit-actions-add-url-form */
563 cgi_edit_actions_add_url_form,
565 { "eau", /* Shortcut for edit-actions-url-form */
566 cgi_edit_actions_url_form,
568 { "ear", /* Shortcut for edit-actions-remove-url-form */
569 cgi_edit_actions_remove_url_form,
571 { "eal", /* Shortcut for edit-actions-list */
572 cgi_edit_actions_list,
574 { "eafu", /* Shortcut for edit-actions-for-url */
575 cgi_edit_actions_for_url,
577 { "eas", /* Shortcut for edit-actions-submit */
578 cgi_edit_actions_submit,
580 { "easa", /* Shortcut for edit-actions-section-add */
581 cgi_edit_actions_section_add,
583 { "easr", /* Shortcut for edit-actions-section-remove */
584 cgi_edit_actions_section_remove,
586 { "eass", /* Shortcut for edit-actions-section-swap */
587 cgi_edit_actions_section_swap,
589 { "edit-actions-for-url",
590 cgi_edit_actions_for_url,
591 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
592 { "edit-actions-list",
593 cgi_edit_actions_list,
594 NULL, TRUE /* Edit the actions list */ },
595 { "edit-actions-submit",
596 cgi_edit_actions_submit,
597 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
598 { "edit-actions-url",
599 cgi_edit_actions_url,
600 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
601 { "edit-actions-url-form",
602 cgi_edit_actions_url_form,
603 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
604 { "edit-actions-add-url",
605 cgi_edit_actions_add_url,
606 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
607 { "edit-actions-add-url-form",
608 cgi_edit_actions_add_url_form,
609 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
610 { "edit-actions-remove-url",
611 cgi_edit_actions_remove_url,
612 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
613 { "edit-actions-remove-url-form",
614 cgi_edit_actions_remove_url_form,
615 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
616 { "edit-actions-section-add",
617 cgi_edit_actions_section_add,
618 NULL, FALSE /* Remove a section from the actionsfile */ },
619 { "edit-actions-section-remove",
620 cgi_edit_actions_section_remove,
621 NULL, FALSE /* Remove a section from the actionsfile */ },
622 { "edit-actions-section-swap",
623 cgi_edit_actions_section_swap,
624 NULL, FALSE /* Swap two sections in the actionsfile */ },
625 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
628 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
631 NULL, TRUE /* Send a built-in image */ },
634 NULL, TRUE /* Send templates/cgi-style.css */ },
636 cgi_transparent_image,
637 NULL, TRUE /* Send a transparent image (short name) */ },
639 cgi_send_user_manual,
640 NULL, TRUE /* Send user-manual */ },
641 { NULL, /* NULL Indicates end of list and default page */
643 NULL, TRUE /* Unknown CGI page */ }
648 * Built-in images for ad replacement
650 * Hint: You can encode your own images like this:
651 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
654 #ifdef FEATURE_NO_GIFS
657 * Checkerboard pattern, as a PNG.
659 const char image_pattern_data[] =
660 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
661 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
662 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
663 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
664 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
665 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
666 "\000\000\000\111\105\116\104\256\102\140\202";
669 * 1x1 transparant PNG.
671 const char image_blank_data[] =
672 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
673 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
674 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
675 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
676 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
677 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
678 "\000\000\000\000\111\105\116\104\256\102\140\202";
682 * Checkerboard pattern, as a GIF.
684 const char image_pattern_data[] =
685 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
686 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
687 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
688 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
692 * 1x1 transparant GIF.
694 const char image_blank_data[] =
695 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
696 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
697 "\000\001\000\000\002\002D\001\000;";
700 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
701 const size_t image_blank_length = sizeof(image_blank_data) - 1;
704 static struct http_response cgi_error_memory_response[1];
706 static struct http_response *dispatch_known_cgi(struct client_state * csp,
708 static struct map *parse_cgi_parameters(char *argstring);
711 /*********************************************************************
713 * Function : dispatch_cgi
715 * Description : Checks if a request URL has either the magical
716 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
717 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
718 * http://config.privoxy.org/). If so, it passes
719 * the (rest of the) path onto dispatch_known_cgi, which
720 * calls the relevant CGI handler function.
723 * 1 : csp = Current client state (buffers, headers, etc...)
725 * Returns : http_response if match, NULL if nonmatch or handler fail
727 *********************************************************************/
728 struct http_response *dispatch_cgi(struct client_state *csp)
730 const char *host = csp->http->host;
731 const char *path = csp->http->path;
734 * Should we intercept ?
737 /* Note: "example.com" and "example.com." are equivalent hostnames. */
739 /* Either the host matches CGI_SITE_1_HOST ..*/
740 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
741 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
742 && (path[0] == '/') )
744 /* ..then the path will all be for us. Remove leading '/' */
747 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
748 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
749 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
750 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
752 /* take everything following CGI_SITE_2_PATH */
753 path += strlen(CGI_SITE_2_PATH);
756 /* skip the forward slash after CGI_SITE_2_PATH */
759 else if (*path != '\0')
762 * weirdness: URL is /configXXX, where XXX is some string
763 * Do *NOT* intercept.
775 * This is a CGI call.
778 return dispatch_known_cgi(csp, path);
782 /*********************************************************************
784 * Function : grep_cgi_referrer
786 * Description : Ugly provisorical fix that greps the value of the
787 * referer HTTP header field out of a linked list of
788 * strings like found at csp->headers. Will disappear
791 * FIXME: csp->headers ought to be csp->http->headers
792 * FIXME: Parsing all client header lines should
793 * happen right after the request is received!
796 * 1 : csp = Current client state (buffers, headers, etc...)
798 * Returns : pointer to value (no copy!), or NULL if none found.
800 *********************************************************************/
801 char *grep_cgi_referrer(struct client_state *csp)
803 struct list_entry *p;
805 for (p = csp->headers->first; p != NULL; p = p->next)
807 if (p->str == NULL) continue;
808 if (strncmpic(p->str, "Referer: ", 9) == 0)
810 return ((p->str) + 9);
818 /*********************************************************************
820 * Function : dispatch_known_cgi
822 * Description : Processes a CGI once dispatch_cgi has determined that
823 * it matches one of the magic prefixes. Parses the path
824 * as a cgi name plus query string, prepares a map that
825 * maps CGI parameter names to their values, initializes
826 * the http_response struct, and calls the relevant CGI
830 * 1 : csp = Current client state (buffers, headers, etc...)
831 * 2 : path = Path of CGI, with the CGI prefix removed.
832 * Should not have a leading "/".
834 * Returns : http_response, or NULL on handler failure or out of
837 *********************************************************************/
838 static struct http_response *dispatch_known_cgi(struct client_state * csp,
841 const struct cgi_dispatcher *d;
842 struct map *param_list;
843 struct http_response *rsp;
844 char *query_args_start;
849 if (NULL == (path_copy = strdup(path)))
851 return cgi_error_memory();
853 query_args_start = path_copy;
854 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
858 if (*query_args_start == '/')
860 *query_args_start++ = '\0';
861 if ((param_list = new_map()))
863 map(param_list, "file", 1, url_decode(query_args_start), 0);
868 if (*query_args_start == '?')
870 *query_args_start++ = '\0';
872 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
875 return cgi_error_memory();
881 * path_copy = CGI call name
882 * param_list = CGI params, as map
885 /* Get mem for response or fail*/
886 if (NULL == (rsp = alloc_http_response()))
889 free_map(param_list);
890 return cgi_error_memory();
893 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
894 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
895 csp->ip_addr_str, csp->http->cmd);
898 * Find and start the right CGI function
903 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
906 * If the called CGI is either harmless, or referred
907 * from a trusted source, start it.
910 || ((NULL != (referrer = grep_cgi_referrer(csp)))
911 && (0 == strncmp(referrer, "http://config.privoxy.org/", 26)))
914 err = (d->handler)(csp, rsp, param_list);
919 * Else, modify toggle calls so that they only display
920 * the status, and deny all other calls.
922 if (0 == strcmp(path_copy, "toggle"))
924 unmap(param_list, "set");
925 err = (d->handler)(csp, rsp, param_list);
929 err = cgi_error_disabled(csp, rsp);
934 free_map(param_list);
936 if (err == JB_ERR_CGI_PARAMS)
938 err = cgi_error_bad_param(csp, rsp);
940 if (err && (err != JB_ERR_MEMORY))
942 /* Unexpected error! Shouldn't get here */
943 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
944 err = cgi_error_unknown(csp, rsp, err);
949 return finish_http_response(rsp);
953 /* Error in handler, probably out-of-memory */
954 free_http_response(rsp);
955 return cgi_error_memory();
963 /*********************************************************************
965 * Function : parse_cgi_parameters
967 * Description : Parse a URL-encoded argument string into name/value
968 * pairs and store them in a struct map list.
971 * 1 : argstring = string to be parsed. Will be trashed.
973 * Returns : pointer to param list, or NULL if out of memory.
975 *********************************************************************/
976 static struct map *parse_cgi_parameters(char *argstring)
979 char *vector[BUFFER_SIZE];
981 struct map *cgi_params;
983 if (NULL == (cgi_params = new_map()))
989 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
990 * the fragment identifier along with the request, so we must
991 * cut it off here, so it won't pollute the CGI params:
993 if (NULL != (p = strchr(argstring, '#')))
998 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1000 for (i = 0; i < pairs; i++)
1002 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1005 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1007 free_map(cgi_params);
1018 /*********************************************************************
1020 * Function : get_char_param
1022 * Description : Get a single-character parameter passed to a CGI
1026 * 1 : parameters = map of cgi parameters
1027 * 2 : param_name = The name of the parameter to read
1029 * Returns : Uppercase character on success, '\0' on error.
1031 *********************************************************************/
1032 char get_char_param(const struct map *parameters,
1033 const char *param_name)
1040 ch = *(lookup(parameters, param_name));
1041 if ((ch >= 'a') && (ch <= 'z'))
1043 ch = ch - 'a' + 'A';
1050 /*********************************************************************
1052 * Function : get_string_param
1054 * Description : Get a string paramater, to be used as an
1055 * ACTION_STRING or ACTION_MULTI paramater.
1056 * Validates the input to prevent stupid/malicious
1057 * users from corrupting their action file.
1060 * 1 : parameters = map of cgi parameters
1061 * 2 : param_name = The name of the parameter to read
1062 * 3 : pparam = destination for paramater. Allocated as
1063 * part of the map "parameters", so don't free it.
1064 * Set to NULL if not specified.
1066 * Returns : JB_ERR_OK on success, or if the paramater
1067 * was not specified.
1068 * JB_ERR_MEMORY on out-of-memory.
1069 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1071 *********************************************************************/
1072 jb_err get_string_param(const struct map *parameters,
1073 const char *param_name,
1074 const char **pparam)
1086 param = lookup(parameters, param_name);
1092 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1097 * Note that the length limit is arbitrary, it just seems
1098 * sensible to limit it to *something*. There's no
1099 * technical reason for any limit at all.
1101 return JB_ERR_CGI_PARAMS;
1104 /* Check every character to see if it's legal */
1106 while ((ch = *s++) != '\0')
1108 if ( ((unsigned char)ch < (unsigned char)' ')
1111 /* Probable hack attempt, or user accidentally used '}'. */
1112 return JB_ERR_CGI_PARAMS;
1123 /*********************************************************************
1125 * Function : get_number_param
1127 * Description : Get a non-negative integer from the parameters
1128 * passed to a CGI function.
1131 * 1 : csp = Current client state (buffers, headers, etc...)
1132 * 2 : parameters = map of cgi parameters
1133 * 3 : name = Name of CGI parameter to read
1134 * 4 : pvalue = destination for value.
1135 * Set to -1 on error.
1137 * Returns : JB_ERR_OK on success
1138 * JB_ERR_MEMORY on out-of-memory
1139 * JB_ERR_CGI_PARAMS if the parameter was not specified
1142 *********************************************************************/
1143 jb_err get_number_param(struct client_state *csp,
1144 const struct map *parameters,
1159 param = lookup(parameters, name);
1162 return JB_ERR_CGI_PARAMS;
1165 /* We don't use atoi because I want to check this carefully... */
1168 while ((ch = *param++) != '\0')
1170 if ((ch < '0') || (ch > '9'))
1172 return JB_ERR_CGI_PARAMS;
1179 * <limits.h> defines UINT_MAX
1181 * (UINT_MAX - ch) / 10 is the largest number that
1182 * can be safely multiplied by 10 then have ch added.
1184 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1186 return JB_ERR_CGI_PARAMS;
1189 value = value * 10 + ch;
1200 /*********************************************************************
1202 * Function : error_response
1204 * Description : returns an http_response that explains the reason
1205 * why a request failed.
1208 * 1 : csp = Current client state (buffers, headers, etc...)
1209 * 2 : templatename = Which template should be used for the answer
1210 * 3 : sys_err = system error number
1212 * Returns : A http_response. If we run out of memory, this
1213 * will be cgi_error_memory().
1215 *********************************************************************/
1216 struct http_response *error_response(struct client_state *csp,
1217 const char *templatename,
1221 struct http_response *rsp;
1222 struct map * exports = default_exports(csp, NULL);
1223 if (exports == NULL)
1225 return cgi_error_memory();
1228 if (NULL == (rsp = alloc_http_response()))
1231 return cgi_error_memory();
1234 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1235 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1236 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1237 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1238 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1241 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1244 /* Some failures, like "404 no such domain", don't have an IP address. */
1245 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1253 free_http_response(rsp);
1254 return cgi_error_memory();
1257 if (!strcmp(templatename, "no-such-domain"))
1259 rsp->status = strdup("404 No such domain");
1260 if (rsp->status == NULL)
1263 free_http_response(rsp);
1264 return cgi_error_memory();
1267 else if (!strcmp(templatename, "connect-failed"))
1269 rsp->status = strdup("503 Connect failed");
1270 if (rsp->status == NULL)
1273 free_http_response(rsp);
1274 return cgi_error_memory();
1278 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1281 free_http_response(rsp);
1282 return cgi_error_memory();
1285 return finish_http_response(rsp);
1289 /*********************************************************************
1291 * Function : cgi_error_disabled
1293 * Description : CGI function that is called to generate an error
1294 * response if the actions editor or toggle CGI are
1295 * accessed despite having being disabled at compile-
1299 * 1 : csp = Current client state (buffers, headers, etc...)
1300 * 2 : rsp = http_response data structure for output
1302 * CGI Parameters : none
1304 * Returns : JB_ERR_OK on success
1305 * JB_ERR_MEMORY on out-of-memory error.
1307 *********************************************************************/
1308 jb_err cgi_error_disabled(struct client_state *csp,
1309 struct http_response *rsp)
1311 struct map *exports;
1316 if (NULL == (exports = default_exports(csp, NULL)))
1318 return JB_ERR_MEMORY;
1321 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1325 /*********************************************************************
1327 * Function : cgi_init_error_messages
1329 * Description : Call at the start of the program to initialize
1330 * the error message used by cgi_error_memory().
1336 *********************************************************************/
1337 void cgi_init_error_messages(void)
1339 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1340 cgi_error_memory_response->head =
1341 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1342 "Content-Type: text/html\r\n"
1344 cgi_error_memory_response->body =
1346 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1348 "<h1>500 Internal Privoxy Error</h1>\r\n"
1349 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1350 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1354 cgi_error_memory_response->head_length =
1355 strlen(cgi_error_memory_response->head);
1356 cgi_error_memory_response->content_length =
1357 strlen(cgi_error_memory_response->body);
1361 /*********************************************************************
1363 * Function : cgi_error_memory
1365 * Description : Called if a CGI function runs out of memory.
1366 * Returns a statically-allocated error response.
1370 * Returns : http_response data structure for output. This is
1371 * statically allocated, for obvious reasons.
1373 *********************************************************************/
1374 struct http_response *cgi_error_memory(void)
1376 /* assert that it's been initialized. */
1377 assert(cgi_error_memory_response->head);
1379 return cgi_error_memory_response;
1383 /*********************************************************************
1385 * Function : cgi_error_no_template
1387 * Description : Almost-CGI function that is called if a template
1388 * cannot be loaded. Note this is not a true CGI,
1389 * it takes a template name rather than a map of
1393 * 1 : csp = Current client state (buffers, headers, etc...)
1394 * 2 : rsp = http_response data structure for output
1395 * 3 : template_name = Name of template that could not
1398 * Returns : JB_ERR_OK on success
1399 * JB_ERR_MEMORY on out-of-memory error.
1401 *********************************************************************/
1402 jb_err cgi_error_no_template(struct client_state *csp,
1403 struct http_response *rsp,
1404 const char *template_name)
1406 static const char status[] =
1407 "500 Internal Privoxy Error";
1408 static const char body_prefix[] =
1410 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1412 "<h1>500 Internal Privoxy Error</h1>\r\n"
1413 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1414 "<p><b>Could not load template file <code>";
1415 static const char body_suffix[] =
1416 "</code> or one of it's included components.</b></p>\r\n"
1417 "<p>Please contact your proxy administrator.</p>\r\n"
1418 "<p>If you are the proxy administrator, please put the required file(s)"
1419 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1420 "location of the <code><i>(confdir)</i></code> directory "
1421 "is specified in the main Privoxy <code>config</code> "
1422 "file. (It's typically the Privoxy install directory"
1424 ", or <code>/etc/privoxy/</code>"
1425 #endif /* ndef _WIN32 */
1432 assert(template_name);
1434 /* Reset rsp, if needed */
1438 rsp->content_length = 0;
1439 rsp->head_length = 0;
1442 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1443 if (rsp->body == NULL)
1445 return JB_ERR_MEMORY;
1447 strcpy(rsp->body, body_prefix);
1448 strcat(rsp->body, template_name);
1449 strcat(rsp->body, body_suffix);
1451 rsp->status = strdup(status);
1452 if (rsp->body == NULL)
1454 return JB_ERR_MEMORY;
1461 /*********************************************************************
1463 * Function : cgi_error_unknown
1465 * Description : Almost-CGI function that is called if an unexpected
1466 * error occurs in the top-level CGI dispatcher.
1467 * In this context, "unexpected" means "anything other
1468 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1469 * expected to handle all other errors internally,
1470 * since they can give more relavent error messages
1473 * Note this is not a true CGI, it takes an error
1474 * code rather than a map of parameters.
1477 * 1 : csp = Current client state (buffers, headers, etc...)
1478 * 2 : rsp = http_response data structure for output
1479 * 3 : error_to_report = Error code to report.
1481 * Returns : JB_ERR_OK on success
1482 * JB_ERR_MEMORY on out-of-memory error.
1484 *********************************************************************/
1485 jb_err cgi_error_unknown(struct client_state *csp,
1486 struct http_response *rsp,
1487 jb_err error_to_report)
1489 static const char status[] =
1490 "500 Internal Privoxy Error";
1491 static const char body_prefix[] =
1493 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1495 "<h1>500 Internal Privoxy Error</h1>\r\n"
1496 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1497 "<p><b>Unexpected internal error: ";
1498 static const char body_suffix[] =
1501 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1502 "file a bug report</a>.</p>\r\n"
1509 /* Reset rsp, if needed */
1513 rsp->content_length = 0;
1514 rsp->head_length = 0;
1517 sprintf(errnumbuf, "%d", error_to_report);
1519 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1520 if (rsp->body == NULL)
1522 return JB_ERR_MEMORY;
1524 strcpy(rsp->body, body_prefix);
1525 strcat(rsp->body, errnumbuf);
1526 strcat(rsp->body, body_suffix);
1528 rsp->status = strdup(status);
1529 if (rsp->body == NULL)
1531 return JB_ERR_MEMORY;
1538 /*********************************************************************
1540 * Function : cgi_error_bad_param
1542 * Description : CGI function that is called if the parameters
1543 * (query string) for a CGI were wrong.
1546 * 1 : csp = Current client state (buffers, headers, etc...)
1547 * 2 : rsp = http_response data structure for output
1549 * CGI Parameters : none
1551 * Returns : JB_ERR_OK on success
1552 * JB_ERR_MEMORY on out-of-memory error.
1554 *********************************************************************/
1555 jb_err cgi_error_bad_param(struct client_state *csp,
1556 struct http_response *rsp)
1558 struct map *exports;
1563 if (NULL == (exports = default_exports(csp, NULL)))
1565 return JB_ERR_MEMORY;
1568 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1572 /*********************************************************************
1574 * Function : cgi_redirect
1576 * Description : CGI support function to generate a HTTP redirect
1580 * 1 : rsp = http_response data structure for output
1581 * 2 : target = string with the target URL
1583 * CGI Parameters : None
1585 * Returns : JB_ERR_OK on success
1586 * JB_ERR_MEMORY on out-of-memory error.
1588 *********************************************************************/
1589 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1596 err = enlist_unique_header(rsp->headers, "Location", target);
1598 rsp->status = strdup("302 Local Redirect from Privoxy");
1599 if (rsp->status == NULL)
1601 return JB_ERR_MEMORY;
1608 /*********************************************************************
1610 * Function : add_help_link
1612 * Description : Produce a copy of the string given as item,
1613 * embedded in an HTML link to its corresponding
1614 * section (item name in uppercase) in the actions
1615 * chapter of the user manual, (whose URL is given in
1616 * the config and defaults to our web site).
1618 * FIXME: I currently only work for actions, and would
1619 * like to be generalized for other topics.
1622 * 1 : item = item (will NOT be free()d.)
1623 * It is assumed to be HTML-safe.
1624 * 2 : config = The current configuration.
1626 * Returns : String with item embedded in link, or NULL on
1629 *********************************************************************/
1630 char *add_help_link(const char *item,
1631 struct configuration_spec *config)
1635 if (!item) return NULL;
1637 result = strdup("<a href=\"");
1638 if (!strncmpic(config->usermanual, "file://", 7) ||
1639 !strncmpic(config->usermanual, "http", 4))
1641 string_append(&result, config->usermanual);
1645 string_append(&result, "http://");
1646 string_append(&result, CGI_SITE_2_HOST);
1647 string_append(&result, "/user-manual/");
1649 string_append(&result, ACTIONS_HELP_PREFIX);
1650 string_join (&result, string_toupper(item));
1651 string_append(&result, "\">");
1652 string_append(&result, item);
1653 string_append(&result, "</a> ");
1659 /*********************************************************************
1661 * Function : get_http_time
1663 * Description : Get the time in a format suitable for use in a
1664 * HTTP header - e.g.:
1665 * "Sun, 06 Nov 1994 08:49:37 GMT"
1668 * 1 : time_offset = Time returned will be current time
1669 * plus this number of seconds.
1670 * 2 : buf = Destination for result. Must be long enough
1671 * to hold 29 characters plus a trailing zero.
1675 *********************************************************************/
1676 void get_http_time(int time_offset, char *buf)
1678 static const char day_names[7][4] =
1679 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1680 static const char month_names[12][4] =
1681 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1682 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1685 time_t current_time;
1686 #if defined(HAVE_GMTIME_R) && !defined(OSX_DARWIN)
1688 * Declare dummy up here (instead of inside get/set gmt block) so it
1689 * doesn't go out of scope before it's potentially used in snprintf later.
1690 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1691 * !defined HAVE_GMTIME_R.
1698 time(¤t_time); /* get current time */
1700 current_time += time_offset;
1702 /* get and save the gmt */
1705 pthread_mutex_lock(&gmtime_mutex);
1706 t = gmtime(¤t_time);
1707 pthread_mutex_unlock(&gmtime_mutex);
1709 t = gmtime_r(¤t_time, &dummy);
1711 t = gmtime(¤t_time);
1715 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1717 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1718 day_names[t->tm_wday],
1720 month_names[t->tm_mon],
1730 /*********************************************************************
1732 * Function : finish_http_response
1734 * Description : Fill in the missing headers in an http response,
1735 * and flatten the headers to an http head.
1738 * 1 : rsp = pointer to http_response to be processed
1740 * Returns : A http_response, usually the rsp parameter.
1741 * On error, free()s rsp and returns cgi_error_memory()
1743 *********************************************************************/
1744 struct http_response *finish_http_response(struct http_response *rsp)
1746 char buf[BUFFER_SIZE];
1749 /* Special case - do NOT change this statically allocated response,
1750 * which is ready for output anyway.
1752 if (rsp == cgi_error_memory_response)
1758 * Fill in the HTTP Status
1760 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1761 err = enlist_first(rsp->headers, buf);
1764 * Set the Content-Length
1766 if (rsp->content_length == 0)
1768 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1772 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1773 err = enlist(rsp->headers, buf);
1776 if (strncmpic(rsp->status, "302", 3))
1779 * If it's not a redirect without any content,
1780 * set the Content-Type to text/html if it's
1781 * not already specified.
1783 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1787 * Fill in the rest of the default headers:
1789 * Date: set to current date/time.
1790 * Last-Modified: set to date/time the page was last changed.
1791 * Expires: set to date/time page next needs reloading.
1792 * Cache-Control: set to "no-cache" if applicable.
1794 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1799 * Set Expires to about 10 min into the future so it'll get reloaded
1800 * occasionally, e.g. if Privoxy gets upgraded.
1805 get_http_time(0, buf);
1806 err = enlist_unique_header(rsp->headers, "Date", buf);
1809 /* Some date in the past. */
1810 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1814 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1815 err = enlist_unique_header(rsp->headers, "Expires", buf);
1818 else if (!strncmpic(rsp->status, "302", 3))
1820 get_http_time(0, buf);
1821 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1826 * Setting "Cache-Control" to "no-cache" and "Expires" to
1827 * the current time doesn't exactly forbid caching, it just
1828 * requires the client to revalidate the cached copy.
1830 * If a temporary problem occurs and the user tries again after
1831 * getting Privoxy's error message, a compliant browser may set the
1832 * If-Modified-Since header with the content of the error page's
1833 * Last-Modified header. More often than not, the document on the server
1834 * is older than Privoxy's error message, the server would send status code
1835 * 304 and the browser would display the outdated error message again and again.
1837 * For documents delivered with status code 404 or 503 we set "Last-Modified"
1838 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1839 * and can be safely used to "revalidate" without getting a status code 304.
1841 * There is no need to let the useless If-Modified-Since header reach the
1842 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1844 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1846 get_http_time(0, buf);
1847 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1848 if (!strncmpic(rsp->status, "404", 3) || !strncmpic(rsp->status, "503", 3))
1850 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1854 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1856 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1857 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1863 * HTTP/1.1 applications that do not support persistent connections MUST
1864 * include the "close" connection option in every message.
1866 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
1871 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1873 free_http_response(rsp);
1874 return cgi_error_memory();
1876 rsp->head_length = strlen(rsp->head);
1883 /*********************************************************************
1885 * Function : alloc_http_response
1887 * Description : Allocates a new http_response structure.
1891 * Returns : pointer to a new http_response, or NULL.
1893 *********************************************************************/
1894 struct http_response *alloc_http_response(void)
1896 return (struct http_response *) zalloc(sizeof(struct http_response));
1901 /*********************************************************************
1903 * Function : free_http_response
1905 * Description : Free the memory occupied by an http_response
1906 * and its depandant structures.
1909 * 1 : rsp = pointer to http_response to be freed
1913 *********************************************************************/
1914 void free_http_response(struct http_response *rsp)
1917 * Must special case cgi_error_memory_response, which is never freed.
1919 if (rsp && (rsp != cgi_error_memory_response))
1924 destroy_list(rsp->headers);
1931 /*********************************************************************
1933 * Function : template_load
1935 * Description : CGI support function that loads a given HTML
1936 * template from the confdir, ignoring comment
1937 * lines and following #include statements up to
1941 * 1 : csp = Current client state (buffers, headers, etc...)
1942 * 2 : template_ptr = Destination for pointer to loaded
1944 * 3 : templatename = name of the HTML template to be used
1945 * 4 : recursive = Flag set if this function calls itself
1946 * following an #include statament
1948 * Returns : JB_ERR_OK on success
1949 * JB_ERR_MEMORY on out-of-memory error.
1950 * JB_ERR_FILE if the template file cannot be read
1952 *********************************************************************/
1953 jb_err template_load(struct client_state *csp, char **template_ptr,
1954 const char *templatename, int recursive)
1957 char *templates_dir_path;
1960 char *included_module;
1963 char buf[BUFFER_SIZE];
1966 assert(template_ptr);
1967 assert(templatename);
1969 *template_ptr = NULL;
1971 /* Validate template name. Paranoia. */
1972 for (p = templatename; *p != 0; p++)
1974 if ( ((*p < 'a') || (*p > 'z'))
1975 && ((*p < 'A') || (*p > 'Z'))
1976 && ((*p < '0') || (*p > '9'))
1980 /* Illegal character */
1985 /* Generate full path */
1987 templates_dir_path = make_path(csp->config->confdir, "templates");
1988 if (templates_dir_path == NULL)
1990 return JB_ERR_MEMORY;
1993 full_path = make_path(templates_dir_path, templatename);
1994 free(templates_dir_path);
1995 if (full_path == NULL)
1997 return JB_ERR_MEMORY;
2000 /* Allocate buffer */
2002 file_buffer = strdup("");
2003 if (file_buffer == NULL)
2006 return JB_ERR_MEMORY;
2009 /* Open template file */
2011 if (NULL == (fp = fopen(full_path, "r")))
2013 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2021 * Read the file, ignoring comments, and honoring #include
2022 * statements, unless we're already called recursively.
2024 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2025 * This is unlikely in practise.
2027 while (fgets(buf, BUFFER_SIZE, fp))
2029 if (!recursive && !strncmp(buf, "#include ", 9))
2031 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2038 if (string_join(&file_buffer, included_module))
2041 return JB_ERR_MEMORY;
2047 /* skip lines starting with '#' */
2053 if (string_append(&file_buffer, buf))
2056 return JB_ERR_MEMORY;
2061 *template_ptr = file_buffer;
2067 /*********************************************************************
2069 * Function : template_fill
2071 * Description : CGI support function that fills in a pre-loaded
2072 * HTML template by replacing @name@ with value using
2073 * pcrs, for each item in the output map.
2075 * Note that a leading '$' charachter in the export map's
2076 * values will be stripped and toggle on backreference
2080 * 1 : template_ptr = IN: Template to be filled out.
2082 * OUT: Filled out template.
2083 * Caller must free().
2084 * 2 : exports = map with fill in symbol -> name pairs
2086 * Returns : JB_ERR_OK on success
2087 * JB_ERR_MEMORY on out-of-memory error
2089 *********************************************************************/
2090 jb_err template_fill(char **template_ptr, const struct map *exports)
2092 struct map_entry *m;
2094 char buf[BUFFER_SIZE];
2095 char *tmp_out_buffer;
2101 assert(template_ptr);
2102 assert(*template_ptr);
2105 file_buffer = *template_ptr;
2106 size = strlen(file_buffer) + 1;
2109 * Assemble pcrs joblist from exports map
2111 for (m = exports->first; m != NULL; m = m->next)
2113 if (*m->name == '$')
2116 * First character of name is '$', so remove this flag
2117 * character and allow backreferences ($1 etc) in the
2118 * "replace with" text.
2120 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2126 * Treat the "replace with" text as a literal string -
2127 * no quoting needed, no backreferences allowed.
2128 * ("Trivial" ['T'] flag).
2132 /* Enclose name in @@ */
2133 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2137 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2139 /* Make and run job. */
2140 job = pcrs_compile(buf, m->value, flags, &error);
2143 if (error == PCRS_ERR_NOMEM)
2146 *template_ptr = NULL;
2147 return JB_ERR_MEMORY;
2151 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2152 /* Hope it wasn't important and silently ignore the invalid job */
2157 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2160 if (NULL == tmp_out_buffer)
2162 *template_ptr = NULL;
2163 return JB_ERR_MEMORY;
2165 file_buffer = tmp_out_buffer;
2172 *template_ptr = file_buffer;
2177 /*********************************************************************
2179 * Function : template_fill_for_cgi
2181 * Description : CGI support function that loads a HTML template
2182 * and fills it in. Handles file-not-found errors
2183 * by sending a HTML error message. For convenience,
2184 * this function also frees the passed "exports" map.
2187 * 1 : csp = Client state
2188 * 2 : templatename = name of the HTML template to be used
2189 * 3 : exports = map with fill in symbol -> name pairs.
2190 * Will be freed by this function.
2191 * 4 : rsp = Response structure to fill in.
2193 * Returns : JB_ERR_OK on success
2194 * JB_ERR_MEMORY on out-of-memory error
2196 *********************************************************************/
2197 jb_err template_fill_for_cgi(struct client_state *csp,
2198 const char *templatename,
2199 struct map *exports,
2200 struct http_response *rsp)
2205 assert(templatename);
2209 err = template_load(csp, &rsp->body, templatename, 0);
2210 if (err == JB_ERR_FILE)
2213 return cgi_error_no_template(csp, rsp, templatename);
2218 return err; /* JB_ERR_MEMORY */
2220 err = template_fill(&rsp->body, exports);
2226 /*********************************************************************
2228 * Function : default_exports
2230 * Description : returns a struct map list that contains exports
2231 * which are common to all CGI functions.
2234 * 1 : csp = Current client state (buffers, headers, etc...)
2235 * 2 : caller = name of CGI who calls us and which should
2236 * be excluded from the generated menu. May be
2238 * Returns : NULL if no memory, else a new map. Caller frees.
2240 *********************************************************************/
2241 struct map *default_exports(const struct client_state *csp, const char *caller)
2245 struct map * exports;
2246 int local_help_exists = 0;
2250 exports = new_map();
2251 if (exports == NULL)
2256 err = map(exports, "version", 1, html_encode(VERSION), 0);
2257 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2258 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2259 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2260 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2261 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
2262 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2263 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2264 !strncmpic(csp->config->usermanual, "http", 4))
2266 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2270 if (!err) err = map(exports, "user-manual", 1, "http://"CGI_SITE_2_HOST"/user-manual/" ,1);
2272 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2273 #ifdef FEATURE_TOGGLE
2274 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2276 if (!err) err = map_block_killer(exports, "can-toggle");
2279 snprintf(buf, 20, "%d", csp->config->hport);
2280 if (!err) err = map(exports, "my-port", 1, buf, 1);
2282 if(!strcmp(CODE_STATUS, "stable"))
2284 if (!err) err = map_block_killer(exports, "unstable");
2287 if (csp->config->admin_address != NULL)
2289 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2290 local_help_exists = 1;
2294 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2297 if (csp->config->proxy_info_url != NULL)
2299 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2300 local_help_exists = 1;
2304 if (!err) err = map_block_killer(exports, "have-proxy-info");
2307 if (local_help_exists == 0)
2309 if (!err) err = map_block_killer(exports, "have-help-info");
2322 /*********************************************************************
2324 * Function : map_block_killer
2326 * Description : Convenience function.
2327 * Adds a "killer" for the conditional HTML-template
2328 * block <name>, i.e. a substitution of the regex
2329 * "if-<name>-start.*if-<name>-end" to the given
2333 * 1 : exports = map to extend
2334 * 2 : name = name of conditional block
2336 * Returns : JB_ERR_OK on success
2337 * JB_ERR_MEMORY on out-of-memory error.
2339 *********************************************************************/
2340 jb_err map_block_killer(struct map *exports, const char *name)
2342 char buf[1000]; /* Will do, since the names are hardwired */
2346 assert(strlen(name) < 490);
2348 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2349 return map(exports, buf, 1, "", 1);
2353 /*********************************************************************
2355 * Function : map_block_keep
2357 * Description : Convenience function. Removes the markers used
2358 * by map-block-killer, to save a few bytes.
2359 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2362 * 1 : exports = map to extend
2363 * 2 : name = name of conditional block
2365 * Returns : JB_ERR_OK on success
2366 * JB_ERR_MEMORY on out-of-memory error.
2368 *********************************************************************/
2369 jb_err map_block_keep(struct map *exports, const char *name)
2372 char buf[500]; /* Will do, since the names are hardwired */
2376 assert(strlen(name) < 490);
2378 snprintf(buf, 500, "if-%s-start", name);
2379 err = map(exports, buf, 1, "", 1);
2386 snprintf(buf, 500, "if-%s-end", name);
2387 return map(exports, buf, 1, "", 1);
2391 /*********************************************************************
2393 * Function : map_conditional
2395 * Description : Convenience function.
2396 * Adds an "if-then-else" for the conditional HTML-template
2397 * block <name>, i.e. a substitution of the form:
2404 * The control structure and one of the alternatives
2408 * 1 : exports = map to extend
2409 * 2 : name = name of conditional block
2410 * 3 : choose_first = nonzero for first, zero for second.
2412 * Returns : JB_ERR_OK on success
2413 * JB_ERR_MEMORY on out-of-memory error.
2415 *********************************************************************/
2416 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2418 char buf[1000]; /* Will do, since the names are hardwired */
2423 assert(strlen(name) < 480);
2425 snprintf(buf, 1000, (choose_first
2426 ? "else-not-%s@.*@endif-%s"
2427 : "if-%s-then@.*@else-not-%s"),
2430 err = map(exports, buf, 1, "", 1);
2436 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2437 return map(exports, buf, 1, "", 1);
2441 /*********************************************************************
2443 * Function : make_menu
2445 * Description : Returns an HTML-formatted menu of the available
2446 * unhidden CGIs, excluding the one given in <self>
2448 * Parameters : self = name of CGI to leave out, can be NULL for
2451 * Returns : menu string, or NULL on out-of-memory error.
2453 *********************************************************************/
2454 char *make_menu(const char *self)
2456 const struct cgi_dispatcher *d;
2457 char *result = strdup("");
2461 self = "NO-SUCH-CGI!";
2464 /* List available unhidden CGI's and export as "other-cgis" */
2465 for (d = cgi_dispatchers; d->name; d++)
2467 if (d->description && strcmp(d->name, self))
2469 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2470 string_append(&result, d->name);
2471 string_append(&result, "\">");
2472 string_append(&result, d->description);
2473 string_append(&result, "</a></li>");
2481 /*********************************************************************
2483 * Function : dump_map
2485 * Description : HTML-dump a map for debugging (as table)
2488 * 1 : the_map = map to dump
2490 * Returns : string with HTML
2492 *********************************************************************/
2493 char *dump_map(const struct map *the_map)
2495 struct map_entry *cur_entry;
2496 char *ret = strdup("");
2498 string_append(&ret, "<table>\n");
2500 for (cur_entry = the_map->first;
2501 (cur_entry != NULL) && (ret != NULL);
2502 cur_entry = cur_entry->next)
2504 string_append(&ret, "<tr><td><b>");
2505 string_join (&ret, html_encode(cur_entry->name));
2506 string_append(&ret, "</b></td><td>");
2507 string_join (&ret, html_encode(cur_entry->value));
2508 string_append(&ret, "</td></tr>\n");
2511 string_append(&ret, "</table>\n");