1 const char cgi_rcs[] = "$Id: cgi.c,v 1.98 2007/05/14 10:33:51 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.98 2007/05/14 10:33:51 fabiankeil
42 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
44 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
45 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
47 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
48 * Use sizeof() more often.
50 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
51 * Don't overlook map result for the forwarding-type.
53 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
54 * Use a transparent background for the PNG replacement pattern.
56 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
57 * - Save the reason for generating http_responses.
58 * - Fix --disable-toggle (again).
59 * - Use TBL birthday hack for 403 responses as well.
60 * - Uglify the @menu@ again to fix JavaScript
61 * errors on the "blocked" template.
62 * - Escape an ampersand in cgi_error_unknown().
64 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
65 * - Add HEAD support to finish_http_response.
66 * - Add error favicon to internal HTML error messages.
68 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
69 * Add new config option "templdir" to
70 * change the templates directory.
72 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
73 * Added "forwarding-failed" template support for error_response().
75 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
76 * Add favicon delivery functions.
78 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
79 * - Map variables that aren't guaranteed to be
80 * pure ASCII html_encoded.
81 * - Use CGI_PREFIX to generate URL for user manual
82 * CGI page to make sure CGI_SITE_2_PATH is included.
84 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
85 * - "Protect" against a rather lame JavaScript-based
86 * Privoxy detection "attack" and check the referrer
87 * before delivering the CGI style sheet.
88 * - Move referrer check for unsafe CGI pages into
89 * referrer_is_safe() and log the result.
90 * - Map @url@ in cgi-error-disabled page.
91 * It's required for the "go there anyway" link.
92 * - Mark *csp as immutable for grep_cgi_referrer().
94 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
95 * Fix strdup() error handling in cgi_error_unknown()
96 * and cgi_error_no_template(). Reported by Markus Elfring.
98 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
99 * Handle pcrs_execute() errors in template_fill() properly.
101 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
102 * Fixed gcc43 conversion warnings and replaced sprintf
103 * calls with snprintf to give OpenBSD's gcc one less reason
106 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
107 * Escape ampersand in Privoxy menu.
109 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
110 * Suppress the toggle link if remote toggling is disabled.
112 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
113 * Fix configure option --disable-toggle.
114 * Thanks to Peter Thoenen for reporting this.
116 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
117 * Don't lose the FORCE_PREFIX in case of
118 * connection problems. Fixes #612235.
120 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
121 * Make pthread mutex locking more generic. Instead of
122 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
123 * and use mutex locking unless there is an _r function
124 * available. Better safe than sorry.
126 * Fixes "./configure --disable-pthread" and should result
127 * in less threading-related problems on pthread-using platforms,
128 * but it still doesn't fix BR#1122404.
130 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
131 * Use CGI_PREFIX to check the referrer.
132 * The check for "http://config.privoxy.org/" fails
133 * if the user modified CGI_SITE_2_HOST.
135 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
136 * Adjusted headers for Privoxy's cgi responses:
137 * Don't set Last-Modified, Expires and Cache-Control
138 * headers for redirects; always set "Connection: close".
140 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
141 * Only predate the Last-Modified header for cgi responses
142 * that are delivered with status code 404 or 503.
144 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
145 * Mark cgi_send_user_manual as harmless,
146 * to fix the access denied problem Hal spotted.
147 * The manual has no secret content, therefore we
148 * don't have to care about "secure" referrers.
150 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
151 * Incorporate modified version of Roland Rosenfeld's patch to
152 * optionally access the user-manual via Privoxy. Closes patch 679075.
154 * Formatting changed to Privoxy style, added call to
155 * cgi_error_no_template if the requested file doesn't
156 * exist and modified check whether or not Privoxy itself
157 * should serve the manual. Should work cross-platform now.
159 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
160 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
162 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
163 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
164 * with what was really the latest development (the v_3_0_branch branch)
166 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
167 * Moved cgi_error_disabled() from cgiedit.c to
168 * cgi.c to re-enable build with --disable-editor.
169 * Fixes Bug #892744. Thanks to Matthew Fischer
172 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
173 * - Added new function cgi_redirect to handle creation of
174 * HTTP redirect messages formerly repeated in the code.
175 * - Send cgi_error_disabled instead of cgi_error_404 when
176 * referrer check fails
177 * - Dynamic content now gets Expires header field with date
180 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
181 * Bugfix: Transparent PNG was not transparent. Thanks to
182 * Dan Razzell of Starfish Systems for notice and new PNG.
184 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
185 * Security fix: dspatch_known_cgi no longer considers an empty
186 * referrer safe for critical CGIs, since malicious links could
187 * reside on https:// locations which browsers don't advertize as
188 * referrers. Closes bug #749916, thanks to Jeff Epler for the
189 * hint. Goodbye One-Click[tm] toggling :-(
191 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
194 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
195 * Killed a compiler warning on OSX
197 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
198 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
199 * (fixes bug #710056)
200 * - Show toggle info only if we have it
202 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
203 * Move declaration of struct tm dummy outside of a control block so it is
204 * accessible later on during snprintf in get_http_time.
206 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
207 * Cosmetic: Renamed cryptic variable
209 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
210 * 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.
212 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
213 * Disable access to critical CGIs via untrusted referrers.
214 * This prevents users from being tricked by malicious websites
215 * into making unintentional configuration changes:
217 * - Added flag to each cgi_dispatcher that allows or denies
219 * - Introduced proviorical function that greps for the
220 * referrer header before regular header parsing happens
221 * - Added safety check to dispatch_known_cgi. CGI is called
222 * if (cgi harmless || no referrer || we are referrer).
223 * Else a) toggle calls are modified not to change status and
224 * b) all other calls are denied.
226 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
227 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
229 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
230 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
232 * Revision 1.70 2002/05/19 11:33:20 jongfoster
233 * If a CGI error was not handled, and propogated back to
234 * dispatch_known_cgi(), then it was assumed to be "out of memory".
235 * This gave a very misleading error message.
237 * Now other errors will cause a simple message giving the error
238 * number and asking the user to report a bug.
241 * http://sourceforge.net/tracker/index.php?func=detail
242 * &aid=557905&group_id=11118&atid=111118
244 * Revision 1.69 2002/05/14 21:28:40 oes
245 * - Fixed add_help_link to link to the (now split) actions
246 * part of the config chapter
247 * - Renamed helplink export to actions-help-prefix
249 * Revision 1.68 2002/05/12 21:36:29 jongfoster
250 * Correcting function comments
252 * Revision 1.67 2002/04/30 12:02:07 oes
253 * Nit: updated a comment
255 * Revision 1.66 2002/04/26 18:32:57 jongfoster
256 * Fixing a memory leak on error
258 * Revision 1.65 2002/04/26 12:53:51 oes
259 * - New function add_help_link
260 * - default_exports now exports links to the user manual
261 * and a prefix for links into the config chapter
263 * Revision 1.64 2002/04/24 02:17:21 oes
264 * - Better descriptions for CGIs
265 * - Hide edit-actions, more shortcuts
266 * - Moved get_char_param, get_string_param and get_number_param here
269 * Revision 1.63 2002/04/15 19:06:43 jongfoster
272 * Revision 1.62 2002/04/10 19:59:46 jongfoster
273 * Fixes to #include in templates:
274 * - Didn't close main file if loading an included template fails.
275 * - I'm paranoid and want to disallow "#include /etc/passwd".
277 * Revision 1.61 2002/04/10 13:37:48 oes
278 * Made templates modular: template_load now recursive with max depth 1
280 * Revision 1.60 2002/04/08 20:50:25 swa
283 * Revision 1.59 2002/04/05 15:51:51 oes
284 * - added send-stylesheet CGI
285 * - bugfix: error-pages now get correct request protocol
287 * - kludged CGI descriptions and menu not to break JS syntax
289 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
290 * Fix Mac OSX compiler warnings
292 * Revision 1.57 2002/03/26 22:29:54 swa
293 * we have a new homepage!
295 * Revision 1.56 2002/03/24 17:50:46 jongfoster
296 * Fixing compile error if actions file editor disabled
298 * Revision 1.55 2002/03/24 16:55:06 oes
299 * Making GIF checkerboard transparent
301 * Revision 1.54 2002/03/24 16:18:15 jongfoster
304 * Revision 1.53 2002/03/24 16:06:00 oes
305 * Correct transparency for checkerboard PNG. Thanks, Magnus!
307 * Revision 1.52 2002/03/24 15:23:33 jongfoster
310 * Revision 1.51 2002/03/24 13:25:43 swa
311 * name change related issues
313 * Revision 1.50 2002/03/16 23:54:06 jongfoster
314 * Adding graceful termination feature, to help look for memory leaks.
315 * If you enable this (which, by design, has to be done by hand
316 * editing config.h) and then go to http://i.j.b/die, then the program
317 * will exit cleanly after the *next* request. It should free all the
318 * memory that was used.
320 * Revision 1.49 2002/03/13 00:27:04 jongfoster
323 * Revision 1.48 2002/03/08 17:47:07 jongfoster
326 * Revision 1.47 2002/03/08 16:41:33 oes
327 * Added GIF images again
329 * Revision 1.46 2002/03/07 03:48:38 oes
330 * - Changed built-in images from GIF to PNG
331 * (with regard to Unisys patent issue)
332 * - Added a 4x4 pattern PNG which is less intrusive
333 * than the logo but also clearly marks the deleted banners
335 * Revision 1.45 2002/03/06 22:54:35 jongfoster
336 * Automated function-comment nitpicking.
338 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
339 * - Better error reporting on OS/2
340 * - Fix double-slash comment (oops)
342 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
343 * - Re-enable OS/2 building after new parms were added
344 * - Fix false out of memory report when resolving CGI templates when no IP
345 * address is available of failed attempt (a la no such domain)
347 * Revision 1.42 2002/01/21 00:33:20 jongfoster
348 * Replacing strsav() with the safer string_append() or string_join().
349 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
350 * Adding missing html_encode() to error message generators.
351 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
353 * Revision 1.41 2002/01/17 20:56:22 jongfoster
354 * Replacing hard references to the URL of the config interface
355 * with #defines from project.h
357 * Revision 1.40 2002/01/09 14:26:46 oes
358 * Added support for thread-safe gmtime_r call.
360 * Revision 1.39 2001/11/16 00:48:13 jongfoster
361 * Fixing a compiler warning
363 * Revision 1.38 2001/11/13 00:31:21 jongfoster
364 * - Adding new CGIs for use by non-JavaScript browsers:
365 * edit-actions-url-form
366 * edit-actions-add-url-form
367 * edit-actions-remove-url-form
368 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
371 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
372 * Show enablement/disablement status in almost all templates.
373 * There is a little trickiness here: apparent recursive resolution of
374 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
375 * the actual enablement status. So a similar construct,
376 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
379 * Revision 1.36 2001/10/26 17:33:27 oes
382 * Revision 1.35 2001/10/23 21:48:19 jongfoster
383 * Cleaning up error handling in CGI functions - they now send back
384 * a HTML error page and should never cause a FATAL error. (Fixes one
385 * potential source of "denial of service" attacks).
387 * CGI actions file editor that works and is actually useful.
389 * Ability to toggle Junkbuster remotely using a CGI call.
391 * You can turn off both the above features in the main configuration
392 * file, e.g. if you are running a multi-user proxy.
394 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
395 * Only show "Local support" on templates conditionally:
396 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
397 * - if not, no Local support section appears
399 * Revision 1.33 2001/10/14 22:28:41 jongfoster
400 * Fixing stupid typo.
402 * Revision 1.32 2001/10/14 22:20:18 jongfoster
403 * - Changes to CGI dispatching method to match CGI names exactly,
404 * rather than doing a prefix match.
405 * - No longer need to count the length of the CGI handler names by hand.
406 * - Adding new handler for 404 error when disptching a CGI, if none of
407 * the handlers match.
408 * - Adding new handlers for CGI actionsfile editor.
410 * Revision 1.31 2001/10/10 10:56:39 oes
411 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
413 * Revision 1.30 2001/10/02 15:30:57 oes
414 * Introduced show-request cgi
416 * Revision 1.29 2001/09/20 15:47:44 steudten
418 * Fix BUG: Modify int size to size_t size in fill_template()
419 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
421 * Revision 1.28 2001/09/19 18:00:37 oes
422 * - Deletef time() FIXME (Can't fail under Linux either, if
423 * the argument is guaranteed to be in out address space,
426 * - Pointer notation cosmetics
427 * - Fixed a minor bug in template_fill(): Failiure of
428 * pcrs_execute() now secure.
430 * Revision 1.27 2001/09/16 17:08:54 jongfoster
431 * Moving simple CGI functions from cgi.c to new file cgisimple.c
433 * Revision 1.26 2001/09/16 15:47:37 jongfoster
434 * First version of CGI-based edit interface. This is very much a
435 * work-in-progress, and you can't actually use it to edit anything
436 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
437 * to have any effect.
439 * Revision 1.25 2001/09/16 15:02:35 jongfoster
440 * Adding i.j.b/robots.txt.
441 * Inlining add_stats() since it's only ever called from one place.
443 * Revision 1.24 2001/09/16 11:38:01 jongfoster
444 * Splitting fill_template() into 2 functions:
445 * template_load() loads the file
446 * template_fill() performs the PCRS regexps.
447 * This is because the CGI edit interface has a "table row"
448 * template which is used many times in the page - this
449 * change means it's only loaded from disk once.
451 * Revision 1.23 2001/09/16 11:16:05 jongfoster
452 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
454 * Revision 1.22 2001/09/16 11:00:10 jongfoster
455 * New function alloc_http_response, for symmetry with free_http_response
457 * Revision 1.21 2001/09/13 23:53:03 jongfoster
458 * Support for both static and dynamically generated CGI pages.
459 * Correctly setting Last-Modified: and Expires: HTTP headers.
461 * Revision 1.20 2001/09/13 23:40:36 jongfoster
462 * (Cosmetic only) Indentation correction
464 * Revision 1.19 2001/09/13 23:31:25 jongfoster
465 * Moving image data to cgi.c rather than cgi.h.
467 * Revision 1.18 2001/08/05 16:06:20 jongfoster
468 * Modifiying "struct map" so that there are now separate header and
469 * "map_entry" structures. This means that functions which modify a
470 * map no longer need to return a pointer to the modified map.
471 * Also, it no longer reverses the order of the entries (which may be
472 * important with some advanced template substitutions).
474 * Revision 1.17 2001/08/05 15:57:38 oes
475 * Adapted finish_http_response to new list_to_text
477 * Revision 1.16 2001/08/01 21:33:18 jongfoster
478 * Changes to fill_template() that reduce memory usage without having
479 * an impact on performance. I also renamed some variables so as not
480 * to clash with the C++ keywords "new" and "template".
482 * Revision 1.15 2001/08/01 21:19:22 jongfoster
483 * Moving file version information to a separate CGI page.
485 * Revision 1.14 2001/08/01 00:19:03 jongfoster
486 * New function: map_conditional() for an if-then-else syntax.
487 * Changing to use new version of show_defines()
489 * Revision 1.13 2001/07/30 22:08:36 jongfoster
490 * Tidying up #defines:
491 * - All feature #defines are now of the form FEATURE_xxx
492 * - Permanently turned off WIN_GUI_EDIT
493 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
495 * Revision 1.12 2001/07/29 18:47:05 jongfoster
496 * Adding missing #include "loadcfg.h"
498 * Revision 1.11 2001/07/18 17:24:37 oes
499 * Changed to conform to new pcrs interface
501 * Revision 1.10 2001/07/13 13:53:13 oes
502 * Removed all #ifdef PCRS and related code
504 * Revision 1.9 2001/06/29 21:45:41 oes
505 * Indentation, CRLF->LF, Tab-> Space
507 * Revision 1.8 2001/06/29 13:21:46 oes
508 * - Cosmetics: renamed and reordered functions, variables,
509 * texts, improved comments etc
511 * - Removed ij_untrusted_url() The relevant
512 * info is now part of the "untrusted" page,
513 * which is generated by filters.c:trust_url()
515 * - Generators of content now call finish_http_response()
516 * themselves, making jcc.c:chat() a little less
519 * - Removed obsolete "Pragma: no-cache" from our headers
521 * - http_responses now know their head length
523 * - fill_template now uses the new interface to pcrs, so that
524 * - long jobs (like whole files) no longer have to be assembled
525 * in a fixed size buffer
526 * - the new T (trivial) option is used, and the replacement may
527 * contain Perl syntax backrefs without confusing pcrs
529 * - Introduced default_exports() which generates a set of exports
530 * common to all CGIs and other content generators
532 * - Introduced convenience function map_block_killer()
534 * - Introduced convenience function make_menu()
536 * - Introduced CGI-like function error_response() which generates
537 * the "No such domain" and "Connect failed" messages using the
540 * - cgi_show_url_info:
541 * - adapted to new CGI features
542 * - form and answers now generated from same template
543 * - http:// prefix in URL now OK
546 * - adapted to new CGI features
547 * - no longer uses csp->init_proxy_args
550 * - moved menu generation to make_menu()
552 * - add_stats now writes single export map entries instead
555 * - Moved redirect_url() to filters.c
557 * - Fixed mem leak in free_http_response(), map_block_killer(),
559 * - Removed logentry from cancelled commit
561 * Revision 1.7 2001/06/09 10:51:58 jongfoster
562 * Changing "show URL info" handler to new style.
563 * Changing BUFSIZ ==> BUFFER_SIZE
565 * Revision 1.6 2001/06/07 23:05:19 jongfoster
566 * Removing code related to old forward and ACL files.
568 * Revision 1.5 2001/06/05 19:59:16 jongfoster
569 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
571 * Revision 1.4 2001/06/04 10:41:52 swa
572 * show version string of cgi.h and cgi.c
574 * Revision 1.3 2001/06/03 19:12:16 oes
575 * introduced new cgi handling
577 * No revisions before 1.3
579 **********************************************************************/
585 #include <sys/types.h>
599 #include "miscutil.h"
600 #include "cgisimple.h"
601 #ifdef FEATURE_CGI_EDIT_ACTIONS
603 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
605 /* loadcfg.h is for global_toggle_state only */
606 #ifdef FEATURE_PTHREAD
608 /* jcc.h is for mutex semaphore globals only */
609 #endif /* def FEATURE_PTHREAD */
610 const char cgi_h_rcs[] = CGI_H_VERSION;
613 * List of CGI functions: name, handler, description
614 * Note: Do NOT use single quotes in the description;
615 * this will break the dynamic "blocked" template!
617 static const struct cgi_dispatcher cgi_dispatchers[] = {
622 #ifdef FEATURE_GRACEFUL_TERMINATION
625 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
626 "this is a one click Denial Of Service attack!!!</em>",
631 #ifdef FEATURE_CGI_EDIT_ACTIONS
632 "View & change the current configuration",
634 "View the current configuration",
639 "View the source code version numbers",
643 "View the request headers.",
647 "Look up which actions apply to a URL and why",
649 #ifdef FEATURE_CGI_EDIT_ACTIONS
650 #ifdef FEATURE_TOGGLE
653 "Toggle Privoxy on or off",
655 #endif /* def FEATURE_TOGGLE */
656 { "edit-actions", /* Edit the actions list */
659 { "eaa", /* Shortcut for edit-actions-add-url-form */
660 cgi_edit_actions_add_url_form,
662 { "eau", /* Shortcut for edit-actions-url-form */
663 cgi_edit_actions_url_form,
665 { "ear", /* Shortcut for edit-actions-remove-url-form */
666 cgi_edit_actions_remove_url_form,
668 { "eal", /* Shortcut for edit-actions-list */
669 cgi_edit_actions_list,
671 { "eafu", /* Shortcut for edit-actions-for-url */
672 cgi_edit_actions_for_url,
674 { "eas", /* Shortcut for edit-actions-submit */
675 cgi_edit_actions_submit,
677 { "easa", /* Shortcut for edit-actions-section-add */
678 cgi_edit_actions_section_add,
680 { "easr", /* Shortcut for edit-actions-section-remove */
681 cgi_edit_actions_section_remove,
683 { "eass", /* Shortcut for edit-actions-section-swap */
684 cgi_edit_actions_section_swap,
686 { "edit-actions-for-url",
687 cgi_edit_actions_for_url,
688 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
689 { "edit-actions-list",
690 cgi_edit_actions_list,
691 NULL, TRUE /* Edit the actions list */ },
692 { "edit-actions-submit",
693 cgi_edit_actions_submit,
694 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
695 { "edit-actions-url",
696 cgi_edit_actions_url,
697 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
698 { "edit-actions-url-form",
699 cgi_edit_actions_url_form,
700 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
701 { "edit-actions-add-url",
702 cgi_edit_actions_add_url,
703 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
704 { "edit-actions-add-url-form",
705 cgi_edit_actions_add_url_form,
706 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
707 { "edit-actions-remove-url",
708 cgi_edit_actions_remove_url,
709 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
710 { "edit-actions-remove-url-form",
711 cgi_edit_actions_remove_url_form,
712 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
713 { "edit-actions-section-add",
714 cgi_edit_actions_section_add,
715 NULL, FALSE /* Remove a section from the actionsfile */ },
716 { "edit-actions-section-remove",
717 cgi_edit_actions_section_remove,
718 NULL, FALSE /* Remove a section from the actionsfile */ },
719 { "edit-actions-section-swap",
720 cgi_edit_actions_section_swap,
721 NULL, FALSE /* Swap two sections in the actionsfile */ },
722 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
723 { "error-favicon.ico",
724 cgi_send_error_favicon,
725 NULL, TRUE /* Sends the favicon image for error pages. */ },
727 cgi_send_default_favicon,
728 NULL, TRUE /* Sends the default favicon image. */ },
731 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
734 NULL, TRUE /* Send a built-in image */ },
737 NULL, FALSE /* Send templates/cgi-style.css */ },
739 cgi_transparent_image,
740 NULL, TRUE /* Send a transparent image (short name) */ },
742 cgi_send_user_manual,
743 NULL, TRUE /* Send user-manual */ },
744 { NULL, /* NULL Indicates end of list and default page */
746 NULL, TRUE /* Unknown CGI page */ }
751 * Built-in images for ad replacement
753 * Hint: You can encode your own images like this:
754 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
757 #ifdef FEATURE_NO_GIFS
760 * Checkerboard pattern, as a PNG.
762 const char image_pattern_data[] =
763 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
764 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
765 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
766 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
767 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
768 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
769 "\000\000\000\000\111\105\116\104\256\102\140\202";
772 * 1x1 transparant PNG.
774 const char image_blank_data[] =
775 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
776 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
777 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
778 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
779 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
780 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
781 "\000\000\000\000\111\105\116\104\256\102\140\202";
785 * Checkerboard pattern, as a GIF.
787 const char image_pattern_data[] =
788 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
789 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
790 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
791 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
795 * 1x1 transparant GIF.
797 const char image_blank_data[] =
798 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
799 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
800 "\000\001\000\000\002\002D\001\000;";
803 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
804 const size_t image_blank_length = sizeof(image_blank_data) - 1;
807 static struct http_response cgi_error_memory_response[1];
809 static struct http_response *dispatch_known_cgi(struct client_state * csp,
811 static struct map *parse_cgi_parameters(char *argstring);
814 /*********************************************************************
816 * Function : dispatch_cgi
818 * Description : Checks if a request URL has either the magical
819 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
820 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
821 * http://config.privoxy.org/). If so, it passes
822 * the (rest of the) path onto dispatch_known_cgi, which
823 * calls the relevant CGI handler function.
826 * 1 : csp = Current client state (buffers, headers, etc...)
828 * Returns : http_response if match, NULL if nonmatch or handler fail
830 *********************************************************************/
831 struct http_response *dispatch_cgi(struct client_state *csp)
833 const char *host = csp->http->host;
834 const char *path = csp->http->path;
837 * Should we intercept ?
840 /* Note: "example.com" and "example.com." are equivalent hostnames. */
842 /* Either the host matches CGI_SITE_1_HOST ..*/
843 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
844 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
845 && (path[0] == '/') )
847 /* ..then the path will all be for us. Remove leading '/' */
850 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
851 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
852 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
853 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
855 /* take everything following CGI_SITE_2_PATH */
856 path += strlen(CGI_SITE_2_PATH);
859 /* skip the forward slash after CGI_SITE_2_PATH */
862 else if (*path != '\0')
865 * weirdness: URL is /configXXX, where XXX is some string
866 * Do *NOT* intercept.
878 * This is a CGI call.
881 return dispatch_known_cgi(csp, path);
885 /*********************************************************************
887 * Function : grep_cgi_referrer
889 * Description : Ugly provisorical fix that greps the value of the
890 * referer HTTP header field out of a linked list of
891 * strings like found at csp->headers. Will disappear
894 * FIXME: csp->headers ought to be csp->http->headers
895 * FIXME: Parsing all client header lines should
896 * happen right after the request is received!
899 * 1 : csp = Current client state (buffers, headers, etc...)
901 * Returns : pointer to value (no copy!), or NULL if none found.
903 *********************************************************************/
904 static char *grep_cgi_referrer(const struct client_state *csp)
906 struct list_entry *p;
908 for (p = csp->headers->first; p != NULL; p = p->next)
910 if (p->str == NULL) continue;
911 if (strncmpic(p->str, "Referer: ", 9) == 0)
913 return ((p->str) + 9);
921 /*********************************************************************
923 * Function : referrer_is_safe
925 * Description : Decides whether we trust the Referer for
926 * CGI pages which are only meant to be reachable
927 * through Privoxy's web interface directly.
930 * 1 : csp = Current client state (buffers, headers, etc...)
932 * Returns : TRUE if the referrer is safe, or
933 * FALSE if the referrer is unsafe or not set.
935 *********************************************************************/
936 static int referrer_is_safe(const struct client_state *csp)
939 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
941 referrer = grep_cgi_referrer(csp);
943 if (NULL == referrer)
945 /* No referrer, no access */
946 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
949 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
950 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
952 /* Trustworthy referrer */
953 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
954 csp->http->url, referrer);
960 /* Untrustworthy referrer */
961 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
962 csp->http->url, referrer);
969 /*********************************************************************
971 * Function : dispatch_known_cgi
973 * Description : Processes a CGI once dispatch_cgi has determined that
974 * it matches one of the magic prefixes. Parses the path
975 * as a cgi name plus query string, prepares a map that
976 * maps CGI parameter names to their values, initializes
977 * the http_response struct, and calls the relevant CGI
981 * 1 : csp = Current client state (buffers, headers, etc...)
982 * 2 : path = Path of CGI, with the CGI prefix removed.
983 * Should not have a leading "/".
985 * Returns : http_response, or NULL on handler failure or out of
988 *********************************************************************/
989 static struct http_response *dispatch_known_cgi(struct client_state * csp,
992 const struct cgi_dispatcher *d;
993 struct map *param_list;
994 struct http_response *rsp;
995 char *query_args_start;
999 if (NULL == (path_copy = strdup(path)))
1001 return cgi_error_memory();
1003 query_args_start = path_copy;
1004 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1008 if (*query_args_start == '/')
1010 *query_args_start++ = '\0';
1011 if ((param_list = new_map()))
1013 map(param_list, "file", 1, url_decode(query_args_start), 0);
1018 if (*query_args_start == '?')
1020 *query_args_start++ = '\0';
1022 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1025 return cgi_error_memory();
1031 * path_copy = CGI call name
1032 * param_list = CGI params, as map
1035 /* Get mem for response or fail*/
1036 if (NULL == (rsp = alloc_http_response()))
1039 free_map(param_list);
1040 return cgi_error_memory();
1044 * Find and start the right CGI function
1046 d = cgi_dispatchers;
1049 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1052 * If the called CGI is either harmless, or referred
1053 * from a trusted source, start it.
1055 if (d->harmless || referrer_is_safe(csp))
1057 err = (d->handler)(csp, rsp, param_list);
1062 * Else, modify toggle calls so that they only display
1063 * the status, and deny all other calls.
1065 if (0 == strcmp(path_copy, "toggle"))
1067 unmap(param_list, "set");
1068 err = (d->handler)(csp, rsp, param_list);
1072 err = cgi_error_disabled(csp, rsp);
1077 free_map(param_list);
1079 if (err == JB_ERR_CGI_PARAMS)
1081 err = cgi_error_bad_param(csp, rsp);
1083 if (err && (err != JB_ERR_MEMORY))
1085 /* Unexpected error! Shouldn't get here */
1086 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1087 err = cgi_error_unknown(csp, rsp, err);
1092 rsp->reason = RSP_REASON_CGI_CALL;
1093 return finish_http_response(csp, rsp);
1097 /* Error in handler, probably out-of-memory */
1098 free_http_response(rsp);
1099 return cgi_error_memory();
1107 /*********************************************************************
1109 * Function : parse_cgi_parameters
1111 * Description : Parse a URL-encoded argument string into name/value
1112 * pairs and store them in a struct map list.
1115 * 1 : argstring = string to be parsed. Will be trashed.
1117 * Returns : pointer to param list, or NULL if out of memory.
1119 *********************************************************************/
1120 static struct map *parse_cgi_parameters(char *argstring)
1123 char *vector[BUFFER_SIZE];
1125 struct map *cgi_params;
1127 if (NULL == (cgi_params = new_map()))
1133 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1134 * the fragment identifier along with the request, so we must
1135 * cut it off here, so it won't pollute the CGI params:
1137 if (NULL != (p = strchr(argstring, '#')))
1142 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1144 for (i = 0; i < pairs; i++)
1146 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1149 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1151 free_map(cgi_params);
1162 /*********************************************************************
1164 * Function : get_char_param
1166 * Description : Get a single-character parameter passed to a CGI
1170 * 1 : parameters = map of cgi parameters
1171 * 2 : param_name = The name of the parameter to read
1173 * Returns : Uppercase character on success, '\0' on error.
1175 *********************************************************************/
1176 char get_char_param(const struct map *parameters,
1177 const char *param_name)
1184 ch = *(lookup(parameters, param_name));
1185 if ((ch >= 'a') && (ch <= 'z'))
1187 ch = (char)(ch - 'a' + 'A');
1194 /*********************************************************************
1196 * Function : get_string_param
1198 * Description : Get a string paramater, to be used as an
1199 * ACTION_STRING or ACTION_MULTI paramater.
1200 * Validates the input to prevent stupid/malicious
1201 * users from corrupting their action file.
1204 * 1 : parameters = map of cgi parameters
1205 * 2 : param_name = The name of the parameter to read
1206 * 3 : pparam = destination for paramater. Allocated as
1207 * part of the map "parameters", so don't free it.
1208 * Set to NULL if not specified.
1210 * Returns : JB_ERR_OK on success, or if the paramater
1211 * was not specified.
1212 * JB_ERR_MEMORY on out-of-memory.
1213 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1215 *********************************************************************/
1216 jb_err get_string_param(const struct map *parameters,
1217 const char *param_name,
1218 const char **pparam)
1230 param = lookup(parameters, param_name);
1236 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1241 * Note that the length limit is arbitrary, it just seems
1242 * sensible to limit it to *something*. There's no
1243 * technical reason for any limit at all.
1245 return JB_ERR_CGI_PARAMS;
1248 /* Check every character to see if it's legal */
1250 while ((ch = *s++) != '\0')
1252 if ( ((unsigned char)ch < (unsigned char)' ')
1255 /* Probable hack attempt, or user accidentally used '}'. */
1256 return JB_ERR_CGI_PARAMS;
1267 /*********************************************************************
1269 * Function : get_number_param
1271 * Description : Get a non-negative integer from the parameters
1272 * passed to a CGI function.
1275 * 1 : csp = Current client state (buffers, headers, etc...)
1276 * 2 : parameters = map of cgi parameters
1277 * 3 : name = Name of CGI parameter to read
1278 * 4 : pvalue = destination for value.
1279 * Set to -1 on error.
1281 * Returns : JB_ERR_OK on success
1282 * JB_ERR_MEMORY on out-of-memory
1283 * JB_ERR_CGI_PARAMS if the parameter was not specified
1286 *********************************************************************/
1287 jb_err get_number_param(struct client_state *csp,
1288 const struct map *parameters,
1303 param = lookup(parameters, name);
1306 return JB_ERR_CGI_PARAMS;
1309 /* We don't use atoi because I want to check this carefully... */
1312 while ((ch = *param++) != '\0')
1314 if ((ch < '0') || (ch > '9'))
1316 return JB_ERR_CGI_PARAMS;
1319 ch = (char)(ch - '0');
1323 * <limits.h> defines UINT_MAX
1325 * (UINT_MAX - ch) / 10 is the largest number that
1326 * can be safely multiplied by 10 then have ch added.
1328 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1330 return JB_ERR_CGI_PARAMS;
1333 value = value * 10 + (unsigned)ch;
1344 /*********************************************************************
1346 * Function : error_response
1348 * Description : returns an http_response that explains the reason
1349 * why a request failed.
1352 * 1 : csp = Current client state (buffers, headers, etc...)
1353 * 2 : templatename = Which template should be used for the answer
1354 * 3 : sys_err = system error number
1356 * Returns : A http_response. If we run out of memory, this
1357 * will be cgi_error_memory().
1359 *********************************************************************/
1360 struct http_response *error_response(struct client_state *csp,
1361 const char *templatename,
1365 struct http_response *rsp;
1366 struct map *exports = default_exports(csp, NULL);
1369 if (exports == NULL)
1371 return cgi_error_memory();
1374 if (NULL == (rsp = alloc_http_response()))
1377 return cgi_error_memory();
1380 #ifdef FEATURE_FORCE_LOAD
1381 if (csp->flags & CSP_FLAG_FORCED)
1383 path = strdup(FORCE_PREFIX);
1386 #endif /* def FEATURE_FORCE_LOAD */
1390 err = string_append(&path, csp->http->path);
1392 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1393 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1394 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1395 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1396 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1399 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1402 /* Some failures, like "404 no such domain", don't have an IP address. */
1403 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1411 free_http_response(rsp);
1412 return cgi_error_memory();
1415 if (!strcmp(templatename, "no-such-domain"))
1417 rsp->status = strdup("404 No such domain");
1418 if (rsp->status == NULL)
1421 free_http_response(rsp);
1422 return cgi_error_memory();
1424 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1426 else if (!strcmp(templatename, "forwarding-failed"))
1428 const struct forward_spec * fwd = forward_url(csp->http, csp);
1431 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1432 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1436 * XXX: While the template is called forwarding-failed,
1437 * it currently only handles socks forwarding failures.
1439 assert(fwd->type != SOCKS_NONE);
1442 * Map failure reason, forwarding type and forwarder.
1444 if (NULL == csp->error_message)
1447 * Either we forgot to record the failure reason,
1448 * or the memory allocation failed.
1450 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1451 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1453 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1454 if (!err) err = map(exports, "forwarding-type", 1, (fwd->type == SOCKS_4) ?
1455 "socks4-" : "socks4a-", 1);
1456 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1458 if (!err) rsp->status = strdup("503 Forwarding failure");
1459 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1462 free_http_response(rsp);
1463 return cgi_error_memory();
1465 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1467 else if (!strcmp(templatename, "connect-failed"))
1469 rsp->status = strdup("503 Connect failed");
1470 if (rsp->status == NULL)
1473 free_http_response(rsp);
1474 return cgi_error_memory();
1476 rsp->reason = RSP_REASON_CONNECT_FAILED;
1479 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1482 free_http_response(rsp);
1483 return cgi_error_memory();
1486 return finish_http_response(csp, rsp);
1490 /*********************************************************************
1492 * Function : cgi_error_disabled
1494 * Description : CGI function that is called to generate an error
1495 * response if the actions editor or toggle CGI are
1496 * accessed despite having being disabled at compile-
1497 * or run-time, or if the user followed an untrusted link
1498 * to access a unsafe CGI feature that is only reachable
1499 * through Privoxy directly.
1502 * 1 : csp = Current client state (buffers, headers, etc...)
1503 * 2 : rsp = http_response data structure for output
1505 * CGI Parameters : none
1507 * Returns : JB_ERR_OK on success
1508 * JB_ERR_MEMORY on out-of-memory error.
1510 *********************************************************************/
1511 jb_err cgi_error_disabled(struct client_state *csp,
1512 struct http_response *rsp)
1514 struct map *exports;
1519 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1521 return JB_ERR_MEMORY;
1523 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1525 /* Not important enough to do anything */
1526 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1529 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1533 /*********************************************************************
1535 * Function : cgi_init_error_messages
1537 * Description : Call at the start of the program to initialize
1538 * the error message used by cgi_error_memory().
1544 *********************************************************************/
1545 void cgi_init_error_messages(void)
1547 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1548 cgi_error_memory_response->head =
1549 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1550 "Content-Type: text/html\r\n"
1552 cgi_error_memory_response->body =
1555 " <title>500 Internal Privoxy Error</title>\r\n"
1556 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1559 "<h1>500 Internal Privoxy Error</h1>\r\n"
1560 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1561 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1565 cgi_error_memory_response->head_length =
1566 strlen(cgi_error_memory_response->head);
1567 cgi_error_memory_response->content_length =
1568 strlen(cgi_error_memory_response->body);
1569 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1573 /*********************************************************************
1575 * Function : cgi_error_memory
1577 * Description : Called if a CGI function runs out of memory.
1578 * Returns a statically-allocated error response.
1582 * Returns : http_response data structure for output. This is
1583 * statically allocated, for obvious reasons.
1585 *********************************************************************/
1586 struct http_response *cgi_error_memory(void)
1588 /* assert that it's been initialized. */
1589 assert(cgi_error_memory_response->head);
1591 return cgi_error_memory_response;
1595 /*********************************************************************
1597 * Function : cgi_error_no_template
1599 * Description : Almost-CGI function that is called if a template
1600 * cannot be loaded. Note this is not a true CGI,
1601 * it takes a template name rather than a map of
1605 * 1 : csp = Current client state (buffers, headers, etc...)
1606 * 2 : rsp = http_response data structure for output
1607 * 3 : template_name = Name of template that could not
1610 * Returns : JB_ERR_OK on success
1611 * JB_ERR_MEMORY on out-of-memory error.
1613 *********************************************************************/
1614 jb_err cgi_error_no_template(struct client_state *csp,
1615 struct http_response *rsp,
1616 const char *template_name)
1618 static const char status[] =
1619 "500 Internal Privoxy Error";
1620 static const char body_prefix[] =
1623 " <title>500 Internal Privoxy Error</title>\r\n"
1624 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1627 "<h1>500 Internal Privoxy Error</h1>\r\n"
1628 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1629 "<p><b>Could not load template file <code>";
1630 static const char body_suffix[] =
1631 "</code> or one of it's included components.</b></p>\r\n"
1632 "<p>Please contact your proxy administrator.</p>\r\n"
1633 "<p>If you are the proxy administrator, please put the required file(s)"
1634 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1635 "location of the <code><i>(confdir)</i></code> directory "
1636 "is specified in the main Privoxy <code>config</code> "
1637 "file. (It's typically the Privoxy install directory"
1639 ", or <code>/etc/privoxy/</code>"
1640 #endif /* ndef _WIN32 */
1644 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1648 assert(template_name);
1650 /* Reset rsp, if needed */
1654 rsp->content_length = 0;
1655 rsp->head_length = 0;
1658 rsp->body = malloc(body_size);
1659 if (rsp->body == NULL)
1661 return JB_ERR_MEMORY;
1663 strlcpy(rsp->body, body_prefix, body_size);
1664 strlcat(rsp->body, template_name, body_size);
1665 strlcat(rsp->body, body_suffix, body_size);
1667 rsp->status = strdup(status);
1668 if (rsp->status == NULL)
1670 return JB_ERR_MEMORY;
1677 /*********************************************************************
1679 * Function : cgi_error_unknown
1681 * Description : Almost-CGI function that is called if an unexpected
1682 * error occurs in the top-level CGI dispatcher.
1683 * In this context, "unexpected" means "anything other
1684 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1685 * expected to handle all other errors internally,
1686 * since they can give more relavent error messages
1689 * Note this is not a true CGI, it takes an error
1690 * code rather than a map of parameters.
1693 * 1 : csp = Current client state (buffers, headers, etc...)
1694 * 2 : rsp = http_response data structure for output
1695 * 3 : error_to_report = Error code to report.
1697 * Returns : JB_ERR_OK on success
1698 * JB_ERR_MEMORY on out-of-memory error.
1700 *********************************************************************/
1701 jb_err cgi_error_unknown(struct client_state *csp,
1702 struct http_response *rsp,
1703 jb_err error_to_report)
1705 static const char status[] =
1706 "500 Internal Privoxy Error";
1707 static const char body_prefix[] =
1710 " <title>500 Internal Privoxy Error</title>\r\n"
1711 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1714 "<h1>500 Internal Privoxy Error</h1>\r\n"
1715 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1716 "<p><b>Unexpected internal error: ";
1717 static const char body_suffix[] =
1720 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1721 "file a bug report</a>.</p>\r\n"
1726 * Due to sizeof(errnumbuf), body_size will be slightly
1727 * bigger than necessary but it doesn't really matter.
1729 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1733 /* Reset rsp, if needed */
1737 rsp->content_length = 0;
1738 rsp->head_length = 0;
1740 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1742 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1744 rsp->body = malloc(body_size);
1745 if (rsp->body == NULL)
1747 return JB_ERR_MEMORY;
1749 strlcpy(rsp->body, body_prefix, body_size);
1750 strlcat(rsp->body, errnumbuf, body_size);
1751 strlcat(rsp->body, body_suffix, body_size);
1753 rsp->status = strdup(status);
1754 if (rsp->status == NULL)
1756 return JB_ERR_MEMORY;
1763 /*********************************************************************
1765 * Function : cgi_error_bad_param
1767 * Description : CGI function that is called if the parameters
1768 * (query string) for a CGI were wrong.
1771 * 1 : csp = Current client state (buffers, headers, etc...)
1772 * 2 : rsp = http_response data structure for output
1774 * CGI Parameters : none
1776 * Returns : JB_ERR_OK on success
1777 * JB_ERR_MEMORY on out-of-memory error.
1779 *********************************************************************/
1780 jb_err cgi_error_bad_param(struct client_state *csp,
1781 struct http_response *rsp)
1783 struct map *exports;
1788 if (NULL == (exports = default_exports(csp, NULL)))
1790 return JB_ERR_MEMORY;
1793 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1797 /*********************************************************************
1799 * Function : cgi_redirect
1801 * Description : CGI support function to generate a HTTP redirect
1805 * 1 : rsp = http_response data structure for output
1806 * 2 : target = string with the target URL
1808 * CGI Parameters : None
1810 * Returns : JB_ERR_OK on success
1811 * JB_ERR_MEMORY on out-of-memory error.
1813 *********************************************************************/
1814 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1821 err = enlist_unique_header(rsp->headers, "Location", target);
1823 rsp->status = strdup("302 Local Redirect from Privoxy");
1824 if (rsp->status == NULL)
1826 return JB_ERR_MEMORY;
1833 /*********************************************************************
1835 * Function : add_help_link
1837 * Description : Produce a copy of the string given as item,
1838 * embedded in an HTML link to its corresponding
1839 * section (item name in uppercase) in the actions
1840 * chapter of the user manual, (whose URL is given in
1841 * the config and defaults to our web site).
1843 * FIXME: I currently only work for actions, and would
1844 * like to be generalized for other topics.
1847 * 1 : item = item (will NOT be free()d.)
1848 * It is assumed to be HTML-safe.
1849 * 2 : config = The current configuration.
1851 * Returns : String with item embedded in link, or NULL on
1854 *********************************************************************/
1855 char *add_help_link(const char *item,
1856 struct configuration_spec *config)
1860 if (!item) return NULL;
1862 result = strdup("<a href=\"");
1863 if (!strncmpic(config->usermanual, "file://", 7) ||
1864 !strncmpic(config->usermanual, "http", 4))
1866 string_append(&result, config->usermanual);
1870 string_append(&result, "http://");
1871 string_append(&result, CGI_SITE_2_HOST);
1872 string_append(&result, "/user-manual/");
1874 string_append(&result, ACTIONS_HELP_PREFIX);
1875 string_join (&result, string_toupper(item));
1876 string_append(&result, "\">");
1877 string_append(&result, item);
1878 string_append(&result, "</a> ");
1884 /*********************************************************************
1886 * Function : get_http_time
1888 * Description : Get the time in a format suitable for use in a
1889 * HTTP header - e.g.:
1890 * "Sun, 06 Nov 1994 08:49:37 GMT"
1892 * XXX: Should probably get a third parameter for
1896 * 1 : time_offset = Time returned will be current time
1897 * plus this number of seconds.
1898 * 2 : buf = Destination for result. Must be long enough
1899 * to hold 29 characters plus a trailing zero.
1903 *********************************************************************/
1904 void get_http_time(int time_offset, char *buf)
1906 static const char day_names[7][4] =
1907 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1908 static const char month_names[12][4] =
1909 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1910 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1913 time_t current_time;
1914 #if defined(HAVE_GMTIME_R)
1916 * Declare dummy up here (instead of inside get/set gmt block) so it
1917 * doesn't go out of scope before it's potentially used in snprintf later.
1918 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1919 * !defined HAVE_GMTIME_R.
1926 time(¤t_time); /* get current time */
1928 current_time += time_offset;
1930 /* get and save the gmt */
1933 t = gmtime_r(¤t_time, &dummy);
1934 #elif FEATURE_PTHREAD
1935 pthread_mutex_lock(&gmtime_mutex);
1936 t = gmtime(¤t_time);
1937 pthread_mutex_unlock(&gmtime_mutex);
1939 t = gmtime(¤t_time);
1943 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1945 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1946 day_names[t->tm_wday],
1948 month_names[t->tm_mon],
1958 /*********************************************************************
1960 * Function : finish_http_response
1962 * Description : Fill in the missing headers in an http response,
1963 * and flatten the headers to an http head.
1964 * For HEAD requests the body is freed once
1965 * the Content-Length header is set.
1968 * 1 : rsp = pointer to http_response to be processed
1970 * Returns : A http_response, usually the rsp parameter.
1971 * On error, free()s rsp and returns cgi_error_memory()
1973 *********************************************************************/
1974 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
1976 char buf[BUFFER_SIZE];
1979 /* Special case - do NOT change this statically allocated response,
1980 * which is ready for output anyway.
1982 if (rsp == cgi_error_memory_response)
1988 * Fill in the HTTP Status
1990 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1991 err = enlist_first(rsp->headers, buf);
1994 * Set the Content-Length
1996 if (rsp->content_length == 0)
1998 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2002 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2003 err = enlist(rsp->headers, buf);
2006 if (0 == strcmpic(csp->http->gpc, "head"))
2009 * The client only asked for the head. Dispose
2010 * the body and log an offensive message.
2012 * While it may seem to be a bit inefficient to
2013 * prepare the body if it isn't needed, it's the
2014 * only way to get the Content-Length right for
2015 * dynamic pages. We could have disposed the body
2016 * earlier, but not without duplicating the
2017 * Content-Length setting code above.
2019 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2021 rsp->content_length = 0;
2024 if (strncmpic(rsp->status, "302", 3))
2027 * If it's not a redirect without any content,
2028 * set the Content-Type to text/html if it's
2029 * not already specified.
2031 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2035 * Fill in the rest of the default headers:
2037 * Date: set to current date/time.
2038 * Last-Modified: set to date/time the page was last changed.
2039 * Expires: set to date/time page next needs reloading.
2040 * Cache-Control: set to "no-cache" if applicable.
2042 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2047 * Set Expires to about 10 min into the future so it'll get reloaded
2048 * occasionally, e.g. if Privoxy gets upgraded.
2053 get_http_time(0, buf);
2054 err = enlist_unique_header(rsp->headers, "Date", buf);
2057 /* Some date in the past. */
2058 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2062 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2063 err = enlist_unique_header(rsp->headers, "Expires", buf);
2066 else if (!strncmpic(rsp->status, "302", 3))
2068 get_http_time(0, buf);
2069 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2074 * Setting "Cache-Control" to "no-cache" and "Expires" to
2075 * the current time doesn't exactly forbid caching, it just
2076 * requires the client to revalidate the cached copy.
2078 * If a temporary problem occurs and the user tries again after
2079 * getting Privoxy's error message, a compliant browser may set the
2080 * If-Modified-Since header with the content of the error page's
2081 * Last-Modified header. More often than not, the document on the server
2082 * is older than Privoxy's error message, the server would send status code
2083 * 304 and the browser would display the outdated error message again and again.
2085 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2086 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2087 * and can be safely used to "revalidate" without getting a status code 304.
2089 * There is no need to let the useless If-Modified-Since header reach the
2090 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2092 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2094 get_http_time(0, buf);
2095 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2096 if (!strncmpic(rsp->status, "403", 3)
2097 || !strncmpic(rsp->status, "404", 3)
2098 || !strncmpic(rsp->status, "503", 3))
2100 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2104 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2106 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2107 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2113 * HTTP/1.1 applications that do not support persistent connections MUST
2114 * include the "close" connection option in every message.
2116 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2121 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2123 free_http_response(rsp);
2124 return cgi_error_memory();
2126 rsp->head_length = strlen(rsp->head);
2133 /*********************************************************************
2135 * Function : alloc_http_response
2137 * Description : Allocates a new http_response structure.
2141 * Returns : pointer to a new http_response, or NULL.
2143 *********************************************************************/
2144 struct http_response *alloc_http_response(void)
2146 return (struct http_response *) zalloc(sizeof(struct http_response));
2151 /*********************************************************************
2153 * Function : free_http_response
2155 * Description : Free the memory occupied by an http_response
2156 * and its depandant structures.
2159 * 1 : rsp = pointer to http_response to be freed
2163 *********************************************************************/
2164 void free_http_response(struct http_response *rsp)
2167 * Must special case cgi_error_memory_response, which is never freed.
2169 if (rsp && (rsp != cgi_error_memory_response))
2174 destroy_list(rsp->headers);
2181 /*********************************************************************
2183 * Function : template_load
2185 * Description : CGI support function that loads a given HTML
2186 * template, ignoring comment lines and following
2187 * #include statements up to a depth of 1.
2190 * 1 : csp = Current client state (buffers, headers, etc...)
2191 * 2 : template_ptr = Destination for pointer to loaded
2193 * 3 : templatename = name of the HTML template to be used
2194 * 4 : recursive = Flag set if this function calls itself
2195 * following an #include statament
2197 * Returns : JB_ERR_OK on success
2198 * JB_ERR_MEMORY on out-of-memory error.
2199 * JB_ERR_FILE if the template file cannot be read
2201 *********************************************************************/
2202 jb_err template_load(struct client_state *csp, char **template_ptr,
2203 const char *templatename, int recursive)
2206 char *templates_dir_path;
2209 char *included_module;
2212 char buf[BUFFER_SIZE];
2215 assert(template_ptr);
2216 assert(templatename);
2218 *template_ptr = NULL;
2220 /* Validate template name. Paranoia. */
2221 for (p = templatename; *p != 0; p++)
2223 if ( ((*p < 'a') || (*p > 'z'))
2224 && ((*p < 'A') || (*p > 'Z'))
2225 && ((*p < '0') || (*p > '9'))
2229 /* Illegal character */
2235 * Generate full path using either templdir
2236 * or confdir/templates as base directory.
2238 if (NULL != csp->config->templdir)
2240 templates_dir_path = strdup(csp->config->templdir);
2244 templates_dir_path = make_path(csp->config->confdir, "templates");
2247 if (templates_dir_path == NULL)
2249 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2251 return JB_ERR_MEMORY;
2254 full_path = make_path(templates_dir_path, templatename);
2255 free(templates_dir_path);
2256 if (full_path == NULL)
2258 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2260 return JB_ERR_MEMORY;
2263 /* Allocate buffer */
2265 file_buffer = strdup("");
2266 if (file_buffer == NULL)
2268 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2270 return JB_ERR_MEMORY;
2273 /* Open template file */
2275 if (NULL == (fp = fopen(full_path, "r")))
2277 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2285 * Read the file, ignoring comments, and honoring #include
2286 * statements, unless we're already called recursively.
2288 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2289 * This is unlikely in practise.
2291 while (fgets(buf, BUFFER_SIZE, fp))
2293 if (!recursive && !strncmp(buf, "#include ", 9))
2295 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2302 if (string_join(&file_buffer, included_module))
2305 return JB_ERR_MEMORY;
2311 /* skip lines starting with '#' */
2317 if (string_append(&file_buffer, buf))
2320 return JB_ERR_MEMORY;
2325 *template_ptr = file_buffer;
2331 /*********************************************************************
2333 * Function : template_fill
2335 * Description : CGI support function that fills in a pre-loaded
2336 * HTML template by replacing @name@ with value using
2337 * pcrs, for each item in the output map.
2339 * Note that a leading '$' charachter in the export map's
2340 * values will be stripped and toggle on backreference
2344 * 1 : template_ptr = IN: Template to be filled out.
2346 * OUT: Filled out template.
2347 * Caller must free().
2348 * 2 : exports = map with fill in symbol -> name pairs
2350 * Returns : JB_ERR_OK on success (and for uncritical errors)
2351 * JB_ERR_MEMORY on out-of-memory error
2353 *********************************************************************/
2354 jb_err template_fill(char **template_ptr, const struct map *exports)
2356 struct map_entry *m;
2358 char buf[BUFFER_SIZE];
2359 char *tmp_out_buffer;
2365 assert(template_ptr);
2366 assert(*template_ptr);
2369 file_buffer = *template_ptr;
2370 size = strlen(file_buffer) + 1;
2373 * Assemble pcrs joblist from exports map
2375 for (m = exports->first; m != NULL; m = m->next)
2377 if (*m->name == '$')
2380 * First character of name is '$', so remove this flag
2381 * character and allow backreferences ($1 etc) in the
2382 * "replace with" text.
2384 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2390 * Treat the "replace with" text as a literal string -
2391 * no quoting needed, no backreferences allowed.
2392 * ("Trivial" ['T'] flag).
2396 /* Enclose name in @@ */
2397 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2401 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2403 /* Make and run job. */
2404 job = pcrs_compile(buf, m->value, flags, &error);
2407 if (error == PCRS_ERR_NOMEM)
2410 *template_ptr = NULL;
2411 return JB_ERR_MEMORY;
2415 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2416 /* Hope it wasn't important and silently ignore the invalid job */
2421 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2424 if (NULL == tmp_out_buffer)
2426 *template_ptr = NULL;
2427 return JB_ERR_MEMORY;
2433 * Substitution failed, keep the original buffer,
2434 * log the problem and ignore it.
2436 * The user might see some unresolved @CGI_VARIABLES@,
2437 * but returning a special CGI error page seems unreasonable
2438 * and could mask more important error messages.
2440 free(tmp_out_buffer);
2441 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2442 buf, m->value, flags, pcrs_strerror(error));
2446 /* Substitution succeeded, use modified buffer. */
2448 file_buffer = tmp_out_buffer;
2456 *template_ptr = file_buffer;
2461 /*********************************************************************
2463 * Function : template_fill_for_cgi
2465 * Description : CGI support function that loads a HTML template
2466 * and fills it in. Handles file-not-found errors
2467 * by sending a HTML error message. For convenience,
2468 * this function also frees the passed "exports" map.
2471 * 1 : csp = Client state
2472 * 2 : templatename = name of the HTML template to be used
2473 * 3 : exports = map with fill in symbol -> name pairs.
2474 * Will be freed by this function.
2475 * 4 : rsp = Response structure to fill in.
2477 * Returns : JB_ERR_OK on success
2478 * JB_ERR_MEMORY on out-of-memory error
2480 *********************************************************************/
2481 jb_err template_fill_for_cgi(struct client_state *csp,
2482 const char *templatename,
2483 struct map *exports,
2484 struct http_response *rsp)
2489 assert(templatename);
2493 err = template_load(csp, &rsp->body, templatename, 0);
2494 if (err == JB_ERR_FILE)
2497 return cgi_error_no_template(csp, rsp, templatename);
2502 return err; /* JB_ERR_MEMORY */
2504 err = template_fill(&rsp->body, exports);
2510 /*********************************************************************
2512 * Function : default_exports
2514 * Description : returns a struct map list that contains exports
2515 * which are common to all CGI functions.
2518 * 1 : csp = Current client state (buffers, headers, etc...)
2519 * 2 : caller = name of CGI who calls us and which should
2520 * be excluded from the generated menu. May be
2522 * Returns : NULL if no memory, else a new map. Caller frees.
2524 *********************************************************************/
2525 struct map *default_exports(const struct client_state *csp, const char *caller)
2529 struct map * exports;
2530 int local_help_exists = 0;
2534 exports = new_map();
2535 if (exports == NULL)
2540 err = map(exports, "version", 1, html_encode(VERSION), 0);
2541 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2542 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2543 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2544 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2545 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2546 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2547 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2548 !strncmpic(csp->config->usermanual, "http", 4))
2550 /* Manual is located somewhere else, just link to it. */
2551 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2555 /* Manual is delivered by Privoxy. */
2556 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2558 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2559 #ifdef FEATURE_TOGGLE
2560 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2562 if (!err) err = map_block_killer(exports, "can-toggle");
2565 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2566 if (!err) err = map(exports, "my-port", 1, buf, 1);
2568 if(!strcmp(CODE_STATUS, "stable"))
2570 if (!err) err = map_block_killer(exports, "unstable");
2573 if (csp->config->admin_address != NULL)
2575 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2576 local_help_exists = 1;
2580 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2583 if (csp->config->proxy_info_url != NULL)
2585 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2586 local_help_exists = 1;
2590 if (!err) err = map_block_killer(exports, "have-proxy-info");
2593 if (local_help_exists == 0)
2595 if (!err) err = map_block_killer(exports, "have-help-info");
2608 /*********************************************************************
2610 * Function : map_block_killer
2612 * Description : Convenience function.
2613 * Adds a "killer" for the conditional HTML-template
2614 * block <name>, i.e. a substitution of the regex
2615 * "if-<name>-start.*if-<name>-end" to the given
2619 * 1 : exports = map to extend
2620 * 2 : name = name of conditional block
2622 * Returns : JB_ERR_OK on success
2623 * JB_ERR_MEMORY on out-of-memory error.
2625 *********************************************************************/
2626 jb_err map_block_killer(struct map *exports, const char *name)
2628 char buf[1000]; /* Will do, since the names are hardwired */
2632 assert(strlen(name) < 490);
2634 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2635 return map(exports, buf, 1, "", 1);
2639 /*********************************************************************
2641 * Function : map_block_keep
2643 * Description : Convenience function. Removes the markers used
2644 * by map-block-killer, to save a few bytes.
2645 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2648 * 1 : exports = map to extend
2649 * 2 : name = name of conditional block
2651 * Returns : JB_ERR_OK on success
2652 * JB_ERR_MEMORY on out-of-memory error.
2654 *********************************************************************/
2655 jb_err map_block_keep(struct map *exports, const char *name)
2658 char buf[500]; /* Will do, since the names are hardwired */
2662 assert(strlen(name) < 490);
2664 snprintf(buf, sizeof(buf), "if-%s-start", name);
2665 err = map(exports, buf, 1, "", 1);
2672 snprintf(buf, sizeof(buf), "if-%s-end", name);
2673 return map(exports, buf, 1, "", 1);
2677 /*********************************************************************
2679 * Function : map_conditional
2681 * Description : Convenience function.
2682 * Adds an "if-then-else" for the conditional HTML-template
2683 * block <name>, i.e. a substitution of the form:
2690 * The control structure and one of the alternatives
2694 * 1 : exports = map to extend
2695 * 2 : name = name of conditional block
2696 * 3 : choose_first = nonzero for first, zero for second.
2698 * Returns : JB_ERR_OK on success
2699 * JB_ERR_MEMORY on out-of-memory error.
2701 *********************************************************************/
2702 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2704 char buf[1000]; /* Will do, since the names are hardwired */
2709 assert(strlen(name) < 480);
2711 snprintf(buf, sizeof(buf), (choose_first
2712 ? "else-not-%s@.*@endif-%s"
2713 : "if-%s-then@.*@else-not-%s"),
2716 err = map(exports, buf, 1, "", 1);
2722 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2723 return map(exports, buf, 1, "", 1);
2727 /*********************************************************************
2729 * Function : make_menu
2731 * Description : Returns an HTML-formatted menu of the available
2732 * unhidden CGIs, excluding the one given in <self>
2733 * and the toggle CGI if toggling is disabled.
2736 * 1 : self = name of CGI to leave out, can be NULL for
2738 * 2 : feature_flags = feature bitmap from csp->config
2741 * Returns : menu string, or NULL on out-of-memory error.
2743 *********************************************************************/
2744 char *make_menu(const char *self, const unsigned feature_flags)
2746 const struct cgi_dispatcher *d;
2747 char *result = strdup("");
2751 self = "NO-SUCH-CGI!";
2754 /* List available unhidden CGI's and export as "other-cgis" */
2755 for (d = cgi_dispatchers; d->name; d++)
2758 #ifdef FEATURE_TOGGLE
2759 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2762 * Suppress the toggle link if remote toggling is disabled.
2766 #endif /* def FEATURE_TOGGLE */
2768 if (d->description && strcmp(d->name, self))
2770 char *html_encoded_prefix;
2773 * Line breaks would be great, but break
2774 * the "blocked" template's JavaScript.
2776 string_append(&result, "<li><a href=\"");
2777 html_encoded_prefix = html_encode(CGI_PREFIX);
2778 if (html_encoded_prefix == NULL)
2784 string_append(&result, html_encoded_prefix);
2785 free(html_encoded_prefix);
2787 string_append(&result, d->name);
2788 string_append(&result, "\">");
2789 string_append(&result, d->description);
2790 string_append(&result, "</a></li>");
2798 /*********************************************************************
2800 * Function : dump_map
2802 * Description : HTML-dump a map for debugging (as table)
2805 * 1 : the_map = map to dump
2807 * Returns : string with HTML
2809 *********************************************************************/
2810 char *dump_map(const struct map *the_map)
2812 struct map_entry *cur_entry;
2813 char *ret = strdup("");
2815 string_append(&ret, "<table>\n");
2817 for (cur_entry = the_map->first;
2818 (cur_entry != NULL) && (ret != NULL);
2819 cur_entry = cur_entry->next)
2821 string_append(&ret, "<tr><td><b>");
2822 string_join (&ret, html_encode(cur_entry->name));
2823 string_append(&ret, "</b></td><td>");
2824 string_join (&ret, html_encode(cur_entry->value));
2825 string_append(&ret, "</td></tr>\n");
2828 string_append(&ret, "</table>\n");