1 const char cgi_rcs[] = "$Id: cgi.c,v 1.74 2006/09/06 18:45:03 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.74 2006/09/06 18:45:03 fabiankeil
42 * Incorporate modified version of Roland Rosenfeld's patch to
43 * optionally access the user-manual via Privoxy. Closes patch 679075.
45 * Formatting changed to Privoxy style, added call to
46 * cgi_error_no_template if the requested file doesn't
47 * exist and modified check whether or not Privoxy itself
48 * should serve the manual. Should work cross-platform now.
50 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
51 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
53 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
54 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
55 * with what was really the latest development (the v_3_0_branch branch)
57 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
58 * Moved cgi_error_disabled() from cgiedit.c to
59 * cgi.c to re-enable build with --disable-editor.
60 * Fixes Bug #892744. Thanks to Matthew Fischer
63 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
64 * - Added new function cgi_redirect to handle creation of
65 * HTTP redirect messages formerly repeated in the code.
66 * - Send cgi_error_disabled instead of cgi_error_404 when
67 * referrer check fails
68 * - Dynamic content now gets Expires header field with date
71 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
72 * Bugfix: Transparent PNG was not transparent. Thanks to
73 * Dan Razzell of Starfish Systems for notice and new PNG.
75 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
76 * Security fix: dspatch_known_cgi no longer considers an empty
77 * referrer safe for critical CGIs, since malicious links could
78 * reside on https:// locations which browsers don't advertize as
79 * referrers. Closes bug #749916, thanks to Jeff Epler for the
80 * hint. Goodbye One-Click[tm] toggling :-(
82 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
85 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
86 * Killed a compiler warning on OSX
88 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
89 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
91 * - Show toggle info only if we have it
93 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
94 * Move declaration of struct tm dummy outside of a control block so it is
95 * accessible later on during snprintf in get_http_time.
97 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
98 * Cosmetic: Renamed cryptic variable
100 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
101 * 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.
103 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
104 * Disable access to critical CGIs via untrusted referrers.
105 * This prevents users from being tricked by malicious websites
106 * into making unintentional configuration changes:
108 * - Added flag to each cgi_dispatcher that allows or denies
110 * - Introduced proviorical function that greps for the
111 * referrer header before regular header parsing happens
112 * - Added safety check to dispatch_known_cgi. CGI is called
113 * if (cgi harmless || no referrer || we are referrer).
114 * Else a) toggle calls are modified not to change status and
115 * b) all other calls are denied.
117 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
118 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
120 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
121 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
123 * Revision 1.70 2002/05/19 11:33:20 jongfoster
124 * If a CGI error was not handled, and propogated back to
125 * dispatch_known_cgi(), then it was assumed to be "out of memory".
126 * This gave a very misleading error message.
128 * Now other errors will cause a simple message giving the error
129 * number and asking the user to report a bug.
132 * http://sourceforge.net/tracker/index.php?func=detail
133 * &aid=557905&group_id=11118&atid=111118
135 * Revision 1.69 2002/05/14 21:28:40 oes
136 * - Fixed add_help_link to link to the (now split) actions
137 * part of the config chapter
138 * - Renamed helplink export to actions-help-prefix
140 * Revision 1.68 2002/05/12 21:36:29 jongfoster
141 * Correcting function comments
143 * Revision 1.67 2002/04/30 12:02:07 oes
144 * Nit: updated a comment
146 * Revision 1.66 2002/04/26 18:32:57 jongfoster
147 * Fixing a memory leak on error
149 * Revision 1.65 2002/04/26 12:53:51 oes
150 * - New function add_help_link
151 * - default_exports now exports links to the user manual
152 * and a prefix for links into the config chapter
154 * Revision 1.64 2002/04/24 02:17:21 oes
155 * - Better descriptions for CGIs
156 * - Hide edit-actions, more shortcuts
157 * - Moved get_char_param, get_string_param and get_number_param here
160 * Revision 1.63 2002/04/15 19:06:43 jongfoster
163 * Revision 1.62 2002/04/10 19:59:46 jongfoster
164 * Fixes to #include in templates:
165 * - Didn't close main file if loading an included template fails.
166 * - I'm paranoid and want to disallow "#include /etc/passwd".
168 * Revision 1.61 2002/04/10 13:37:48 oes
169 * Made templates modular: template_load now recursive with max depth 1
171 * Revision 1.60 2002/04/08 20:50:25 swa
174 * Revision 1.59 2002/04/05 15:51:51 oes
175 * - added send-stylesheet CGI
176 * - bugfix: error-pages now get correct request protocol
178 * - kludged CGI descriptions and menu not to break JS syntax
180 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
181 * Fix Mac OSX compiler warnings
183 * Revision 1.57 2002/03/26 22:29:54 swa
184 * we have a new homepage!
186 * Revision 1.56 2002/03/24 17:50:46 jongfoster
187 * Fixing compile error if actions file editor disabled
189 * Revision 1.55 2002/03/24 16:55:06 oes
190 * Making GIF checkerboard transparent
192 * Revision 1.54 2002/03/24 16:18:15 jongfoster
195 * Revision 1.53 2002/03/24 16:06:00 oes
196 * Correct transparency for checkerboard PNG. Thanks, Magnus!
198 * Revision 1.52 2002/03/24 15:23:33 jongfoster
201 * Revision 1.51 2002/03/24 13:25:43 swa
202 * name change related issues
204 * Revision 1.50 2002/03/16 23:54:06 jongfoster
205 * Adding graceful termination feature, to help look for memory leaks.
206 * If you enable this (which, by design, has to be done by hand
207 * editing config.h) and then go to http://i.j.b/die, then the program
208 * will exit cleanly after the *next* request. It should free all the
209 * memory that was used.
211 * Revision 1.49 2002/03/13 00:27:04 jongfoster
214 * Revision 1.48 2002/03/08 17:47:07 jongfoster
217 * Revision 1.47 2002/03/08 16:41:33 oes
218 * Added GIF images again
220 * Revision 1.46 2002/03/07 03:48:38 oes
221 * - Changed built-in images from GIF to PNG
222 * (with regard to Unisys patent issue)
223 * - Added a 4x4 pattern PNG which is less intrusive
224 * than the logo but also clearly marks the deleted banners
226 * Revision 1.45 2002/03/06 22:54:35 jongfoster
227 * Automated function-comment nitpicking.
229 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
230 * - Better error reporting on OS/2
231 * - Fix double-slash comment (oops)
233 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
234 * - Re-enable OS/2 building after new parms were added
235 * - Fix false out of memory report when resolving CGI templates when no IP
236 * address is available of failed attempt (a la no such domain)
238 * Revision 1.42 2002/01/21 00:33:20 jongfoster
239 * Replacing strsav() with the safer string_append() or string_join().
240 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
241 * Adding missing html_encode() to error message generators.
242 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
244 * Revision 1.41 2002/01/17 20:56:22 jongfoster
245 * Replacing hard references to the URL of the config interface
246 * with #defines from project.h
248 * Revision 1.40 2002/01/09 14:26:46 oes
249 * Added support for thread-safe gmtime_r call.
251 * Revision 1.39 2001/11/16 00:48:13 jongfoster
252 * Fixing a compiler warning
254 * Revision 1.38 2001/11/13 00:31:21 jongfoster
255 * - Adding new CGIs for use by non-JavaScript browsers:
256 * edit-actions-url-form
257 * edit-actions-add-url-form
258 * edit-actions-remove-url-form
259 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
262 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
263 * Show enablement/disablement status in almost all templates.
264 * There is a little trickiness here: apparent recursive resolution of
265 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
266 * the actual enablement status. So a similar construct,
267 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
270 * Revision 1.36 2001/10/26 17:33:27 oes
273 * Revision 1.35 2001/10/23 21:48:19 jongfoster
274 * Cleaning up error handling in CGI functions - they now send back
275 * a HTML error page and should never cause a FATAL error. (Fixes one
276 * potential source of "denial of service" attacks).
278 * CGI actions file editor that works and is actually useful.
280 * Ability to toggle Junkbuster remotely using a CGI call.
282 * You can turn off both the above features in the main configuration
283 * file, e.g. if you are running a multi-user proxy.
285 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
286 * Only show "Local support" on templates conditionally:
287 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
288 * - if not, no Local support section appears
290 * Revision 1.33 2001/10/14 22:28:41 jongfoster
291 * Fixing stupid typo.
293 * Revision 1.32 2001/10/14 22:20:18 jongfoster
294 * - Changes to CGI dispatching method to match CGI names exactly,
295 * rather than doing a prefix match.
296 * - No longer need to count the length of the CGI handler names by hand.
297 * - Adding new handler for 404 error when disptching a CGI, if none of
298 * the handlers match.
299 * - Adding new handlers for CGI actionsfile editor.
301 * Revision 1.31 2001/10/10 10:56:39 oes
302 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
304 * Revision 1.30 2001/10/02 15:30:57 oes
305 * Introduced show-request cgi
307 * Revision 1.29 2001/09/20 15:47:44 steudten
309 * Fix BUG: Modify int size to size_t size in fill_template()
310 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
312 * Revision 1.28 2001/09/19 18:00:37 oes
313 * - Deletef time() FIXME (Can't fail under Linux either, if
314 * the argument is guaranteed to be in out address space,
317 * - Pointer notation cosmetics
318 * - Fixed a minor bug in template_fill(): Failiure of
319 * pcrs_execute() now secure.
321 * Revision 1.27 2001/09/16 17:08:54 jongfoster
322 * Moving simple CGI functions from cgi.c to new file cgisimple.c
324 * Revision 1.26 2001/09/16 15:47:37 jongfoster
325 * First version of CGI-based edit interface. This is very much a
326 * work-in-progress, and you can't actually use it to edit anything
327 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
328 * to have any effect.
330 * Revision 1.25 2001/09/16 15:02:35 jongfoster
331 * Adding i.j.b/robots.txt.
332 * Inlining add_stats() since it's only ever called from one place.
334 * Revision 1.24 2001/09/16 11:38:01 jongfoster
335 * Splitting fill_template() into 2 functions:
336 * template_load() loads the file
337 * template_fill() performs the PCRS regexps.
338 * This is because the CGI edit interface has a "table row"
339 * template which is used many times in the page - this
340 * change means it's only loaded from disk once.
342 * Revision 1.23 2001/09/16 11:16:05 jongfoster
343 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
345 * Revision 1.22 2001/09/16 11:00:10 jongfoster
346 * New function alloc_http_response, for symmetry with free_http_response
348 * Revision 1.21 2001/09/13 23:53:03 jongfoster
349 * Support for both static and dynamically generated CGI pages.
350 * Correctly setting Last-Modified: and Expires: HTTP headers.
352 * Revision 1.20 2001/09/13 23:40:36 jongfoster
353 * (Cosmetic only) Indentation correction
355 * Revision 1.19 2001/09/13 23:31:25 jongfoster
356 * Moving image data to cgi.c rather than cgi.h.
358 * Revision 1.18 2001/08/05 16:06:20 jongfoster
359 * Modifiying "struct map" so that there are now separate header and
360 * "map_entry" structures. This means that functions which modify a
361 * map no longer need to return a pointer to the modified map.
362 * Also, it no longer reverses the order of the entries (which may be
363 * important with some advanced template substitutions).
365 * Revision 1.17 2001/08/05 15:57:38 oes
366 * Adapted finish_http_response to new list_to_text
368 * Revision 1.16 2001/08/01 21:33:18 jongfoster
369 * Changes to fill_template() that reduce memory usage without having
370 * an impact on performance. I also renamed some variables so as not
371 * to clash with the C++ keywords "new" and "template".
373 * Revision 1.15 2001/08/01 21:19:22 jongfoster
374 * Moving file version information to a separate CGI page.
376 * Revision 1.14 2001/08/01 00:19:03 jongfoster
377 * New function: map_conditional() for an if-then-else syntax.
378 * Changing to use new version of show_defines()
380 * Revision 1.13 2001/07/30 22:08:36 jongfoster
381 * Tidying up #defines:
382 * - All feature #defines are now of the form FEATURE_xxx
383 * - Permanently turned off WIN_GUI_EDIT
384 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
386 * Revision 1.12 2001/07/29 18:47:05 jongfoster
387 * Adding missing #include "loadcfg.h"
389 * Revision 1.11 2001/07/18 17:24:37 oes
390 * Changed to conform to new pcrs interface
392 * Revision 1.10 2001/07/13 13:53:13 oes
393 * Removed all #ifdef PCRS and related code
395 * Revision 1.9 2001/06/29 21:45:41 oes
396 * Indentation, CRLF->LF, Tab-> Space
398 * Revision 1.8 2001/06/29 13:21:46 oes
399 * - Cosmetics: renamed and reordered functions, variables,
400 * texts, improved comments etc
402 * - Removed ij_untrusted_url() The relevant
403 * info is now part of the "untrusted" page,
404 * which is generated by filters.c:trust_url()
406 * - Generators of content now call finish_http_response()
407 * themselves, making jcc.c:chat() a little less
410 * - Removed obsolete "Pragma: no-cache" from our headers
412 * - http_responses now know their head length
414 * - fill_template now uses the new interface to pcrs, so that
415 * - long jobs (like whole files) no longer have to be assembled
416 * in a fixed size buffer
417 * - the new T (trivial) option is used, and the replacement may
418 * contain Perl syntax backrefs without confusing pcrs
420 * - Introduced default_exports() which generates a set of exports
421 * common to all CGIs and other content generators
423 * - Introduced convenience function map_block_killer()
425 * - Introduced convenience function make_menu()
427 * - Introduced CGI-like function error_response() which generates
428 * the "No such domain" and "Connect failed" messages using the
431 * - cgi_show_url_info:
432 * - adapted to new CGI features
433 * - form and answers now generated from same template
434 * - http:// prefix in URL now OK
437 * - adapted to new CGI features
438 * - no longer uses csp->init_proxy_args
441 * - moved menu generation to make_menu()
443 * - add_stats now writes single export map entries instead
446 * - Moved redirect_url() to filters.c
448 * - Fixed mem leak in free_http_response(), map_block_killer(),
450 * - Removed logentry from cancelled commit
452 * Revision 1.7 2001/06/09 10:51:58 jongfoster
453 * Changing "show URL info" handler to new style.
454 * Changing BUFSIZ ==> BUFFER_SIZE
456 * Revision 1.6 2001/06/07 23:05:19 jongfoster
457 * Removing code related to old forward and ACL files.
459 * Revision 1.5 2001/06/05 19:59:16 jongfoster
460 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
462 * Revision 1.4 2001/06/04 10:41:52 swa
463 * show version string of cgi.h and cgi.c
465 * Revision 1.3 2001/06/03 19:12:16 oes
466 * introduced new cgi handling
468 * No revisions before 1.3
470 **********************************************************************/
476 #include <sys/types.h>
484 #define snprintf _snprintf
485 #endif /* def _WIN32 */
493 #include "miscutil.h"
494 #include "cgisimple.h"
495 #ifdef FEATURE_CGI_EDIT_ACTIONS
497 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
499 /* loadcfg.h is for global_toggle_state only */
500 #ifdef FEATURE_PTHREAD
503 /* jcc.h is for mutex semaphore globals only */
504 #endif /* def FEATURE_PTHREAD */
505 const char cgi_h_rcs[] = CGI_H_VERSION;
508 * List of CGI functions: name, handler, description
509 * Note: Do NOT use single quotes in the description;
510 * this will break the dynamic "blocked" template!
512 static const struct cgi_dispatcher cgi_dispatchers[] = {
517 #ifdef FEATURE_GRACEFUL_TERMINATION
520 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
521 "this is a one click Denial Of Service attack!!!</em>",
526 #ifdef FEATURE_CGI_EDIT_ACTIONS
527 "View & change the current configuration",
529 "View the current configuration",
534 "View the source code version numbers",
538 "View the request headers.",
542 "Look up which actions apply to a URL and why",
544 #ifdef FEATURE_CGI_EDIT_ACTIONS
547 "Toggle Privoxy on or off",
549 { "edit-actions", /* Edit the actions list */
552 { "eaa", /* Shortcut for edit-actions-add-url-form */
553 cgi_edit_actions_add_url_form,
555 { "eau", /* Shortcut for edit-actions-url-form */
556 cgi_edit_actions_url_form,
558 { "ear", /* Shortcut for edit-actions-remove-url-form */
559 cgi_edit_actions_remove_url_form,
561 { "eal", /* Shortcut for edit-actions-list */
562 cgi_edit_actions_list,
564 { "eafu", /* Shortcut for edit-actions-for-url */
565 cgi_edit_actions_for_url,
567 { "eas", /* Shortcut for edit-actions-submit */
568 cgi_edit_actions_submit,
570 { "easa", /* Shortcut for edit-actions-section-add */
571 cgi_edit_actions_section_add,
573 { "easr", /* Shortcut for edit-actions-section-remove */
574 cgi_edit_actions_section_remove,
576 { "eass", /* Shortcut for edit-actions-section-swap */
577 cgi_edit_actions_section_swap,
579 { "edit-actions-for-url",
580 cgi_edit_actions_for_url,
581 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
582 { "edit-actions-list",
583 cgi_edit_actions_list,
584 NULL, TRUE /* Edit the actions list */ },
585 { "edit-actions-submit",
586 cgi_edit_actions_submit,
587 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
588 { "edit-actions-url",
589 cgi_edit_actions_url,
590 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
591 { "edit-actions-url-form",
592 cgi_edit_actions_url_form,
593 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
594 { "edit-actions-add-url",
595 cgi_edit_actions_add_url,
596 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
597 { "edit-actions-add-url-form",
598 cgi_edit_actions_add_url_form,
599 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
600 { "edit-actions-remove-url",
601 cgi_edit_actions_remove_url,
602 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
603 { "edit-actions-remove-url-form",
604 cgi_edit_actions_remove_url_form,
605 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
606 { "edit-actions-section-add",
607 cgi_edit_actions_section_add,
608 NULL, FALSE /* Remove a section from the actionsfile */ },
609 { "edit-actions-section-remove",
610 cgi_edit_actions_section_remove,
611 NULL, FALSE /* Remove a section from the actionsfile */ },
612 { "edit-actions-section-swap",
613 cgi_edit_actions_section_swap,
614 NULL, FALSE /* Swap two sections in the actionsfile */ },
615 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
618 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
621 NULL, TRUE /* Send a built-in image */ },
624 NULL, TRUE /* Send templates/cgi-style.css */ },
626 cgi_transparent_image,
627 NULL, TRUE /* Send a transparent image (short name) */ },
629 cgi_send_user_manual,
630 NULL, TRUE /* Send user-manual */ },
631 { NULL, /* NULL Indicates end of list and default page */
633 NULL, TRUE /* Unknown CGI page */ }
638 * Built-in images for ad replacement
640 * Hint: You can encode your own images like this:
641 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
644 #ifdef FEATURE_NO_GIFS
647 * Checkerboard pattern, as a PNG.
649 const char image_pattern_data[] =
650 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
651 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
652 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
653 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
654 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
655 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
656 "\000\000\000\111\105\116\104\256\102\140\202";
659 * 1x1 transparant PNG.
661 const char image_blank_data[] =
662 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
663 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
664 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
665 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
666 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
667 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
668 "\000\000\000\000\111\105\116\104\256\102\140\202";
672 * Checkerboard pattern, as a GIF.
674 const char image_pattern_data[] =
675 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
676 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
677 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
678 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
682 * 1x1 transparant GIF.
684 const char image_blank_data[] =
685 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
686 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
687 "\000\001\000\000\002\002D\001\000;";
690 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
691 const size_t image_blank_length = sizeof(image_blank_data) - 1;
694 static struct http_response cgi_error_memory_response[1];
696 static struct http_response *dispatch_known_cgi(struct client_state * csp,
698 static struct map *parse_cgi_parameters(char *argstring);
701 /*********************************************************************
703 * Function : dispatch_cgi
705 * Description : Checks if a request URL has either the magical
706 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
707 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
708 * http://config.privoxy.org/). If so, it passes
709 * the (rest of the) path onto dispatch_known_cgi, which
710 * calls the relevant CGI handler function.
713 * 1 : csp = Current client state (buffers, headers, etc...)
715 * Returns : http_response if match, NULL if nonmatch or handler fail
717 *********************************************************************/
718 struct http_response *dispatch_cgi(struct client_state *csp)
720 const char *host = csp->http->host;
721 const char *path = csp->http->path;
724 * Should we intercept ?
727 /* Note: "example.com" and "example.com." are equivalent hostnames. */
729 /* Either the host matches CGI_SITE_1_HOST ..*/
730 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
731 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
732 && (path[0] == '/') )
734 /* ..then the path will all be for us. Remove leading '/' */
737 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
738 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
739 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
740 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
742 /* take everything following CGI_SITE_2_PATH */
743 path += strlen(CGI_SITE_2_PATH);
746 /* skip the forward slash after CGI_SITE_2_PATH */
749 else if (*path != '\0')
752 * weirdness: URL is /configXXX, where XXX is some string
753 * Do *NOT* intercept.
765 * This is a CGI call.
768 return dispatch_known_cgi(csp, path);
772 /*********************************************************************
774 * Function : grep_cgi_referrer
776 * Description : Ugly provisorical fix that greps the value of the
777 * referer HTTP header field out of a linked list of
778 * strings like found at csp->headers. Will disappear
781 * FIXME: csp->headers ought to be csp->http->headers
782 * FIXME: Parsing all client header lines should
783 * happen right after the request is received!
786 * 1 : csp = Current client state (buffers, headers, etc...)
788 * Returns : pointer to value (no copy!), or NULL if none found.
790 *********************************************************************/
791 char *grep_cgi_referrer(struct client_state *csp)
793 struct list_entry *p;
795 for (p = csp->headers->first; p != NULL; p = p->next)
797 if (p->str == NULL) continue;
798 if (strncmpic(p->str, "Referer: ", 9) == 0)
800 return ((p->str) + 9);
808 /*********************************************************************
810 * Function : dispatch_known_cgi
812 * Description : Processes a CGI once dispatch_cgi has determined that
813 * it matches one of the magic prefixes. Parses the path
814 * as a cgi name plus query string, prepares a map that
815 * maps CGI parameter names to their values, initializes
816 * the http_response struct, and calls the relevant CGI
820 * 1 : csp = Current client state (buffers, headers, etc...)
821 * 2 : path = Path of CGI, with the CGI prefix removed.
822 * Should not have a leading "/".
824 * Returns : http_response, or NULL on handler failure or out of
827 *********************************************************************/
828 static struct http_response *dispatch_known_cgi(struct client_state * csp,
831 const struct cgi_dispatcher *d;
832 struct map *param_list;
833 struct http_response *rsp;
834 char *query_args_start;
839 if (NULL == (path_copy = strdup(path)))
841 return cgi_error_memory();
843 query_args_start = path_copy;
844 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
848 if (*query_args_start == '/')
850 *query_args_start++ = '\0';
851 if ((param_list = new_map()))
853 map(param_list, "file", 1, url_decode(query_args_start), 0);
858 if (*query_args_start == '?')
860 *query_args_start++ = '\0';
862 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
865 return cgi_error_memory();
871 * path_copy = CGI call name
872 * param_list = CGI params, as map
875 /* Get mem for response or fail*/
876 if (NULL == (rsp = alloc_http_response()))
879 free_map(param_list);
880 return cgi_error_memory();
883 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
884 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
885 csp->ip_addr_str, csp->http->cmd);
888 * Find and start the right CGI function
893 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
896 * If the called CGI is either harmless, or referred
897 * from a trusted source, start it.
900 || ((NULL != (referrer = grep_cgi_referrer(csp)))
901 && (0 == strncmp(referrer, "http://config.privoxy.org/", 26)))
904 err = (d->handler)(csp, rsp, param_list);
909 * Else, modify toggle calls so that they only display
910 * the status, and deny all other calls.
912 if (0 == strcmp(path_copy, "toggle"))
914 unmap(param_list, "set");
915 err = (d->handler)(csp, rsp, param_list);
919 err = cgi_error_disabled(csp, rsp);
924 free_map(param_list);
926 if (err == JB_ERR_CGI_PARAMS)
928 err = cgi_error_bad_param(csp, rsp);
930 if (err && (err != JB_ERR_MEMORY))
932 /* Unexpected error! Shouldn't get here */
933 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
934 err = cgi_error_unknown(csp, rsp, err);
939 return finish_http_response(rsp);
943 /* Error in handler, probably out-of-memory */
944 free_http_response(rsp);
945 return cgi_error_memory();
953 /*********************************************************************
955 * Function : parse_cgi_parameters
957 * Description : Parse a URL-encoded argument string into name/value
958 * pairs and store them in a struct map list.
961 * 1 : argstring = string to be parsed. Will be trashed.
963 * Returns : pointer to param list, or NULL if out of memory.
965 *********************************************************************/
966 static struct map *parse_cgi_parameters(char *argstring)
969 char *vector[BUFFER_SIZE];
971 struct map *cgi_params;
973 if (NULL == (cgi_params = new_map()))
979 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
980 * the fragment identifier along with the request, so we must
981 * cut it off here, so it won't pollute the CGI params:
983 if (NULL != (p = strchr(argstring, '#')))
988 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
990 for (i = 0; i < pairs; i++)
992 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
995 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
997 free_map(cgi_params);
1008 /*********************************************************************
1010 * Function : get_char_param
1012 * Description : Get a single-character parameter passed to a CGI
1016 * 1 : parameters = map of cgi parameters
1017 * 2 : param_name = The name of the parameter to read
1019 * Returns : Uppercase character on success, '\0' on error.
1021 *********************************************************************/
1022 char get_char_param(const struct map *parameters,
1023 const char *param_name)
1030 ch = *(lookup(parameters, param_name));
1031 if ((ch >= 'a') && (ch <= 'z'))
1033 ch = ch - 'a' + 'A';
1040 /*********************************************************************
1042 * Function : get_string_param
1044 * Description : Get a string paramater, to be used as an
1045 * ACTION_STRING or ACTION_MULTI paramater.
1046 * Validates the input to prevent stupid/malicious
1047 * users from corrupting their action file.
1050 * 1 : parameters = map of cgi parameters
1051 * 2 : param_name = The name of the parameter to read
1052 * 3 : pparam = destination for paramater. Allocated as
1053 * part of the map "parameters", so don't free it.
1054 * Set to NULL if not specified.
1056 * Returns : JB_ERR_OK on success, or if the paramater
1057 * was not specified.
1058 * JB_ERR_MEMORY on out-of-memory.
1059 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1061 *********************************************************************/
1062 jb_err get_string_param(const struct map *parameters,
1063 const char *param_name,
1064 const char **pparam)
1076 param = lookup(parameters, param_name);
1082 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1087 * Note that the length limit is arbitrary, it just seems
1088 * sensible to limit it to *something*. There's no
1089 * technical reason for any limit at all.
1091 return JB_ERR_CGI_PARAMS;
1094 /* Check every character to see if it's legal */
1096 while ((ch = *s++) != '\0')
1098 if ( ((unsigned char)ch < (unsigned char)' ')
1101 /* Probable hack attempt, or user accidentally used '}'. */
1102 return JB_ERR_CGI_PARAMS;
1113 /*********************************************************************
1115 * Function : get_number_param
1117 * Description : Get a non-negative integer from the parameters
1118 * passed to a CGI function.
1121 * 1 : csp = Current client state (buffers, headers, etc...)
1122 * 2 : parameters = map of cgi parameters
1123 * 3 : name = Name of CGI parameter to read
1124 * 4 : pvalue = destination for value.
1125 * Set to -1 on error.
1127 * Returns : JB_ERR_OK on success
1128 * JB_ERR_MEMORY on out-of-memory
1129 * JB_ERR_CGI_PARAMS if the parameter was not specified
1132 *********************************************************************/
1133 jb_err get_number_param(struct client_state *csp,
1134 const struct map *parameters,
1149 param = lookup(parameters, name);
1152 return JB_ERR_CGI_PARAMS;
1155 /* We don't use atoi because I want to check this carefully... */
1158 while ((ch = *param++) != '\0')
1160 if ((ch < '0') || (ch > '9'))
1162 return JB_ERR_CGI_PARAMS;
1169 * <limits.h> defines UINT_MAX
1171 * (UINT_MAX - ch) / 10 is the largest number that
1172 * can be safely multiplied by 10 then have ch added.
1174 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1176 return JB_ERR_CGI_PARAMS;
1179 value = value * 10 + ch;
1190 /*********************************************************************
1192 * Function : error_response
1194 * Description : returns an http_response that explains the reason
1195 * why a request failed.
1198 * 1 : csp = Current client state (buffers, headers, etc...)
1199 * 2 : templatename = Which template should be used for the answer
1200 * 3 : sys_err = system error number
1202 * Returns : A http_response. If we run out of memory, this
1203 * will be cgi_error_memory().
1205 *********************************************************************/
1206 struct http_response *error_response(struct client_state *csp,
1207 const char *templatename,
1211 struct http_response *rsp;
1212 struct map * exports = default_exports(csp, NULL);
1213 if (exports == NULL)
1215 return cgi_error_memory();
1218 if (NULL == (rsp = alloc_http_response()))
1221 return cgi_error_memory();
1224 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1225 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1226 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1227 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1228 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1231 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1234 /* Some failures, like "404 no such domain", don't have an IP address. */
1235 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1243 free_http_response(rsp);
1244 return cgi_error_memory();
1247 if (!strcmp(templatename, "no-such-domain"))
1249 rsp->status = strdup("404 No such domain");
1250 if (rsp->status == NULL)
1253 free_http_response(rsp);
1254 return cgi_error_memory();
1257 else if (!strcmp(templatename, "connect-failed"))
1259 rsp->status = strdup("503 Connect failed");
1260 if (rsp->status == NULL)
1263 free_http_response(rsp);
1264 return cgi_error_memory();
1268 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1271 free_http_response(rsp);
1272 return cgi_error_memory();
1275 return finish_http_response(rsp);
1279 /*********************************************************************
1281 * Function : cgi_error_disabled
1283 * Description : CGI function that is called to generate an error
1284 * response if the actions editor or toggle CGI are
1285 * accessed despite having being disabled at compile-
1289 * 1 : csp = Current client state (buffers, headers, etc...)
1290 * 2 : rsp = http_response data structure for output
1292 * CGI Parameters : none
1294 * Returns : JB_ERR_OK on success
1295 * JB_ERR_MEMORY on out-of-memory error.
1297 *********************************************************************/
1298 jb_err cgi_error_disabled(struct client_state *csp,
1299 struct http_response *rsp)
1301 struct map *exports;
1306 if (NULL == (exports = default_exports(csp, NULL)))
1308 return JB_ERR_MEMORY;
1311 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1315 /*********************************************************************
1317 * Function : cgi_init_error_messages
1319 * Description : Call at the start of the program to initialize
1320 * the error message used by cgi_error_memory().
1326 *********************************************************************/
1327 void cgi_init_error_messages(void)
1329 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1330 cgi_error_memory_response->head =
1331 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1332 "Content-Type: text/html\r\n"
1334 cgi_error_memory_response->body =
1336 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1338 "<h1>500 Internal Privoxy Error</h1>\r\n"
1339 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1340 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1344 cgi_error_memory_response->head_length =
1345 strlen(cgi_error_memory_response->head);
1346 cgi_error_memory_response->content_length =
1347 strlen(cgi_error_memory_response->body);
1351 /*********************************************************************
1353 * Function : cgi_error_memory
1355 * Description : Called if a CGI function runs out of memory.
1356 * Returns a statically-allocated error response.
1360 * Returns : http_response data structure for output. This is
1361 * statically allocated, for obvious reasons.
1363 *********************************************************************/
1364 struct http_response *cgi_error_memory(void)
1366 /* assert that it's been initialized. */
1367 assert(cgi_error_memory_response->head);
1369 return cgi_error_memory_response;
1373 /*********************************************************************
1375 * Function : cgi_error_no_template
1377 * Description : Almost-CGI function that is called if a template
1378 * cannot be loaded. Note this is not a true CGI,
1379 * it takes a template name rather than a map of
1383 * 1 : csp = Current client state (buffers, headers, etc...)
1384 * 2 : rsp = http_response data structure for output
1385 * 3 : template_name = Name of template that could not
1388 * Returns : JB_ERR_OK on success
1389 * JB_ERR_MEMORY on out-of-memory error.
1391 *********************************************************************/
1392 jb_err cgi_error_no_template(struct client_state *csp,
1393 struct http_response *rsp,
1394 const char *template_name)
1396 static const char status[] =
1397 "500 Internal Privoxy Error";
1398 static const char body_prefix[] =
1400 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1402 "<h1>500 Internal Privoxy Error</h1>\r\n"
1403 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1404 "<p><b>Could not load template file <code>";
1405 static const char body_suffix[] =
1406 "</code> or one of it's included components.</b></p>\r\n"
1407 "<p>Please contact your proxy administrator.</p>\r\n"
1408 "<p>If you are the proxy administrator, please put the required file(s)"
1409 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1410 "location of the <code><i>(confdir)</i></code> directory "
1411 "is specified in the main Privoxy <code>config</code> "
1412 "file. (It's typically the Privoxy install directory"
1414 ", or <code>/etc/privoxy/</code>"
1415 #endif /* ndef _WIN32 */
1422 assert(template_name);
1424 /* Reset rsp, if needed */
1428 rsp->content_length = 0;
1429 rsp->head_length = 0;
1432 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1433 if (rsp->body == NULL)
1435 return JB_ERR_MEMORY;
1437 strcpy(rsp->body, body_prefix);
1438 strcat(rsp->body, template_name);
1439 strcat(rsp->body, body_suffix);
1441 rsp->status = strdup(status);
1442 if (rsp->body == NULL)
1444 return JB_ERR_MEMORY;
1451 /*********************************************************************
1453 * Function : cgi_error_unknown
1455 * Description : Almost-CGI function that is called if an unexpected
1456 * error occurs in the top-level CGI dispatcher.
1457 * In this context, "unexpected" means "anything other
1458 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1459 * expected to handle all other errors internally,
1460 * since they can give more relavent error messages
1463 * Note this is not a true CGI, it takes an error
1464 * code rather than a map of parameters.
1467 * 1 : csp = Current client state (buffers, headers, etc...)
1468 * 2 : rsp = http_response data structure for output
1469 * 3 : error_to_report = Error code to report.
1471 * Returns : JB_ERR_OK on success
1472 * JB_ERR_MEMORY on out-of-memory error.
1474 *********************************************************************/
1475 jb_err cgi_error_unknown(struct client_state *csp,
1476 struct http_response *rsp,
1477 jb_err error_to_report)
1479 static const char status[] =
1480 "500 Internal Privoxy Error";
1481 static const char body_prefix[] =
1483 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1485 "<h1>500 Internal Privoxy Error</h1>\r\n"
1486 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1487 "<p><b>Unexpected internal error: ";
1488 static const char body_suffix[] =
1491 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1492 "file a bug report</a>.</p>\r\n"
1499 /* Reset rsp, if needed */
1503 rsp->content_length = 0;
1504 rsp->head_length = 0;
1507 sprintf(errnumbuf, "%d", error_to_report);
1509 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1510 if (rsp->body == NULL)
1512 return JB_ERR_MEMORY;
1514 strcpy(rsp->body, body_prefix);
1515 strcat(rsp->body, errnumbuf);
1516 strcat(rsp->body, body_suffix);
1518 rsp->status = strdup(status);
1519 if (rsp->body == NULL)
1521 return JB_ERR_MEMORY;
1528 /*********************************************************************
1530 * Function : cgi_error_bad_param
1532 * Description : CGI function that is called if the parameters
1533 * (query string) for a CGI were wrong.
1536 * 1 : csp = Current client state (buffers, headers, etc...)
1537 * 2 : rsp = http_response data structure for output
1539 * CGI Parameters : none
1541 * Returns : JB_ERR_OK on success
1542 * JB_ERR_MEMORY on out-of-memory error.
1544 *********************************************************************/
1545 jb_err cgi_error_bad_param(struct client_state *csp,
1546 struct http_response *rsp)
1548 struct map *exports;
1553 if (NULL == (exports = default_exports(csp, NULL)))
1555 return JB_ERR_MEMORY;
1558 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1562 /*********************************************************************
1564 * Function : cgi_redirect
1566 * Description : CGI support function to generate a HTTP redirect
1570 * 1 : rsp = http_response data structure for output
1571 * 2 : target = string with the target URL
1573 * CGI Parameters : None
1575 * Returns : JB_ERR_OK on success
1576 * JB_ERR_MEMORY on out-of-memory error.
1578 *********************************************************************/
1579 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1586 err = enlist_unique_header(rsp->headers, "Location", target);
1588 rsp->status = strdup("302 Local Redirect from Privoxy");
1589 if (rsp->status == NULL)
1591 return JB_ERR_MEMORY;
1598 /*********************************************************************
1600 * Function : add_help_link
1602 * Description : Produce a copy of the string given as item,
1603 * embedded in an HTML link to its corresponding
1604 * section (item name in uppercase) in the actions
1605 * chapter of the user manual, (whose URL is given in
1606 * the config and defaults to our web site).
1608 * FIXME: I currently only work for actions, and would
1609 * like to be generalized for other topics.
1612 * 1 : item = item (will NOT be free()d.)
1613 * It is assumed to be HTML-safe.
1614 * 2 : config = The current configuration.
1616 * Returns : String with item embedded in link, or NULL on
1619 *********************************************************************/
1620 char *add_help_link(const char *item,
1621 struct configuration_spec *config)
1625 if (!item) return NULL;
1627 result = strdup("<a href=\"");
1628 if (!strncmpic(config->usermanual, "file://", 7) ||
1629 !strncmpic(config->usermanual, "http", 4))
1631 string_append(&result, config->usermanual);
1635 string_append(&result, "http://");
1636 string_append(&result, CGI_SITE_2_HOST);
1637 string_append(&result, "/user-manual/");
1639 string_append(&result, ACTIONS_HELP_PREFIX);
1640 string_join (&result, string_toupper(item));
1641 string_append(&result, "\">");
1642 string_append(&result, item);
1643 string_append(&result, "</a> ");
1649 /*********************************************************************
1651 * Function : get_http_time
1653 * Description : Get the time in a format suitable for use in a
1654 * HTTP header - e.g.:
1655 * "Sun, 06 Nov 1994 08:49:37 GMT"
1658 * 1 : time_offset = Time returned will be current time
1659 * plus this number of seconds.
1660 * 2 : buf = Destination for result. Must be long enough
1661 * to hold 29 characters plus a trailing zero.
1665 *********************************************************************/
1666 void get_http_time(int time_offset, char *buf)
1668 static const char day_names[7][4] =
1669 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1670 static const char month_names[12][4] =
1671 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1672 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1675 time_t current_time;
1676 #if defined(HAVE_GMTIME_R) && !defined(OSX_DARWIN)
1678 * Declare dummy up here (instead of inside get/set gmt block) so it
1679 * doesn't go out of scope before it's potentially used in snprintf later.
1680 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1681 * !defined HAVE_GMTIME_R.
1688 time(¤t_time); /* get current time */
1690 current_time += time_offset;
1692 /* get and save the gmt */
1695 pthread_mutex_lock(&gmtime_mutex);
1696 t = gmtime(¤t_time);
1697 pthread_mutex_unlock(&gmtime_mutex);
1699 t = gmtime_r(¤t_time, &dummy);
1701 t = gmtime(¤t_time);
1705 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1707 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1708 day_names[t->tm_wday],
1710 month_names[t->tm_mon],
1720 /*********************************************************************
1722 * Function : finish_http_response
1724 * Description : Fill in the missing headers in an http response,
1725 * and flatten the headers to an http head.
1728 * 1 : rsp = pointer to http_response to be processed
1730 * Returns : A http_response, usually the rsp parameter.
1731 * On error, free()s rsp and returns cgi_error_memory()
1733 *********************************************************************/
1734 struct http_response *finish_http_response(struct http_response *rsp)
1736 char buf[BUFFER_SIZE];
1739 /* Special case - do NOT change this statically allocated response,
1740 * which is ready for output anyway.
1742 if (rsp == cgi_error_memory_response)
1748 * Fill in the HTTP Status
1750 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1751 err = enlist_first(rsp->headers, buf);
1754 * Set the Content-Length
1756 if (rsp->content_length == 0)
1758 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1762 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1763 err = enlist(rsp->headers, buf);
1767 * Fill in the default headers:
1769 * Content-Type: default to text/html if not already specified.
1770 * Date: set to current date/time.
1771 * Last-Modified: set to date/time the page was last changed.
1772 * Expires: set to date/time page next needs reloading.
1773 * Cache-Control: set to "no-cache" if applicable.
1775 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1777 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1782 * Set Expires to about 10 min into the future so it'll get reloaded
1783 * occasionally, e.g. if Privoxy gets upgraded.
1788 get_http_time(0, buf);
1789 err = enlist_unique_header(rsp->headers, "Date", buf);
1792 /* Some date in the past. */
1793 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1797 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1798 err = enlist_unique_header(rsp->headers, "Expires", buf);
1804 * Setting "Cache-Control" to "no-cache" and "Expires" to
1805 * the current time doesn't exactly forbid caching, it just
1806 * requires the client to revalidate the cached copy.
1808 * If a temporary problem occurres and the user tries again after
1809 * getting Privoxy's error message, a compliant browser may set the
1810 * If-Modified-Since header with the content of the error page's
1811 * Last-Modified header. More often than not, the document on the server
1812 * is older than Privoxy's error message, the server would send status code
1813 * 304 and the browser would display the outdated error message again and again.
1815 * As a last resort we set "Last-Modified" to Tim Berners-Lee's birthday,
1816 * which predates the age of any page on the web and can be safely used to
1817 * "revalidate" without getting a status code 304.
1819 * There is no need to let the useless If-Modified-Since header reach the
1820 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1822 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1824 get_http_time(0, buf);
1825 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1826 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1827 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1828 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1835 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1837 free_http_response(rsp);
1838 return cgi_error_memory();
1840 rsp->head_length = strlen(rsp->head);
1847 /*********************************************************************
1849 * Function : alloc_http_response
1851 * Description : Allocates a new http_response structure.
1855 * Returns : pointer to a new http_response, or NULL.
1857 *********************************************************************/
1858 struct http_response *alloc_http_response(void)
1860 return (struct http_response *) zalloc(sizeof(struct http_response));
1865 /*********************************************************************
1867 * Function : free_http_response
1869 * Description : Free the memory occupied by an http_response
1870 * and its depandant structures.
1873 * 1 : rsp = pointer to http_response to be freed
1877 *********************************************************************/
1878 void free_http_response(struct http_response *rsp)
1881 * Must special case cgi_error_memory_response, which is never freed.
1883 if (rsp && (rsp != cgi_error_memory_response))
1888 destroy_list(rsp->headers);
1895 /*********************************************************************
1897 * Function : template_load
1899 * Description : CGI support function that loads a given HTML
1900 * template from the confdir, ignoring comment
1901 * lines and following #include statements up to
1905 * 1 : csp = Current client state (buffers, headers, etc...)
1906 * 2 : template_ptr = Destination for pointer to loaded
1908 * 3 : templatename = name of the HTML template to be used
1909 * 4 : recursive = Flag set if this function calls itself
1910 * following an #include statament
1912 * Returns : JB_ERR_OK on success
1913 * JB_ERR_MEMORY on out-of-memory error.
1914 * JB_ERR_FILE if the template file cannot be read
1916 *********************************************************************/
1917 jb_err template_load(struct client_state *csp, char **template_ptr,
1918 const char *templatename, int recursive)
1921 char *templates_dir_path;
1924 char *included_module;
1927 char buf[BUFFER_SIZE];
1930 assert(template_ptr);
1931 assert(templatename);
1933 *template_ptr = NULL;
1935 /* Validate template name. Paranoia. */
1936 for (p = templatename; *p != 0; p++)
1938 if ( ((*p < 'a') || (*p > 'z'))
1939 && ((*p < 'A') || (*p > 'Z'))
1940 && ((*p < '0') || (*p > '9'))
1944 /* Illegal character */
1949 /* Generate full path */
1951 templates_dir_path = make_path(csp->config->confdir, "templates");
1952 if (templates_dir_path == NULL)
1954 return JB_ERR_MEMORY;
1957 full_path = make_path(templates_dir_path, templatename);
1958 free(templates_dir_path);
1959 if (full_path == NULL)
1961 return JB_ERR_MEMORY;
1964 /* Allocate buffer */
1966 file_buffer = strdup("");
1967 if (file_buffer == NULL)
1970 return JB_ERR_MEMORY;
1973 /* Open template file */
1975 if (NULL == (fp = fopen(full_path, "r")))
1977 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1985 * Read the file, ignoring comments, and honoring #include
1986 * statements, unless we're already called recursively.
1988 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1989 * This is unlikely in practise.
1991 while (fgets(buf, BUFFER_SIZE, fp))
1993 if (!recursive && !strncmp(buf, "#include ", 9))
1995 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2002 if (string_join(&file_buffer, included_module))
2005 return JB_ERR_MEMORY;
2011 /* skip lines starting with '#' */
2017 if (string_append(&file_buffer, buf))
2020 return JB_ERR_MEMORY;
2025 *template_ptr = file_buffer;
2031 /*********************************************************************
2033 * Function : template_fill
2035 * Description : CGI support function that fills in a pre-loaded
2036 * HTML template by replacing @name@ with value using
2037 * pcrs, for each item in the output map.
2039 * Note that a leading '$' charachter in the export map's
2040 * values will be stripped and toggle on backreference
2044 * 1 : template_ptr = IN: Template to be filled out.
2046 * OUT: Filled out template.
2047 * Caller must free().
2048 * 2 : exports = map with fill in symbol -> name pairs
2050 * Returns : JB_ERR_OK on success
2051 * JB_ERR_MEMORY on out-of-memory error
2053 *********************************************************************/
2054 jb_err template_fill(char **template_ptr, const struct map *exports)
2056 struct map_entry *m;
2058 char buf[BUFFER_SIZE];
2059 char *tmp_out_buffer;
2065 assert(template_ptr);
2066 assert(*template_ptr);
2069 file_buffer = *template_ptr;
2070 size = strlen(file_buffer) + 1;
2073 * Assemble pcrs joblist from exports map
2075 for (m = exports->first; m != NULL; m = m->next)
2077 if (*m->name == '$')
2080 * First character of name is '$', so remove this flag
2081 * character and allow backreferences ($1 etc) in the
2082 * "replace with" text.
2084 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2090 * Treat the "replace with" text as a literal string -
2091 * no quoting needed, no backreferences allowed.
2092 * ("Trivial" ['T'] flag).
2096 /* Enclose name in @@ */
2097 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2101 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2103 /* Make and run job. */
2104 job = pcrs_compile(buf, m->value, flags, &error);
2107 if (error == PCRS_ERR_NOMEM)
2110 *template_ptr = NULL;
2111 return JB_ERR_MEMORY;
2115 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2116 /* Hope it wasn't important and silently ignore the invalid job */
2121 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2124 if (NULL == tmp_out_buffer)
2126 *template_ptr = NULL;
2127 return JB_ERR_MEMORY;
2129 file_buffer = tmp_out_buffer;
2136 *template_ptr = file_buffer;
2141 /*********************************************************************
2143 * Function : template_fill_for_cgi
2145 * Description : CGI support function that loads a HTML template
2146 * and fills it in. Handles file-not-found errors
2147 * by sending a HTML error message. For convenience,
2148 * this function also frees the passed "exports" map.
2151 * 1 : csp = Client state
2152 * 2 : templatename = name of the HTML template to be used
2153 * 3 : exports = map with fill in symbol -> name pairs.
2154 * Will be freed by this function.
2155 * 4 : rsp = Response structure to fill in.
2157 * Returns : JB_ERR_OK on success
2158 * JB_ERR_MEMORY on out-of-memory error
2160 *********************************************************************/
2161 jb_err template_fill_for_cgi(struct client_state *csp,
2162 const char *templatename,
2163 struct map *exports,
2164 struct http_response *rsp)
2169 assert(templatename);
2173 err = template_load(csp, &rsp->body, templatename, 0);
2174 if (err == JB_ERR_FILE)
2177 return cgi_error_no_template(csp, rsp, templatename);
2182 return err; /* JB_ERR_MEMORY */
2184 err = template_fill(&rsp->body, exports);
2190 /*********************************************************************
2192 * Function : default_exports
2194 * Description : returns a struct map list that contains exports
2195 * which are common to all CGI functions.
2198 * 1 : csp = Current client state (buffers, headers, etc...)
2199 * 2 : caller = name of CGI who calls us and which should
2200 * be excluded from the generated menu. May be
2202 * Returns : NULL if no memory, else a new map. Caller frees.
2204 *********************************************************************/
2205 struct map *default_exports(const struct client_state *csp, const char *caller)
2209 struct map * exports;
2210 int local_help_exists = 0;
2214 exports = new_map();
2215 if (exports == NULL)
2220 err = map(exports, "version", 1, html_encode(VERSION), 0);
2221 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2222 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2223 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2224 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2225 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
2226 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2227 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2228 !strncmpic(csp->config->usermanual, "http", 4))
2230 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2234 if (!err) err = map(exports, "user-manual", 1, "http://"CGI_SITE_2_HOST"/user-manual/" ,1);
2236 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2237 #ifdef FEATURE_TOGGLE
2238 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2240 if (!err) err = map_block_killer(exports, "can-toggle");
2243 snprintf(buf, 20, "%d", csp->config->hport);
2244 if (!err) err = map(exports, "my-port", 1, buf, 1);
2246 if(!strcmp(CODE_STATUS, "stable"))
2248 if (!err) err = map_block_killer(exports, "unstable");
2251 if (csp->config->admin_address != NULL)
2253 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2254 local_help_exists = 1;
2258 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2261 if (csp->config->proxy_info_url != NULL)
2263 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2264 local_help_exists = 1;
2268 if (!err) err = map_block_killer(exports, "have-proxy-info");
2271 if (local_help_exists == 0)
2273 if (!err) err = map_block_killer(exports, "have-help-info");
2286 /*********************************************************************
2288 * Function : map_block_killer
2290 * Description : Convenience function.
2291 * Adds a "killer" for the conditional HTML-template
2292 * block <name>, i.e. a substitution of the regex
2293 * "if-<name>-start.*if-<name>-end" to the given
2297 * 1 : exports = map to extend
2298 * 2 : name = name of conditional block
2300 * Returns : JB_ERR_OK on success
2301 * JB_ERR_MEMORY on out-of-memory error.
2303 *********************************************************************/
2304 jb_err map_block_killer(struct map *exports, const char *name)
2306 char buf[1000]; /* Will do, since the names are hardwired */
2310 assert(strlen(name) < 490);
2312 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2313 return map(exports, buf, 1, "", 1);
2317 /*********************************************************************
2319 * Function : map_block_keep
2321 * Description : Convenience function. Removes the markers used
2322 * by map-block-killer, to save a few bytes.
2323 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2326 * 1 : exports = map to extend
2327 * 2 : name = name of conditional block
2329 * Returns : JB_ERR_OK on success
2330 * JB_ERR_MEMORY on out-of-memory error.
2332 *********************************************************************/
2333 jb_err map_block_keep(struct map *exports, const char *name)
2336 char buf[500]; /* Will do, since the names are hardwired */
2340 assert(strlen(name) < 490);
2342 snprintf(buf, 500, "if-%s-start", name);
2343 err = map(exports, buf, 1, "", 1);
2350 snprintf(buf, 500, "if-%s-end", name);
2351 return map(exports, buf, 1, "", 1);
2355 /*********************************************************************
2357 * Function : map_conditional
2359 * Description : Convenience function.
2360 * Adds an "if-then-else" for the conditional HTML-template
2361 * block <name>, i.e. a substitution of the form:
2368 * The control structure and one of the alternatives
2372 * 1 : exports = map to extend
2373 * 2 : name = name of conditional block
2374 * 3 : choose_first = nonzero for first, zero for second.
2376 * Returns : JB_ERR_OK on success
2377 * JB_ERR_MEMORY on out-of-memory error.
2379 *********************************************************************/
2380 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2382 char buf[1000]; /* Will do, since the names are hardwired */
2387 assert(strlen(name) < 480);
2389 snprintf(buf, 1000, (choose_first
2390 ? "else-not-%s@.*@endif-%s"
2391 : "if-%s-then@.*@else-not-%s"),
2394 err = map(exports, buf, 1, "", 1);
2400 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2401 return map(exports, buf, 1, "", 1);
2405 /*********************************************************************
2407 * Function : make_menu
2409 * Description : Returns an HTML-formatted menu of the available
2410 * unhidden CGIs, excluding the one given in <self>
2412 * Parameters : self = name of CGI to leave out, can be NULL for
2415 * Returns : menu string, or NULL on out-of-memory error.
2417 *********************************************************************/
2418 char *make_menu(const char *self)
2420 const struct cgi_dispatcher *d;
2421 char *result = strdup("");
2425 self = "NO-SUCH-CGI!";
2428 /* List available unhidden CGI's and export as "other-cgis" */
2429 for (d = cgi_dispatchers; d->name; d++)
2431 if (d->description && strcmp(d->name, self))
2433 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2434 string_append(&result, d->name);
2435 string_append(&result, "\">");
2436 string_append(&result, d->description);
2437 string_append(&result, "</a></li>");
2445 /*********************************************************************
2447 * Function : dump_map
2449 * Description : HTML-dump a map for debugging (as table)
2452 * 1 : the_map = map to dump
2454 * Returns : string with HTML
2456 *********************************************************************/
2457 char *dump_map(const struct map *the_map)
2459 struct map_entry *cur_entry;
2460 char *ret = strdup("");
2462 string_append(&ret, "<table>\n");
2464 for (cur_entry = the_map->first;
2465 (cur_entry != NULL) && (ret != NULL);
2466 cur_entry = cur_entry->next)
2468 string_append(&ret, "<tr><td><b>");
2469 string_join (&ret, html_encode(cur_entry->name));
2470 string_append(&ret, "</b></td><td>");
2471 string_join (&ret, html_encode(cur_entry->value));
2472 string_append(&ret, "</td></tr>\n");
2475 string_append(&ret, "</table>\n");