1 const char cgi_rcs[] = "$Id: cgi.c,v 1.84 2006/12/28 17:54:22 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
6 * Purpose : Declares functions to intercept request, generate
7 * html or gif answers, and to compose HTTP resonses.
8 * This only contains the framework functions, the
9 * actual handler functions are declared elsewhere.
11 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001-2004, 2006
15 * the SourceForge Privoxy team. http://www.privoxy.org/
17 * Based on the Internet Junkbuster originally written
18 * by and Copyright (C) 1997 Anonymous Coders and
19 * Junkbusters Corporation. http://www.junkbusters.com
21 * This program is free software; you can redistribute it
22 * and/or modify it under the terms of the GNU General
23 * Public License as published by the Free Software
24 * Foundation; either version 2 of the License, or (at
25 * your option) any later version.
27 * This program is distributed in the hope that it will
28 * be useful, but WITHOUT ANY WARRANTY; without even the
29 * implied warranty of MERCHANTABILITY or FITNESS FOR A
30 * PARTICULAR PURPOSE. See the GNU General Public
31 * License for more details.
33 * The GNU General Public License should be included with
34 * this file. If not, you can view it at
35 * http://www.gnu.org/copyleft/gpl.html
36 * or write to the Free Software Foundation, Inc., 59
37 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
41 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
42 * Fixed gcc43 conversion warnings and replaced sprintf
43 * calls with snprintf to give OpenBSD's gcc one less reason
46 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
47 * Escape ampersand in Privoxy menu.
49 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
50 * Suppress the toggle link if remote toggling is disabled.
52 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
53 * Fix configure option --disable-toggle.
54 * Thanks to Peter Thoenen for reporting this.
56 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
57 * Don't lose the FORCE_PREFIX in case of
58 * connection problems. Fixes #612235.
60 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
61 * Make pthread mutex locking more generic. Instead of
62 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
63 * and use mutex locking unless there is an _r function
64 * available. Better safe than sorry.
66 * Fixes "./configure --disable-pthread" and should result
67 * in less threading-related problems on pthread-using platforms,
68 * but it still doesn't fix BR#1122404.
70 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
71 * Use CGI_PREFIX to check the referrer.
72 * The check for "http://config.privoxy.org/" fails
73 * if the user modified CGI_SITE_2_HOST.
75 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
76 * Adjusted headers for Privoxy's cgi responses:
77 * Don't set Last-Modified, Expires and Cache-Control
78 * headers for redirects; always set "Connection: close".
80 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
81 * Only predate the Last-Modified header for cgi responses
82 * that are delivered with status code 404 or 503.
84 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
85 * Mark cgi_send_user_manual as harmless,
86 * to fix the access denied problem Hal spotted.
87 * The manual has no secret content, therefore we
88 * don't have to care about "secure" referrers.
90 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
91 * Incorporate modified version of Roland Rosenfeld's patch to
92 * optionally access the user-manual via Privoxy. Closes patch 679075.
94 * Formatting changed to Privoxy style, added call to
95 * cgi_error_no_template if the requested file doesn't
96 * exist and modified check whether or not Privoxy itself
97 * should serve the manual. Should work cross-platform now.
99 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
100 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
102 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
103 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
104 * with what was really the latest development (the v_3_0_branch branch)
106 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
107 * Moved cgi_error_disabled() from cgiedit.c to
108 * cgi.c to re-enable build with --disable-editor.
109 * Fixes Bug #892744. Thanks to Matthew Fischer
112 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
113 * - Added new function cgi_redirect to handle creation of
114 * HTTP redirect messages formerly repeated in the code.
115 * - Send cgi_error_disabled instead of cgi_error_404 when
116 * referrer check fails
117 * - Dynamic content now gets Expires header field with date
120 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
121 * Bugfix: Transparent PNG was not transparent. Thanks to
122 * Dan Razzell of Starfish Systems for notice and new PNG.
124 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
125 * Security fix: dspatch_known_cgi no longer considers an empty
126 * referrer safe for critical CGIs, since malicious links could
127 * reside on https:// locations which browsers don't advertize as
128 * referrers. Closes bug #749916, thanks to Jeff Epler for the
129 * hint. Goodbye One-Click[tm] toggling :-(
131 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
134 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
135 * Killed a compiler warning on OSX
137 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
138 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
139 * (fixes bug #710056)
140 * - Show toggle info only if we have it
142 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
143 * Move declaration of struct tm dummy outside of a control block so it is
144 * accessible later on during snprintf in get_http_time.
146 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
147 * Cosmetic: Renamed cryptic variable
149 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
150 * 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.
152 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
153 * Disable access to critical CGIs via untrusted referrers.
154 * This prevents users from being tricked by malicious websites
155 * into making unintentional configuration changes:
157 * - Added flag to each cgi_dispatcher that allows or denies
159 * - Introduced proviorical function that greps for the
160 * referrer header before regular header parsing happens
161 * - Added safety check to dispatch_known_cgi. CGI is called
162 * if (cgi harmless || no referrer || we are referrer).
163 * Else a) toggle calls are modified not to change status and
164 * b) all other calls are denied.
166 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
167 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
169 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
170 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
172 * Revision 1.70 2002/05/19 11:33:20 jongfoster
173 * If a CGI error was not handled, and propogated back to
174 * dispatch_known_cgi(), then it was assumed to be "out of memory".
175 * This gave a very misleading error message.
177 * Now other errors will cause a simple message giving the error
178 * number and asking the user to report a bug.
181 * http://sourceforge.net/tracker/index.php?func=detail
182 * &aid=557905&group_id=11118&atid=111118
184 * Revision 1.69 2002/05/14 21:28:40 oes
185 * - Fixed add_help_link to link to the (now split) actions
186 * part of the config chapter
187 * - Renamed helplink export to actions-help-prefix
189 * Revision 1.68 2002/05/12 21:36:29 jongfoster
190 * Correcting function comments
192 * Revision 1.67 2002/04/30 12:02:07 oes
193 * Nit: updated a comment
195 * Revision 1.66 2002/04/26 18:32:57 jongfoster
196 * Fixing a memory leak on error
198 * Revision 1.65 2002/04/26 12:53:51 oes
199 * - New function add_help_link
200 * - default_exports now exports links to the user manual
201 * and a prefix for links into the config chapter
203 * Revision 1.64 2002/04/24 02:17:21 oes
204 * - Better descriptions for CGIs
205 * - Hide edit-actions, more shortcuts
206 * - Moved get_char_param, get_string_param and get_number_param here
209 * Revision 1.63 2002/04/15 19:06:43 jongfoster
212 * Revision 1.62 2002/04/10 19:59:46 jongfoster
213 * Fixes to #include in templates:
214 * - Didn't close main file if loading an included template fails.
215 * - I'm paranoid and want to disallow "#include /etc/passwd".
217 * Revision 1.61 2002/04/10 13:37:48 oes
218 * Made templates modular: template_load now recursive with max depth 1
220 * Revision 1.60 2002/04/08 20:50:25 swa
223 * Revision 1.59 2002/04/05 15:51:51 oes
224 * - added send-stylesheet CGI
225 * - bugfix: error-pages now get correct request protocol
227 * - kludged CGI descriptions and menu not to break JS syntax
229 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
230 * Fix Mac OSX compiler warnings
232 * Revision 1.57 2002/03/26 22:29:54 swa
233 * we have a new homepage!
235 * Revision 1.56 2002/03/24 17:50:46 jongfoster
236 * Fixing compile error if actions file editor disabled
238 * Revision 1.55 2002/03/24 16:55:06 oes
239 * Making GIF checkerboard transparent
241 * Revision 1.54 2002/03/24 16:18:15 jongfoster
244 * Revision 1.53 2002/03/24 16:06:00 oes
245 * Correct transparency for checkerboard PNG. Thanks, Magnus!
247 * Revision 1.52 2002/03/24 15:23:33 jongfoster
250 * Revision 1.51 2002/03/24 13:25:43 swa
251 * name change related issues
253 * Revision 1.50 2002/03/16 23:54:06 jongfoster
254 * Adding graceful termination feature, to help look for memory leaks.
255 * If you enable this (which, by design, has to be done by hand
256 * editing config.h) and then go to http://i.j.b/die, then the program
257 * will exit cleanly after the *next* request. It should free all the
258 * memory that was used.
260 * Revision 1.49 2002/03/13 00:27:04 jongfoster
263 * Revision 1.48 2002/03/08 17:47:07 jongfoster
266 * Revision 1.47 2002/03/08 16:41:33 oes
267 * Added GIF images again
269 * Revision 1.46 2002/03/07 03:48:38 oes
270 * - Changed built-in images from GIF to PNG
271 * (with regard to Unisys patent issue)
272 * - Added a 4x4 pattern PNG which is less intrusive
273 * than the logo but also clearly marks the deleted banners
275 * Revision 1.45 2002/03/06 22:54:35 jongfoster
276 * Automated function-comment nitpicking.
278 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
279 * - Better error reporting on OS/2
280 * - Fix double-slash comment (oops)
282 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
283 * - Re-enable OS/2 building after new parms were added
284 * - Fix false out of memory report when resolving CGI templates when no IP
285 * address is available of failed attempt (a la no such domain)
287 * Revision 1.42 2002/01/21 00:33:20 jongfoster
288 * Replacing strsav() with the safer string_append() or string_join().
289 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
290 * Adding missing html_encode() to error message generators.
291 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
293 * Revision 1.41 2002/01/17 20:56:22 jongfoster
294 * Replacing hard references to the URL of the config interface
295 * with #defines from project.h
297 * Revision 1.40 2002/01/09 14:26:46 oes
298 * Added support for thread-safe gmtime_r call.
300 * Revision 1.39 2001/11/16 00:48:13 jongfoster
301 * Fixing a compiler warning
303 * Revision 1.38 2001/11/13 00:31:21 jongfoster
304 * - Adding new CGIs for use by non-JavaScript browsers:
305 * edit-actions-url-form
306 * edit-actions-add-url-form
307 * edit-actions-remove-url-form
308 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
311 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
312 * Show enablement/disablement status in almost all templates.
313 * There is a little trickiness here: apparent recursive resolution of
314 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
315 * the actual enablement status. So a similar construct,
316 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
319 * Revision 1.36 2001/10/26 17:33:27 oes
322 * Revision 1.35 2001/10/23 21:48:19 jongfoster
323 * Cleaning up error handling in CGI functions - they now send back
324 * a HTML error page and should never cause a FATAL error. (Fixes one
325 * potential source of "denial of service" attacks).
327 * CGI actions file editor that works and is actually useful.
329 * Ability to toggle Junkbuster remotely using a CGI call.
331 * You can turn off both the above features in the main configuration
332 * file, e.g. if you are running a multi-user proxy.
334 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
335 * Only show "Local support" on templates conditionally:
336 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
337 * - if not, no Local support section appears
339 * Revision 1.33 2001/10/14 22:28:41 jongfoster
340 * Fixing stupid typo.
342 * Revision 1.32 2001/10/14 22:20:18 jongfoster
343 * - Changes to CGI dispatching method to match CGI names exactly,
344 * rather than doing a prefix match.
345 * - No longer need to count the length of the CGI handler names by hand.
346 * - Adding new handler for 404 error when disptching a CGI, if none of
347 * the handlers match.
348 * - Adding new handlers for CGI actionsfile editor.
350 * Revision 1.31 2001/10/10 10:56:39 oes
351 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
353 * Revision 1.30 2001/10/02 15:30:57 oes
354 * Introduced show-request cgi
356 * Revision 1.29 2001/09/20 15:47:44 steudten
358 * Fix BUG: Modify int size to size_t size in fill_template()
359 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
361 * Revision 1.28 2001/09/19 18:00:37 oes
362 * - Deletef time() FIXME (Can't fail under Linux either, if
363 * the argument is guaranteed to be in out address space,
366 * - Pointer notation cosmetics
367 * - Fixed a minor bug in template_fill(): Failiure of
368 * pcrs_execute() now secure.
370 * Revision 1.27 2001/09/16 17:08:54 jongfoster
371 * Moving simple CGI functions from cgi.c to new file cgisimple.c
373 * Revision 1.26 2001/09/16 15:47:37 jongfoster
374 * First version of CGI-based edit interface. This is very much a
375 * work-in-progress, and you can't actually use it to edit anything
376 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
377 * to have any effect.
379 * Revision 1.25 2001/09/16 15:02:35 jongfoster
380 * Adding i.j.b/robots.txt.
381 * Inlining add_stats() since it's only ever called from one place.
383 * Revision 1.24 2001/09/16 11:38:01 jongfoster
384 * Splitting fill_template() into 2 functions:
385 * template_load() loads the file
386 * template_fill() performs the PCRS regexps.
387 * This is because the CGI edit interface has a "table row"
388 * template which is used many times in the page - this
389 * change means it's only loaded from disk once.
391 * Revision 1.23 2001/09/16 11:16:05 jongfoster
392 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
394 * Revision 1.22 2001/09/16 11:00:10 jongfoster
395 * New function alloc_http_response, for symmetry with free_http_response
397 * Revision 1.21 2001/09/13 23:53:03 jongfoster
398 * Support for both static and dynamically generated CGI pages.
399 * Correctly setting Last-Modified: and Expires: HTTP headers.
401 * Revision 1.20 2001/09/13 23:40:36 jongfoster
402 * (Cosmetic only) Indentation correction
404 * Revision 1.19 2001/09/13 23:31:25 jongfoster
405 * Moving image data to cgi.c rather than cgi.h.
407 * Revision 1.18 2001/08/05 16:06:20 jongfoster
408 * Modifiying "struct map" so that there are now separate header and
409 * "map_entry" structures. This means that functions which modify a
410 * map no longer need to return a pointer to the modified map.
411 * Also, it no longer reverses the order of the entries (which may be
412 * important with some advanced template substitutions).
414 * Revision 1.17 2001/08/05 15:57:38 oes
415 * Adapted finish_http_response to new list_to_text
417 * Revision 1.16 2001/08/01 21:33:18 jongfoster
418 * Changes to fill_template() that reduce memory usage without having
419 * an impact on performance. I also renamed some variables so as not
420 * to clash with the C++ keywords "new" and "template".
422 * Revision 1.15 2001/08/01 21:19:22 jongfoster
423 * Moving file version information to a separate CGI page.
425 * Revision 1.14 2001/08/01 00:19:03 jongfoster
426 * New function: map_conditional() for an if-then-else syntax.
427 * Changing to use new version of show_defines()
429 * Revision 1.13 2001/07/30 22:08:36 jongfoster
430 * Tidying up #defines:
431 * - All feature #defines are now of the form FEATURE_xxx
432 * - Permanently turned off WIN_GUI_EDIT
433 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
435 * Revision 1.12 2001/07/29 18:47:05 jongfoster
436 * Adding missing #include "loadcfg.h"
438 * Revision 1.11 2001/07/18 17:24:37 oes
439 * Changed to conform to new pcrs interface
441 * Revision 1.10 2001/07/13 13:53:13 oes
442 * Removed all #ifdef PCRS and related code
444 * Revision 1.9 2001/06/29 21:45:41 oes
445 * Indentation, CRLF->LF, Tab-> Space
447 * Revision 1.8 2001/06/29 13:21:46 oes
448 * - Cosmetics: renamed and reordered functions, variables,
449 * texts, improved comments etc
451 * - Removed ij_untrusted_url() The relevant
452 * info is now part of the "untrusted" page,
453 * which is generated by filters.c:trust_url()
455 * - Generators of content now call finish_http_response()
456 * themselves, making jcc.c:chat() a little less
459 * - Removed obsolete "Pragma: no-cache" from our headers
461 * - http_responses now know their head length
463 * - fill_template now uses the new interface to pcrs, so that
464 * - long jobs (like whole files) no longer have to be assembled
465 * in a fixed size buffer
466 * - the new T (trivial) option is used, and the replacement may
467 * contain Perl syntax backrefs without confusing pcrs
469 * - Introduced default_exports() which generates a set of exports
470 * common to all CGIs and other content generators
472 * - Introduced convenience function map_block_killer()
474 * - Introduced convenience function make_menu()
476 * - Introduced CGI-like function error_response() which generates
477 * the "No such domain" and "Connect failed" messages using the
480 * - cgi_show_url_info:
481 * - adapted to new CGI features
482 * - form and answers now generated from same template
483 * - http:// prefix in URL now OK
486 * - adapted to new CGI features
487 * - no longer uses csp->init_proxy_args
490 * - moved menu generation to make_menu()
492 * - add_stats now writes single export map entries instead
495 * - Moved redirect_url() to filters.c
497 * - Fixed mem leak in free_http_response(), map_block_killer(),
499 * - Removed logentry from cancelled commit
501 * Revision 1.7 2001/06/09 10:51:58 jongfoster
502 * Changing "show URL info" handler to new style.
503 * Changing BUFSIZ ==> BUFFER_SIZE
505 * Revision 1.6 2001/06/07 23:05:19 jongfoster
506 * Removing code related to old forward and ACL files.
508 * Revision 1.5 2001/06/05 19:59:16 jongfoster
509 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
511 * Revision 1.4 2001/06/04 10:41:52 swa
512 * show version string of cgi.h and cgi.c
514 * Revision 1.3 2001/06/03 19:12:16 oes
515 * introduced new cgi handling
517 * No revisions before 1.3
519 **********************************************************************/
525 #include <sys/types.h>
533 #define snprintf _snprintf
534 #endif /* def _WIN32 */
542 #include "miscutil.h"
543 #include "cgisimple.h"
544 #ifdef FEATURE_CGI_EDIT_ACTIONS
546 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
548 /* loadcfg.h is for global_toggle_state only */
549 #ifdef FEATURE_PTHREAD
551 /* jcc.h is for mutex semaphore globals only */
552 #endif /* def FEATURE_PTHREAD */
553 const char cgi_h_rcs[] = CGI_H_VERSION;
556 * List of CGI functions: name, handler, description
557 * Note: Do NOT use single quotes in the description;
558 * this will break the dynamic "blocked" template!
560 static const struct cgi_dispatcher cgi_dispatchers[] = {
565 #ifdef FEATURE_GRACEFUL_TERMINATION
568 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
569 "this is a one click Denial Of Service attack!!!</em>",
574 #ifdef FEATURE_CGI_EDIT_ACTIONS
575 "View & change the current configuration",
577 "View the current configuration",
582 "View the source code version numbers",
586 "View the request headers.",
590 "Look up which actions apply to a URL and why",
592 #ifdef FEATURE_CGI_EDIT_ACTIONS
593 #ifdef FEATURE_TOGGLE
596 "Toggle Privoxy on or off",
598 #endif /* def FEATURE_TOGGLE */
599 { "edit-actions", /* Edit the actions list */
602 { "eaa", /* Shortcut for edit-actions-add-url-form */
603 cgi_edit_actions_add_url_form,
605 { "eau", /* Shortcut for edit-actions-url-form */
606 cgi_edit_actions_url_form,
608 { "ear", /* Shortcut for edit-actions-remove-url-form */
609 cgi_edit_actions_remove_url_form,
611 { "eal", /* Shortcut for edit-actions-list */
612 cgi_edit_actions_list,
614 { "eafu", /* Shortcut for edit-actions-for-url */
615 cgi_edit_actions_for_url,
617 { "eas", /* Shortcut for edit-actions-submit */
618 cgi_edit_actions_submit,
620 { "easa", /* Shortcut for edit-actions-section-add */
621 cgi_edit_actions_section_add,
623 { "easr", /* Shortcut for edit-actions-section-remove */
624 cgi_edit_actions_section_remove,
626 { "eass", /* Shortcut for edit-actions-section-swap */
627 cgi_edit_actions_section_swap,
629 { "edit-actions-for-url",
630 cgi_edit_actions_for_url,
631 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
632 { "edit-actions-list",
633 cgi_edit_actions_list,
634 NULL, TRUE /* Edit the actions list */ },
635 { "edit-actions-submit",
636 cgi_edit_actions_submit,
637 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
638 { "edit-actions-url",
639 cgi_edit_actions_url,
640 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
641 { "edit-actions-url-form",
642 cgi_edit_actions_url_form,
643 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
644 { "edit-actions-add-url",
645 cgi_edit_actions_add_url,
646 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
647 { "edit-actions-add-url-form",
648 cgi_edit_actions_add_url_form,
649 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
650 { "edit-actions-remove-url",
651 cgi_edit_actions_remove_url,
652 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
653 { "edit-actions-remove-url-form",
654 cgi_edit_actions_remove_url_form,
655 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
656 { "edit-actions-section-add",
657 cgi_edit_actions_section_add,
658 NULL, FALSE /* Remove a section from the actionsfile */ },
659 { "edit-actions-section-remove",
660 cgi_edit_actions_section_remove,
661 NULL, FALSE /* Remove a section from the actionsfile */ },
662 { "edit-actions-section-swap",
663 cgi_edit_actions_section_swap,
664 NULL, FALSE /* Swap two sections in the actionsfile */ },
665 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
668 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
671 NULL, TRUE /* Send a built-in image */ },
674 NULL, TRUE /* Send templates/cgi-style.css */ },
676 cgi_transparent_image,
677 NULL, TRUE /* Send a transparent image (short name) */ },
679 cgi_send_user_manual,
680 NULL, TRUE /* Send user-manual */ },
681 { NULL, /* NULL Indicates end of list and default page */
683 NULL, TRUE /* Unknown CGI page */ }
688 * Built-in images for ad replacement
690 * Hint: You can encode your own images like this:
691 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
694 #ifdef FEATURE_NO_GIFS
697 * Checkerboard pattern, as a PNG.
699 const char image_pattern_data[] =
700 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
701 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
702 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
703 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
704 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
705 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
706 "\000\000\000\111\105\116\104\256\102\140\202";
709 * 1x1 transparant PNG.
711 const char image_blank_data[] =
712 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
713 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
714 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
715 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
716 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
717 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
718 "\000\000\000\000\111\105\116\104\256\102\140\202";
722 * Checkerboard pattern, as a GIF.
724 const char image_pattern_data[] =
725 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
726 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
727 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
728 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
732 * 1x1 transparant GIF.
734 const char image_blank_data[] =
735 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
736 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
737 "\000\001\000\000\002\002D\001\000;";
740 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
741 const size_t image_blank_length = sizeof(image_blank_data) - 1;
744 static struct http_response cgi_error_memory_response[1];
746 static struct http_response *dispatch_known_cgi(struct client_state * csp,
748 static struct map *parse_cgi_parameters(char *argstring);
751 /*********************************************************************
753 * Function : dispatch_cgi
755 * Description : Checks if a request URL has either the magical
756 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
757 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
758 * http://config.privoxy.org/). If so, it passes
759 * the (rest of the) path onto dispatch_known_cgi, which
760 * calls the relevant CGI handler function.
763 * 1 : csp = Current client state (buffers, headers, etc...)
765 * Returns : http_response if match, NULL if nonmatch or handler fail
767 *********************************************************************/
768 struct http_response *dispatch_cgi(struct client_state *csp)
770 const char *host = csp->http->host;
771 const char *path = csp->http->path;
774 * Should we intercept ?
777 /* Note: "example.com" and "example.com." are equivalent hostnames. */
779 /* Either the host matches CGI_SITE_1_HOST ..*/
780 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
781 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
782 && (path[0] == '/') )
784 /* ..then the path will all be for us. Remove leading '/' */
787 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
788 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
789 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
790 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
792 /* take everything following CGI_SITE_2_PATH */
793 path += strlen(CGI_SITE_2_PATH);
796 /* skip the forward slash after CGI_SITE_2_PATH */
799 else if (*path != '\0')
802 * weirdness: URL is /configXXX, where XXX is some string
803 * Do *NOT* intercept.
815 * This is a CGI call.
818 return dispatch_known_cgi(csp, path);
822 /*********************************************************************
824 * Function : grep_cgi_referrer
826 * Description : Ugly provisorical fix that greps the value of the
827 * referer HTTP header field out of a linked list of
828 * strings like found at csp->headers. Will disappear
831 * FIXME: csp->headers ought to be csp->http->headers
832 * FIXME: Parsing all client header lines should
833 * happen right after the request is received!
836 * 1 : csp = Current client state (buffers, headers, etc...)
838 * Returns : pointer to value (no copy!), or NULL if none found.
840 *********************************************************************/
841 char *grep_cgi_referrer(struct client_state *csp)
843 struct list_entry *p;
845 for (p = csp->headers->first; p != NULL; p = p->next)
847 if (p->str == NULL) continue;
848 if (strncmpic(p->str, "Referer: ", 9) == 0)
850 return ((p->str) + 9);
858 /*********************************************************************
860 * Function : dispatch_known_cgi
862 * Description : Processes a CGI once dispatch_cgi has determined that
863 * it matches one of the magic prefixes. Parses the path
864 * as a cgi name plus query string, prepares a map that
865 * maps CGI parameter names to their values, initializes
866 * the http_response struct, and calls the relevant CGI
870 * 1 : csp = Current client state (buffers, headers, etc...)
871 * 2 : path = Path of CGI, with the CGI prefix removed.
872 * Should not have a leading "/".
874 * Returns : http_response, or NULL on handler failure or out of
877 *********************************************************************/
878 static struct http_response *dispatch_known_cgi(struct client_state * csp,
881 const struct cgi_dispatcher *d;
882 struct map *param_list;
883 struct http_response *rsp;
884 char *query_args_start;
889 if (NULL == (path_copy = strdup(path)))
891 return cgi_error_memory();
893 query_args_start = path_copy;
894 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
898 if (*query_args_start == '/')
900 *query_args_start++ = '\0';
901 if ((param_list = new_map()))
903 map(param_list, "file", 1, url_decode(query_args_start), 0);
908 if (*query_args_start == '?')
910 *query_args_start++ = '\0';
912 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
915 return cgi_error_memory();
921 * path_copy = CGI call name
922 * param_list = CGI params, as map
925 /* Get mem for response or fail*/
926 if (NULL == (rsp = alloc_http_response()))
929 free_map(param_list);
930 return cgi_error_memory();
933 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
934 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
935 csp->ip_addr_str, csp->http->cmd);
938 * Find and start the right CGI function
943 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
946 * If the called CGI is either harmless, or referred
947 * from a trusted source, start it.
950 || ((NULL != (referrer = grep_cgi_referrer(csp)))
951 && (0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)))
954 err = (d->handler)(csp, rsp, param_list);
959 * Else, modify toggle calls so that they only display
960 * the status, and deny all other calls.
962 if (0 == strcmp(path_copy, "toggle"))
964 unmap(param_list, "set");
965 err = (d->handler)(csp, rsp, param_list);
969 err = cgi_error_disabled(csp, rsp);
974 free_map(param_list);
976 if (err == JB_ERR_CGI_PARAMS)
978 err = cgi_error_bad_param(csp, rsp);
980 if (err && (err != JB_ERR_MEMORY))
982 /* Unexpected error! Shouldn't get here */
983 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
984 err = cgi_error_unknown(csp, rsp, err);
989 return finish_http_response(rsp);
993 /* Error in handler, probably out-of-memory */
994 free_http_response(rsp);
995 return cgi_error_memory();
1003 /*********************************************************************
1005 * Function : parse_cgi_parameters
1007 * Description : Parse a URL-encoded argument string into name/value
1008 * pairs and store them in a struct map list.
1011 * 1 : argstring = string to be parsed. Will be trashed.
1013 * Returns : pointer to param list, or NULL if out of memory.
1015 *********************************************************************/
1016 static struct map *parse_cgi_parameters(char *argstring)
1019 char *vector[BUFFER_SIZE];
1021 struct map *cgi_params;
1023 if (NULL == (cgi_params = new_map()))
1029 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1030 * the fragment identifier along with the request, so we must
1031 * cut it off here, so it won't pollute the CGI params:
1033 if (NULL != (p = strchr(argstring, '#')))
1038 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1040 for (i = 0; i < pairs; i++)
1042 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1045 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1047 free_map(cgi_params);
1058 /*********************************************************************
1060 * Function : get_char_param
1062 * Description : Get a single-character parameter passed to a CGI
1066 * 1 : parameters = map of cgi parameters
1067 * 2 : param_name = The name of the parameter to read
1069 * Returns : Uppercase character on success, '\0' on error.
1071 *********************************************************************/
1072 char get_char_param(const struct map *parameters,
1073 const char *param_name)
1080 ch = *(lookup(parameters, param_name));
1081 if ((ch >= 'a') && (ch <= 'z'))
1083 ch = (char)(ch - 'a' + 'A');
1090 /*********************************************************************
1092 * Function : get_string_param
1094 * Description : Get a string paramater, to be used as an
1095 * ACTION_STRING or ACTION_MULTI paramater.
1096 * Validates the input to prevent stupid/malicious
1097 * users from corrupting their action file.
1100 * 1 : parameters = map of cgi parameters
1101 * 2 : param_name = The name of the parameter to read
1102 * 3 : pparam = destination for paramater. Allocated as
1103 * part of the map "parameters", so don't free it.
1104 * Set to NULL if not specified.
1106 * Returns : JB_ERR_OK on success, or if the paramater
1107 * was not specified.
1108 * JB_ERR_MEMORY on out-of-memory.
1109 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1111 *********************************************************************/
1112 jb_err get_string_param(const struct map *parameters,
1113 const char *param_name,
1114 const char **pparam)
1126 param = lookup(parameters, param_name);
1132 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1137 * Note that the length limit is arbitrary, it just seems
1138 * sensible to limit it to *something*. There's no
1139 * technical reason for any limit at all.
1141 return JB_ERR_CGI_PARAMS;
1144 /* Check every character to see if it's legal */
1146 while ((ch = *s++) != '\0')
1148 if ( ((unsigned char)ch < (unsigned char)' ')
1151 /* Probable hack attempt, or user accidentally used '}'. */
1152 return JB_ERR_CGI_PARAMS;
1163 /*********************************************************************
1165 * Function : get_number_param
1167 * Description : Get a non-negative integer from the parameters
1168 * passed to a CGI function.
1171 * 1 : csp = Current client state (buffers, headers, etc...)
1172 * 2 : parameters = map of cgi parameters
1173 * 3 : name = Name of CGI parameter to read
1174 * 4 : pvalue = destination for value.
1175 * Set to -1 on error.
1177 * Returns : JB_ERR_OK on success
1178 * JB_ERR_MEMORY on out-of-memory
1179 * JB_ERR_CGI_PARAMS if the parameter was not specified
1182 *********************************************************************/
1183 jb_err get_number_param(struct client_state *csp,
1184 const struct map *parameters,
1199 param = lookup(parameters, name);
1202 return JB_ERR_CGI_PARAMS;
1205 /* We don't use atoi because I want to check this carefully... */
1208 while ((ch = *param++) != '\0')
1210 if ((ch < '0') || (ch > '9'))
1212 return JB_ERR_CGI_PARAMS;
1215 ch = (char)(ch - '0');
1219 * <limits.h> defines UINT_MAX
1221 * (UINT_MAX - ch) / 10 is the largest number that
1222 * can be safely multiplied by 10 then have ch added.
1224 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1226 return JB_ERR_CGI_PARAMS;
1229 value = value * 10 + (unsigned)ch;
1240 /*********************************************************************
1242 * Function : error_response
1244 * Description : returns an http_response that explains the reason
1245 * why a request failed.
1248 * 1 : csp = Current client state (buffers, headers, etc...)
1249 * 2 : templatename = Which template should be used for the answer
1250 * 3 : sys_err = system error number
1252 * Returns : A http_response. If we run out of memory, this
1253 * will be cgi_error_memory().
1255 *********************************************************************/
1256 struct http_response *error_response(struct client_state *csp,
1257 const char *templatename,
1261 struct http_response *rsp;
1262 struct map *exports = default_exports(csp, NULL);
1265 if (exports == NULL)
1267 return cgi_error_memory();
1270 if (NULL == (rsp = alloc_http_response()))
1273 return cgi_error_memory();
1276 if (csp->flags & CSP_FLAG_FORCED)
1278 path = strdup(FORCE_PREFIX);
1284 err = string_append(&path, csp->http->path);
1286 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1287 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1288 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1289 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1290 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1293 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1296 /* Some failures, like "404 no such domain", don't have an IP address. */
1297 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1305 free_http_response(rsp);
1306 return cgi_error_memory();
1309 if (!strcmp(templatename, "no-such-domain"))
1311 rsp->status = strdup("404 No such domain");
1312 if (rsp->status == NULL)
1315 free_http_response(rsp);
1316 return cgi_error_memory();
1319 else if (!strcmp(templatename, "connect-failed"))
1321 rsp->status = strdup("503 Connect failed");
1322 if (rsp->status == NULL)
1325 free_http_response(rsp);
1326 return cgi_error_memory();
1330 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1333 free_http_response(rsp);
1334 return cgi_error_memory();
1337 return finish_http_response(rsp);
1341 /*********************************************************************
1343 * Function : cgi_error_disabled
1345 * Description : CGI function that is called to generate an error
1346 * response if the actions editor or toggle CGI are
1347 * accessed despite having being disabled at compile-
1351 * 1 : csp = Current client state (buffers, headers, etc...)
1352 * 2 : rsp = http_response data structure for output
1354 * CGI Parameters : none
1356 * Returns : JB_ERR_OK on success
1357 * JB_ERR_MEMORY on out-of-memory error.
1359 *********************************************************************/
1360 jb_err cgi_error_disabled(struct client_state *csp,
1361 struct http_response *rsp)
1363 struct map *exports;
1368 if (NULL == (exports = default_exports(csp, NULL)))
1370 return JB_ERR_MEMORY;
1373 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1377 /*********************************************************************
1379 * Function : cgi_init_error_messages
1381 * Description : Call at the start of the program to initialize
1382 * the error message used by cgi_error_memory().
1388 *********************************************************************/
1389 void cgi_init_error_messages(void)
1391 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1392 cgi_error_memory_response->head =
1393 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1394 "Content-Type: text/html\r\n"
1396 cgi_error_memory_response->body =
1398 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1400 "<h1>500 Internal Privoxy Error</h1>\r\n"
1401 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1402 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1406 cgi_error_memory_response->head_length =
1407 strlen(cgi_error_memory_response->head);
1408 cgi_error_memory_response->content_length =
1409 strlen(cgi_error_memory_response->body);
1413 /*********************************************************************
1415 * Function : cgi_error_memory
1417 * Description : Called if a CGI function runs out of memory.
1418 * Returns a statically-allocated error response.
1422 * Returns : http_response data structure for output. This is
1423 * statically allocated, for obvious reasons.
1425 *********************************************************************/
1426 struct http_response *cgi_error_memory(void)
1428 /* assert that it's been initialized. */
1429 assert(cgi_error_memory_response->head);
1431 return cgi_error_memory_response;
1435 /*********************************************************************
1437 * Function : cgi_error_no_template
1439 * Description : Almost-CGI function that is called if a template
1440 * cannot be loaded. Note this is not a true CGI,
1441 * it takes a template name rather than a map of
1445 * 1 : csp = Current client state (buffers, headers, etc...)
1446 * 2 : rsp = http_response data structure for output
1447 * 3 : template_name = Name of template that could not
1450 * Returns : JB_ERR_OK on success
1451 * JB_ERR_MEMORY on out-of-memory error.
1453 *********************************************************************/
1454 jb_err cgi_error_no_template(struct client_state *csp,
1455 struct http_response *rsp,
1456 const char *template_name)
1458 static const char status[] =
1459 "500 Internal Privoxy Error";
1460 static const char body_prefix[] =
1462 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1464 "<h1>500 Internal Privoxy Error</h1>\r\n"
1465 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1466 "<p><b>Could not load template file <code>";
1467 static const char body_suffix[] =
1468 "</code> or one of it's included components.</b></p>\r\n"
1469 "<p>Please contact your proxy administrator.</p>\r\n"
1470 "<p>If you are the proxy administrator, please put the required file(s)"
1471 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1472 "location of the <code><i>(confdir)</i></code> directory "
1473 "is specified in the main Privoxy <code>config</code> "
1474 "file. (It's typically the Privoxy install directory"
1476 ", or <code>/etc/privoxy/</code>"
1477 #endif /* ndef _WIN32 */
1484 assert(template_name);
1486 /* Reset rsp, if needed */
1490 rsp->content_length = 0;
1491 rsp->head_length = 0;
1494 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1495 if (rsp->body == NULL)
1497 return JB_ERR_MEMORY;
1499 strcpy(rsp->body, body_prefix);
1500 strcat(rsp->body, template_name);
1501 strcat(rsp->body, body_suffix);
1503 rsp->status = strdup(status);
1504 if (rsp->body == NULL)
1506 return JB_ERR_MEMORY;
1513 /*********************************************************************
1515 * Function : cgi_error_unknown
1517 * Description : Almost-CGI function that is called if an unexpected
1518 * error occurs in the top-level CGI dispatcher.
1519 * In this context, "unexpected" means "anything other
1520 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1521 * expected to handle all other errors internally,
1522 * since they can give more relavent error messages
1525 * Note this is not a true CGI, it takes an error
1526 * code rather than a map of parameters.
1529 * 1 : csp = Current client state (buffers, headers, etc...)
1530 * 2 : rsp = http_response data structure for output
1531 * 3 : error_to_report = Error code to report.
1533 * Returns : JB_ERR_OK on success
1534 * JB_ERR_MEMORY on out-of-memory error.
1536 *********************************************************************/
1537 jb_err cgi_error_unknown(struct client_state *csp,
1538 struct http_response *rsp,
1539 jb_err error_to_report)
1541 static const char status[] =
1542 "500 Internal Privoxy Error";
1543 static const char body_prefix[] =
1545 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1547 "<h1>500 Internal Privoxy Error</h1>\r\n"
1548 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1549 "<p><b>Unexpected internal error: ";
1550 static const char body_suffix[] =
1553 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1554 "file a bug report</a>.</p>\r\n"
1561 /* Reset rsp, if needed */
1565 rsp->content_length = 0;
1566 rsp->head_length = 0;
1569 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1571 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1572 if (rsp->body == NULL)
1574 return JB_ERR_MEMORY;
1576 strcpy(rsp->body, body_prefix);
1577 strcat(rsp->body, errnumbuf);
1578 strcat(rsp->body, body_suffix);
1580 rsp->status = strdup(status);
1581 if (rsp->body == NULL)
1583 return JB_ERR_MEMORY;
1590 /*********************************************************************
1592 * Function : cgi_error_bad_param
1594 * Description : CGI function that is called if the parameters
1595 * (query string) for a CGI were wrong.
1598 * 1 : csp = Current client state (buffers, headers, etc...)
1599 * 2 : rsp = http_response data structure for output
1601 * CGI Parameters : none
1603 * Returns : JB_ERR_OK on success
1604 * JB_ERR_MEMORY on out-of-memory error.
1606 *********************************************************************/
1607 jb_err cgi_error_bad_param(struct client_state *csp,
1608 struct http_response *rsp)
1610 struct map *exports;
1615 if (NULL == (exports = default_exports(csp, NULL)))
1617 return JB_ERR_MEMORY;
1620 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1624 /*********************************************************************
1626 * Function : cgi_redirect
1628 * Description : CGI support function to generate a HTTP redirect
1632 * 1 : rsp = http_response data structure for output
1633 * 2 : target = string with the target URL
1635 * CGI Parameters : None
1637 * Returns : JB_ERR_OK on success
1638 * JB_ERR_MEMORY on out-of-memory error.
1640 *********************************************************************/
1641 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1648 err = enlist_unique_header(rsp->headers, "Location", target);
1650 rsp->status = strdup("302 Local Redirect from Privoxy");
1651 if (rsp->status == NULL)
1653 return JB_ERR_MEMORY;
1660 /*********************************************************************
1662 * Function : add_help_link
1664 * Description : Produce a copy of the string given as item,
1665 * embedded in an HTML link to its corresponding
1666 * section (item name in uppercase) in the actions
1667 * chapter of the user manual, (whose URL is given in
1668 * the config and defaults to our web site).
1670 * FIXME: I currently only work for actions, and would
1671 * like to be generalized for other topics.
1674 * 1 : item = item (will NOT be free()d.)
1675 * It is assumed to be HTML-safe.
1676 * 2 : config = The current configuration.
1678 * Returns : String with item embedded in link, or NULL on
1681 *********************************************************************/
1682 char *add_help_link(const char *item,
1683 struct configuration_spec *config)
1687 if (!item) return NULL;
1689 result = strdup("<a href=\"");
1690 if (!strncmpic(config->usermanual, "file://", 7) ||
1691 !strncmpic(config->usermanual, "http", 4))
1693 string_append(&result, config->usermanual);
1697 string_append(&result, "http://");
1698 string_append(&result, CGI_SITE_2_HOST);
1699 string_append(&result, "/user-manual/");
1701 string_append(&result, ACTIONS_HELP_PREFIX);
1702 string_join (&result, string_toupper(item));
1703 string_append(&result, "\">");
1704 string_append(&result, item);
1705 string_append(&result, "</a> ");
1711 /*********************************************************************
1713 * Function : get_http_time
1715 * Description : Get the time in a format suitable for use in a
1716 * HTTP header - e.g.:
1717 * "Sun, 06 Nov 1994 08:49:37 GMT"
1720 * 1 : time_offset = Time returned will be current time
1721 * plus this number of seconds.
1722 * 2 : buf = Destination for result. Must be long enough
1723 * to hold 29 characters plus a trailing zero.
1727 *********************************************************************/
1728 void get_http_time(int time_offset, char *buf)
1730 static const char day_names[7][4] =
1731 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1732 static const char month_names[12][4] =
1733 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1734 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1737 time_t current_time;
1738 #if defined(HAVE_GMTIME_R)
1740 * Declare dummy up here (instead of inside get/set gmt block) so it
1741 * doesn't go out of scope before it's potentially used in snprintf later.
1742 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1743 * !defined HAVE_GMTIME_R.
1750 time(¤t_time); /* get current time */
1752 current_time += time_offset;
1754 /* get and save the gmt */
1757 t = gmtime_r(¤t_time, &dummy);
1758 #elif FEATURE_PTHREAD
1759 pthread_mutex_lock(&gmtime_mutex);
1760 t = gmtime(¤t_time);
1761 pthread_mutex_unlock(&gmtime_mutex);
1763 t = gmtime(¤t_time);
1767 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1769 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1770 day_names[t->tm_wday],
1772 month_names[t->tm_mon],
1782 /*********************************************************************
1784 * Function : finish_http_response
1786 * Description : Fill in the missing headers in an http response,
1787 * and flatten the headers to an http head.
1790 * 1 : rsp = pointer to http_response to be processed
1792 * Returns : A http_response, usually the rsp parameter.
1793 * On error, free()s rsp and returns cgi_error_memory()
1795 *********************************************************************/
1796 struct http_response *finish_http_response(struct http_response *rsp)
1798 char buf[BUFFER_SIZE];
1801 /* Special case - do NOT change this statically allocated response,
1802 * which is ready for output anyway.
1804 if (rsp == cgi_error_memory_response)
1810 * Fill in the HTTP Status
1812 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1813 err = enlist_first(rsp->headers, buf);
1816 * Set the Content-Length
1818 if (rsp->content_length == 0)
1820 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1824 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1825 err = enlist(rsp->headers, buf);
1828 if (strncmpic(rsp->status, "302", 3))
1831 * If it's not a redirect without any content,
1832 * set the Content-Type to text/html if it's
1833 * not already specified.
1835 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1839 * Fill in the rest of the default headers:
1841 * Date: set to current date/time.
1842 * Last-Modified: set to date/time the page was last changed.
1843 * Expires: set to date/time page next needs reloading.
1844 * Cache-Control: set to "no-cache" if applicable.
1846 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1851 * Set Expires to about 10 min into the future so it'll get reloaded
1852 * occasionally, e.g. if Privoxy gets upgraded.
1857 get_http_time(0, buf);
1858 err = enlist_unique_header(rsp->headers, "Date", buf);
1861 /* Some date in the past. */
1862 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1866 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1867 err = enlist_unique_header(rsp->headers, "Expires", buf);
1870 else if (!strncmpic(rsp->status, "302", 3))
1872 get_http_time(0, buf);
1873 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1878 * Setting "Cache-Control" to "no-cache" and "Expires" to
1879 * the current time doesn't exactly forbid caching, it just
1880 * requires the client to revalidate the cached copy.
1882 * If a temporary problem occurs and the user tries again after
1883 * getting Privoxy's error message, a compliant browser may set the
1884 * If-Modified-Since header with the content of the error page's
1885 * Last-Modified header. More often than not, the document on the server
1886 * is older than Privoxy's error message, the server would send status code
1887 * 304 and the browser would display the outdated error message again and again.
1889 * For documents delivered with status code 404 or 503 we set "Last-Modified"
1890 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1891 * and can be safely used to "revalidate" without getting a status code 304.
1893 * There is no need to let the useless If-Modified-Since header reach the
1894 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1896 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1898 get_http_time(0, buf);
1899 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1900 if (!strncmpic(rsp->status, "404", 3) || !strncmpic(rsp->status, "503", 3))
1902 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1906 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1908 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1909 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1915 * HTTP/1.1 applications that do not support persistent connections MUST
1916 * include the "close" connection option in every message.
1918 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
1923 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1925 free_http_response(rsp);
1926 return cgi_error_memory();
1928 rsp->head_length = strlen(rsp->head);
1935 /*********************************************************************
1937 * Function : alloc_http_response
1939 * Description : Allocates a new http_response structure.
1943 * Returns : pointer to a new http_response, or NULL.
1945 *********************************************************************/
1946 struct http_response *alloc_http_response(void)
1948 return (struct http_response *) zalloc(sizeof(struct http_response));
1953 /*********************************************************************
1955 * Function : free_http_response
1957 * Description : Free the memory occupied by an http_response
1958 * and its depandant structures.
1961 * 1 : rsp = pointer to http_response to be freed
1965 *********************************************************************/
1966 void free_http_response(struct http_response *rsp)
1969 * Must special case cgi_error_memory_response, which is never freed.
1971 if (rsp && (rsp != cgi_error_memory_response))
1976 destroy_list(rsp->headers);
1983 /*********************************************************************
1985 * Function : template_load
1987 * Description : CGI support function that loads a given HTML
1988 * template from the confdir, ignoring comment
1989 * lines and following #include statements up to
1993 * 1 : csp = Current client state (buffers, headers, etc...)
1994 * 2 : template_ptr = Destination for pointer to loaded
1996 * 3 : templatename = name of the HTML template to be used
1997 * 4 : recursive = Flag set if this function calls itself
1998 * following an #include statament
2000 * Returns : JB_ERR_OK on success
2001 * JB_ERR_MEMORY on out-of-memory error.
2002 * JB_ERR_FILE if the template file cannot be read
2004 *********************************************************************/
2005 jb_err template_load(struct client_state *csp, char **template_ptr,
2006 const char *templatename, int recursive)
2009 char *templates_dir_path;
2012 char *included_module;
2015 char buf[BUFFER_SIZE];
2018 assert(template_ptr);
2019 assert(templatename);
2021 *template_ptr = NULL;
2023 /* Validate template name. Paranoia. */
2024 for (p = templatename; *p != 0; p++)
2026 if ( ((*p < 'a') || (*p > 'z'))
2027 && ((*p < 'A') || (*p > 'Z'))
2028 && ((*p < '0') || (*p > '9'))
2032 /* Illegal character */
2037 /* Generate full path */
2039 templates_dir_path = make_path(csp->config->confdir, "templates");
2040 if (templates_dir_path == NULL)
2042 return JB_ERR_MEMORY;
2045 full_path = make_path(templates_dir_path, templatename);
2046 free(templates_dir_path);
2047 if (full_path == NULL)
2049 return JB_ERR_MEMORY;
2052 /* Allocate buffer */
2054 file_buffer = strdup("");
2055 if (file_buffer == NULL)
2058 return JB_ERR_MEMORY;
2061 /* Open template file */
2063 if (NULL == (fp = fopen(full_path, "r")))
2065 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2073 * Read the file, ignoring comments, and honoring #include
2074 * statements, unless we're already called recursively.
2076 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2077 * This is unlikely in practise.
2079 while (fgets(buf, BUFFER_SIZE, fp))
2081 if (!recursive && !strncmp(buf, "#include ", 9))
2083 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2090 if (string_join(&file_buffer, included_module))
2093 return JB_ERR_MEMORY;
2099 /* skip lines starting with '#' */
2105 if (string_append(&file_buffer, buf))
2108 return JB_ERR_MEMORY;
2113 *template_ptr = file_buffer;
2119 /*********************************************************************
2121 * Function : template_fill
2123 * Description : CGI support function that fills in a pre-loaded
2124 * HTML template by replacing @name@ with value using
2125 * pcrs, for each item in the output map.
2127 * Note that a leading '$' charachter in the export map's
2128 * values will be stripped and toggle on backreference
2132 * 1 : template_ptr = IN: Template to be filled out.
2134 * OUT: Filled out template.
2135 * Caller must free().
2136 * 2 : exports = map with fill in symbol -> name pairs
2138 * Returns : JB_ERR_OK on success (and for uncritical errors)
2139 * JB_ERR_MEMORY on out-of-memory error
2141 *********************************************************************/
2142 jb_err template_fill(char **template_ptr, const struct map *exports)
2144 struct map_entry *m;
2146 char buf[BUFFER_SIZE];
2147 char *tmp_out_buffer;
2153 assert(template_ptr);
2154 assert(*template_ptr);
2157 file_buffer = *template_ptr;
2158 size = strlen(file_buffer) + 1;
2161 * Assemble pcrs joblist from exports map
2163 for (m = exports->first; m != NULL; m = m->next)
2165 if (*m->name == '$')
2168 * First character of name is '$', so remove this flag
2169 * character and allow backreferences ($1 etc) in the
2170 * "replace with" text.
2172 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2178 * Treat the "replace with" text as a literal string -
2179 * no quoting needed, no backreferences allowed.
2180 * ("Trivial" ['T'] flag).
2184 /* Enclose name in @@ */
2185 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2189 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2191 /* Make and run job. */
2192 job = pcrs_compile(buf, m->value, flags, &error);
2195 if (error == PCRS_ERR_NOMEM)
2198 *template_ptr = NULL;
2199 return JB_ERR_MEMORY;
2203 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2204 /* Hope it wasn't important and silently ignore the invalid job */
2209 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2212 if (NULL == tmp_out_buffer)
2214 *template_ptr = NULL;
2215 return JB_ERR_MEMORY;
2221 * Substitution failed, keep the original buffer,
2222 * log the problem and ignore it.
2224 * The user might see some unresolved @CGI_VARIABLES@,
2225 * but returning a special CGI error page seems unreasonable
2226 * and could mask more important error messages.
2228 free(tmp_out_buffer);
2229 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2230 buf, m->value, flags, pcrs_strerror(error));
2234 /* Substitution succeeded, use modified buffer. */
2236 file_buffer = tmp_out_buffer;
2244 *template_ptr = file_buffer;
2249 /*********************************************************************
2251 * Function : template_fill_for_cgi
2253 * Description : CGI support function that loads a HTML template
2254 * and fills it in. Handles file-not-found errors
2255 * by sending a HTML error message. For convenience,
2256 * this function also frees the passed "exports" map.
2259 * 1 : csp = Client state
2260 * 2 : templatename = name of the HTML template to be used
2261 * 3 : exports = map with fill in symbol -> name pairs.
2262 * Will be freed by this function.
2263 * 4 : rsp = Response structure to fill in.
2265 * Returns : JB_ERR_OK on success
2266 * JB_ERR_MEMORY on out-of-memory error
2268 *********************************************************************/
2269 jb_err template_fill_for_cgi(struct client_state *csp,
2270 const char *templatename,
2271 struct map *exports,
2272 struct http_response *rsp)
2277 assert(templatename);
2281 err = template_load(csp, &rsp->body, templatename, 0);
2282 if (err == JB_ERR_FILE)
2285 return cgi_error_no_template(csp, rsp, templatename);
2290 return err; /* JB_ERR_MEMORY */
2292 err = template_fill(&rsp->body, exports);
2298 /*********************************************************************
2300 * Function : default_exports
2302 * Description : returns a struct map list that contains exports
2303 * which are common to all CGI functions.
2306 * 1 : csp = Current client state (buffers, headers, etc...)
2307 * 2 : caller = name of CGI who calls us and which should
2308 * be excluded from the generated menu. May be
2310 * Returns : NULL if no memory, else a new map. Caller frees.
2312 *********************************************************************/
2313 struct map *default_exports(const struct client_state *csp, const char *caller)
2317 struct map * exports;
2318 int local_help_exists = 0;
2322 exports = new_map();
2323 if (exports == NULL)
2328 err = map(exports, "version", 1, html_encode(VERSION), 0);
2329 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2330 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2331 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2332 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2333 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2334 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2335 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2336 !strncmpic(csp->config->usermanual, "http", 4))
2338 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2342 if (!err) err = map(exports, "user-manual", 1, "http://"CGI_SITE_2_HOST"/user-manual/" ,1);
2344 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2345 #ifdef FEATURE_TOGGLE
2346 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2348 if (!err) err = map_block_killer(exports, "can-toggle");
2351 snprintf(buf, 20, "%d", csp->config->hport);
2352 if (!err) err = map(exports, "my-port", 1, buf, 1);
2354 if(!strcmp(CODE_STATUS, "stable"))
2356 if (!err) err = map_block_killer(exports, "unstable");
2359 if (csp->config->admin_address != NULL)
2361 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2362 local_help_exists = 1;
2366 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2369 if (csp->config->proxy_info_url != NULL)
2371 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2372 local_help_exists = 1;
2376 if (!err) err = map_block_killer(exports, "have-proxy-info");
2379 if (local_help_exists == 0)
2381 if (!err) err = map_block_killer(exports, "have-help-info");
2394 /*********************************************************************
2396 * Function : map_block_killer
2398 * Description : Convenience function.
2399 * Adds a "killer" for the conditional HTML-template
2400 * block <name>, i.e. a substitution of the regex
2401 * "if-<name>-start.*if-<name>-end" to the given
2405 * 1 : exports = map to extend
2406 * 2 : name = name of conditional block
2408 * Returns : JB_ERR_OK on success
2409 * JB_ERR_MEMORY on out-of-memory error.
2411 *********************************************************************/
2412 jb_err map_block_killer(struct map *exports, const char *name)
2414 char buf[1000]; /* Will do, since the names are hardwired */
2418 assert(strlen(name) < 490);
2420 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2421 return map(exports, buf, 1, "", 1);
2425 /*********************************************************************
2427 * Function : map_block_keep
2429 * Description : Convenience function. Removes the markers used
2430 * by map-block-killer, to save a few bytes.
2431 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2434 * 1 : exports = map to extend
2435 * 2 : name = name of conditional block
2437 * Returns : JB_ERR_OK on success
2438 * JB_ERR_MEMORY on out-of-memory error.
2440 *********************************************************************/
2441 jb_err map_block_keep(struct map *exports, const char *name)
2444 char buf[500]; /* Will do, since the names are hardwired */
2448 assert(strlen(name) < 490);
2450 snprintf(buf, 500, "if-%s-start", name);
2451 err = map(exports, buf, 1, "", 1);
2458 snprintf(buf, 500, "if-%s-end", name);
2459 return map(exports, buf, 1, "", 1);
2463 /*********************************************************************
2465 * Function : map_conditional
2467 * Description : Convenience function.
2468 * Adds an "if-then-else" for the conditional HTML-template
2469 * block <name>, i.e. a substitution of the form:
2476 * The control structure and one of the alternatives
2480 * 1 : exports = map to extend
2481 * 2 : name = name of conditional block
2482 * 3 : choose_first = nonzero for first, zero for second.
2484 * Returns : JB_ERR_OK on success
2485 * JB_ERR_MEMORY on out-of-memory error.
2487 *********************************************************************/
2488 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2490 char buf[1000]; /* Will do, since the names are hardwired */
2495 assert(strlen(name) < 480);
2497 snprintf(buf, 1000, (choose_first
2498 ? "else-not-%s@.*@endif-%s"
2499 : "if-%s-then@.*@else-not-%s"),
2502 err = map(exports, buf, 1, "", 1);
2508 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2509 return map(exports, buf, 1, "", 1);
2513 /*********************************************************************
2515 * Function : make_menu
2517 * Description : Returns an HTML-formatted menu of the available
2518 * unhidden CGIs, excluding the one given in <self>
2519 * and the toggle CGI if toggling is disabled.
2522 * 1 : self = name of CGI to leave out, can be NULL for
2524 * 2 : feature_flags = feature bitmap from csp->config
2527 * Returns : menu string, or NULL on out-of-memory error.
2529 *********************************************************************/
2530 char *make_menu(const char *self, const unsigned feature_flags)
2532 const struct cgi_dispatcher *d;
2533 char *result = strdup("");
2537 self = "NO-SUCH-CGI!";
2540 /* List available unhidden CGI's and export as "other-cgis" */
2541 for (d = cgi_dispatchers; d->name; d++)
2544 #ifdef FEATURE_TOGGLE
2545 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2548 * Suppress the toggle link if remote toggling is disabled.
2552 #endif /* def FEATURE_TOGGLE */
2554 if (d->description && strcmp(d->name, self))
2556 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2557 string_append(&result, d->name);
2558 string_append(&result, "\">");
2559 string_append(&result, d->description);
2560 string_append(&result, "</a></li>");
2568 /*********************************************************************
2570 * Function : dump_map
2572 * Description : HTML-dump a map for debugging (as table)
2575 * 1 : the_map = map to dump
2577 * Returns : string with HTML
2579 *********************************************************************/
2580 char *dump_map(const struct map *the_map)
2582 struct map_entry *cur_entry;
2583 char *ret = strdup("");
2585 string_append(&ret, "<table>\n");
2587 for (cur_entry = the_map->first;
2588 (cur_entry != NULL) && (ret != NULL);
2589 cur_entry = cur_entry->next)
2591 string_append(&ret, "<tr><td><b>");
2592 string_join (&ret, html_encode(cur_entry->name));
2593 string_append(&ret, "</b></td><td>");
2594 string_join (&ret, html_encode(cur_entry->value));
2595 string_append(&ret, "</td></tr>\n");
2598 string_append(&ret, "</table>\n");