1 const char cgi_rcs[] = "$Id: cgi.c,v 1.99 2007/08/05 13:42: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-2007
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.99 2007/08/05 13:42:22 fabiankeil
42 * #1763173 from Stefan Huehner: declare some more functions static.
44 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
45 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
47 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
48 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
50 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
51 * Use sizeof() more often.
53 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
54 * Don't overlook map result for the forwarding-type.
56 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
57 * Use a transparent background for the PNG replacement pattern.
59 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
60 * - Save the reason for generating http_responses.
61 * - Fix --disable-toggle (again).
62 * - Use TBL birthday hack for 403 responses as well.
63 * - Uglify the @menu@ again to fix JavaScript
64 * errors on the "blocked" template.
65 * - Escape an ampersand in cgi_error_unknown().
67 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
68 * - Add HEAD support to finish_http_response.
69 * - Add error favicon to internal HTML error messages.
71 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
72 * Add new config option "templdir" to
73 * change the templates directory.
75 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
76 * Added "forwarding-failed" template support for error_response().
78 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
79 * Add favicon delivery functions.
81 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
82 * - Map variables that aren't guaranteed to be
83 * pure ASCII html_encoded.
84 * - Use CGI_PREFIX to generate URL for user manual
85 * CGI page to make sure CGI_SITE_2_PATH is included.
87 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
88 * - "Protect" against a rather lame JavaScript-based
89 * Privoxy detection "attack" and check the referrer
90 * before delivering the CGI style sheet.
91 * - Move referrer check for unsafe CGI pages into
92 * referrer_is_safe() and log the result.
93 * - Map @url@ in cgi-error-disabled page.
94 * It's required for the "go there anyway" link.
95 * - Mark *csp as immutable for grep_cgi_referrer().
97 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
98 * Fix strdup() error handling in cgi_error_unknown()
99 * and cgi_error_no_template(). Reported by Markus Elfring.
101 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
102 * Handle pcrs_execute() errors in template_fill() properly.
104 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
105 * Fixed gcc43 conversion warnings and replaced sprintf
106 * calls with snprintf to give OpenBSD's gcc one less reason
109 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
110 * Escape ampersand in Privoxy menu.
112 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
113 * Suppress the toggle link if remote toggling is disabled.
115 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
116 * Fix configure option --disable-toggle.
117 * Thanks to Peter Thoenen for reporting this.
119 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
120 * Don't lose the FORCE_PREFIX in case of
121 * connection problems. Fixes #612235.
123 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
124 * Make pthread mutex locking more generic. Instead of
125 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
126 * and use mutex locking unless there is an _r function
127 * available. Better safe than sorry.
129 * Fixes "./configure --disable-pthread" and should result
130 * in less threading-related problems on pthread-using platforms,
131 * but it still doesn't fix BR#1122404.
133 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
134 * Use CGI_PREFIX to check the referrer.
135 * The check for "http://config.privoxy.org/" fails
136 * if the user modified CGI_SITE_2_HOST.
138 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
139 * Adjusted headers for Privoxy's cgi responses:
140 * Don't set Last-Modified, Expires and Cache-Control
141 * headers for redirects; always set "Connection: close".
143 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
144 * Only predate the Last-Modified header for cgi responses
145 * that are delivered with status code 404 or 503.
147 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
148 * Mark cgi_send_user_manual as harmless,
149 * to fix the access denied problem Hal spotted.
150 * The manual has no secret content, therefore we
151 * don't have to care about "secure" referrers.
153 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
154 * Incorporate modified version of Roland Rosenfeld's patch to
155 * optionally access the user-manual via Privoxy. Closes patch 679075.
157 * Formatting changed to Privoxy style, added call to
158 * cgi_error_no_template if the requested file doesn't
159 * exist and modified check whether or not Privoxy itself
160 * should serve the manual. Should work cross-platform now.
162 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
163 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
165 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
166 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
167 * with what was really the latest development (the v_3_0_branch branch)
169 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
170 * Moved cgi_error_disabled() from cgiedit.c to
171 * cgi.c to re-enable build with --disable-editor.
172 * Fixes Bug #892744. Thanks to Matthew Fischer
175 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
176 * - Added new function cgi_redirect to handle creation of
177 * HTTP redirect messages formerly repeated in the code.
178 * - Send cgi_error_disabled instead of cgi_error_404 when
179 * referrer check fails
180 * - Dynamic content now gets Expires header field with date
183 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
184 * Bugfix: Transparent PNG was not transparent. Thanks to
185 * Dan Razzell of Starfish Systems for notice and new PNG.
187 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
188 * Security fix: dspatch_known_cgi no longer considers an empty
189 * referrer safe for critical CGIs, since malicious links could
190 * reside on https:// locations which browsers don't advertize as
191 * referrers. Closes bug #749916, thanks to Jeff Epler for the
192 * hint. Goodbye One-Click[tm] toggling :-(
194 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
197 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
198 * Killed a compiler warning on OSX
200 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
201 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
202 * (fixes bug #710056)
203 * - Show toggle info only if we have it
205 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
206 * Move declaration of struct tm dummy outside of a control block so it is
207 * accessible later on during snprintf in get_http_time.
209 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
210 * Cosmetic: Renamed cryptic variable
212 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
213 * 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.
215 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
216 * Disable access to critical CGIs via untrusted referrers.
217 * This prevents users from being tricked by malicious websites
218 * into making unintentional configuration changes:
220 * - Added flag to each cgi_dispatcher that allows or denies
222 * - Introduced proviorical function that greps for the
223 * referrer header before regular header parsing happens
224 * - Added safety check to dispatch_known_cgi. CGI is called
225 * if (cgi harmless || no referrer || we are referrer).
226 * Else a) toggle calls are modified not to change status and
227 * b) all other calls are denied.
229 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
230 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
232 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
233 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
235 * Revision 1.70 2002/05/19 11:33:20 jongfoster
236 * If a CGI error was not handled, and propogated back to
237 * dispatch_known_cgi(), then it was assumed to be "out of memory".
238 * This gave a very misleading error message.
240 * Now other errors will cause a simple message giving the error
241 * number and asking the user to report a bug.
244 * http://sourceforge.net/tracker/index.php?func=detail
245 * &aid=557905&group_id=11118&atid=111118
247 * Revision 1.69 2002/05/14 21:28:40 oes
248 * - Fixed add_help_link to link to the (now split) actions
249 * part of the config chapter
250 * - Renamed helplink export to actions-help-prefix
252 * Revision 1.68 2002/05/12 21:36:29 jongfoster
253 * Correcting function comments
255 * Revision 1.67 2002/04/30 12:02:07 oes
256 * Nit: updated a comment
258 * Revision 1.66 2002/04/26 18:32:57 jongfoster
259 * Fixing a memory leak on error
261 * Revision 1.65 2002/04/26 12:53:51 oes
262 * - New function add_help_link
263 * - default_exports now exports links to the user manual
264 * and a prefix for links into the config chapter
266 * Revision 1.64 2002/04/24 02:17:21 oes
267 * - Better descriptions for CGIs
268 * - Hide edit-actions, more shortcuts
269 * - Moved get_char_param, get_string_param and get_number_param here
272 * Revision 1.63 2002/04/15 19:06:43 jongfoster
275 * Revision 1.62 2002/04/10 19:59:46 jongfoster
276 * Fixes to #include in templates:
277 * - Didn't close main file if loading an included template fails.
278 * - I'm paranoid and want to disallow "#include /etc/passwd".
280 * Revision 1.61 2002/04/10 13:37:48 oes
281 * Made templates modular: template_load now recursive with max depth 1
283 * Revision 1.60 2002/04/08 20:50:25 swa
286 * Revision 1.59 2002/04/05 15:51:51 oes
287 * - added send-stylesheet CGI
288 * - bugfix: error-pages now get correct request protocol
290 * - kludged CGI descriptions and menu not to break JS syntax
292 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
293 * Fix Mac OSX compiler warnings
295 * Revision 1.57 2002/03/26 22:29:54 swa
296 * we have a new homepage!
298 * Revision 1.56 2002/03/24 17:50:46 jongfoster
299 * Fixing compile error if actions file editor disabled
301 * Revision 1.55 2002/03/24 16:55:06 oes
302 * Making GIF checkerboard transparent
304 * Revision 1.54 2002/03/24 16:18:15 jongfoster
307 * Revision 1.53 2002/03/24 16:06:00 oes
308 * Correct transparency for checkerboard PNG. Thanks, Magnus!
310 * Revision 1.52 2002/03/24 15:23:33 jongfoster
313 * Revision 1.51 2002/03/24 13:25:43 swa
314 * name change related issues
316 * Revision 1.50 2002/03/16 23:54:06 jongfoster
317 * Adding graceful termination feature, to help look for memory leaks.
318 * If you enable this (which, by design, has to be done by hand
319 * editing config.h) and then go to http://i.j.b/die, then the program
320 * will exit cleanly after the *next* request. It should free all the
321 * memory that was used.
323 * Revision 1.49 2002/03/13 00:27:04 jongfoster
326 * Revision 1.48 2002/03/08 17:47:07 jongfoster
329 * Revision 1.47 2002/03/08 16:41:33 oes
330 * Added GIF images again
332 * Revision 1.46 2002/03/07 03:48:38 oes
333 * - Changed built-in images from GIF to PNG
334 * (with regard to Unisys patent issue)
335 * - Added a 4x4 pattern PNG which is less intrusive
336 * than the logo but also clearly marks the deleted banners
338 * Revision 1.45 2002/03/06 22:54:35 jongfoster
339 * Automated function-comment nitpicking.
341 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
342 * - Better error reporting on OS/2
343 * - Fix double-slash comment (oops)
345 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
346 * - Re-enable OS/2 building after new parms were added
347 * - Fix false out of memory report when resolving CGI templates when no IP
348 * address is available of failed attempt (a la no such domain)
350 * Revision 1.42 2002/01/21 00:33:20 jongfoster
351 * Replacing strsav() with the safer string_append() or string_join().
352 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
353 * Adding missing html_encode() to error message generators.
354 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
356 * Revision 1.41 2002/01/17 20:56:22 jongfoster
357 * Replacing hard references to the URL of the config interface
358 * with #defines from project.h
360 * Revision 1.40 2002/01/09 14:26:46 oes
361 * Added support for thread-safe gmtime_r call.
363 * Revision 1.39 2001/11/16 00:48:13 jongfoster
364 * Fixing a compiler warning
366 * Revision 1.38 2001/11/13 00:31:21 jongfoster
367 * - Adding new CGIs for use by non-JavaScript browsers:
368 * edit-actions-url-form
369 * edit-actions-add-url-form
370 * edit-actions-remove-url-form
371 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
374 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
375 * Show enablement/disablement status in almost all templates.
376 * There is a little trickiness here: apparent recursive resolution of
377 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
378 * the actual enablement status. So a similar construct,
379 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
382 * Revision 1.36 2001/10/26 17:33:27 oes
385 * Revision 1.35 2001/10/23 21:48:19 jongfoster
386 * Cleaning up error handling in CGI functions - they now send back
387 * a HTML error page and should never cause a FATAL error. (Fixes one
388 * potential source of "denial of service" attacks).
390 * CGI actions file editor that works and is actually useful.
392 * Ability to toggle Junkbuster remotely using a CGI call.
394 * You can turn off both the above features in the main configuration
395 * file, e.g. if you are running a multi-user proxy.
397 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
398 * Only show "Local support" on templates conditionally:
399 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
400 * - if not, no Local support section appears
402 * Revision 1.33 2001/10/14 22:28:41 jongfoster
403 * Fixing stupid typo.
405 * Revision 1.32 2001/10/14 22:20:18 jongfoster
406 * - Changes to CGI dispatching method to match CGI names exactly,
407 * rather than doing a prefix match.
408 * - No longer need to count the length of the CGI handler names by hand.
409 * - Adding new handler for 404 error when disptching a CGI, if none of
410 * the handlers match.
411 * - Adding new handlers for CGI actionsfile editor.
413 * Revision 1.31 2001/10/10 10:56:39 oes
414 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
416 * Revision 1.30 2001/10/02 15:30:57 oes
417 * Introduced show-request cgi
419 * Revision 1.29 2001/09/20 15:47:44 steudten
421 * Fix BUG: Modify int size to size_t size in fill_template()
422 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
424 * Revision 1.28 2001/09/19 18:00:37 oes
425 * - Deletef time() FIXME (Can't fail under Linux either, if
426 * the argument is guaranteed to be in out address space,
429 * - Pointer notation cosmetics
430 * - Fixed a minor bug in template_fill(): Failiure of
431 * pcrs_execute() now secure.
433 * Revision 1.27 2001/09/16 17:08:54 jongfoster
434 * Moving simple CGI functions from cgi.c to new file cgisimple.c
436 * Revision 1.26 2001/09/16 15:47:37 jongfoster
437 * First version of CGI-based edit interface. This is very much a
438 * work-in-progress, and you can't actually use it to edit anything
439 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
440 * to have any effect.
442 * Revision 1.25 2001/09/16 15:02:35 jongfoster
443 * Adding i.j.b/robots.txt.
444 * Inlining add_stats() since it's only ever called from one place.
446 * Revision 1.24 2001/09/16 11:38:01 jongfoster
447 * Splitting fill_template() into 2 functions:
448 * template_load() loads the file
449 * template_fill() performs the PCRS regexps.
450 * This is because the CGI edit interface has a "table row"
451 * template which is used many times in the page - this
452 * change means it's only loaded from disk once.
454 * Revision 1.23 2001/09/16 11:16:05 jongfoster
455 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
457 * Revision 1.22 2001/09/16 11:00:10 jongfoster
458 * New function alloc_http_response, for symmetry with free_http_response
460 * Revision 1.21 2001/09/13 23:53:03 jongfoster
461 * Support for both static and dynamically generated CGI pages.
462 * Correctly setting Last-Modified: and Expires: HTTP headers.
464 * Revision 1.20 2001/09/13 23:40:36 jongfoster
465 * (Cosmetic only) Indentation correction
467 * Revision 1.19 2001/09/13 23:31:25 jongfoster
468 * Moving image data to cgi.c rather than cgi.h.
470 * Revision 1.18 2001/08/05 16:06:20 jongfoster
471 * Modifiying "struct map" so that there are now separate header and
472 * "map_entry" structures. This means that functions which modify a
473 * map no longer need to return a pointer to the modified map.
474 * Also, it no longer reverses the order of the entries (which may be
475 * important with some advanced template substitutions).
477 * Revision 1.17 2001/08/05 15:57:38 oes
478 * Adapted finish_http_response to new list_to_text
480 * Revision 1.16 2001/08/01 21:33:18 jongfoster
481 * Changes to fill_template() that reduce memory usage without having
482 * an impact on performance. I also renamed some variables so as not
483 * to clash with the C++ keywords "new" and "template".
485 * Revision 1.15 2001/08/01 21:19:22 jongfoster
486 * Moving file version information to a separate CGI page.
488 * Revision 1.14 2001/08/01 00:19:03 jongfoster
489 * New function: map_conditional() for an if-then-else syntax.
490 * Changing to use new version of show_defines()
492 * Revision 1.13 2001/07/30 22:08:36 jongfoster
493 * Tidying up #defines:
494 * - All feature #defines are now of the form FEATURE_xxx
495 * - Permanently turned off WIN_GUI_EDIT
496 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
498 * Revision 1.12 2001/07/29 18:47:05 jongfoster
499 * Adding missing #include "loadcfg.h"
501 * Revision 1.11 2001/07/18 17:24:37 oes
502 * Changed to conform to new pcrs interface
504 * Revision 1.10 2001/07/13 13:53:13 oes
505 * Removed all #ifdef PCRS and related code
507 * Revision 1.9 2001/06/29 21:45:41 oes
508 * Indentation, CRLF->LF, Tab-> Space
510 * Revision 1.8 2001/06/29 13:21:46 oes
511 * - Cosmetics: renamed and reordered functions, variables,
512 * texts, improved comments etc
514 * - Removed ij_untrusted_url() The relevant
515 * info is now part of the "untrusted" page,
516 * which is generated by filters.c:trust_url()
518 * - Generators of content now call finish_http_response()
519 * themselves, making jcc.c:chat() a little less
522 * - Removed obsolete "Pragma: no-cache" from our headers
524 * - http_responses now know their head length
526 * - fill_template now uses the new interface to pcrs, so that
527 * - long jobs (like whole files) no longer have to be assembled
528 * in a fixed size buffer
529 * - the new T (trivial) option is used, and the replacement may
530 * contain Perl syntax backrefs without confusing pcrs
532 * - Introduced default_exports() which generates a set of exports
533 * common to all CGIs and other content generators
535 * - Introduced convenience function map_block_killer()
537 * - Introduced convenience function make_menu()
539 * - Introduced CGI-like function error_response() which generates
540 * the "No such domain" and "Connect failed" messages using the
543 * - cgi_show_url_info:
544 * - adapted to new CGI features
545 * - form and answers now generated from same template
546 * - http:// prefix in URL now OK
549 * - adapted to new CGI features
550 * - no longer uses csp->init_proxy_args
553 * - moved menu generation to make_menu()
555 * - add_stats now writes single export map entries instead
558 * - Moved redirect_url() to filters.c
560 * - Fixed mem leak in free_http_response(), map_block_killer(),
562 * - Removed logentry from cancelled commit
564 * Revision 1.7 2001/06/09 10:51:58 jongfoster
565 * Changing "show URL info" handler to new style.
566 * Changing BUFSIZ ==> BUFFER_SIZE
568 * Revision 1.6 2001/06/07 23:05:19 jongfoster
569 * Removing code related to old forward and ACL files.
571 * Revision 1.5 2001/06/05 19:59:16 jongfoster
572 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
574 * Revision 1.4 2001/06/04 10:41:52 swa
575 * show version string of cgi.h and cgi.c
577 * Revision 1.3 2001/06/03 19:12:16 oes
578 * introduced new cgi handling
580 * No revisions before 1.3
582 **********************************************************************/
588 #include <sys/types.h>
602 #include "miscutil.h"
603 #include "cgisimple.h"
604 #ifdef FEATURE_CGI_EDIT_ACTIONS
606 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
608 /* loadcfg.h is for global_toggle_state only */
609 #ifdef FEATURE_PTHREAD
611 /* jcc.h is for mutex semaphore globals only */
612 #endif /* def FEATURE_PTHREAD */
613 const char cgi_h_rcs[] = CGI_H_VERSION;
616 * List of CGI functions: name, handler, description
617 * Note: Do NOT use single quotes in the description;
618 * this will break the dynamic "blocked" template!
620 static const struct cgi_dispatcher cgi_dispatchers[] = {
625 #ifdef FEATURE_GRACEFUL_TERMINATION
628 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
629 "this is a one click Denial Of Service attack!!!</em>",
634 #ifdef FEATURE_CGI_EDIT_ACTIONS
635 "View & change the current configuration",
637 "View the current configuration",
642 "View the source code version numbers",
646 "View the request headers.",
650 "Look up which actions apply to a URL and why",
652 #ifdef FEATURE_CGI_EDIT_ACTIONS
653 #ifdef FEATURE_TOGGLE
656 "Toggle Privoxy on or off",
658 #endif /* def FEATURE_TOGGLE */
659 { "edit-actions", /* Edit the actions list */
662 { "eaa", /* Shortcut for edit-actions-add-url-form */
663 cgi_edit_actions_add_url_form,
665 { "eau", /* Shortcut for edit-actions-url-form */
666 cgi_edit_actions_url_form,
668 { "ear", /* Shortcut for edit-actions-remove-url-form */
669 cgi_edit_actions_remove_url_form,
671 { "eal", /* Shortcut for edit-actions-list */
672 cgi_edit_actions_list,
674 { "eafu", /* Shortcut for edit-actions-for-url */
675 cgi_edit_actions_for_url,
677 { "eas", /* Shortcut for edit-actions-submit */
678 cgi_edit_actions_submit,
680 { "easa", /* Shortcut for edit-actions-section-add */
681 cgi_edit_actions_section_add,
683 { "easr", /* Shortcut for edit-actions-section-remove */
684 cgi_edit_actions_section_remove,
686 { "eass", /* Shortcut for edit-actions-section-swap */
687 cgi_edit_actions_section_swap,
689 { "edit-actions-for-url",
690 cgi_edit_actions_for_url,
691 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
692 { "edit-actions-list",
693 cgi_edit_actions_list,
694 NULL, TRUE /* Edit the actions list */ },
695 { "edit-actions-submit",
696 cgi_edit_actions_submit,
697 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
698 { "edit-actions-url",
699 cgi_edit_actions_url,
700 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
701 { "edit-actions-url-form",
702 cgi_edit_actions_url_form,
703 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
704 { "edit-actions-add-url",
705 cgi_edit_actions_add_url,
706 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
707 { "edit-actions-add-url-form",
708 cgi_edit_actions_add_url_form,
709 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
710 { "edit-actions-remove-url",
711 cgi_edit_actions_remove_url,
712 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
713 { "edit-actions-remove-url-form",
714 cgi_edit_actions_remove_url_form,
715 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
716 { "edit-actions-section-add",
717 cgi_edit_actions_section_add,
718 NULL, FALSE /* Remove a section from the actionsfile */ },
719 { "edit-actions-section-remove",
720 cgi_edit_actions_section_remove,
721 NULL, FALSE /* Remove a section from the actionsfile */ },
722 { "edit-actions-section-swap",
723 cgi_edit_actions_section_swap,
724 NULL, FALSE /* Swap two sections in the actionsfile */ },
725 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
726 { "error-favicon.ico",
727 cgi_send_error_favicon,
728 NULL, TRUE /* Sends the favicon image for error pages. */ },
730 cgi_send_default_favicon,
731 NULL, TRUE /* Sends the default favicon image. */ },
734 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
737 NULL, TRUE /* Send a built-in image */ },
740 NULL, FALSE /* Send templates/cgi-style.css */ },
742 cgi_transparent_image,
743 NULL, TRUE /* Send a transparent image (short name) */ },
745 cgi_send_user_manual,
746 NULL, TRUE /* Send user-manual */ },
747 { NULL, /* NULL Indicates end of list and default page */
749 NULL, TRUE /* Unknown CGI page */ }
754 * Built-in images for ad replacement
756 * Hint: You can encode your own images like this:
757 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
760 #ifdef FEATURE_NO_GIFS
763 * Checkerboard pattern, as a PNG.
765 const char image_pattern_data[] =
766 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
767 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
768 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
769 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
770 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
771 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
772 "\000\000\000\000\111\105\116\104\256\102\140\202";
775 * 1x1 transparant PNG.
777 const char image_blank_data[] =
778 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
779 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
780 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
781 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
782 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
783 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
784 "\000\000\000\000\111\105\116\104\256\102\140\202";
788 * Checkerboard pattern, as a GIF.
790 const char image_pattern_data[] =
791 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
792 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
793 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
794 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
798 * 1x1 transparant GIF.
800 const char image_blank_data[] =
801 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
802 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
803 "\000\001\000\000\002\002D\001\000;";
806 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
807 const size_t image_blank_length = sizeof(image_blank_data) - 1;
810 static struct http_response cgi_error_memory_response[1];
812 static struct http_response *dispatch_known_cgi(struct client_state * csp,
814 static struct map *parse_cgi_parameters(char *argstring);
817 /*********************************************************************
819 * Function : dispatch_cgi
821 * Description : Checks if a request URL has either the magical
822 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
823 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
824 * http://config.privoxy.org/). If so, it passes
825 * the (rest of the) path onto dispatch_known_cgi, which
826 * calls the relevant CGI handler function.
829 * 1 : csp = Current client state (buffers, headers, etc...)
831 * Returns : http_response if match, NULL if nonmatch or handler fail
833 *********************************************************************/
834 struct http_response *dispatch_cgi(struct client_state *csp)
836 const char *host = csp->http->host;
837 const char *path = csp->http->path;
840 * Should we intercept ?
843 /* Note: "example.com" and "example.com." are equivalent hostnames. */
845 /* Either the host matches CGI_SITE_1_HOST ..*/
846 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
847 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
848 && (path[0] == '/') )
850 /* ..then the path will all be for us. Remove leading '/' */
853 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
854 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
855 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
856 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
858 /* take everything following CGI_SITE_2_PATH */
859 path += strlen(CGI_SITE_2_PATH);
862 /* skip the forward slash after CGI_SITE_2_PATH */
865 else if (*path != '\0')
868 * weirdness: URL is /configXXX, where XXX is some string
869 * Do *NOT* intercept.
881 * This is a CGI call.
884 return dispatch_known_cgi(csp, path);
888 /*********************************************************************
890 * Function : grep_cgi_referrer
892 * Description : Ugly provisorical fix that greps the value of the
893 * referer HTTP header field out of a linked list of
894 * strings like found at csp->headers. Will disappear
897 * FIXME: csp->headers ought to be csp->http->headers
898 * FIXME: Parsing all client header lines should
899 * happen right after the request is received!
902 * 1 : csp = Current client state (buffers, headers, etc...)
904 * Returns : pointer to value (no copy!), or NULL if none found.
906 *********************************************************************/
907 static char *grep_cgi_referrer(const struct client_state *csp)
909 struct list_entry *p;
911 for (p = csp->headers->first; p != NULL; p = p->next)
913 if (p->str == NULL) continue;
914 if (strncmpic(p->str, "Referer: ", 9) == 0)
916 return ((p->str) + 9);
924 /*********************************************************************
926 * Function : referrer_is_safe
928 * Description : Decides whether we trust the Referer for
929 * CGI pages which are only meant to be reachable
930 * through Privoxy's web interface directly.
933 * 1 : csp = Current client state (buffers, headers, etc...)
935 * Returns : TRUE if the referrer is safe, or
936 * FALSE if the referrer is unsafe or not set.
938 *********************************************************************/
939 static int referrer_is_safe(const struct client_state *csp)
942 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
944 referrer = grep_cgi_referrer(csp);
946 if (NULL == referrer)
948 /* No referrer, no access */
949 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
952 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
953 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
955 /* Trustworthy referrer */
956 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
957 csp->http->url, referrer);
963 /* Untrustworthy referrer */
964 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
965 csp->http->url, referrer);
972 /*********************************************************************
974 * Function : dispatch_known_cgi
976 * Description : Processes a CGI once dispatch_cgi has determined that
977 * it matches one of the magic prefixes. Parses the path
978 * as a cgi name plus query string, prepares a map that
979 * maps CGI parameter names to their values, initializes
980 * the http_response struct, and calls the relevant CGI
984 * 1 : csp = Current client state (buffers, headers, etc...)
985 * 2 : path = Path of CGI, with the CGI prefix removed.
986 * Should not have a leading "/".
988 * Returns : http_response, or NULL on handler failure or out of
991 *********************************************************************/
992 static struct http_response *dispatch_known_cgi(struct client_state * csp,
995 const struct cgi_dispatcher *d;
996 struct map *param_list;
997 struct http_response *rsp;
998 char *query_args_start;
1002 if (NULL == (path_copy = strdup(path)))
1004 return cgi_error_memory();
1006 query_args_start = path_copy;
1007 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1011 if (*query_args_start == '/')
1013 *query_args_start++ = '\0';
1014 if ((param_list = new_map()))
1016 map(param_list, "file", 1, url_decode(query_args_start), 0);
1021 if (*query_args_start == '?')
1023 *query_args_start++ = '\0';
1025 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1028 return cgi_error_memory();
1034 * path_copy = CGI call name
1035 * param_list = CGI params, as map
1038 /* Get mem for response or fail*/
1039 if (NULL == (rsp = alloc_http_response()))
1042 free_map(param_list);
1043 return cgi_error_memory();
1047 * Find and start the right CGI function
1049 d = cgi_dispatchers;
1052 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1055 * If the called CGI is either harmless, or referred
1056 * from a trusted source, start it.
1058 if (d->harmless || referrer_is_safe(csp))
1060 err = (d->handler)(csp, rsp, param_list);
1065 * Else, modify toggle calls so that they only display
1066 * the status, and deny all other calls.
1068 if (0 == strcmp(path_copy, "toggle"))
1070 unmap(param_list, "set");
1071 err = (d->handler)(csp, rsp, param_list);
1075 err = cgi_error_disabled(csp, rsp);
1080 free_map(param_list);
1082 if (err == JB_ERR_CGI_PARAMS)
1084 err = cgi_error_bad_param(csp, rsp);
1086 if (err && (err != JB_ERR_MEMORY))
1088 /* Unexpected error! Shouldn't get here */
1089 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1090 err = cgi_error_unknown(csp, rsp, err);
1095 rsp->reason = RSP_REASON_CGI_CALL;
1096 return finish_http_response(csp, rsp);
1100 /* Error in handler, probably out-of-memory */
1101 free_http_response(rsp);
1102 return cgi_error_memory();
1110 /*********************************************************************
1112 * Function : parse_cgi_parameters
1114 * Description : Parse a URL-encoded argument string into name/value
1115 * pairs and store them in a struct map list.
1118 * 1 : argstring = string to be parsed. Will be trashed.
1120 * Returns : pointer to param list, or NULL if out of memory.
1122 *********************************************************************/
1123 static struct map *parse_cgi_parameters(char *argstring)
1126 char *vector[BUFFER_SIZE];
1128 struct map *cgi_params;
1130 if (NULL == (cgi_params = new_map()))
1136 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1137 * the fragment identifier along with the request, so we must
1138 * cut it off here, so it won't pollute the CGI params:
1140 if (NULL != (p = strchr(argstring, '#')))
1145 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1147 for (i = 0; i < pairs; i++)
1149 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1152 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1154 free_map(cgi_params);
1165 /*********************************************************************
1167 * Function : get_char_param
1169 * Description : Get a single-character parameter passed to a CGI
1173 * 1 : parameters = map of cgi parameters
1174 * 2 : param_name = The name of the parameter to read
1176 * Returns : Uppercase character on success, '\0' on error.
1178 *********************************************************************/
1179 char get_char_param(const struct map *parameters,
1180 const char *param_name)
1187 ch = *(lookup(parameters, param_name));
1188 if ((ch >= 'a') && (ch <= 'z'))
1190 ch = (char)(ch - 'a' + 'A');
1197 /*********************************************************************
1199 * Function : get_string_param
1201 * Description : Get a string paramater, to be used as an
1202 * ACTION_STRING or ACTION_MULTI paramater.
1203 * Validates the input to prevent stupid/malicious
1204 * users from corrupting their action file.
1207 * 1 : parameters = map of cgi parameters
1208 * 2 : param_name = The name of the parameter to read
1209 * 3 : pparam = destination for paramater. Allocated as
1210 * part of the map "parameters", so don't free it.
1211 * Set to NULL if not specified.
1213 * Returns : JB_ERR_OK on success, or if the paramater
1214 * was not specified.
1215 * JB_ERR_MEMORY on out-of-memory.
1216 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1218 *********************************************************************/
1219 jb_err get_string_param(const struct map *parameters,
1220 const char *param_name,
1221 const char **pparam)
1233 param = lookup(parameters, param_name);
1239 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1244 * Note that the length limit is arbitrary, it just seems
1245 * sensible to limit it to *something*. There's no
1246 * technical reason for any limit at all.
1248 return JB_ERR_CGI_PARAMS;
1251 /* Check every character to see if it's legal */
1253 while ((ch = *s++) != '\0')
1255 if ( ((unsigned char)ch < (unsigned char)' ')
1258 /* Probable hack attempt, or user accidentally used '}'. */
1259 return JB_ERR_CGI_PARAMS;
1270 /*********************************************************************
1272 * Function : get_number_param
1274 * Description : Get a non-negative integer from the parameters
1275 * passed to a CGI function.
1278 * 1 : csp = Current client state (buffers, headers, etc...)
1279 * 2 : parameters = map of cgi parameters
1280 * 3 : name = Name of CGI parameter to read
1281 * 4 : pvalue = destination for value.
1282 * Set to -1 on error.
1284 * Returns : JB_ERR_OK on success
1285 * JB_ERR_MEMORY on out-of-memory
1286 * JB_ERR_CGI_PARAMS if the parameter was not specified
1289 *********************************************************************/
1290 jb_err get_number_param(struct client_state *csp,
1291 const struct map *parameters,
1306 param = lookup(parameters, name);
1309 return JB_ERR_CGI_PARAMS;
1312 /* We don't use atoi because I want to check this carefully... */
1315 while ((ch = *param++) != '\0')
1317 if ((ch < '0') || (ch > '9'))
1319 return JB_ERR_CGI_PARAMS;
1322 ch = (char)(ch - '0');
1326 * <limits.h> defines UINT_MAX
1328 * (UINT_MAX - ch) / 10 is the largest number that
1329 * can be safely multiplied by 10 then have ch added.
1331 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1333 return JB_ERR_CGI_PARAMS;
1336 value = value * 10 + (unsigned)ch;
1347 /*********************************************************************
1349 * Function : error_response
1351 * Description : returns an http_response that explains the reason
1352 * why a request failed.
1355 * 1 : csp = Current client state (buffers, headers, etc...)
1356 * 2 : templatename = Which template should be used for the answer
1357 * 3 : sys_err = system error number
1359 * Returns : A http_response. If we run out of memory, this
1360 * will be cgi_error_memory().
1362 *********************************************************************/
1363 struct http_response *error_response(struct client_state *csp,
1364 const char *templatename,
1368 struct http_response *rsp;
1369 struct map *exports = default_exports(csp, NULL);
1372 if (exports == NULL)
1374 return cgi_error_memory();
1377 if (NULL == (rsp = alloc_http_response()))
1380 return cgi_error_memory();
1383 #ifdef FEATURE_FORCE_LOAD
1384 if (csp->flags & CSP_FLAG_FORCED)
1386 path = strdup(FORCE_PREFIX);
1389 #endif /* def FEATURE_FORCE_LOAD */
1393 err = string_append(&path, csp->http->path);
1395 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1396 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1397 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1398 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1399 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1402 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1405 /* Some failures, like "404 no such domain", don't have an IP address. */
1406 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1414 free_http_response(rsp);
1415 return cgi_error_memory();
1418 if (!strcmp(templatename, "no-such-domain"))
1420 rsp->status = strdup("404 No such domain");
1421 if (rsp->status == NULL)
1424 free_http_response(rsp);
1425 return cgi_error_memory();
1427 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1429 else if (!strcmp(templatename, "forwarding-failed"))
1431 const struct forward_spec * fwd = forward_url(csp->http, csp);
1434 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1435 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1439 * XXX: While the template is called forwarding-failed,
1440 * it currently only handles socks forwarding failures.
1442 assert(fwd->type != SOCKS_NONE);
1445 * Map failure reason, forwarding type and forwarder.
1447 if (NULL == csp->error_message)
1450 * Either we forgot to record the failure reason,
1451 * or the memory allocation failed.
1453 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1454 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1456 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1457 if (!err) err = map(exports, "forwarding-type", 1, (fwd->type == SOCKS_4) ?
1458 "socks4-" : "socks4a-", 1);
1459 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1461 if (!err) rsp->status = strdup("503 Forwarding failure");
1462 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1465 free_http_response(rsp);
1466 return cgi_error_memory();
1468 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1470 else if (!strcmp(templatename, "connect-failed"))
1472 rsp->status = strdup("503 Connect failed");
1473 if (rsp->status == NULL)
1476 free_http_response(rsp);
1477 return cgi_error_memory();
1479 rsp->reason = RSP_REASON_CONNECT_FAILED;
1482 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1485 free_http_response(rsp);
1486 return cgi_error_memory();
1489 return finish_http_response(csp, rsp);
1493 /*********************************************************************
1495 * Function : cgi_error_disabled
1497 * Description : CGI function that is called to generate an error
1498 * response if the actions editor or toggle CGI are
1499 * accessed despite having being disabled at compile-
1500 * or run-time, or if the user followed an untrusted link
1501 * to access a unsafe CGI feature that is only reachable
1502 * through Privoxy directly.
1505 * 1 : csp = Current client state (buffers, headers, etc...)
1506 * 2 : rsp = http_response data structure for output
1508 * CGI Parameters : none
1510 * Returns : JB_ERR_OK on success
1511 * JB_ERR_MEMORY on out-of-memory error.
1513 *********************************************************************/
1514 jb_err cgi_error_disabled(struct client_state *csp,
1515 struct http_response *rsp)
1517 struct map *exports;
1522 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1524 return JB_ERR_MEMORY;
1526 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1528 /* Not important enough to do anything */
1529 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1532 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1536 /*********************************************************************
1538 * Function : cgi_init_error_messages
1540 * Description : Call at the start of the program to initialize
1541 * the error message used by cgi_error_memory().
1547 *********************************************************************/
1548 void cgi_init_error_messages(void)
1550 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1551 cgi_error_memory_response->head =
1552 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1553 "Content-Type: text/html\r\n"
1555 cgi_error_memory_response->body =
1558 " <title>500 Internal Privoxy Error</title>\r\n"
1559 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1562 "<h1>500 Internal Privoxy Error</h1>\r\n"
1563 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1564 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1568 cgi_error_memory_response->head_length =
1569 strlen(cgi_error_memory_response->head);
1570 cgi_error_memory_response->content_length =
1571 strlen(cgi_error_memory_response->body);
1572 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1576 /*********************************************************************
1578 * Function : cgi_error_memory
1580 * Description : Called if a CGI function runs out of memory.
1581 * Returns a statically-allocated error response.
1585 * Returns : http_response data structure for output. This is
1586 * statically allocated, for obvious reasons.
1588 *********************************************************************/
1589 struct http_response *cgi_error_memory(void)
1591 /* assert that it's been initialized. */
1592 assert(cgi_error_memory_response->head);
1594 return cgi_error_memory_response;
1598 /*********************************************************************
1600 * Function : cgi_error_no_template
1602 * Description : Almost-CGI function that is called if a template
1603 * cannot be loaded. Note this is not a true CGI,
1604 * it takes a template name rather than a map of
1608 * 1 : csp = Current client state (buffers, headers, etc...)
1609 * 2 : rsp = http_response data structure for output
1610 * 3 : template_name = Name of template that could not
1613 * Returns : JB_ERR_OK on success
1614 * JB_ERR_MEMORY on out-of-memory error.
1616 *********************************************************************/
1617 jb_err cgi_error_no_template(struct client_state *csp,
1618 struct http_response *rsp,
1619 const char *template_name)
1621 static const char status[] =
1622 "500 Internal Privoxy Error";
1623 static const char body_prefix[] =
1626 " <title>500 Internal Privoxy Error</title>\r\n"
1627 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1630 "<h1>500 Internal Privoxy Error</h1>\r\n"
1631 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1632 "<p><b>Could not load template file <code>";
1633 static const char body_suffix[] =
1634 "</code> or one of it's included components.</b></p>\r\n"
1635 "<p>Please contact your proxy administrator.</p>\r\n"
1636 "<p>If you are the proxy administrator, please put the required file(s)"
1637 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1638 "location of the <code><i>(confdir)</i></code> directory "
1639 "is specified in the main Privoxy <code>config</code> "
1640 "file. (It's typically the Privoxy install directory"
1642 ", or <code>/etc/privoxy/</code>"
1643 #endif /* ndef _WIN32 */
1647 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1651 assert(template_name);
1653 /* Reset rsp, if needed */
1657 rsp->content_length = 0;
1658 rsp->head_length = 0;
1661 rsp->body = malloc(body_size);
1662 if (rsp->body == NULL)
1664 return JB_ERR_MEMORY;
1666 strlcpy(rsp->body, body_prefix, body_size);
1667 strlcat(rsp->body, template_name, body_size);
1668 strlcat(rsp->body, body_suffix, body_size);
1670 rsp->status = strdup(status);
1671 if (rsp->status == NULL)
1673 return JB_ERR_MEMORY;
1680 /*********************************************************************
1682 * Function : cgi_error_unknown
1684 * Description : Almost-CGI function that is called if an unexpected
1685 * error occurs in the top-level CGI dispatcher.
1686 * In this context, "unexpected" means "anything other
1687 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1688 * expected to handle all other errors internally,
1689 * since they can give more relavent error messages
1692 * Note this is not a true CGI, it takes an error
1693 * code rather than a map of parameters.
1696 * 1 : csp = Current client state (buffers, headers, etc...)
1697 * 2 : rsp = http_response data structure for output
1698 * 3 : error_to_report = Error code to report.
1700 * Returns : JB_ERR_OK on success
1701 * JB_ERR_MEMORY on out-of-memory error.
1703 *********************************************************************/
1704 jb_err cgi_error_unknown(struct client_state *csp,
1705 struct http_response *rsp,
1706 jb_err error_to_report)
1708 static const char status[] =
1709 "500 Internal Privoxy Error";
1710 static const char body_prefix[] =
1713 " <title>500 Internal Privoxy Error</title>\r\n"
1714 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1717 "<h1>500 Internal Privoxy Error</h1>\r\n"
1718 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1719 "<p><b>Unexpected internal error: ";
1720 static const char body_suffix[] =
1723 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1724 "file a bug report</a>.</p>\r\n"
1729 * Due to sizeof(errnumbuf), body_size will be slightly
1730 * bigger than necessary but it doesn't really matter.
1732 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1736 /* Reset rsp, if needed */
1740 rsp->content_length = 0;
1741 rsp->head_length = 0;
1743 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1745 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1747 rsp->body = malloc(body_size);
1748 if (rsp->body == NULL)
1750 return JB_ERR_MEMORY;
1752 strlcpy(rsp->body, body_prefix, body_size);
1753 strlcat(rsp->body, errnumbuf, body_size);
1754 strlcat(rsp->body, body_suffix, body_size);
1756 rsp->status = strdup(status);
1757 if (rsp->status == NULL)
1759 return JB_ERR_MEMORY;
1766 /*********************************************************************
1768 * Function : cgi_error_bad_param
1770 * Description : CGI function that is called if the parameters
1771 * (query string) for a CGI were wrong.
1774 * 1 : csp = Current client state (buffers, headers, etc...)
1775 * 2 : rsp = http_response data structure for output
1777 * CGI Parameters : none
1779 * Returns : JB_ERR_OK on success
1780 * JB_ERR_MEMORY on out-of-memory error.
1782 *********************************************************************/
1783 jb_err cgi_error_bad_param(struct client_state *csp,
1784 struct http_response *rsp)
1786 struct map *exports;
1791 if (NULL == (exports = default_exports(csp, NULL)))
1793 return JB_ERR_MEMORY;
1796 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1800 /*********************************************************************
1802 * Function : cgi_redirect
1804 * Description : CGI support function to generate a HTTP redirect
1808 * 1 : rsp = http_response data structure for output
1809 * 2 : target = string with the target URL
1811 * CGI Parameters : None
1813 * Returns : JB_ERR_OK on success
1814 * JB_ERR_MEMORY on out-of-memory error.
1816 *********************************************************************/
1817 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1824 err = enlist_unique_header(rsp->headers, "Location", target);
1826 rsp->status = strdup("302 Local Redirect from Privoxy");
1827 if (rsp->status == NULL)
1829 return JB_ERR_MEMORY;
1836 /*********************************************************************
1838 * Function : add_help_link
1840 * Description : Produce a copy of the string given as item,
1841 * embedded in an HTML link to its corresponding
1842 * section (item name in uppercase) in the actions
1843 * chapter of the user manual, (whose URL is given in
1844 * the config and defaults to our web site).
1846 * FIXME: I currently only work for actions, and would
1847 * like to be generalized for other topics.
1850 * 1 : item = item (will NOT be free()d.)
1851 * It is assumed to be HTML-safe.
1852 * 2 : config = The current configuration.
1854 * Returns : String with item embedded in link, or NULL on
1857 *********************************************************************/
1858 char *add_help_link(const char *item,
1859 struct configuration_spec *config)
1863 if (!item) return NULL;
1865 result = strdup("<a href=\"");
1866 if (!strncmpic(config->usermanual, "file://", 7) ||
1867 !strncmpic(config->usermanual, "http", 4))
1869 string_append(&result, config->usermanual);
1873 string_append(&result, "http://");
1874 string_append(&result, CGI_SITE_2_HOST);
1875 string_append(&result, "/user-manual/");
1877 string_append(&result, ACTIONS_HELP_PREFIX);
1878 string_join (&result, string_toupper(item));
1879 string_append(&result, "\">");
1880 string_append(&result, item);
1881 string_append(&result, "</a> ");
1887 /*********************************************************************
1889 * Function : get_http_time
1891 * Description : Get the time in a format suitable for use in a
1892 * HTTP header - e.g.:
1893 * "Sun, 06 Nov 1994 08:49:37 GMT"
1895 * XXX: Should probably get a third parameter for
1899 * 1 : time_offset = Time returned will be current time
1900 * plus this number of seconds.
1901 * 2 : buf = Destination for result. Must be long enough
1902 * to hold 29 characters plus a trailing zero.
1906 *********************************************************************/
1907 void get_http_time(int time_offset, char *buf)
1909 static const char day_names[7][4] =
1910 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1911 static const char month_names[12][4] =
1912 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1913 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1916 time_t current_time;
1917 #if defined(HAVE_GMTIME_R)
1919 * Declare dummy up here (instead of inside get/set gmt block) so it
1920 * doesn't go out of scope before it's potentially used in snprintf later.
1921 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1922 * !defined HAVE_GMTIME_R.
1929 time(¤t_time); /* get current time */
1931 current_time += time_offset;
1933 /* get and save the gmt */
1936 t = gmtime_r(¤t_time, &dummy);
1937 #elif FEATURE_PTHREAD
1938 pthread_mutex_lock(&gmtime_mutex);
1939 t = gmtime(¤t_time);
1940 pthread_mutex_unlock(&gmtime_mutex);
1942 t = gmtime(¤t_time);
1946 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1948 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1949 day_names[t->tm_wday],
1951 month_names[t->tm_mon],
1961 /*********************************************************************
1963 * Function : finish_http_response
1965 * Description : Fill in the missing headers in an http response,
1966 * and flatten the headers to an http head.
1967 * For HEAD requests the body is freed once
1968 * the Content-Length header is set.
1971 * 1 : rsp = pointer to http_response to be processed
1973 * Returns : A http_response, usually the rsp parameter.
1974 * On error, free()s rsp and returns cgi_error_memory()
1976 *********************************************************************/
1977 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
1979 char buf[BUFFER_SIZE];
1982 /* Special case - do NOT change this statically allocated response,
1983 * which is ready for output anyway.
1985 if (rsp == cgi_error_memory_response)
1991 * Fill in the HTTP Status, using HTTP/1.1
1992 * unless the client asked for HTTP/1.0.
1994 snprintf(buf, sizeof(buf), "%s %s",
1995 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
1996 rsp->status ? rsp->status : "200 OK");
1997 err = enlist_first(rsp->headers, buf);
2000 * Set the Content-Length
2002 if (rsp->content_length == 0)
2004 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2008 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2009 err = enlist(rsp->headers, buf);
2012 if (0 == strcmpic(csp->http->gpc, "head"))
2015 * The client only asked for the head. Dispose
2016 * the body and log an offensive message.
2018 * While it may seem to be a bit inefficient to
2019 * prepare the body if it isn't needed, it's the
2020 * only way to get the Content-Length right for
2021 * dynamic pages. We could have disposed the body
2022 * earlier, but not without duplicating the
2023 * Content-Length setting code above.
2025 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2027 rsp->content_length = 0;
2030 if (strncmpic(rsp->status, "302", 3))
2033 * If it's not a redirect without any content,
2034 * set the Content-Type to text/html if it's
2035 * not already specified.
2037 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2041 * Fill in the rest of the default headers:
2043 * Date: set to current date/time.
2044 * Last-Modified: set to date/time the page was last changed.
2045 * Expires: set to date/time page next needs reloading.
2046 * Cache-Control: set to "no-cache" if applicable.
2048 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2053 * Set Expires to about 10 min into the future so it'll get reloaded
2054 * occasionally, e.g. if Privoxy gets upgraded.
2059 get_http_time(0, buf);
2060 err = enlist_unique_header(rsp->headers, "Date", buf);
2063 /* Some date in the past. */
2064 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2068 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2069 err = enlist_unique_header(rsp->headers, "Expires", buf);
2072 else if (!strncmpic(rsp->status, "302", 3))
2074 get_http_time(0, buf);
2075 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2080 * Setting "Cache-Control" to "no-cache" and "Expires" to
2081 * the current time doesn't exactly forbid caching, it just
2082 * requires the client to revalidate the cached copy.
2084 * If a temporary problem occurs and the user tries again after
2085 * getting Privoxy's error message, a compliant browser may set the
2086 * If-Modified-Since header with the content of the error page's
2087 * Last-Modified header. More often than not, the document on the server
2088 * is older than Privoxy's error message, the server would send status code
2089 * 304 and the browser would display the outdated error message again and again.
2091 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2092 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2093 * and can be safely used to "revalidate" without getting a status code 304.
2095 * There is no need to let the useless If-Modified-Since header reach the
2096 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2098 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2100 get_http_time(0, buf);
2101 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2102 if (!strncmpic(rsp->status, "403", 3)
2103 || !strncmpic(rsp->status, "404", 3)
2104 || !strncmpic(rsp->status, "503", 3))
2106 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2110 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2112 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2113 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2119 * HTTP/1.1 applications that do not support persistent connections MUST
2120 * include the "close" connection option in every message.
2122 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2127 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2129 free_http_response(rsp);
2130 return cgi_error_memory();
2132 rsp->head_length = strlen(rsp->head);
2139 /*********************************************************************
2141 * Function : alloc_http_response
2143 * Description : Allocates a new http_response structure.
2147 * Returns : pointer to a new http_response, or NULL.
2149 *********************************************************************/
2150 struct http_response *alloc_http_response(void)
2152 return (struct http_response *) zalloc(sizeof(struct http_response));
2157 /*********************************************************************
2159 * Function : free_http_response
2161 * Description : Free the memory occupied by an http_response
2162 * and its depandant structures.
2165 * 1 : rsp = pointer to http_response to be freed
2169 *********************************************************************/
2170 void free_http_response(struct http_response *rsp)
2173 * Must special case cgi_error_memory_response, which is never freed.
2175 if (rsp && (rsp != cgi_error_memory_response))
2180 destroy_list(rsp->headers);
2187 /*********************************************************************
2189 * Function : template_load
2191 * Description : CGI support function that loads a given HTML
2192 * template, ignoring comment lines and following
2193 * #include statements up to a depth of 1.
2196 * 1 : csp = Current client state (buffers, headers, etc...)
2197 * 2 : template_ptr = Destination for pointer to loaded
2199 * 3 : templatename = name of the HTML template to be used
2200 * 4 : recursive = Flag set if this function calls itself
2201 * following an #include statament
2203 * Returns : JB_ERR_OK on success
2204 * JB_ERR_MEMORY on out-of-memory error.
2205 * JB_ERR_FILE if the template file cannot be read
2207 *********************************************************************/
2208 jb_err template_load(struct client_state *csp, char **template_ptr,
2209 const char *templatename, int recursive)
2212 char *templates_dir_path;
2215 char *included_module;
2218 char buf[BUFFER_SIZE];
2221 assert(template_ptr);
2222 assert(templatename);
2224 *template_ptr = NULL;
2226 /* Validate template name. Paranoia. */
2227 for (p = templatename; *p != 0; p++)
2229 if ( ((*p < 'a') || (*p > 'z'))
2230 && ((*p < 'A') || (*p > 'Z'))
2231 && ((*p < '0') || (*p > '9'))
2235 /* Illegal character */
2241 * Generate full path using either templdir
2242 * or confdir/templates as base directory.
2244 if (NULL != csp->config->templdir)
2246 templates_dir_path = strdup(csp->config->templdir);
2250 templates_dir_path = make_path(csp->config->confdir, "templates");
2253 if (templates_dir_path == NULL)
2255 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2257 return JB_ERR_MEMORY;
2260 full_path = make_path(templates_dir_path, templatename);
2261 free(templates_dir_path);
2262 if (full_path == NULL)
2264 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2266 return JB_ERR_MEMORY;
2269 /* Allocate buffer */
2271 file_buffer = strdup("");
2272 if (file_buffer == NULL)
2274 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2276 return JB_ERR_MEMORY;
2279 /* Open template file */
2281 if (NULL == (fp = fopen(full_path, "r")))
2283 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2291 * Read the file, ignoring comments, and honoring #include
2292 * statements, unless we're already called recursively.
2294 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2295 * This is unlikely in practise.
2297 while (fgets(buf, BUFFER_SIZE, fp))
2299 if (!recursive && !strncmp(buf, "#include ", 9))
2301 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2308 if (string_join(&file_buffer, included_module))
2311 return JB_ERR_MEMORY;
2317 /* skip lines starting with '#' */
2323 if (string_append(&file_buffer, buf))
2326 return JB_ERR_MEMORY;
2331 *template_ptr = file_buffer;
2337 /*********************************************************************
2339 * Function : template_fill
2341 * Description : CGI support function that fills in a pre-loaded
2342 * HTML template by replacing @name@ with value using
2343 * pcrs, for each item in the output map.
2345 * Note that a leading '$' charachter in the export map's
2346 * values will be stripped and toggle on backreference
2350 * 1 : template_ptr = IN: Template to be filled out.
2352 * OUT: Filled out template.
2353 * Caller must free().
2354 * 2 : exports = map with fill in symbol -> name pairs
2356 * Returns : JB_ERR_OK on success (and for uncritical errors)
2357 * JB_ERR_MEMORY on out-of-memory error
2359 *********************************************************************/
2360 jb_err template_fill(char **template_ptr, const struct map *exports)
2362 struct map_entry *m;
2364 char buf[BUFFER_SIZE];
2365 char *tmp_out_buffer;
2371 assert(template_ptr);
2372 assert(*template_ptr);
2375 file_buffer = *template_ptr;
2376 size = strlen(file_buffer) + 1;
2379 * Assemble pcrs joblist from exports map
2381 for (m = exports->first; m != NULL; m = m->next)
2383 if (*m->name == '$')
2386 * First character of name is '$', so remove this flag
2387 * character and allow backreferences ($1 etc) in the
2388 * "replace with" text.
2390 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2396 * Treat the "replace with" text as a literal string -
2397 * no quoting needed, no backreferences allowed.
2398 * ("Trivial" ['T'] flag).
2402 /* Enclose name in @@ */
2403 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2407 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2409 /* Make and run job. */
2410 job = pcrs_compile(buf, m->value, flags, &error);
2413 if (error == PCRS_ERR_NOMEM)
2416 *template_ptr = NULL;
2417 return JB_ERR_MEMORY;
2421 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2422 /* Hope it wasn't important and silently ignore the invalid job */
2427 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2430 if (NULL == tmp_out_buffer)
2432 *template_ptr = NULL;
2433 return JB_ERR_MEMORY;
2439 * Substitution failed, keep the original buffer,
2440 * log the problem and ignore it.
2442 * The user might see some unresolved @CGI_VARIABLES@,
2443 * but returning a special CGI error page seems unreasonable
2444 * and could mask more important error messages.
2446 free(tmp_out_buffer);
2447 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2448 buf, m->value, flags, pcrs_strerror(error));
2452 /* Substitution succeeded, use modified buffer. */
2454 file_buffer = tmp_out_buffer;
2462 *template_ptr = file_buffer;
2467 /*********************************************************************
2469 * Function : template_fill_for_cgi
2471 * Description : CGI support function that loads a HTML template
2472 * and fills it in. Handles file-not-found errors
2473 * by sending a HTML error message. For convenience,
2474 * this function also frees the passed "exports" map.
2477 * 1 : csp = Client state
2478 * 2 : templatename = name of the HTML template to be used
2479 * 3 : exports = map with fill in symbol -> name pairs.
2480 * Will be freed by this function.
2481 * 4 : rsp = Response structure to fill in.
2483 * Returns : JB_ERR_OK on success
2484 * JB_ERR_MEMORY on out-of-memory error
2486 *********************************************************************/
2487 jb_err template_fill_for_cgi(struct client_state *csp,
2488 const char *templatename,
2489 struct map *exports,
2490 struct http_response *rsp)
2495 assert(templatename);
2499 err = template_load(csp, &rsp->body, templatename, 0);
2500 if (err == JB_ERR_FILE)
2503 return cgi_error_no_template(csp, rsp, templatename);
2508 return err; /* JB_ERR_MEMORY */
2510 err = template_fill(&rsp->body, exports);
2516 /*********************************************************************
2518 * Function : default_exports
2520 * Description : returns a struct map list that contains exports
2521 * which are common to all CGI functions.
2524 * 1 : csp = Current client state (buffers, headers, etc...)
2525 * 2 : caller = name of CGI who calls us and which should
2526 * be excluded from the generated menu. May be
2528 * Returns : NULL if no memory, else a new map. Caller frees.
2530 *********************************************************************/
2531 struct map *default_exports(const struct client_state *csp, const char *caller)
2535 struct map * exports;
2536 int local_help_exists = 0;
2540 exports = new_map();
2541 if (exports == NULL)
2546 err = map(exports, "version", 1, html_encode(VERSION), 0);
2547 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2548 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2549 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2550 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2551 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2552 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2553 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2554 !strncmpic(csp->config->usermanual, "http", 4))
2556 /* Manual is located somewhere else, just link to it. */
2557 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2561 /* Manual is delivered by Privoxy. */
2562 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2564 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2565 #ifdef FEATURE_TOGGLE
2566 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2568 if (!err) err = map_block_killer(exports, "can-toggle");
2571 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2572 if (!err) err = map(exports, "my-port", 1, buf, 1);
2574 if(!strcmp(CODE_STATUS, "stable"))
2576 if (!err) err = map_block_killer(exports, "unstable");
2579 if (csp->config->admin_address != NULL)
2581 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2582 local_help_exists = 1;
2586 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2589 if (csp->config->proxy_info_url != NULL)
2591 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2592 local_help_exists = 1;
2596 if (!err) err = map_block_killer(exports, "have-proxy-info");
2599 if (local_help_exists == 0)
2601 if (!err) err = map_block_killer(exports, "have-help-info");
2614 /*********************************************************************
2616 * Function : map_block_killer
2618 * Description : Convenience function.
2619 * Adds a "killer" for the conditional HTML-template
2620 * block <name>, i.e. a substitution of the regex
2621 * "if-<name>-start.*if-<name>-end" to the given
2625 * 1 : exports = map to extend
2626 * 2 : name = name of conditional block
2628 * Returns : JB_ERR_OK on success
2629 * JB_ERR_MEMORY on out-of-memory error.
2631 *********************************************************************/
2632 jb_err map_block_killer(struct map *exports, const char *name)
2634 char buf[1000]; /* Will do, since the names are hardwired */
2638 assert(strlen(name) < 490);
2640 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2641 return map(exports, buf, 1, "", 1);
2645 /*********************************************************************
2647 * Function : map_block_keep
2649 * Description : Convenience function. Removes the markers used
2650 * by map-block-killer, to save a few bytes.
2651 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2654 * 1 : exports = map to extend
2655 * 2 : name = name of conditional block
2657 * Returns : JB_ERR_OK on success
2658 * JB_ERR_MEMORY on out-of-memory error.
2660 *********************************************************************/
2661 jb_err map_block_keep(struct map *exports, const char *name)
2664 char buf[500]; /* Will do, since the names are hardwired */
2668 assert(strlen(name) < 490);
2670 snprintf(buf, sizeof(buf), "if-%s-start", name);
2671 err = map(exports, buf, 1, "", 1);
2678 snprintf(buf, sizeof(buf), "if-%s-end", name);
2679 return map(exports, buf, 1, "", 1);
2683 /*********************************************************************
2685 * Function : map_conditional
2687 * Description : Convenience function.
2688 * Adds an "if-then-else" for the conditional HTML-template
2689 * block <name>, i.e. a substitution of the form:
2696 * The control structure and one of the alternatives
2700 * 1 : exports = map to extend
2701 * 2 : name = name of conditional block
2702 * 3 : choose_first = nonzero for first, zero for second.
2704 * Returns : JB_ERR_OK on success
2705 * JB_ERR_MEMORY on out-of-memory error.
2707 *********************************************************************/
2708 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2710 char buf[1000]; /* Will do, since the names are hardwired */
2715 assert(strlen(name) < 480);
2717 snprintf(buf, sizeof(buf), (choose_first
2718 ? "else-not-%s@.*@endif-%s"
2719 : "if-%s-then@.*@else-not-%s"),
2722 err = map(exports, buf, 1, "", 1);
2728 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2729 return map(exports, buf, 1, "", 1);
2733 /*********************************************************************
2735 * Function : make_menu
2737 * Description : Returns an HTML-formatted menu of the available
2738 * unhidden CGIs, excluding the one given in <self>
2739 * and the toggle CGI if toggling is disabled.
2742 * 1 : self = name of CGI to leave out, can be NULL for
2744 * 2 : feature_flags = feature bitmap from csp->config
2747 * Returns : menu string, or NULL on out-of-memory error.
2749 *********************************************************************/
2750 char *make_menu(const char *self, const unsigned feature_flags)
2752 const struct cgi_dispatcher *d;
2753 char *result = strdup("");
2757 self = "NO-SUCH-CGI!";
2760 /* List available unhidden CGI's and export as "other-cgis" */
2761 for (d = cgi_dispatchers; d->name; d++)
2764 #ifdef FEATURE_TOGGLE
2765 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2768 * Suppress the toggle link if remote toggling is disabled.
2772 #endif /* def FEATURE_TOGGLE */
2774 if (d->description && strcmp(d->name, self))
2776 char *html_encoded_prefix;
2779 * Line breaks would be great, but break
2780 * the "blocked" template's JavaScript.
2782 string_append(&result, "<li><a href=\"");
2783 html_encoded_prefix = html_encode(CGI_PREFIX);
2784 if (html_encoded_prefix == NULL)
2790 string_append(&result, html_encoded_prefix);
2791 free(html_encoded_prefix);
2793 string_append(&result, d->name);
2794 string_append(&result, "\">");
2795 string_append(&result, d->description);
2796 string_append(&result, "</a></li>");
2804 /*********************************************************************
2806 * Function : dump_map
2808 * Description : HTML-dump a map for debugging (as table)
2811 * 1 : the_map = map to dump
2813 * Returns : string with HTML
2815 *********************************************************************/
2816 char *dump_map(const struct map *the_map)
2818 struct map_entry *cur_entry;
2819 char *ret = strdup("");
2821 string_append(&ret, "<table>\n");
2823 for (cur_entry = the_map->first;
2824 (cur_entry != NULL) && (ret != NULL);
2825 cur_entry = cur_entry->next)
2827 string_append(&ret, "<tr><td><b>");
2828 string_join (&ret, html_encode(cur_entry->name));
2829 string_append(&ret, "</b></td><td>");
2830 string_join (&ret, html_encode(cur_entry->value));
2831 string_append(&ret, "</td></tr>\n");
2834 string_append(&ret, "</table>\n");