1 const char cgi_rcs[] = "$Id: cgi.c,v 1.79 2006/11/13 19:05:50 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.79 2006/11/13 19:05:50 fabiankeil
42 * Make pthread mutex locking more generic. Instead of
43 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
44 * and use mutex locking unless there is an _r function
45 * available. Better safe than sorry.
47 * Fixes "./configure --disable-pthread" and should result
48 * in less threading-related problems on pthread-using platforms,
49 * but it still doesn't fix BR#1122404.
51 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
52 * Use CGI_PREFIX to check the referrer.
53 * The check for "http://config.privoxy.org/" fails
54 * if the user modified CGI_SITE_2_HOST.
56 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
57 * Adjusted headers for Privoxy's cgi responses:
58 * Don't set Last-Modified, Expires and Cache-Control
59 * headers for redirects; always set "Connection: close".
61 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
62 * Only predate the Last-Modified header for cgi responses
63 * that are delivered with status code 404 or 503.
65 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
66 * Mark cgi_send_user_manual as harmless,
67 * to fix the access denied problem Hal spotted.
68 * The manual has no secret content, therefore we
69 * don't have to care about "secure" referrers.
71 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
72 * Incorporate modified version of Roland Rosenfeld's patch to
73 * optionally access the user-manual via Privoxy. Closes patch 679075.
75 * Formatting changed to Privoxy style, added call to
76 * cgi_error_no_template if the requested file doesn't
77 * exist and modified check whether or not Privoxy itself
78 * should serve the manual. Should work cross-platform now.
80 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
81 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
83 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
84 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
85 * with what was really the latest development (the v_3_0_branch branch)
87 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
88 * Moved cgi_error_disabled() from cgiedit.c to
89 * cgi.c to re-enable build with --disable-editor.
90 * Fixes Bug #892744. Thanks to Matthew Fischer
93 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
94 * - Added new function cgi_redirect to handle creation of
95 * HTTP redirect messages formerly repeated in the code.
96 * - Send cgi_error_disabled instead of cgi_error_404 when
97 * referrer check fails
98 * - Dynamic content now gets Expires header field with date
101 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
102 * Bugfix: Transparent PNG was not transparent. Thanks to
103 * Dan Razzell of Starfish Systems for notice and new PNG.
105 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
106 * Security fix: dspatch_known_cgi no longer considers an empty
107 * referrer safe for critical CGIs, since malicious links could
108 * reside on https:// locations which browsers don't advertize as
109 * referrers. Closes bug #749916, thanks to Jeff Epler for the
110 * hint. Goodbye One-Click[tm] toggling :-(
112 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
115 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
116 * Killed a compiler warning on OSX
118 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
119 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
120 * (fixes bug #710056)
121 * - Show toggle info only if we have it
123 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
124 * Move declaration of struct tm dummy outside of a control block so it is
125 * accessible later on during snprintf in get_http_time.
127 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
128 * Cosmetic: Renamed cryptic variable
130 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
131 * 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.
133 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
134 * Disable access to critical CGIs via untrusted referrers.
135 * This prevents users from being tricked by malicious websites
136 * into making unintentional configuration changes:
138 * - Added flag to each cgi_dispatcher that allows or denies
140 * - Introduced proviorical function that greps for the
141 * referrer header before regular header parsing happens
142 * - Added safety check to dispatch_known_cgi. CGI is called
143 * if (cgi harmless || no referrer || we are referrer).
144 * Else a) toggle calls are modified not to change status and
145 * b) all other calls are denied.
147 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
148 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
150 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
151 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
153 * Revision 1.70 2002/05/19 11:33:20 jongfoster
154 * If a CGI error was not handled, and propogated back to
155 * dispatch_known_cgi(), then it was assumed to be "out of memory".
156 * This gave a very misleading error message.
158 * Now other errors will cause a simple message giving the error
159 * number and asking the user to report a bug.
162 * http://sourceforge.net/tracker/index.php?func=detail
163 * &aid=557905&group_id=11118&atid=111118
165 * Revision 1.69 2002/05/14 21:28:40 oes
166 * - Fixed add_help_link to link to the (now split) actions
167 * part of the config chapter
168 * - Renamed helplink export to actions-help-prefix
170 * Revision 1.68 2002/05/12 21:36:29 jongfoster
171 * Correcting function comments
173 * Revision 1.67 2002/04/30 12:02:07 oes
174 * Nit: updated a comment
176 * Revision 1.66 2002/04/26 18:32:57 jongfoster
177 * Fixing a memory leak on error
179 * Revision 1.65 2002/04/26 12:53:51 oes
180 * - New function add_help_link
181 * - default_exports now exports links to the user manual
182 * and a prefix for links into the config chapter
184 * Revision 1.64 2002/04/24 02:17:21 oes
185 * - Better descriptions for CGIs
186 * - Hide edit-actions, more shortcuts
187 * - Moved get_char_param, get_string_param and get_number_param here
190 * Revision 1.63 2002/04/15 19:06:43 jongfoster
193 * Revision 1.62 2002/04/10 19:59:46 jongfoster
194 * Fixes to #include in templates:
195 * - Didn't close main file if loading an included template fails.
196 * - I'm paranoid and want to disallow "#include /etc/passwd".
198 * Revision 1.61 2002/04/10 13:37:48 oes
199 * Made templates modular: template_load now recursive with max depth 1
201 * Revision 1.60 2002/04/08 20:50:25 swa
204 * Revision 1.59 2002/04/05 15:51:51 oes
205 * - added send-stylesheet CGI
206 * - bugfix: error-pages now get correct request protocol
208 * - kludged CGI descriptions and menu not to break JS syntax
210 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
211 * Fix Mac OSX compiler warnings
213 * Revision 1.57 2002/03/26 22:29:54 swa
214 * we have a new homepage!
216 * Revision 1.56 2002/03/24 17:50:46 jongfoster
217 * Fixing compile error if actions file editor disabled
219 * Revision 1.55 2002/03/24 16:55:06 oes
220 * Making GIF checkerboard transparent
222 * Revision 1.54 2002/03/24 16:18:15 jongfoster
225 * Revision 1.53 2002/03/24 16:06:00 oes
226 * Correct transparency for checkerboard PNG. Thanks, Magnus!
228 * Revision 1.52 2002/03/24 15:23:33 jongfoster
231 * Revision 1.51 2002/03/24 13:25:43 swa
232 * name change related issues
234 * Revision 1.50 2002/03/16 23:54:06 jongfoster
235 * Adding graceful termination feature, to help look for memory leaks.
236 * If you enable this (which, by design, has to be done by hand
237 * editing config.h) and then go to http://i.j.b/die, then the program
238 * will exit cleanly after the *next* request. It should free all the
239 * memory that was used.
241 * Revision 1.49 2002/03/13 00:27:04 jongfoster
244 * Revision 1.48 2002/03/08 17:47:07 jongfoster
247 * Revision 1.47 2002/03/08 16:41:33 oes
248 * Added GIF images again
250 * Revision 1.46 2002/03/07 03:48:38 oes
251 * - Changed built-in images from GIF to PNG
252 * (with regard to Unisys patent issue)
253 * - Added a 4x4 pattern PNG which is less intrusive
254 * than the logo but also clearly marks the deleted banners
256 * Revision 1.45 2002/03/06 22:54:35 jongfoster
257 * Automated function-comment nitpicking.
259 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
260 * - Better error reporting on OS/2
261 * - Fix double-slash comment (oops)
263 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
264 * - Re-enable OS/2 building after new parms were added
265 * - Fix false out of memory report when resolving CGI templates when no IP
266 * address is available of failed attempt (a la no such domain)
268 * Revision 1.42 2002/01/21 00:33:20 jongfoster
269 * Replacing strsav() with the safer string_append() or string_join().
270 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
271 * Adding missing html_encode() to error message generators.
272 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
274 * Revision 1.41 2002/01/17 20:56:22 jongfoster
275 * Replacing hard references to the URL of the config interface
276 * with #defines from project.h
278 * Revision 1.40 2002/01/09 14:26:46 oes
279 * Added support for thread-safe gmtime_r call.
281 * Revision 1.39 2001/11/16 00:48:13 jongfoster
282 * Fixing a compiler warning
284 * Revision 1.38 2001/11/13 00:31:21 jongfoster
285 * - Adding new CGIs for use by non-JavaScript browsers:
286 * edit-actions-url-form
287 * edit-actions-add-url-form
288 * edit-actions-remove-url-form
289 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
292 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
293 * Show enablement/disablement status in almost all templates.
294 * There is a little trickiness here: apparent recursive resolution of
295 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
296 * the actual enablement status. So a similar construct,
297 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
300 * Revision 1.36 2001/10/26 17:33:27 oes
303 * Revision 1.35 2001/10/23 21:48:19 jongfoster
304 * Cleaning up error handling in CGI functions - they now send back
305 * a HTML error page and should never cause a FATAL error. (Fixes one
306 * potential source of "denial of service" attacks).
308 * CGI actions file editor that works and is actually useful.
310 * Ability to toggle Junkbuster remotely using a CGI call.
312 * You can turn off both the above features in the main configuration
313 * file, e.g. if you are running a multi-user proxy.
315 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
316 * Only show "Local support" on templates conditionally:
317 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
318 * - if not, no Local support section appears
320 * Revision 1.33 2001/10/14 22:28:41 jongfoster
321 * Fixing stupid typo.
323 * Revision 1.32 2001/10/14 22:20:18 jongfoster
324 * - Changes to CGI dispatching method to match CGI names exactly,
325 * rather than doing a prefix match.
326 * - No longer need to count the length of the CGI handler names by hand.
327 * - Adding new handler for 404 error when disptching a CGI, if none of
328 * the handlers match.
329 * - Adding new handlers for CGI actionsfile editor.
331 * Revision 1.31 2001/10/10 10:56:39 oes
332 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
334 * Revision 1.30 2001/10/02 15:30:57 oes
335 * Introduced show-request cgi
337 * Revision 1.29 2001/09/20 15:47:44 steudten
339 * Fix BUG: Modify int size to size_t size in fill_template()
340 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
342 * Revision 1.28 2001/09/19 18:00:37 oes
343 * - Deletef time() FIXME (Can't fail under Linux either, if
344 * the argument is guaranteed to be in out address space,
347 * - Pointer notation cosmetics
348 * - Fixed a minor bug in template_fill(): Failiure of
349 * pcrs_execute() now secure.
351 * Revision 1.27 2001/09/16 17:08:54 jongfoster
352 * Moving simple CGI functions from cgi.c to new file cgisimple.c
354 * Revision 1.26 2001/09/16 15:47:37 jongfoster
355 * First version of CGI-based edit interface. This is very much a
356 * work-in-progress, and you can't actually use it to edit anything
357 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
358 * to have any effect.
360 * Revision 1.25 2001/09/16 15:02:35 jongfoster
361 * Adding i.j.b/robots.txt.
362 * Inlining add_stats() since it's only ever called from one place.
364 * Revision 1.24 2001/09/16 11:38:01 jongfoster
365 * Splitting fill_template() into 2 functions:
366 * template_load() loads the file
367 * template_fill() performs the PCRS regexps.
368 * This is because the CGI edit interface has a "table row"
369 * template which is used many times in the page - this
370 * change means it's only loaded from disk once.
372 * Revision 1.23 2001/09/16 11:16:05 jongfoster
373 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
375 * Revision 1.22 2001/09/16 11:00:10 jongfoster
376 * New function alloc_http_response, for symmetry with free_http_response
378 * Revision 1.21 2001/09/13 23:53:03 jongfoster
379 * Support for both static and dynamically generated CGI pages.
380 * Correctly setting Last-Modified: and Expires: HTTP headers.
382 * Revision 1.20 2001/09/13 23:40:36 jongfoster
383 * (Cosmetic only) Indentation correction
385 * Revision 1.19 2001/09/13 23:31:25 jongfoster
386 * Moving image data to cgi.c rather than cgi.h.
388 * Revision 1.18 2001/08/05 16:06:20 jongfoster
389 * Modifiying "struct map" so that there are now separate header and
390 * "map_entry" structures. This means that functions which modify a
391 * map no longer need to return a pointer to the modified map.
392 * Also, it no longer reverses the order of the entries (which may be
393 * important with some advanced template substitutions).
395 * Revision 1.17 2001/08/05 15:57:38 oes
396 * Adapted finish_http_response to new list_to_text
398 * Revision 1.16 2001/08/01 21:33:18 jongfoster
399 * Changes to fill_template() that reduce memory usage without having
400 * an impact on performance. I also renamed some variables so as not
401 * to clash with the C++ keywords "new" and "template".
403 * Revision 1.15 2001/08/01 21:19:22 jongfoster
404 * Moving file version information to a separate CGI page.
406 * Revision 1.14 2001/08/01 00:19:03 jongfoster
407 * New function: map_conditional() for an if-then-else syntax.
408 * Changing to use new version of show_defines()
410 * Revision 1.13 2001/07/30 22:08:36 jongfoster
411 * Tidying up #defines:
412 * - All feature #defines are now of the form FEATURE_xxx
413 * - Permanently turned off WIN_GUI_EDIT
414 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
416 * Revision 1.12 2001/07/29 18:47:05 jongfoster
417 * Adding missing #include "loadcfg.h"
419 * Revision 1.11 2001/07/18 17:24:37 oes
420 * Changed to conform to new pcrs interface
422 * Revision 1.10 2001/07/13 13:53:13 oes
423 * Removed all #ifdef PCRS and related code
425 * Revision 1.9 2001/06/29 21:45:41 oes
426 * Indentation, CRLF->LF, Tab-> Space
428 * Revision 1.8 2001/06/29 13:21:46 oes
429 * - Cosmetics: renamed and reordered functions, variables,
430 * texts, improved comments etc
432 * - Removed ij_untrusted_url() The relevant
433 * info is now part of the "untrusted" page,
434 * which is generated by filters.c:trust_url()
436 * - Generators of content now call finish_http_response()
437 * themselves, making jcc.c:chat() a little less
440 * - Removed obsolete "Pragma: no-cache" from our headers
442 * - http_responses now know their head length
444 * - fill_template now uses the new interface to pcrs, so that
445 * - long jobs (like whole files) no longer have to be assembled
446 * in a fixed size buffer
447 * - the new T (trivial) option is used, and the replacement may
448 * contain Perl syntax backrefs without confusing pcrs
450 * - Introduced default_exports() which generates a set of exports
451 * common to all CGIs and other content generators
453 * - Introduced convenience function map_block_killer()
455 * - Introduced convenience function make_menu()
457 * - Introduced CGI-like function error_response() which generates
458 * the "No such domain" and "Connect failed" messages using the
461 * - cgi_show_url_info:
462 * - adapted to new CGI features
463 * - form and answers now generated from same template
464 * - http:// prefix in URL now OK
467 * - adapted to new CGI features
468 * - no longer uses csp->init_proxy_args
471 * - moved menu generation to make_menu()
473 * - add_stats now writes single export map entries instead
476 * - Moved redirect_url() to filters.c
478 * - Fixed mem leak in free_http_response(), map_block_killer(),
480 * - Removed logentry from cancelled commit
482 * Revision 1.7 2001/06/09 10:51:58 jongfoster
483 * Changing "show URL info" handler to new style.
484 * Changing BUFSIZ ==> BUFFER_SIZE
486 * Revision 1.6 2001/06/07 23:05:19 jongfoster
487 * Removing code related to old forward and ACL files.
489 * Revision 1.5 2001/06/05 19:59:16 jongfoster
490 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
492 * Revision 1.4 2001/06/04 10:41:52 swa
493 * show version string of cgi.h and cgi.c
495 * Revision 1.3 2001/06/03 19:12:16 oes
496 * introduced new cgi handling
498 * No revisions before 1.3
500 **********************************************************************/
506 #include <sys/types.h>
514 #define snprintf _snprintf
515 #endif /* def _WIN32 */
523 #include "miscutil.h"
524 #include "cgisimple.h"
525 #ifdef FEATURE_CGI_EDIT_ACTIONS
527 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
529 /* loadcfg.h is for global_toggle_state only */
530 #ifdef FEATURE_PTHREAD
532 /* jcc.h is for mutex semaphore globals only */
533 #endif /* def FEATURE_PTHREAD */
534 const char cgi_h_rcs[] = CGI_H_VERSION;
537 * List of CGI functions: name, handler, description
538 * Note: Do NOT use single quotes in the description;
539 * this will break the dynamic "blocked" template!
541 static const struct cgi_dispatcher cgi_dispatchers[] = {
546 #ifdef FEATURE_GRACEFUL_TERMINATION
549 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
550 "this is a one click Denial Of Service attack!!!</em>",
555 #ifdef FEATURE_CGI_EDIT_ACTIONS
556 "View & change the current configuration",
558 "View the current configuration",
563 "View the source code version numbers",
567 "View the request headers.",
571 "Look up which actions apply to a URL and why",
573 #ifdef FEATURE_CGI_EDIT_ACTIONS
576 "Toggle Privoxy on or off",
578 { "edit-actions", /* Edit the actions list */
581 { "eaa", /* Shortcut for edit-actions-add-url-form */
582 cgi_edit_actions_add_url_form,
584 { "eau", /* Shortcut for edit-actions-url-form */
585 cgi_edit_actions_url_form,
587 { "ear", /* Shortcut for edit-actions-remove-url-form */
588 cgi_edit_actions_remove_url_form,
590 { "eal", /* Shortcut for edit-actions-list */
591 cgi_edit_actions_list,
593 { "eafu", /* Shortcut for edit-actions-for-url */
594 cgi_edit_actions_for_url,
596 { "eas", /* Shortcut for edit-actions-submit */
597 cgi_edit_actions_submit,
599 { "easa", /* Shortcut for edit-actions-section-add */
600 cgi_edit_actions_section_add,
602 { "easr", /* Shortcut for edit-actions-section-remove */
603 cgi_edit_actions_section_remove,
605 { "eass", /* Shortcut for edit-actions-section-swap */
606 cgi_edit_actions_section_swap,
608 { "edit-actions-for-url",
609 cgi_edit_actions_for_url,
610 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
611 { "edit-actions-list",
612 cgi_edit_actions_list,
613 NULL, TRUE /* Edit the actions list */ },
614 { "edit-actions-submit",
615 cgi_edit_actions_submit,
616 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
617 { "edit-actions-url",
618 cgi_edit_actions_url,
619 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
620 { "edit-actions-url-form",
621 cgi_edit_actions_url_form,
622 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
623 { "edit-actions-add-url",
624 cgi_edit_actions_add_url,
625 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
626 { "edit-actions-add-url-form",
627 cgi_edit_actions_add_url_form,
628 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
629 { "edit-actions-remove-url",
630 cgi_edit_actions_remove_url,
631 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
632 { "edit-actions-remove-url-form",
633 cgi_edit_actions_remove_url_form,
634 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
635 { "edit-actions-section-add",
636 cgi_edit_actions_section_add,
637 NULL, FALSE /* Remove a section from the actionsfile */ },
638 { "edit-actions-section-remove",
639 cgi_edit_actions_section_remove,
640 NULL, FALSE /* Remove a section from the actionsfile */ },
641 { "edit-actions-section-swap",
642 cgi_edit_actions_section_swap,
643 NULL, FALSE /* Swap two sections in the actionsfile */ },
644 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
647 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
650 NULL, TRUE /* Send a built-in image */ },
653 NULL, TRUE /* Send templates/cgi-style.css */ },
655 cgi_transparent_image,
656 NULL, TRUE /* Send a transparent image (short name) */ },
658 cgi_send_user_manual,
659 NULL, TRUE /* Send user-manual */ },
660 { NULL, /* NULL Indicates end of list and default page */
662 NULL, TRUE /* Unknown CGI page */ }
667 * Built-in images for ad replacement
669 * Hint: You can encode your own images like this:
670 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
673 #ifdef FEATURE_NO_GIFS
676 * Checkerboard pattern, as a PNG.
678 const char image_pattern_data[] =
679 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
680 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
681 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
682 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
683 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
684 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
685 "\000\000\000\111\105\116\104\256\102\140\202";
688 * 1x1 transparant PNG.
690 const char image_blank_data[] =
691 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
692 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
693 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
694 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
695 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
696 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
697 "\000\000\000\000\111\105\116\104\256\102\140\202";
701 * Checkerboard pattern, as a GIF.
703 const char image_pattern_data[] =
704 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
705 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
706 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
707 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
711 * 1x1 transparant GIF.
713 const char image_blank_data[] =
714 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
715 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
716 "\000\001\000\000\002\002D\001\000;";
719 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
720 const size_t image_blank_length = sizeof(image_blank_data) - 1;
723 static struct http_response cgi_error_memory_response[1];
725 static struct http_response *dispatch_known_cgi(struct client_state * csp,
727 static struct map *parse_cgi_parameters(char *argstring);
730 /*********************************************************************
732 * Function : dispatch_cgi
734 * Description : Checks if a request URL has either the magical
735 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
736 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
737 * http://config.privoxy.org/). If so, it passes
738 * the (rest of the) path onto dispatch_known_cgi, which
739 * calls the relevant CGI handler function.
742 * 1 : csp = Current client state (buffers, headers, etc...)
744 * Returns : http_response if match, NULL if nonmatch or handler fail
746 *********************************************************************/
747 struct http_response *dispatch_cgi(struct client_state *csp)
749 const char *host = csp->http->host;
750 const char *path = csp->http->path;
753 * Should we intercept ?
756 /* Note: "example.com" and "example.com." are equivalent hostnames. */
758 /* Either the host matches CGI_SITE_1_HOST ..*/
759 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
760 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
761 && (path[0] == '/') )
763 /* ..then the path will all be for us. Remove leading '/' */
766 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
767 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
768 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
769 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
771 /* take everything following CGI_SITE_2_PATH */
772 path += strlen(CGI_SITE_2_PATH);
775 /* skip the forward slash after CGI_SITE_2_PATH */
778 else if (*path != '\0')
781 * weirdness: URL is /configXXX, where XXX is some string
782 * Do *NOT* intercept.
794 * This is a CGI call.
797 return dispatch_known_cgi(csp, path);
801 /*********************************************************************
803 * Function : grep_cgi_referrer
805 * Description : Ugly provisorical fix that greps the value of the
806 * referer HTTP header field out of a linked list of
807 * strings like found at csp->headers. Will disappear
810 * FIXME: csp->headers ought to be csp->http->headers
811 * FIXME: Parsing all client header lines should
812 * happen right after the request is received!
815 * 1 : csp = Current client state (buffers, headers, etc...)
817 * Returns : pointer to value (no copy!), or NULL if none found.
819 *********************************************************************/
820 char *grep_cgi_referrer(struct client_state *csp)
822 struct list_entry *p;
824 for (p = csp->headers->first; p != NULL; p = p->next)
826 if (p->str == NULL) continue;
827 if (strncmpic(p->str, "Referer: ", 9) == 0)
829 return ((p->str) + 9);
837 /*********************************************************************
839 * Function : dispatch_known_cgi
841 * Description : Processes a CGI once dispatch_cgi has determined that
842 * it matches one of the magic prefixes. Parses the path
843 * as a cgi name plus query string, prepares a map that
844 * maps CGI parameter names to their values, initializes
845 * the http_response struct, and calls the relevant CGI
849 * 1 : csp = Current client state (buffers, headers, etc...)
850 * 2 : path = Path of CGI, with the CGI prefix removed.
851 * Should not have a leading "/".
853 * Returns : http_response, or NULL on handler failure or out of
856 *********************************************************************/
857 static struct http_response *dispatch_known_cgi(struct client_state * csp,
860 const struct cgi_dispatcher *d;
861 struct map *param_list;
862 struct http_response *rsp;
863 char *query_args_start;
868 if (NULL == (path_copy = strdup(path)))
870 return cgi_error_memory();
872 query_args_start = path_copy;
873 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
877 if (*query_args_start == '/')
879 *query_args_start++ = '\0';
880 if ((param_list = new_map()))
882 map(param_list, "file", 1, url_decode(query_args_start), 0);
887 if (*query_args_start == '?')
889 *query_args_start++ = '\0';
891 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
894 return cgi_error_memory();
900 * path_copy = CGI call name
901 * param_list = CGI params, as map
904 /* Get mem for response or fail*/
905 if (NULL == (rsp = alloc_http_response()))
908 free_map(param_list);
909 return cgi_error_memory();
912 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
913 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
914 csp->ip_addr_str, csp->http->cmd);
917 * Find and start the right CGI function
922 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
925 * If the called CGI is either harmless, or referred
926 * from a trusted source, start it.
929 || ((NULL != (referrer = grep_cgi_referrer(csp)))
930 && (0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)))
933 err = (d->handler)(csp, rsp, param_list);
938 * Else, modify toggle calls so that they only display
939 * the status, and deny all other calls.
941 if (0 == strcmp(path_copy, "toggle"))
943 unmap(param_list, "set");
944 err = (d->handler)(csp, rsp, param_list);
948 err = cgi_error_disabled(csp, rsp);
953 free_map(param_list);
955 if (err == JB_ERR_CGI_PARAMS)
957 err = cgi_error_bad_param(csp, rsp);
959 if (err && (err != JB_ERR_MEMORY))
961 /* Unexpected error! Shouldn't get here */
962 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
963 err = cgi_error_unknown(csp, rsp, err);
968 return finish_http_response(rsp);
972 /* Error in handler, probably out-of-memory */
973 free_http_response(rsp);
974 return cgi_error_memory();
982 /*********************************************************************
984 * Function : parse_cgi_parameters
986 * Description : Parse a URL-encoded argument string into name/value
987 * pairs and store them in a struct map list.
990 * 1 : argstring = string to be parsed. Will be trashed.
992 * Returns : pointer to param list, or NULL if out of memory.
994 *********************************************************************/
995 static struct map *parse_cgi_parameters(char *argstring)
998 char *vector[BUFFER_SIZE];
1000 struct map *cgi_params;
1002 if (NULL == (cgi_params = new_map()))
1008 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1009 * the fragment identifier along with the request, so we must
1010 * cut it off here, so it won't pollute the CGI params:
1012 if (NULL != (p = strchr(argstring, '#')))
1017 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1019 for (i = 0; i < pairs; i++)
1021 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1024 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1026 free_map(cgi_params);
1037 /*********************************************************************
1039 * Function : get_char_param
1041 * Description : Get a single-character parameter passed to a CGI
1045 * 1 : parameters = map of cgi parameters
1046 * 2 : param_name = The name of the parameter to read
1048 * Returns : Uppercase character on success, '\0' on error.
1050 *********************************************************************/
1051 char get_char_param(const struct map *parameters,
1052 const char *param_name)
1059 ch = *(lookup(parameters, param_name));
1060 if ((ch >= 'a') && (ch <= 'z'))
1062 ch = ch - 'a' + 'A';
1069 /*********************************************************************
1071 * Function : get_string_param
1073 * Description : Get a string paramater, to be used as an
1074 * ACTION_STRING or ACTION_MULTI paramater.
1075 * Validates the input to prevent stupid/malicious
1076 * users from corrupting their action file.
1079 * 1 : parameters = map of cgi parameters
1080 * 2 : param_name = The name of the parameter to read
1081 * 3 : pparam = destination for paramater. Allocated as
1082 * part of the map "parameters", so don't free it.
1083 * Set to NULL if not specified.
1085 * Returns : JB_ERR_OK on success, or if the paramater
1086 * was not specified.
1087 * JB_ERR_MEMORY on out-of-memory.
1088 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1090 *********************************************************************/
1091 jb_err get_string_param(const struct map *parameters,
1092 const char *param_name,
1093 const char **pparam)
1105 param = lookup(parameters, param_name);
1111 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1116 * Note that the length limit is arbitrary, it just seems
1117 * sensible to limit it to *something*. There's no
1118 * technical reason for any limit at all.
1120 return JB_ERR_CGI_PARAMS;
1123 /* Check every character to see if it's legal */
1125 while ((ch = *s++) != '\0')
1127 if ( ((unsigned char)ch < (unsigned char)' ')
1130 /* Probable hack attempt, or user accidentally used '}'. */
1131 return JB_ERR_CGI_PARAMS;
1142 /*********************************************************************
1144 * Function : get_number_param
1146 * Description : Get a non-negative integer from the parameters
1147 * passed to a CGI function.
1150 * 1 : csp = Current client state (buffers, headers, etc...)
1151 * 2 : parameters = map of cgi parameters
1152 * 3 : name = Name of CGI parameter to read
1153 * 4 : pvalue = destination for value.
1154 * Set to -1 on error.
1156 * Returns : JB_ERR_OK on success
1157 * JB_ERR_MEMORY on out-of-memory
1158 * JB_ERR_CGI_PARAMS if the parameter was not specified
1161 *********************************************************************/
1162 jb_err get_number_param(struct client_state *csp,
1163 const struct map *parameters,
1178 param = lookup(parameters, name);
1181 return JB_ERR_CGI_PARAMS;
1184 /* We don't use atoi because I want to check this carefully... */
1187 while ((ch = *param++) != '\0')
1189 if ((ch < '0') || (ch > '9'))
1191 return JB_ERR_CGI_PARAMS;
1198 * <limits.h> defines UINT_MAX
1200 * (UINT_MAX - ch) / 10 is the largest number that
1201 * can be safely multiplied by 10 then have ch added.
1203 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1205 return JB_ERR_CGI_PARAMS;
1208 value = value * 10 + ch;
1219 /*********************************************************************
1221 * Function : error_response
1223 * Description : returns an http_response that explains the reason
1224 * why a request failed.
1227 * 1 : csp = Current client state (buffers, headers, etc...)
1228 * 2 : templatename = Which template should be used for the answer
1229 * 3 : sys_err = system error number
1231 * Returns : A http_response. If we run out of memory, this
1232 * will be cgi_error_memory().
1234 *********************************************************************/
1235 struct http_response *error_response(struct client_state *csp,
1236 const char *templatename,
1240 struct http_response *rsp;
1241 struct map *exports = default_exports(csp, NULL);
1244 if (exports == NULL)
1246 return cgi_error_memory();
1249 if (NULL == (rsp = alloc_http_response()))
1252 return cgi_error_memory();
1255 if (csp->flags & CSP_FLAG_FORCED)
1257 path = strdup(FORCE_PREFIX);
1263 err = string_append(&path, csp->http->path);
1265 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1266 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1267 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1268 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1269 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1272 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1275 /* Some failures, like "404 no such domain", don't have an IP address. */
1276 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1284 free_http_response(rsp);
1285 return cgi_error_memory();
1288 if (!strcmp(templatename, "no-such-domain"))
1290 rsp->status = strdup("404 No such domain");
1291 if (rsp->status == NULL)
1294 free_http_response(rsp);
1295 return cgi_error_memory();
1298 else if (!strcmp(templatename, "connect-failed"))
1300 rsp->status = strdup("503 Connect failed");
1301 if (rsp->status == NULL)
1304 free_http_response(rsp);
1305 return cgi_error_memory();
1309 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1312 free_http_response(rsp);
1313 return cgi_error_memory();
1316 return finish_http_response(rsp);
1320 /*********************************************************************
1322 * Function : cgi_error_disabled
1324 * Description : CGI function that is called to generate an error
1325 * response if the actions editor or toggle CGI are
1326 * accessed despite having being disabled at compile-
1330 * 1 : csp = Current client state (buffers, headers, etc...)
1331 * 2 : rsp = http_response data structure for output
1333 * CGI Parameters : none
1335 * Returns : JB_ERR_OK on success
1336 * JB_ERR_MEMORY on out-of-memory error.
1338 *********************************************************************/
1339 jb_err cgi_error_disabled(struct client_state *csp,
1340 struct http_response *rsp)
1342 struct map *exports;
1347 if (NULL == (exports = default_exports(csp, NULL)))
1349 return JB_ERR_MEMORY;
1352 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1356 /*********************************************************************
1358 * Function : cgi_init_error_messages
1360 * Description : Call at the start of the program to initialize
1361 * the error message used by cgi_error_memory().
1367 *********************************************************************/
1368 void cgi_init_error_messages(void)
1370 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1371 cgi_error_memory_response->head =
1372 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1373 "Content-Type: text/html\r\n"
1375 cgi_error_memory_response->body =
1377 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1379 "<h1>500 Internal Privoxy Error</h1>\r\n"
1380 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1381 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1385 cgi_error_memory_response->head_length =
1386 strlen(cgi_error_memory_response->head);
1387 cgi_error_memory_response->content_length =
1388 strlen(cgi_error_memory_response->body);
1392 /*********************************************************************
1394 * Function : cgi_error_memory
1396 * Description : Called if a CGI function runs out of memory.
1397 * Returns a statically-allocated error response.
1401 * Returns : http_response data structure for output. This is
1402 * statically allocated, for obvious reasons.
1404 *********************************************************************/
1405 struct http_response *cgi_error_memory(void)
1407 /* assert that it's been initialized. */
1408 assert(cgi_error_memory_response->head);
1410 return cgi_error_memory_response;
1414 /*********************************************************************
1416 * Function : cgi_error_no_template
1418 * Description : Almost-CGI function that is called if a template
1419 * cannot be loaded. Note this is not a true CGI,
1420 * it takes a template name rather than a map of
1424 * 1 : csp = Current client state (buffers, headers, etc...)
1425 * 2 : rsp = http_response data structure for output
1426 * 3 : template_name = Name of template that could not
1429 * Returns : JB_ERR_OK on success
1430 * JB_ERR_MEMORY on out-of-memory error.
1432 *********************************************************************/
1433 jb_err cgi_error_no_template(struct client_state *csp,
1434 struct http_response *rsp,
1435 const char *template_name)
1437 static const char status[] =
1438 "500 Internal Privoxy Error";
1439 static const char body_prefix[] =
1441 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1443 "<h1>500 Internal Privoxy Error</h1>\r\n"
1444 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1445 "<p><b>Could not load template file <code>";
1446 static const char body_suffix[] =
1447 "</code> or one of it's included components.</b></p>\r\n"
1448 "<p>Please contact your proxy administrator.</p>\r\n"
1449 "<p>If you are the proxy administrator, please put the required file(s)"
1450 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1451 "location of the <code><i>(confdir)</i></code> directory "
1452 "is specified in the main Privoxy <code>config</code> "
1453 "file. (It's typically the Privoxy install directory"
1455 ", or <code>/etc/privoxy/</code>"
1456 #endif /* ndef _WIN32 */
1463 assert(template_name);
1465 /* Reset rsp, if needed */
1469 rsp->content_length = 0;
1470 rsp->head_length = 0;
1473 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1474 if (rsp->body == NULL)
1476 return JB_ERR_MEMORY;
1478 strcpy(rsp->body, body_prefix);
1479 strcat(rsp->body, template_name);
1480 strcat(rsp->body, body_suffix);
1482 rsp->status = strdup(status);
1483 if (rsp->body == NULL)
1485 return JB_ERR_MEMORY;
1492 /*********************************************************************
1494 * Function : cgi_error_unknown
1496 * Description : Almost-CGI function that is called if an unexpected
1497 * error occurs in the top-level CGI dispatcher.
1498 * In this context, "unexpected" means "anything other
1499 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1500 * expected to handle all other errors internally,
1501 * since they can give more relavent error messages
1504 * Note this is not a true CGI, it takes an error
1505 * code rather than a map of parameters.
1508 * 1 : csp = Current client state (buffers, headers, etc...)
1509 * 2 : rsp = http_response data structure for output
1510 * 3 : error_to_report = Error code to report.
1512 * Returns : JB_ERR_OK on success
1513 * JB_ERR_MEMORY on out-of-memory error.
1515 *********************************************************************/
1516 jb_err cgi_error_unknown(struct client_state *csp,
1517 struct http_response *rsp,
1518 jb_err error_to_report)
1520 static const char status[] =
1521 "500 Internal Privoxy Error";
1522 static const char body_prefix[] =
1524 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1526 "<h1>500 Internal Privoxy Error</h1>\r\n"
1527 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1528 "<p><b>Unexpected internal error: ";
1529 static const char body_suffix[] =
1532 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1533 "file a bug report</a>.</p>\r\n"
1540 /* Reset rsp, if needed */
1544 rsp->content_length = 0;
1545 rsp->head_length = 0;
1548 sprintf(errnumbuf, "%d", error_to_report);
1550 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1551 if (rsp->body == NULL)
1553 return JB_ERR_MEMORY;
1555 strcpy(rsp->body, body_prefix);
1556 strcat(rsp->body, errnumbuf);
1557 strcat(rsp->body, body_suffix);
1559 rsp->status = strdup(status);
1560 if (rsp->body == NULL)
1562 return JB_ERR_MEMORY;
1569 /*********************************************************************
1571 * Function : cgi_error_bad_param
1573 * Description : CGI function that is called if the parameters
1574 * (query string) for a CGI were wrong.
1577 * 1 : csp = Current client state (buffers, headers, etc...)
1578 * 2 : rsp = http_response data structure for output
1580 * CGI Parameters : none
1582 * Returns : JB_ERR_OK on success
1583 * JB_ERR_MEMORY on out-of-memory error.
1585 *********************************************************************/
1586 jb_err cgi_error_bad_param(struct client_state *csp,
1587 struct http_response *rsp)
1589 struct map *exports;
1594 if (NULL == (exports = default_exports(csp, NULL)))
1596 return JB_ERR_MEMORY;
1599 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1603 /*********************************************************************
1605 * Function : cgi_redirect
1607 * Description : CGI support function to generate a HTTP redirect
1611 * 1 : rsp = http_response data structure for output
1612 * 2 : target = string with the target URL
1614 * CGI Parameters : None
1616 * Returns : JB_ERR_OK on success
1617 * JB_ERR_MEMORY on out-of-memory error.
1619 *********************************************************************/
1620 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1627 err = enlist_unique_header(rsp->headers, "Location", target);
1629 rsp->status = strdup("302 Local Redirect from Privoxy");
1630 if (rsp->status == NULL)
1632 return JB_ERR_MEMORY;
1639 /*********************************************************************
1641 * Function : add_help_link
1643 * Description : Produce a copy of the string given as item,
1644 * embedded in an HTML link to its corresponding
1645 * section (item name in uppercase) in the actions
1646 * chapter of the user manual, (whose URL is given in
1647 * the config and defaults to our web site).
1649 * FIXME: I currently only work for actions, and would
1650 * like to be generalized for other topics.
1653 * 1 : item = item (will NOT be free()d.)
1654 * It is assumed to be HTML-safe.
1655 * 2 : config = The current configuration.
1657 * Returns : String with item embedded in link, or NULL on
1660 *********************************************************************/
1661 char *add_help_link(const char *item,
1662 struct configuration_spec *config)
1666 if (!item) return NULL;
1668 result = strdup("<a href=\"");
1669 if (!strncmpic(config->usermanual, "file://", 7) ||
1670 !strncmpic(config->usermanual, "http", 4))
1672 string_append(&result, config->usermanual);
1676 string_append(&result, "http://");
1677 string_append(&result, CGI_SITE_2_HOST);
1678 string_append(&result, "/user-manual/");
1680 string_append(&result, ACTIONS_HELP_PREFIX);
1681 string_join (&result, string_toupper(item));
1682 string_append(&result, "\">");
1683 string_append(&result, item);
1684 string_append(&result, "</a> ");
1690 /*********************************************************************
1692 * Function : get_http_time
1694 * Description : Get the time in a format suitable for use in a
1695 * HTTP header - e.g.:
1696 * "Sun, 06 Nov 1994 08:49:37 GMT"
1699 * 1 : time_offset = Time returned will be current time
1700 * plus this number of seconds.
1701 * 2 : buf = Destination for result. Must be long enough
1702 * to hold 29 characters plus a trailing zero.
1706 *********************************************************************/
1707 void get_http_time(int time_offset, char *buf)
1709 static const char day_names[7][4] =
1710 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1711 static const char month_names[12][4] =
1712 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1713 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1716 time_t current_time;
1717 #if defined(HAVE_GMTIME_R)
1719 * Declare dummy up here (instead of inside get/set gmt block) so it
1720 * doesn't go out of scope before it's potentially used in snprintf later.
1721 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1722 * !defined HAVE_GMTIME_R.
1729 time(¤t_time); /* get current time */
1731 current_time += time_offset;
1733 /* get and save the gmt */
1736 t = gmtime_r(¤t_time, &dummy);
1737 #elif FEATURE_PTHREAD
1738 pthread_mutex_lock(&gmtime_mutex);
1739 t = gmtime(¤t_time);
1740 pthread_mutex_unlock(&gmtime_mutex);
1742 t = gmtime(¤t_time);
1746 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1748 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1749 day_names[t->tm_wday],
1751 month_names[t->tm_mon],
1761 /*********************************************************************
1763 * Function : finish_http_response
1765 * Description : Fill in the missing headers in an http response,
1766 * and flatten the headers to an http head.
1769 * 1 : rsp = pointer to http_response to be processed
1771 * Returns : A http_response, usually the rsp parameter.
1772 * On error, free()s rsp and returns cgi_error_memory()
1774 *********************************************************************/
1775 struct http_response *finish_http_response(struct http_response *rsp)
1777 char buf[BUFFER_SIZE];
1780 /* Special case - do NOT change this statically allocated response,
1781 * which is ready for output anyway.
1783 if (rsp == cgi_error_memory_response)
1789 * Fill in the HTTP Status
1791 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1792 err = enlist_first(rsp->headers, buf);
1795 * Set the Content-Length
1797 if (rsp->content_length == 0)
1799 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1803 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1804 err = enlist(rsp->headers, buf);
1807 if (strncmpic(rsp->status, "302", 3))
1810 * If it's not a redirect without any content,
1811 * set the Content-Type to text/html if it's
1812 * not already specified.
1814 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1818 * Fill in the rest of the default headers:
1820 * Date: set to current date/time.
1821 * Last-Modified: set to date/time the page was last changed.
1822 * Expires: set to date/time page next needs reloading.
1823 * Cache-Control: set to "no-cache" if applicable.
1825 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1830 * Set Expires to about 10 min into the future so it'll get reloaded
1831 * occasionally, e.g. if Privoxy gets upgraded.
1836 get_http_time(0, buf);
1837 err = enlist_unique_header(rsp->headers, "Date", buf);
1840 /* Some date in the past. */
1841 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1845 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1846 err = enlist_unique_header(rsp->headers, "Expires", buf);
1849 else if (!strncmpic(rsp->status, "302", 3))
1851 get_http_time(0, buf);
1852 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1857 * Setting "Cache-Control" to "no-cache" and "Expires" to
1858 * the current time doesn't exactly forbid caching, it just
1859 * requires the client to revalidate the cached copy.
1861 * If a temporary problem occurs and the user tries again after
1862 * getting Privoxy's error message, a compliant browser may set the
1863 * If-Modified-Since header with the content of the error page's
1864 * Last-Modified header. More often than not, the document on the server
1865 * is older than Privoxy's error message, the server would send status code
1866 * 304 and the browser would display the outdated error message again and again.
1868 * For documents delivered with status code 404 or 503 we set "Last-Modified"
1869 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1870 * and can be safely used to "revalidate" without getting a status code 304.
1872 * There is no need to let the useless If-Modified-Since header reach the
1873 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1875 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1877 get_http_time(0, buf);
1878 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1879 if (!strncmpic(rsp->status, "404", 3) || !strncmpic(rsp->status, "503", 3))
1881 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1885 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1887 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1888 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1894 * HTTP/1.1 applications that do not support persistent connections MUST
1895 * include the "close" connection option in every message.
1897 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
1902 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1904 free_http_response(rsp);
1905 return cgi_error_memory();
1907 rsp->head_length = strlen(rsp->head);
1914 /*********************************************************************
1916 * Function : alloc_http_response
1918 * Description : Allocates a new http_response structure.
1922 * Returns : pointer to a new http_response, or NULL.
1924 *********************************************************************/
1925 struct http_response *alloc_http_response(void)
1927 return (struct http_response *) zalloc(sizeof(struct http_response));
1932 /*********************************************************************
1934 * Function : free_http_response
1936 * Description : Free the memory occupied by an http_response
1937 * and its depandant structures.
1940 * 1 : rsp = pointer to http_response to be freed
1944 *********************************************************************/
1945 void free_http_response(struct http_response *rsp)
1948 * Must special case cgi_error_memory_response, which is never freed.
1950 if (rsp && (rsp != cgi_error_memory_response))
1955 destroy_list(rsp->headers);
1962 /*********************************************************************
1964 * Function : template_load
1966 * Description : CGI support function that loads a given HTML
1967 * template from the confdir, ignoring comment
1968 * lines and following #include statements up to
1972 * 1 : csp = Current client state (buffers, headers, etc...)
1973 * 2 : template_ptr = Destination for pointer to loaded
1975 * 3 : templatename = name of the HTML template to be used
1976 * 4 : recursive = Flag set if this function calls itself
1977 * following an #include statament
1979 * Returns : JB_ERR_OK on success
1980 * JB_ERR_MEMORY on out-of-memory error.
1981 * JB_ERR_FILE if the template file cannot be read
1983 *********************************************************************/
1984 jb_err template_load(struct client_state *csp, char **template_ptr,
1985 const char *templatename, int recursive)
1988 char *templates_dir_path;
1991 char *included_module;
1994 char buf[BUFFER_SIZE];
1997 assert(template_ptr);
1998 assert(templatename);
2000 *template_ptr = NULL;
2002 /* Validate template name. Paranoia. */
2003 for (p = templatename; *p != 0; p++)
2005 if ( ((*p < 'a') || (*p > 'z'))
2006 && ((*p < 'A') || (*p > 'Z'))
2007 && ((*p < '0') || (*p > '9'))
2011 /* Illegal character */
2016 /* Generate full path */
2018 templates_dir_path = make_path(csp->config->confdir, "templates");
2019 if (templates_dir_path == NULL)
2021 return JB_ERR_MEMORY;
2024 full_path = make_path(templates_dir_path, templatename);
2025 free(templates_dir_path);
2026 if (full_path == NULL)
2028 return JB_ERR_MEMORY;
2031 /* Allocate buffer */
2033 file_buffer = strdup("");
2034 if (file_buffer == NULL)
2037 return JB_ERR_MEMORY;
2040 /* Open template file */
2042 if (NULL == (fp = fopen(full_path, "r")))
2044 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2052 * Read the file, ignoring comments, and honoring #include
2053 * statements, unless we're already called recursively.
2055 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2056 * This is unlikely in practise.
2058 while (fgets(buf, BUFFER_SIZE, fp))
2060 if (!recursive && !strncmp(buf, "#include ", 9))
2062 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2069 if (string_join(&file_buffer, included_module))
2072 return JB_ERR_MEMORY;
2078 /* skip lines starting with '#' */
2084 if (string_append(&file_buffer, buf))
2087 return JB_ERR_MEMORY;
2092 *template_ptr = file_buffer;
2098 /*********************************************************************
2100 * Function : template_fill
2102 * Description : CGI support function that fills in a pre-loaded
2103 * HTML template by replacing @name@ with value using
2104 * pcrs, for each item in the output map.
2106 * Note that a leading '$' charachter in the export map's
2107 * values will be stripped and toggle on backreference
2111 * 1 : template_ptr = IN: Template to be filled out.
2113 * OUT: Filled out template.
2114 * Caller must free().
2115 * 2 : exports = map with fill in symbol -> name pairs
2117 * Returns : JB_ERR_OK on success
2118 * JB_ERR_MEMORY on out-of-memory error
2120 *********************************************************************/
2121 jb_err template_fill(char **template_ptr, const struct map *exports)
2123 struct map_entry *m;
2125 char buf[BUFFER_SIZE];
2126 char *tmp_out_buffer;
2132 assert(template_ptr);
2133 assert(*template_ptr);
2136 file_buffer = *template_ptr;
2137 size = strlen(file_buffer) + 1;
2140 * Assemble pcrs joblist from exports map
2142 for (m = exports->first; m != NULL; m = m->next)
2144 if (*m->name == '$')
2147 * First character of name is '$', so remove this flag
2148 * character and allow backreferences ($1 etc) in the
2149 * "replace with" text.
2151 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2157 * Treat the "replace with" text as a literal string -
2158 * no quoting needed, no backreferences allowed.
2159 * ("Trivial" ['T'] flag).
2163 /* Enclose name in @@ */
2164 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2168 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2170 /* Make and run job. */
2171 job = pcrs_compile(buf, m->value, flags, &error);
2174 if (error == PCRS_ERR_NOMEM)
2177 *template_ptr = NULL;
2178 return JB_ERR_MEMORY;
2182 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2183 /* Hope it wasn't important and silently ignore the invalid job */
2188 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2191 if (NULL == tmp_out_buffer)
2193 *template_ptr = NULL;
2194 return JB_ERR_MEMORY;
2196 file_buffer = tmp_out_buffer;
2203 *template_ptr = file_buffer;
2208 /*********************************************************************
2210 * Function : template_fill_for_cgi
2212 * Description : CGI support function that loads a HTML template
2213 * and fills it in. Handles file-not-found errors
2214 * by sending a HTML error message. For convenience,
2215 * this function also frees the passed "exports" map.
2218 * 1 : csp = Client state
2219 * 2 : templatename = name of the HTML template to be used
2220 * 3 : exports = map with fill in symbol -> name pairs.
2221 * Will be freed by this function.
2222 * 4 : rsp = Response structure to fill in.
2224 * Returns : JB_ERR_OK on success
2225 * JB_ERR_MEMORY on out-of-memory error
2227 *********************************************************************/
2228 jb_err template_fill_for_cgi(struct client_state *csp,
2229 const char *templatename,
2230 struct map *exports,
2231 struct http_response *rsp)
2236 assert(templatename);
2240 err = template_load(csp, &rsp->body, templatename, 0);
2241 if (err == JB_ERR_FILE)
2244 return cgi_error_no_template(csp, rsp, templatename);
2249 return err; /* JB_ERR_MEMORY */
2251 err = template_fill(&rsp->body, exports);
2257 /*********************************************************************
2259 * Function : default_exports
2261 * Description : returns a struct map list that contains exports
2262 * which are common to all CGI functions.
2265 * 1 : csp = Current client state (buffers, headers, etc...)
2266 * 2 : caller = name of CGI who calls us and which should
2267 * be excluded from the generated menu. May be
2269 * Returns : NULL if no memory, else a new map. Caller frees.
2271 *********************************************************************/
2272 struct map *default_exports(const struct client_state *csp, const char *caller)
2276 struct map * exports;
2277 int local_help_exists = 0;
2281 exports = new_map();
2282 if (exports == NULL)
2287 err = map(exports, "version", 1, html_encode(VERSION), 0);
2288 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2289 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2290 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2291 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2292 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
2293 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2294 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2295 !strncmpic(csp->config->usermanual, "http", 4))
2297 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2301 if (!err) err = map(exports, "user-manual", 1, "http://"CGI_SITE_2_HOST"/user-manual/" ,1);
2303 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2304 #ifdef FEATURE_TOGGLE
2305 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2307 if (!err) err = map_block_killer(exports, "can-toggle");
2310 snprintf(buf, 20, "%d", csp->config->hport);
2311 if (!err) err = map(exports, "my-port", 1, buf, 1);
2313 if(!strcmp(CODE_STATUS, "stable"))
2315 if (!err) err = map_block_killer(exports, "unstable");
2318 if (csp->config->admin_address != NULL)
2320 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2321 local_help_exists = 1;
2325 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2328 if (csp->config->proxy_info_url != NULL)
2330 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2331 local_help_exists = 1;
2335 if (!err) err = map_block_killer(exports, "have-proxy-info");
2338 if (local_help_exists == 0)
2340 if (!err) err = map_block_killer(exports, "have-help-info");
2353 /*********************************************************************
2355 * Function : map_block_killer
2357 * Description : Convenience function.
2358 * Adds a "killer" for the conditional HTML-template
2359 * block <name>, i.e. a substitution of the regex
2360 * "if-<name>-start.*if-<name>-end" to the given
2364 * 1 : exports = map to extend
2365 * 2 : name = name of conditional block
2367 * Returns : JB_ERR_OK on success
2368 * JB_ERR_MEMORY on out-of-memory error.
2370 *********************************************************************/
2371 jb_err map_block_killer(struct map *exports, const char *name)
2373 char buf[1000]; /* Will do, since the names are hardwired */
2377 assert(strlen(name) < 490);
2379 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2380 return map(exports, buf, 1, "", 1);
2384 /*********************************************************************
2386 * Function : map_block_keep
2388 * Description : Convenience function. Removes the markers used
2389 * by map-block-killer, to save a few bytes.
2390 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2393 * 1 : exports = map to extend
2394 * 2 : name = name of conditional block
2396 * Returns : JB_ERR_OK on success
2397 * JB_ERR_MEMORY on out-of-memory error.
2399 *********************************************************************/
2400 jb_err map_block_keep(struct map *exports, const char *name)
2403 char buf[500]; /* Will do, since the names are hardwired */
2407 assert(strlen(name) < 490);
2409 snprintf(buf, 500, "if-%s-start", name);
2410 err = map(exports, buf, 1, "", 1);
2417 snprintf(buf, 500, "if-%s-end", name);
2418 return map(exports, buf, 1, "", 1);
2422 /*********************************************************************
2424 * Function : map_conditional
2426 * Description : Convenience function.
2427 * Adds an "if-then-else" for the conditional HTML-template
2428 * block <name>, i.e. a substitution of the form:
2435 * The control structure and one of the alternatives
2439 * 1 : exports = map to extend
2440 * 2 : name = name of conditional block
2441 * 3 : choose_first = nonzero for first, zero for second.
2443 * Returns : JB_ERR_OK on success
2444 * JB_ERR_MEMORY on out-of-memory error.
2446 *********************************************************************/
2447 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2449 char buf[1000]; /* Will do, since the names are hardwired */
2454 assert(strlen(name) < 480);
2456 snprintf(buf, 1000, (choose_first
2457 ? "else-not-%s@.*@endif-%s"
2458 : "if-%s-then@.*@else-not-%s"),
2461 err = map(exports, buf, 1, "", 1);
2467 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2468 return map(exports, buf, 1, "", 1);
2472 /*********************************************************************
2474 * Function : make_menu
2476 * Description : Returns an HTML-formatted menu of the available
2477 * unhidden CGIs, excluding the one given in <self>
2479 * Parameters : self = name of CGI to leave out, can be NULL for
2482 * Returns : menu string, or NULL on out-of-memory error.
2484 *********************************************************************/
2485 char *make_menu(const char *self)
2487 const struct cgi_dispatcher *d;
2488 char *result = strdup("");
2492 self = "NO-SUCH-CGI!";
2495 /* List available unhidden CGI's and export as "other-cgis" */
2496 for (d = cgi_dispatchers; d->name; d++)
2498 if (d->description && strcmp(d->name, self))
2500 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2501 string_append(&result, d->name);
2502 string_append(&result, "\">");
2503 string_append(&result, d->description);
2504 string_append(&result, "</a></li>");
2512 /*********************************************************************
2514 * Function : dump_map
2516 * Description : HTML-dump a map for debugging (as table)
2519 * 1 : the_map = map to dump
2521 * Returns : string with HTML
2523 *********************************************************************/
2524 char *dump_map(const struct map *the_map)
2526 struct map_entry *cur_entry;
2527 char *ret = strdup("");
2529 string_append(&ret, "<table>\n");
2531 for (cur_entry = the_map->first;
2532 (cur_entry != NULL) && (ret != NULL);
2533 cur_entry = cur_entry->next)
2535 string_append(&ret, "<tr><td><b>");
2536 string_join (&ret, html_encode(cur_entry->name));
2537 string_append(&ret, "</b></td><td>");
2538 string_join (&ret, html_encode(cur_entry->value));
2539 string_append(&ret, "</td></tr>\n");
2542 string_append(&ret, "</table>\n");