1 const char cgi_rcs[] = "$Id: cgi.c,v 1.94 2007/02/08 19:44:49 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.94 2007/02/08 19:44:49 fabiankeil
42 * Use a transparent background for the PNG replacement pattern.
44 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
45 * - Save the reason for generating http_responses.
46 * - Fix --disable-toggle (again).
47 * - Use TBL birthday hack for 403 responses as well.
48 * - Uglify the @menu@ again to fix JavaScript
49 * errors on the "blocked" template.
50 * - Escape an ampersand in cgi_error_unknown().
52 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
53 * - Add HEAD support to finish_http_response.
54 * - Add error favicon to internal HTML error messages.
56 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
57 * Add new config option "templdir" to
58 * change the templates directory.
60 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
61 * Added "forwarding-failed" template support for error_response().
63 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
64 * Add favicon delivery functions.
66 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
67 * - Map variables that aren't guaranteed to be
68 * pure ASCII html_encoded.
69 * - Use CGI_PREFIX to generate URL for user manual
70 * CGI page to make sure CGI_SITE_2_PATH is included.
72 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
73 * - "Protect" against a rather lame JavaScript-based
74 * Privoxy detection "attack" and check the referrer
75 * before delivering the CGI style sheet.
76 * - Move referrer check for unsafe CGI pages into
77 * referrer_is_safe() and log the result.
78 * - Map @url@ in cgi-error-disabled page.
79 * It's required for the "go there anyway" link.
80 * - Mark *csp as immutable for grep_cgi_referrer().
82 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
83 * Fix strdup() error handling in cgi_error_unknown()
84 * and cgi_error_no_template(). Reported by Markus Elfring.
86 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
87 * Handle pcrs_execute() errors in template_fill() properly.
89 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
90 * Fixed gcc43 conversion warnings and replaced sprintf
91 * calls with snprintf to give OpenBSD's gcc one less reason
94 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
95 * Escape ampersand in Privoxy menu.
97 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
98 * Suppress the toggle link if remote toggling is disabled.
100 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
101 * Fix configure option --disable-toggle.
102 * Thanks to Peter Thoenen for reporting this.
104 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
105 * Don't lose the FORCE_PREFIX in case of
106 * connection problems. Fixes #612235.
108 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
109 * Make pthread mutex locking more generic. Instead of
110 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
111 * and use mutex locking unless there is an _r function
112 * available. Better safe than sorry.
114 * Fixes "./configure --disable-pthread" and should result
115 * in less threading-related problems on pthread-using platforms,
116 * but it still doesn't fix BR#1122404.
118 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
119 * Use CGI_PREFIX to check the referrer.
120 * The check for "http://config.privoxy.org/" fails
121 * if the user modified CGI_SITE_2_HOST.
123 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
124 * Adjusted headers for Privoxy's cgi responses:
125 * Don't set Last-Modified, Expires and Cache-Control
126 * headers for redirects; always set "Connection: close".
128 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
129 * Only predate the Last-Modified header for cgi responses
130 * that are delivered with status code 404 or 503.
132 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
133 * Mark cgi_send_user_manual as harmless,
134 * to fix the access denied problem Hal spotted.
135 * The manual has no secret content, therefore we
136 * don't have to care about "secure" referrers.
138 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
139 * Incorporate modified version of Roland Rosenfeld's patch to
140 * optionally access the user-manual via Privoxy. Closes patch 679075.
142 * Formatting changed to Privoxy style, added call to
143 * cgi_error_no_template if the requested file doesn't
144 * exist and modified check whether or not Privoxy itself
145 * should serve the manual. Should work cross-platform now.
147 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
148 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
150 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
151 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
152 * with what was really the latest development (the v_3_0_branch branch)
154 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
155 * Moved cgi_error_disabled() from cgiedit.c to
156 * cgi.c to re-enable build with --disable-editor.
157 * Fixes Bug #892744. Thanks to Matthew Fischer
160 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
161 * - Added new function cgi_redirect to handle creation of
162 * HTTP redirect messages formerly repeated in the code.
163 * - Send cgi_error_disabled instead of cgi_error_404 when
164 * referrer check fails
165 * - Dynamic content now gets Expires header field with date
168 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
169 * Bugfix: Transparent PNG was not transparent. Thanks to
170 * Dan Razzell of Starfish Systems for notice and new PNG.
172 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
173 * Security fix: dspatch_known_cgi no longer considers an empty
174 * referrer safe for critical CGIs, since malicious links could
175 * reside on https:// locations which browsers don't advertize as
176 * referrers. Closes bug #749916, thanks to Jeff Epler for the
177 * hint. Goodbye One-Click[tm] toggling :-(
179 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
182 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
183 * Killed a compiler warning on OSX
185 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
186 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
187 * (fixes bug #710056)
188 * - Show toggle info only if we have it
190 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
191 * Move declaration of struct tm dummy outside of a control block so it is
192 * accessible later on during snprintf in get_http_time.
194 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
195 * Cosmetic: Renamed cryptic variable
197 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
198 * 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.
200 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
201 * Disable access to critical CGIs via untrusted referrers.
202 * This prevents users from being tricked by malicious websites
203 * into making unintentional configuration changes:
205 * - Added flag to each cgi_dispatcher that allows or denies
207 * - Introduced proviorical function that greps for the
208 * referrer header before regular header parsing happens
209 * - Added safety check to dispatch_known_cgi. CGI is called
210 * if (cgi harmless || no referrer || we are referrer).
211 * Else a) toggle calls are modified not to change status and
212 * b) all other calls are denied.
214 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
215 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
217 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
218 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
220 * Revision 1.70 2002/05/19 11:33:20 jongfoster
221 * If a CGI error was not handled, and propogated back to
222 * dispatch_known_cgi(), then it was assumed to be "out of memory".
223 * This gave a very misleading error message.
225 * Now other errors will cause a simple message giving the error
226 * number and asking the user to report a bug.
229 * http://sourceforge.net/tracker/index.php?func=detail
230 * &aid=557905&group_id=11118&atid=111118
232 * Revision 1.69 2002/05/14 21:28:40 oes
233 * - Fixed add_help_link to link to the (now split) actions
234 * part of the config chapter
235 * - Renamed helplink export to actions-help-prefix
237 * Revision 1.68 2002/05/12 21:36:29 jongfoster
238 * Correcting function comments
240 * Revision 1.67 2002/04/30 12:02:07 oes
241 * Nit: updated a comment
243 * Revision 1.66 2002/04/26 18:32:57 jongfoster
244 * Fixing a memory leak on error
246 * Revision 1.65 2002/04/26 12:53:51 oes
247 * - New function add_help_link
248 * - default_exports now exports links to the user manual
249 * and a prefix for links into the config chapter
251 * Revision 1.64 2002/04/24 02:17:21 oes
252 * - Better descriptions for CGIs
253 * - Hide edit-actions, more shortcuts
254 * - Moved get_char_param, get_string_param and get_number_param here
257 * Revision 1.63 2002/04/15 19:06:43 jongfoster
260 * Revision 1.62 2002/04/10 19:59:46 jongfoster
261 * Fixes to #include in templates:
262 * - Didn't close main file if loading an included template fails.
263 * - I'm paranoid and want to disallow "#include /etc/passwd".
265 * Revision 1.61 2002/04/10 13:37:48 oes
266 * Made templates modular: template_load now recursive with max depth 1
268 * Revision 1.60 2002/04/08 20:50:25 swa
271 * Revision 1.59 2002/04/05 15:51:51 oes
272 * - added send-stylesheet CGI
273 * - bugfix: error-pages now get correct request protocol
275 * - kludged CGI descriptions and menu not to break JS syntax
277 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
278 * Fix Mac OSX compiler warnings
280 * Revision 1.57 2002/03/26 22:29:54 swa
281 * we have a new homepage!
283 * Revision 1.56 2002/03/24 17:50:46 jongfoster
284 * Fixing compile error if actions file editor disabled
286 * Revision 1.55 2002/03/24 16:55:06 oes
287 * Making GIF checkerboard transparent
289 * Revision 1.54 2002/03/24 16:18:15 jongfoster
292 * Revision 1.53 2002/03/24 16:06:00 oes
293 * Correct transparency for checkerboard PNG. Thanks, Magnus!
295 * Revision 1.52 2002/03/24 15:23:33 jongfoster
298 * Revision 1.51 2002/03/24 13:25:43 swa
299 * name change related issues
301 * Revision 1.50 2002/03/16 23:54:06 jongfoster
302 * Adding graceful termination feature, to help look for memory leaks.
303 * If you enable this (which, by design, has to be done by hand
304 * editing config.h) and then go to http://i.j.b/die, then the program
305 * will exit cleanly after the *next* request. It should free all the
306 * memory that was used.
308 * Revision 1.49 2002/03/13 00:27:04 jongfoster
311 * Revision 1.48 2002/03/08 17:47:07 jongfoster
314 * Revision 1.47 2002/03/08 16:41:33 oes
315 * Added GIF images again
317 * Revision 1.46 2002/03/07 03:48:38 oes
318 * - Changed built-in images from GIF to PNG
319 * (with regard to Unisys patent issue)
320 * - Added a 4x4 pattern PNG which is less intrusive
321 * than the logo but also clearly marks the deleted banners
323 * Revision 1.45 2002/03/06 22:54:35 jongfoster
324 * Automated function-comment nitpicking.
326 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
327 * - Better error reporting on OS/2
328 * - Fix double-slash comment (oops)
330 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
331 * - Re-enable OS/2 building after new parms were added
332 * - Fix false out of memory report when resolving CGI templates when no IP
333 * address is available of failed attempt (a la no such domain)
335 * Revision 1.42 2002/01/21 00:33:20 jongfoster
336 * Replacing strsav() with the safer string_append() or string_join().
337 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
338 * Adding missing html_encode() to error message generators.
339 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
341 * Revision 1.41 2002/01/17 20:56:22 jongfoster
342 * Replacing hard references to the URL of the config interface
343 * with #defines from project.h
345 * Revision 1.40 2002/01/09 14:26:46 oes
346 * Added support for thread-safe gmtime_r call.
348 * Revision 1.39 2001/11/16 00:48:13 jongfoster
349 * Fixing a compiler warning
351 * Revision 1.38 2001/11/13 00:31:21 jongfoster
352 * - Adding new CGIs for use by non-JavaScript browsers:
353 * edit-actions-url-form
354 * edit-actions-add-url-form
355 * edit-actions-remove-url-form
356 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
359 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
360 * Show enablement/disablement status in almost all templates.
361 * There is a little trickiness here: apparent recursive resolution of
362 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
363 * the actual enablement status. So a similar construct,
364 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
367 * Revision 1.36 2001/10/26 17:33:27 oes
370 * Revision 1.35 2001/10/23 21:48:19 jongfoster
371 * Cleaning up error handling in CGI functions - they now send back
372 * a HTML error page and should never cause a FATAL error. (Fixes one
373 * potential source of "denial of service" attacks).
375 * CGI actions file editor that works and is actually useful.
377 * Ability to toggle Junkbuster remotely using a CGI call.
379 * You can turn off both the above features in the main configuration
380 * file, e.g. if you are running a multi-user proxy.
382 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
383 * Only show "Local support" on templates conditionally:
384 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
385 * - if not, no Local support section appears
387 * Revision 1.33 2001/10/14 22:28:41 jongfoster
388 * Fixing stupid typo.
390 * Revision 1.32 2001/10/14 22:20:18 jongfoster
391 * - Changes to CGI dispatching method to match CGI names exactly,
392 * rather than doing a prefix match.
393 * - No longer need to count the length of the CGI handler names by hand.
394 * - Adding new handler for 404 error when disptching a CGI, if none of
395 * the handlers match.
396 * - Adding new handlers for CGI actionsfile editor.
398 * Revision 1.31 2001/10/10 10:56:39 oes
399 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
401 * Revision 1.30 2001/10/02 15:30:57 oes
402 * Introduced show-request cgi
404 * Revision 1.29 2001/09/20 15:47:44 steudten
406 * Fix BUG: Modify int size to size_t size in fill_template()
407 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
409 * Revision 1.28 2001/09/19 18:00:37 oes
410 * - Deletef time() FIXME (Can't fail under Linux either, if
411 * the argument is guaranteed to be in out address space,
414 * - Pointer notation cosmetics
415 * - Fixed a minor bug in template_fill(): Failiure of
416 * pcrs_execute() now secure.
418 * Revision 1.27 2001/09/16 17:08:54 jongfoster
419 * Moving simple CGI functions from cgi.c to new file cgisimple.c
421 * Revision 1.26 2001/09/16 15:47:37 jongfoster
422 * First version of CGI-based edit interface. This is very much a
423 * work-in-progress, and you can't actually use it to edit anything
424 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
425 * to have any effect.
427 * Revision 1.25 2001/09/16 15:02:35 jongfoster
428 * Adding i.j.b/robots.txt.
429 * Inlining add_stats() since it's only ever called from one place.
431 * Revision 1.24 2001/09/16 11:38:01 jongfoster
432 * Splitting fill_template() into 2 functions:
433 * template_load() loads the file
434 * template_fill() performs the PCRS regexps.
435 * This is because the CGI edit interface has a "table row"
436 * template which is used many times in the page - this
437 * change means it's only loaded from disk once.
439 * Revision 1.23 2001/09/16 11:16:05 jongfoster
440 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
442 * Revision 1.22 2001/09/16 11:00:10 jongfoster
443 * New function alloc_http_response, for symmetry with free_http_response
445 * Revision 1.21 2001/09/13 23:53:03 jongfoster
446 * Support for both static and dynamically generated CGI pages.
447 * Correctly setting Last-Modified: and Expires: HTTP headers.
449 * Revision 1.20 2001/09/13 23:40:36 jongfoster
450 * (Cosmetic only) Indentation correction
452 * Revision 1.19 2001/09/13 23:31:25 jongfoster
453 * Moving image data to cgi.c rather than cgi.h.
455 * Revision 1.18 2001/08/05 16:06:20 jongfoster
456 * Modifiying "struct map" so that there are now separate header and
457 * "map_entry" structures. This means that functions which modify a
458 * map no longer need to return a pointer to the modified map.
459 * Also, it no longer reverses the order of the entries (which may be
460 * important with some advanced template substitutions).
462 * Revision 1.17 2001/08/05 15:57:38 oes
463 * Adapted finish_http_response to new list_to_text
465 * Revision 1.16 2001/08/01 21:33:18 jongfoster
466 * Changes to fill_template() that reduce memory usage without having
467 * an impact on performance. I also renamed some variables so as not
468 * to clash with the C++ keywords "new" and "template".
470 * Revision 1.15 2001/08/01 21:19:22 jongfoster
471 * Moving file version information to a separate CGI page.
473 * Revision 1.14 2001/08/01 00:19:03 jongfoster
474 * New function: map_conditional() for an if-then-else syntax.
475 * Changing to use new version of show_defines()
477 * Revision 1.13 2001/07/30 22:08:36 jongfoster
478 * Tidying up #defines:
479 * - All feature #defines are now of the form FEATURE_xxx
480 * - Permanently turned off WIN_GUI_EDIT
481 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
483 * Revision 1.12 2001/07/29 18:47:05 jongfoster
484 * Adding missing #include "loadcfg.h"
486 * Revision 1.11 2001/07/18 17:24:37 oes
487 * Changed to conform to new pcrs interface
489 * Revision 1.10 2001/07/13 13:53:13 oes
490 * Removed all #ifdef PCRS and related code
492 * Revision 1.9 2001/06/29 21:45:41 oes
493 * Indentation, CRLF->LF, Tab-> Space
495 * Revision 1.8 2001/06/29 13:21:46 oes
496 * - Cosmetics: renamed and reordered functions, variables,
497 * texts, improved comments etc
499 * - Removed ij_untrusted_url() The relevant
500 * info is now part of the "untrusted" page,
501 * which is generated by filters.c:trust_url()
503 * - Generators of content now call finish_http_response()
504 * themselves, making jcc.c:chat() a little less
507 * - Removed obsolete "Pragma: no-cache" from our headers
509 * - http_responses now know their head length
511 * - fill_template now uses the new interface to pcrs, so that
512 * - long jobs (like whole files) no longer have to be assembled
513 * in a fixed size buffer
514 * - the new T (trivial) option is used, and the replacement may
515 * contain Perl syntax backrefs without confusing pcrs
517 * - Introduced default_exports() which generates a set of exports
518 * common to all CGIs and other content generators
520 * - Introduced convenience function map_block_killer()
522 * - Introduced convenience function make_menu()
524 * - Introduced CGI-like function error_response() which generates
525 * the "No such domain" and "Connect failed" messages using the
528 * - cgi_show_url_info:
529 * - adapted to new CGI features
530 * - form and answers now generated from same template
531 * - http:// prefix in URL now OK
534 * - adapted to new CGI features
535 * - no longer uses csp->init_proxy_args
538 * - moved menu generation to make_menu()
540 * - add_stats now writes single export map entries instead
543 * - Moved redirect_url() to filters.c
545 * - Fixed mem leak in free_http_response(), map_block_killer(),
547 * - Removed logentry from cancelled commit
549 * Revision 1.7 2001/06/09 10:51:58 jongfoster
550 * Changing "show URL info" handler to new style.
551 * Changing BUFSIZ ==> BUFFER_SIZE
553 * Revision 1.6 2001/06/07 23:05:19 jongfoster
554 * Removing code related to old forward and ACL files.
556 * Revision 1.5 2001/06/05 19:59:16 jongfoster
557 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
559 * Revision 1.4 2001/06/04 10:41:52 swa
560 * show version string of cgi.h and cgi.c
562 * Revision 1.3 2001/06/03 19:12:16 oes
563 * introduced new cgi handling
565 * No revisions before 1.3
567 **********************************************************************/
573 #include <sys/types.h>
581 #define snprintf _snprintf
582 #endif /* def _WIN32 */
591 #include "miscutil.h"
592 #include "cgisimple.h"
593 #ifdef FEATURE_CGI_EDIT_ACTIONS
595 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
597 /* loadcfg.h is for global_toggle_state only */
598 #ifdef FEATURE_PTHREAD
600 /* jcc.h is for mutex semaphore globals only */
601 #endif /* def FEATURE_PTHREAD */
602 const char cgi_h_rcs[] = CGI_H_VERSION;
605 * List of CGI functions: name, handler, description
606 * Note: Do NOT use single quotes in the description;
607 * this will break the dynamic "blocked" template!
609 static const struct cgi_dispatcher cgi_dispatchers[] = {
614 #ifdef FEATURE_GRACEFUL_TERMINATION
617 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
618 "this is a one click Denial Of Service attack!!!</em>",
623 #ifdef FEATURE_CGI_EDIT_ACTIONS
624 "View & change the current configuration",
626 "View the current configuration",
631 "View the source code version numbers",
635 "View the request headers.",
639 "Look up which actions apply to a URL and why",
641 #ifdef FEATURE_CGI_EDIT_ACTIONS
642 #ifdef FEATURE_TOGGLE
645 "Toggle Privoxy on or off",
647 #endif /* def FEATURE_TOGGLE */
648 { "edit-actions", /* Edit the actions list */
651 { "eaa", /* Shortcut for edit-actions-add-url-form */
652 cgi_edit_actions_add_url_form,
654 { "eau", /* Shortcut for edit-actions-url-form */
655 cgi_edit_actions_url_form,
657 { "ear", /* Shortcut for edit-actions-remove-url-form */
658 cgi_edit_actions_remove_url_form,
660 { "eal", /* Shortcut for edit-actions-list */
661 cgi_edit_actions_list,
663 { "eafu", /* Shortcut for edit-actions-for-url */
664 cgi_edit_actions_for_url,
666 { "eas", /* Shortcut for edit-actions-submit */
667 cgi_edit_actions_submit,
669 { "easa", /* Shortcut for edit-actions-section-add */
670 cgi_edit_actions_section_add,
672 { "easr", /* Shortcut for edit-actions-section-remove */
673 cgi_edit_actions_section_remove,
675 { "eass", /* Shortcut for edit-actions-section-swap */
676 cgi_edit_actions_section_swap,
678 { "edit-actions-for-url",
679 cgi_edit_actions_for_url,
680 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
681 { "edit-actions-list",
682 cgi_edit_actions_list,
683 NULL, TRUE /* Edit the actions list */ },
684 { "edit-actions-submit",
685 cgi_edit_actions_submit,
686 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
687 { "edit-actions-url",
688 cgi_edit_actions_url,
689 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
690 { "edit-actions-url-form",
691 cgi_edit_actions_url_form,
692 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
693 { "edit-actions-add-url",
694 cgi_edit_actions_add_url,
695 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
696 { "edit-actions-add-url-form",
697 cgi_edit_actions_add_url_form,
698 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
699 { "edit-actions-remove-url",
700 cgi_edit_actions_remove_url,
701 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
702 { "edit-actions-remove-url-form",
703 cgi_edit_actions_remove_url_form,
704 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
705 { "edit-actions-section-add",
706 cgi_edit_actions_section_add,
707 NULL, FALSE /* Remove a section from the actionsfile */ },
708 { "edit-actions-section-remove",
709 cgi_edit_actions_section_remove,
710 NULL, FALSE /* Remove a section from the actionsfile */ },
711 { "edit-actions-section-swap",
712 cgi_edit_actions_section_swap,
713 NULL, FALSE /* Swap two sections in the actionsfile */ },
714 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
715 { "error-favicon.ico",
716 cgi_send_error_favicon,
717 NULL, TRUE /* Sends the favicon image for error pages. */ },
719 cgi_send_default_favicon,
720 NULL, TRUE /* Sends the default favicon image. */ },
723 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
726 NULL, TRUE /* Send a built-in image */ },
729 NULL, FALSE /* Send templates/cgi-style.css */ },
731 cgi_transparent_image,
732 NULL, TRUE /* Send a transparent image (short name) */ },
734 cgi_send_user_manual,
735 NULL, TRUE /* Send user-manual */ },
736 { NULL, /* NULL Indicates end of list and default page */
738 NULL, TRUE /* Unknown CGI page */ }
743 * Built-in images for ad replacement
745 * Hint: You can encode your own images like this:
746 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
749 #ifdef FEATURE_NO_GIFS
752 * Checkerboard pattern, as a PNG.
754 const char image_pattern_data[] =
755 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
756 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
757 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
758 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
759 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
760 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
761 "\000\000\000\000\111\105\116\104\256\102\140\202";
764 * 1x1 transparant PNG.
766 const char image_blank_data[] =
767 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
768 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
769 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
770 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
771 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
772 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
773 "\000\000\000\000\111\105\116\104\256\102\140\202";
777 * Checkerboard pattern, as a GIF.
779 const char image_pattern_data[] =
780 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
781 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
782 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
783 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
787 * 1x1 transparant GIF.
789 const char image_blank_data[] =
790 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
791 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
792 "\000\001\000\000\002\002D\001\000;";
795 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
796 const size_t image_blank_length = sizeof(image_blank_data) - 1;
799 static struct http_response cgi_error_memory_response[1];
801 static struct http_response *dispatch_known_cgi(struct client_state * csp,
803 static struct map *parse_cgi_parameters(char *argstring);
806 /*********************************************************************
808 * Function : dispatch_cgi
810 * Description : Checks if a request URL has either the magical
811 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
812 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
813 * http://config.privoxy.org/). If so, it passes
814 * the (rest of the) path onto dispatch_known_cgi, which
815 * calls the relevant CGI handler function.
818 * 1 : csp = Current client state (buffers, headers, etc...)
820 * Returns : http_response if match, NULL if nonmatch or handler fail
822 *********************************************************************/
823 struct http_response *dispatch_cgi(struct client_state *csp)
825 const char *host = csp->http->host;
826 const char *path = csp->http->path;
829 * Should we intercept ?
832 /* Note: "example.com" and "example.com." are equivalent hostnames. */
834 /* Either the host matches CGI_SITE_1_HOST ..*/
835 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
836 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
837 && (path[0] == '/') )
839 /* ..then the path will all be for us. Remove leading '/' */
842 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
843 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
844 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
845 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
847 /* take everything following CGI_SITE_2_PATH */
848 path += strlen(CGI_SITE_2_PATH);
851 /* skip the forward slash after CGI_SITE_2_PATH */
854 else if (*path != '\0')
857 * weirdness: URL is /configXXX, where XXX is some string
858 * Do *NOT* intercept.
870 * This is a CGI call.
873 return dispatch_known_cgi(csp, path);
877 /*********************************************************************
879 * Function : grep_cgi_referrer
881 * Description : Ugly provisorical fix that greps the value of the
882 * referer HTTP header field out of a linked list of
883 * strings like found at csp->headers. Will disappear
886 * FIXME: csp->headers ought to be csp->http->headers
887 * FIXME: Parsing all client header lines should
888 * happen right after the request is received!
891 * 1 : csp = Current client state (buffers, headers, etc...)
893 * Returns : pointer to value (no copy!), or NULL if none found.
895 *********************************************************************/
896 char *grep_cgi_referrer(const struct client_state *csp)
898 struct list_entry *p;
900 for (p = csp->headers->first; p != NULL; p = p->next)
902 if (p->str == NULL) continue;
903 if (strncmpic(p->str, "Referer: ", 9) == 0)
905 return ((p->str) + 9);
913 /*********************************************************************
915 * Function : referrer_is_safe
917 * Description : Decides whether we trust the Referer for
918 * CGI pages which are only meant to be reachable
919 * through Privoxy's web interface directly.
922 * 1 : csp = Current client state (buffers, headers, etc...)
924 * Returns : TRUE if the referrer is safe, or
925 * FALSE if the referrer is unsafe or not set.
927 *********************************************************************/
928 int referrer_is_safe (const struct client_state *csp)
931 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
933 referrer = grep_cgi_referrer(csp);
935 if (NULL == referrer)
937 /* No referrer, no access */
938 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
941 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
942 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
944 /* Trustworthy referrer */
945 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
946 csp->http->url, referrer);
952 /* Untrustworthy referrer */
953 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
954 csp->http->url, referrer);
961 /*********************************************************************
963 * Function : dispatch_known_cgi
965 * Description : Processes a CGI once dispatch_cgi has determined that
966 * it matches one of the magic prefixes. Parses the path
967 * as a cgi name plus query string, prepares a map that
968 * maps CGI parameter names to their values, initializes
969 * the http_response struct, and calls the relevant CGI
973 * 1 : csp = Current client state (buffers, headers, etc...)
974 * 2 : path = Path of CGI, with the CGI prefix removed.
975 * Should not have a leading "/".
977 * Returns : http_response, or NULL on handler failure or out of
980 *********************************************************************/
981 static struct http_response *dispatch_known_cgi(struct client_state * csp,
984 const struct cgi_dispatcher *d;
985 struct map *param_list;
986 struct http_response *rsp;
987 char *query_args_start;
991 if (NULL == (path_copy = strdup(path)))
993 return cgi_error_memory();
995 query_args_start = path_copy;
996 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1000 if (*query_args_start == '/')
1002 *query_args_start++ = '\0';
1003 if ((param_list = new_map()))
1005 map(param_list, "file", 1, url_decode(query_args_start), 0);
1010 if (*query_args_start == '?')
1012 *query_args_start++ = '\0';
1014 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1017 return cgi_error_memory();
1023 * path_copy = CGI call name
1024 * param_list = CGI params, as map
1027 /* Get mem for response or fail*/
1028 if (NULL == (rsp = alloc_http_response()))
1031 free_map(param_list);
1032 return cgi_error_memory();
1036 * Find and start the right CGI function
1038 d = cgi_dispatchers;
1041 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1044 * If the called CGI is either harmless, or referred
1045 * from a trusted source, start it.
1047 if (d->harmless || referrer_is_safe(csp))
1049 err = (d->handler)(csp, rsp, param_list);
1054 * Else, modify toggle calls so that they only display
1055 * the status, and deny all other calls.
1057 if (0 == strcmp(path_copy, "toggle"))
1059 unmap(param_list, "set");
1060 err = (d->handler)(csp, rsp, param_list);
1064 err = cgi_error_disabled(csp, rsp);
1069 free_map(param_list);
1071 if (err == JB_ERR_CGI_PARAMS)
1073 err = cgi_error_bad_param(csp, rsp);
1075 if (err && (err != JB_ERR_MEMORY))
1077 /* Unexpected error! Shouldn't get here */
1078 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1079 err = cgi_error_unknown(csp, rsp, err);
1084 rsp->reason = RSP_REASON_CGI_CALL;
1085 return finish_http_response(csp, rsp);
1089 /* Error in handler, probably out-of-memory */
1090 free_http_response(rsp);
1091 return cgi_error_memory();
1099 /*********************************************************************
1101 * Function : parse_cgi_parameters
1103 * Description : Parse a URL-encoded argument string into name/value
1104 * pairs and store them in a struct map list.
1107 * 1 : argstring = string to be parsed. Will be trashed.
1109 * Returns : pointer to param list, or NULL if out of memory.
1111 *********************************************************************/
1112 static struct map *parse_cgi_parameters(char *argstring)
1115 char *vector[BUFFER_SIZE];
1117 struct map *cgi_params;
1119 if (NULL == (cgi_params = new_map()))
1125 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1126 * the fragment identifier along with the request, so we must
1127 * cut it off here, so it won't pollute the CGI params:
1129 if (NULL != (p = strchr(argstring, '#')))
1134 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1136 for (i = 0; i < pairs; i++)
1138 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1141 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1143 free_map(cgi_params);
1154 /*********************************************************************
1156 * Function : get_char_param
1158 * Description : Get a single-character parameter passed to a CGI
1162 * 1 : parameters = map of cgi parameters
1163 * 2 : param_name = The name of the parameter to read
1165 * Returns : Uppercase character on success, '\0' on error.
1167 *********************************************************************/
1168 char get_char_param(const struct map *parameters,
1169 const char *param_name)
1176 ch = *(lookup(parameters, param_name));
1177 if ((ch >= 'a') && (ch <= 'z'))
1179 ch = (char)(ch - 'a' + 'A');
1186 /*********************************************************************
1188 * Function : get_string_param
1190 * Description : Get a string paramater, to be used as an
1191 * ACTION_STRING or ACTION_MULTI paramater.
1192 * Validates the input to prevent stupid/malicious
1193 * users from corrupting their action file.
1196 * 1 : parameters = map of cgi parameters
1197 * 2 : param_name = The name of the parameter to read
1198 * 3 : pparam = destination for paramater. Allocated as
1199 * part of the map "parameters", so don't free it.
1200 * Set to NULL if not specified.
1202 * Returns : JB_ERR_OK on success, or if the paramater
1203 * was not specified.
1204 * JB_ERR_MEMORY on out-of-memory.
1205 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1207 *********************************************************************/
1208 jb_err get_string_param(const struct map *parameters,
1209 const char *param_name,
1210 const char **pparam)
1222 param = lookup(parameters, param_name);
1228 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1233 * Note that the length limit is arbitrary, it just seems
1234 * sensible to limit it to *something*. There's no
1235 * technical reason for any limit at all.
1237 return JB_ERR_CGI_PARAMS;
1240 /* Check every character to see if it's legal */
1242 while ((ch = *s++) != '\0')
1244 if ( ((unsigned char)ch < (unsigned char)' ')
1247 /* Probable hack attempt, or user accidentally used '}'. */
1248 return JB_ERR_CGI_PARAMS;
1259 /*********************************************************************
1261 * Function : get_number_param
1263 * Description : Get a non-negative integer from the parameters
1264 * passed to a CGI function.
1267 * 1 : csp = Current client state (buffers, headers, etc...)
1268 * 2 : parameters = map of cgi parameters
1269 * 3 : name = Name of CGI parameter to read
1270 * 4 : pvalue = destination for value.
1271 * Set to -1 on error.
1273 * Returns : JB_ERR_OK on success
1274 * JB_ERR_MEMORY on out-of-memory
1275 * JB_ERR_CGI_PARAMS if the parameter was not specified
1278 *********************************************************************/
1279 jb_err get_number_param(struct client_state *csp,
1280 const struct map *parameters,
1295 param = lookup(parameters, name);
1298 return JB_ERR_CGI_PARAMS;
1301 /* We don't use atoi because I want to check this carefully... */
1304 while ((ch = *param++) != '\0')
1306 if ((ch < '0') || (ch > '9'))
1308 return JB_ERR_CGI_PARAMS;
1311 ch = (char)(ch - '0');
1315 * <limits.h> defines UINT_MAX
1317 * (UINT_MAX - ch) / 10 is the largest number that
1318 * can be safely multiplied by 10 then have ch added.
1320 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1322 return JB_ERR_CGI_PARAMS;
1325 value = value * 10 + (unsigned)ch;
1336 /*********************************************************************
1338 * Function : error_response
1340 * Description : returns an http_response that explains the reason
1341 * why a request failed.
1344 * 1 : csp = Current client state (buffers, headers, etc...)
1345 * 2 : templatename = Which template should be used for the answer
1346 * 3 : sys_err = system error number
1348 * Returns : A http_response. If we run out of memory, this
1349 * will be cgi_error_memory().
1351 *********************************************************************/
1352 struct http_response *error_response(struct client_state *csp,
1353 const char *templatename,
1357 struct http_response *rsp;
1358 struct map *exports = default_exports(csp, NULL);
1361 if (exports == NULL)
1363 return cgi_error_memory();
1366 if (NULL == (rsp = alloc_http_response()))
1369 return cgi_error_memory();
1372 #ifdef FEATURE_FORCE_LOAD
1373 if (csp->flags & CSP_FLAG_FORCED)
1375 path = strdup(FORCE_PREFIX);
1378 #endif /* def FEATURE_FORCE_LOAD */
1382 err = string_append(&path, csp->http->path);
1384 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1385 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1386 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1387 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1388 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1391 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1394 /* Some failures, like "404 no such domain", don't have an IP address. */
1395 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1403 free_http_response(rsp);
1404 return cgi_error_memory();
1407 if (!strcmp(templatename, "no-such-domain"))
1409 rsp->status = strdup("404 No such domain");
1410 if (rsp->status == NULL)
1413 free_http_response(rsp);
1414 return cgi_error_memory();
1416 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1418 else if (!strcmp(templatename, "forwarding-failed"))
1420 const struct forward_spec * fwd = forward_url(csp->http, csp);
1423 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1424 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1428 * XXX: While the template is called forwarding-failed,
1429 * it currently only handles socks forwarding failures.
1431 assert(fwd->type != SOCKS_NONE);
1434 * Map failure reason, forwarding type and forwarder.
1436 if (NULL == csp->error_message)
1439 * Either we forgot to record the failure reason,
1440 * or the memory allocation failed.
1442 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1443 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1445 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1446 if (!err) err = map(exports, "forwarding-type", 1, (fwd->type == SOCKS_4) ?
1447 "socks4-" : "socks4a-", 1);
1448 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1450 if (!err) rsp->status = strdup("503 Forwarding failure");
1451 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1454 free_http_response(rsp);
1455 return cgi_error_memory();
1457 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1459 else if (!strcmp(templatename, "connect-failed"))
1461 rsp->status = strdup("503 Connect failed");
1462 if (rsp->status == NULL)
1465 free_http_response(rsp);
1466 return cgi_error_memory();
1468 rsp->reason = RSP_REASON_CONNECT_FAILED;
1471 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1474 free_http_response(rsp);
1475 return cgi_error_memory();
1478 return finish_http_response(csp, rsp);
1482 /*********************************************************************
1484 * Function : cgi_error_disabled
1486 * Description : CGI function that is called to generate an error
1487 * response if the actions editor or toggle CGI are
1488 * accessed despite having being disabled at compile-
1489 * or run-time, or if the user followed an untrusted link
1490 * to access a unsafe CGI feature that is only reachable
1491 * through Privoxy directly.
1494 * 1 : csp = Current client state (buffers, headers, etc...)
1495 * 2 : rsp = http_response data structure for output
1497 * CGI Parameters : none
1499 * Returns : JB_ERR_OK on success
1500 * JB_ERR_MEMORY on out-of-memory error.
1502 *********************************************************************/
1503 jb_err cgi_error_disabled(struct client_state *csp,
1504 struct http_response *rsp)
1506 struct map *exports;
1511 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1513 return JB_ERR_MEMORY;
1515 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1517 /* Not important enough to do anything */
1518 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1521 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1525 /*********************************************************************
1527 * Function : cgi_init_error_messages
1529 * Description : Call at the start of the program to initialize
1530 * the error message used by cgi_error_memory().
1536 *********************************************************************/
1537 void cgi_init_error_messages(void)
1539 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1540 cgi_error_memory_response->head =
1541 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1542 "Content-Type: text/html\r\n"
1544 cgi_error_memory_response->body =
1547 " <title>500 Internal Privoxy Error</title>\r\n"
1548 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1551 "<h1>500 Internal Privoxy Error</h1>\r\n"
1552 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1553 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1557 cgi_error_memory_response->head_length =
1558 strlen(cgi_error_memory_response->head);
1559 cgi_error_memory_response->content_length =
1560 strlen(cgi_error_memory_response->body);
1561 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1565 /*********************************************************************
1567 * Function : cgi_error_memory
1569 * Description : Called if a CGI function runs out of memory.
1570 * Returns a statically-allocated error response.
1574 * Returns : http_response data structure for output. This is
1575 * statically allocated, for obvious reasons.
1577 *********************************************************************/
1578 struct http_response *cgi_error_memory(void)
1580 /* assert that it's been initialized. */
1581 assert(cgi_error_memory_response->head);
1583 return cgi_error_memory_response;
1587 /*********************************************************************
1589 * Function : cgi_error_no_template
1591 * Description : Almost-CGI function that is called if a template
1592 * cannot be loaded. Note this is not a true CGI,
1593 * it takes a template name rather than a map of
1597 * 1 : csp = Current client state (buffers, headers, etc...)
1598 * 2 : rsp = http_response data structure for output
1599 * 3 : template_name = Name of template that could not
1602 * Returns : JB_ERR_OK on success
1603 * JB_ERR_MEMORY on out-of-memory error.
1605 *********************************************************************/
1606 jb_err cgi_error_no_template(struct client_state *csp,
1607 struct http_response *rsp,
1608 const char *template_name)
1610 static const char status[] =
1611 "500 Internal Privoxy Error";
1612 static const char body_prefix[] =
1615 " <title>500 Internal Privoxy Error</title>\r\n"
1616 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1619 "<h1>500 Internal Privoxy Error</h1>\r\n"
1620 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1621 "<p><b>Could not load template file <code>";
1622 static const char body_suffix[] =
1623 "</code> or one of it's included components.</b></p>\r\n"
1624 "<p>Please contact your proxy administrator.</p>\r\n"
1625 "<p>If you are the proxy administrator, please put the required file(s)"
1626 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1627 "location of the <code><i>(confdir)</i></code> directory "
1628 "is specified in the main Privoxy <code>config</code> "
1629 "file. (It's typically the Privoxy install directory"
1631 ", or <code>/etc/privoxy/</code>"
1632 #endif /* ndef _WIN32 */
1639 assert(template_name);
1641 /* Reset rsp, if needed */
1645 rsp->content_length = 0;
1646 rsp->head_length = 0;
1649 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1650 if (rsp->body == NULL)
1652 return JB_ERR_MEMORY;
1654 strcpy(rsp->body, body_prefix);
1655 strcat(rsp->body, template_name);
1656 strcat(rsp->body, body_suffix);
1658 rsp->status = strdup(status);
1659 if (rsp->status == NULL)
1661 return JB_ERR_MEMORY;
1668 /*********************************************************************
1670 * Function : cgi_error_unknown
1672 * Description : Almost-CGI function that is called if an unexpected
1673 * error occurs in the top-level CGI dispatcher.
1674 * In this context, "unexpected" means "anything other
1675 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1676 * expected to handle all other errors internally,
1677 * since they can give more relavent error messages
1680 * Note this is not a true CGI, it takes an error
1681 * code rather than a map of parameters.
1684 * 1 : csp = Current client state (buffers, headers, etc...)
1685 * 2 : rsp = http_response data structure for output
1686 * 3 : error_to_report = Error code to report.
1688 * Returns : JB_ERR_OK on success
1689 * JB_ERR_MEMORY on out-of-memory error.
1691 *********************************************************************/
1692 jb_err cgi_error_unknown(struct client_state *csp,
1693 struct http_response *rsp,
1694 jb_err error_to_report)
1696 static const char status[] =
1697 "500 Internal Privoxy Error";
1698 static const char body_prefix[] =
1701 " <title>500 Internal Privoxy Error</title>\r\n"
1702 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1705 "<h1>500 Internal Privoxy Error</h1>\r\n"
1706 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1707 "<p><b>Unexpected internal error: ";
1708 static const char body_suffix[] =
1711 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1712 "file a bug report</a>.</p>\r\n"
1719 /* Reset rsp, if needed */
1723 rsp->content_length = 0;
1724 rsp->head_length = 0;
1726 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1728 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1730 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1731 if (rsp->body == NULL)
1733 return JB_ERR_MEMORY;
1735 strcpy(rsp->body, body_prefix);
1736 strcat(rsp->body, errnumbuf);
1737 strcat(rsp->body, body_suffix);
1739 rsp->status = strdup(status);
1740 if (rsp->status == NULL)
1742 return JB_ERR_MEMORY;
1749 /*********************************************************************
1751 * Function : cgi_error_bad_param
1753 * Description : CGI function that is called if the parameters
1754 * (query string) for a CGI were wrong.
1757 * 1 : csp = Current client state (buffers, headers, etc...)
1758 * 2 : rsp = http_response data structure for output
1760 * CGI Parameters : none
1762 * Returns : JB_ERR_OK on success
1763 * JB_ERR_MEMORY on out-of-memory error.
1765 *********************************************************************/
1766 jb_err cgi_error_bad_param(struct client_state *csp,
1767 struct http_response *rsp)
1769 struct map *exports;
1774 if (NULL == (exports = default_exports(csp, NULL)))
1776 return JB_ERR_MEMORY;
1779 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1783 /*********************************************************************
1785 * Function : cgi_redirect
1787 * Description : CGI support function to generate a HTTP redirect
1791 * 1 : rsp = http_response data structure for output
1792 * 2 : target = string with the target URL
1794 * CGI Parameters : None
1796 * Returns : JB_ERR_OK on success
1797 * JB_ERR_MEMORY on out-of-memory error.
1799 *********************************************************************/
1800 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1807 err = enlist_unique_header(rsp->headers, "Location", target);
1809 rsp->status = strdup("302 Local Redirect from Privoxy");
1810 if (rsp->status == NULL)
1812 return JB_ERR_MEMORY;
1819 /*********************************************************************
1821 * Function : add_help_link
1823 * Description : Produce a copy of the string given as item,
1824 * embedded in an HTML link to its corresponding
1825 * section (item name in uppercase) in the actions
1826 * chapter of the user manual, (whose URL is given in
1827 * the config and defaults to our web site).
1829 * FIXME: I currently only work for actions, and would
1830 * like to be generalized for other topics.
1833 * 1 : item = item (will NOT be free()d.)
1834 * It is assumed to be HTML-safe.
1835 * 2 : config = The current configuration.
1837 * Returns : String with item embedded in link, or NULL on
1840 *********************************************************************/
1841 char *add_help_link(const char *item,
1842 struct configuration_spec *config)
1846 if (!item) return NULL;
1848 result = strdup("<a href=\"");
1849 if (!strncmpic(config->usermanual, "file://", 7) ||
1850 !strncmpic(config->usermanual, "http", 4))
1852 string_append(&result, config->usermanual);
1856 string_append(&result, "http://");
1857 string_append(&result, CGI_SITE_2_HOST);
1858 string_append(&result, "/user-manual/");
1860 string_append(&result, ACTIONS_HELP_PREFIX);
1861 string_join (&result, string_toupper(item));
1862 string_append(&result, "\">");
1863 string_append(&result, item);
1864 string_append(&result, "</a> ");
1870 /*********************************************************************
1872 * Function : get_http_time
1874 * Description : Get the time in a format suitable for use in a
1875 * HTTP header - e.g.:
1876 * "Sun, 06 Nov 1994 08:49:37 GMT"
1879 * 1 : time_offset = Time returned will be current time
1880 * plus this number of seconds.
1881 * 2 : buf = Destination for result. Must be long enough
1882 * to hold 29 characters plus a trailing zero.
1886 *********************************************************************/
1887 void get_http_time(int time_offset, char *buf)
1889 static const char day_names[7][4] =
1890 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1891 static const char month_names[12][4] =
1892 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1893 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1896 time_t current_time;
1897 #if defined(HAVE_GMTIME_R)
1899 * Declare dummy up here (instead of inside get/set gmt block) so it
1900 * doesn't go out of scope before it's potentially used in snprintf later.
1901 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1902 * !defined HAVE_GMTIME_R.
1909 time(¤t_time); /* get current time */
1911 current_time += time_offset;
1913 /* get and save the gmt */
1916 t = gmtime_r(¤t_time, &dummy);
1917 #elif FEATURE_PTHREAD
1918 pthread_mutex_lock(&gmtime_mutex);
1919 t = gmtime(¤t_time);
1920 pthread_mutex_unlock(&gmtime_mutex);
1922 t = gmtime(¤t_time);
1926 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1928 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1929 day_names[t->tm_wday],
1931 month_names[t->tm_mon],
1941 /*********************************************************************
1943 * Function : finish_http_response
1945 * Description : Fill in the missing headers in an http response,
1946 * and flatten the headers to an http head.
1947 * For HEAD requests the body is freed once
1948 * the Content-Length header is set.
1951 * 1 : rsp = pointer to http_response to be processed
1953 * Returns : A http_response, usually the rsp parameter.
1954 * On error, free()s rsp and returns cgi_error_memory()
1956 *********************************************************************/
1957 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
1959 char buf[BUFFER_SIZE];
1962 /* Special case - do NOT change this statically allocated response,
1963 * which is ready for output anyway.
1965 if (rsp == cgi_error_memory_response)
1971 * Fill in the HTTP Status
1973 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1974 err = enlist_first(rsp->headers, buf);
1977 * Set the Content-Length
1979 if (rsp->content_length == 0)
1981 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1985 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1986 err = enlist(rsp->headers, buf);
1989 if (0 == strcmpic(csp->http->gpc, "head"))
1992 * The client only asked for the head. Dispose
1993 * the body and log an offensive message.
1995 * While it may seem to be a bit inefficient to
1996 * prepare the body if it isn't needed, it's the
1997 * only way to get the Content-Length right for
1998 * dynamic pages. We could have disposed the body
1999 * earlier, but not without duplicating the
2000 * Content-Length setting code above.
2002 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2004 rsp->content_length = 0;
2007 if (strncmpic(rsp->status, "302", 3))
2010 * If it's not a redirect without any content,
2011 * set the Content-Type to text/html if it's
2012 * not already specified.
2014 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2018 * Fill in the rest of the default headers:
2020 * Date: set to current date/time.
2021 * Last-Modified: set to date/time the page was last changed.
2022 * Expires: set to date/time page next needs reloading.
2023 * Cache-Control: set to "no-cache" if applicable.
2025 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2030 * Set Expires to about 10 min into the future so it'll get reloaded
2031 * occasionally, e.g. if Privoxy gets upgraded.
2036 get_http_time(0, buf);
2037 err = enlist_unique_header(rsp->headers, "Date", buf);
2040 /* Some date in the past. */
2041 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2045 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2046 err = enlist_unique_header(rsp->headers, "Expires", buf);
2049 else if (!strncmpic(rsp->status, "302", 3))
2051 get_http_time(0, buf);
2052 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2057 * Setting "Cache-Control" to "no-cache" and "Expires" to
2058 * the current time doesn't exactly forbid caching, it just
2059 * requires the client to revalidate the cached copy.
2061 * If a temporary problem occurs and the user tries again after
2062 * getting Privoxy's error message, a compliant browser may set the
2063 * If-Modified-Since header with the content of the error page's
2064 * Last-Modified header. More often than not, the document on the server
2065 * is older than Privoxy's error message, the server would send status code
2066 * 304 and the browser would display the outdated error message again and again.
2068 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2069 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2070 * and can be safely used to "revalidate" without getting a status code 304.
2072 * There is no need to let the useless If-Modified-Since header reach the
2073 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2075 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2077 get_http_time(0, buf);
2078 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2079 if (!strncmpic(rsp->status, "403", 3)
2080 || !strncmpic(rsp->status, "404", 3)
2081 || !strncmpic(rsp->status, "503", 3))
2083 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2087 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2089 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2090 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2096 * HTTP/1.1 applications that do not support persistent connections MUST
2097 * include the "close" connection option in every message.
2099 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2104 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2106 free_http_response(rsp);
2107 return cgi_error_memory();
2109 rsp->head_length = strlen(rsp->head);
2116 /*********************************************************************
2118 * Function : alloc_http_response
2120 * Description : Allocates a new http_response structure.
2124 * Returns : pointer to a new http_response, or NULL.
2126 *********************************************************************/
2127 struct http_response *alloc_http_response(void)
2129 return (struct http_response *) zalloc(sizeof(struct http_response));
2134 /*********************************************************************
2136 * Function : free_http_response
2138 * Description : Free the memory occupied by an http_response
2139 * and its depandant structures.
2142 * 1 : rsp = pointer to http_response to be freed
2146 *********************************************************************/
2147 void free_http_response(struct http_response *rsp)
2150 * Must special case cgi_error_memory_response, which is never freed.
2152 if (rsp && (rsp != cgi_error_memory_response))
2157 destroy_list(rsp->headers);
2164 /*********************************************************************
2166 * Function : template_load
2168 * Description : CGI support function that loads a given HTML
2169 * template, ignoring comment lines and following
2170 * #include statements up to a depth of 1.
2173 * 1 : csp = Current client state (buffers, headers, etc...)
2174 * 2 : template_ptr = Destination for pointer to loaded
2176 * 3 : templatename = name of the HTML template to be used
2177 * 4 : recursive = Flag set if this function calls itself
2178 * following an #include statament
2180 * Returns : JB_ERR_OK on success
2181 * JB_ERR_MEMORY on out-of-memory error.
2182 * JB_ERR_FILE if the template file cannot be read
2184 *********************************************************************/
2185 jb_err template_load(struct client_state *csp, char **template_ptr,
2186 const char *templatename, int recursive)
2189 char *templates_dir_path;
2192 char *included_module;
2195 char buf[BUFFER_SIZE];
2198 assert(template_ptr);
2199 assert(templatename);
2201 *template_ptr = NULL;
2203 /* Validate template name. Paranoia. */
2204 for (p = templatename; *p != 0; p++)
2206 if ( ((*p < 'a') || (*p > 'z'))
2207 && ((*p < 'A') || (*p > 'Z'))
2208 && ((*p < '0') || (*p > '9'))
2212 /* Illegal character */
2218 * Generate full path using either templdir
2219 * or confdir/templates as base directory.
2221 if (NULL != csp->config->templdir)
2223 templates_dir_path = strdup(csp->config->templdir);
2227 templates_dir_path = make_path(csp->config->confdir, "templates");
2230 if (templates_dir_path == NULL)
2232 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2234 return JB_ERR_MEMORY;
2237 full_path = make_path(templates_dir_path, templatename);
2238 free(templates_dir_path);
2239 if (full_path == NULL)
2241 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2243 return JB_ERR_MEMORY;
2246 /* Allocate buffer */
2248 file_buffer = strdup("");
2249 if (file_buffer == NULL)
2251 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2253 return JB_ERR_MEMORY;
2256 /* Open template file */
2258 if (NULL == (fp = fopen(full_path, "r")))
2260 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2268 * Read the file, ignoring comments, and honoring #include
2269 * statements, unless we're already called recursively.
2271 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2272 * This is unlikely in practise.
2274 while (fgets(buf, BUFFER_SIZE, fp))
2276 if (!recursive && !strncmp(buf, "#include ", 9))
2278 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2285 if (string_join(&file_buffer, included_module))
2288 return JB_ERR_MEMORY;
2294 /* skip lines starting with '#' */
2300 if (string_append(&file_buffer, buf))
2303 return JB_ERR_MEMORY;
2308 *template_ptr = file_buffer;
2314 /*********************************************************************
2316 * Function : template_fill
2318 * Description : CGI support function that fills in a pre-loaded
2319 * HTML template by replacing @name@ with value using
2320 * pcrs, for each item in the output map.
2322 * Note that a leading '$' charachter in the export map's
2323 * values will be stripped and toggle on backreference
2327 * 1 : template_ptr = IN: Template to be filled out.
2329 * OUT: Filled out template.
2330 * Caller must free().
2331 * 2 : exports = map with fill in symbol -> name pairs
2333 * Returns : JB_ERR_OK on success (and for uncritical errors)
2334 * JB_ERR_MEMORY on out-of-memory error
2336 *********************************************************************/
2337 jb_err template_fill(char **template_ptr, const struct map *exports)
2339 struct map_entry *m;
2341 char buf[BUFFER_SIZE];
2342 char *tmp_out_buffer;
2348 assert(template_ptr);
2349 assert(*template_ptr);
2352 file_buffer = *template_ptr;
2353 size = strlen(file_buffer) + 1;
2356 * Assemble pcrs joblist from exports map
2358 for (m = exports->first; m != NULL; m = m->next)
2360 if (*m->name == '$')
2363 * First character of name is '$', so remove this flag
2364 * character and allow backreferences ($1 etc) in the
2365 * "replace with" text.
2367 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2373 * Treat the "replace with" text as a literal string -
2374 * no quoting needed, no backreferences allowed.
2375 * ("Trivial" ['T'] flag).
2379 /* Enclose name in @@ */
2380 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2384 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2386 /* Make and run job. */
2387 job = pcrs_compile(buf, m->value, flags, &error);
2390 if (error == PCRS_ERR_NOMEM)
2393 *template_ptr = NULL;
2394 return JB_ERR_MEMORY;
2398 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2399 /* Hope it wasn't important and silently ignore the invalid job */
2404 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2407 if (NULL == tmp_out_buffer)
2409 *template_ptr = NULL;
2410 return JB_ERR_MEMORY;
2416 * Substitution failed, keep the original buffer,
2417 * log the problem and ignore it.
2419 * The user might see some unresolved @CGI_VARIABLES@,
2420 * but returning a special CGI error page seems unreasonable
2421 * and could mask more important error messages.
2423 free(tmp_out_buffer);
2424 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2425 buf, m->value, flags, pcrs_strerror(error));
2429 /* Substitution succeeded, use modified buffer. */
2431 file_buffer = tmp_out_buffer;
2439 *template_ptr = file_buffer;
2444 /*********************************************************************
2446 * Function : template_fill_for_cgi
2448 * Description : CGI support function that loads a HTML template
2449 * and fills it in. Handles file-not-found errors
2450 * by sending a HTML error message. For convenience,
2451 * this function also frees the passed "exports" map.
2454 * 1 : csp = Client state
2455 * 2 : templatename = name of the HTML template to be used
2456 * 3 : exports = map with fill in symbol -> name pairs.
2457 * Will be freed by this function.
2458 * 4 : rsp = Response structure to fill in.
2460 * Returns : JB_ERR_OK on success
2461 * JB_ERR_MEMORY on out-of-memory error
2463 *********************************************************************/
2464 jb_err template_fill_for_cgi(struct client_state *csp,
2465 const char *templatename,
2466 struct map *exports,
2467 struct http_response *rsp)
2472 assert(templatename);
2476 err = template_load(csp, &rsp->body, templatename, 0);
2477 if (err == JB_ERR_FILE)
2480 return cgi_error_no_template(csp, rsp, templatename);
2485 return err; /* JB_ERR_MEMORY */
2487 err = template_fill(&rsp->body, exports);
2493 /*********************************************************************
2495 * Function : default_exports
2497 * Description : returns a struct map list that contains exports
2498 * which are common to all CGI functions.
2501 * 1 : csp = Current client state (buffers, headers, etc...)
2502 * 2 : caller = name of CGI who calls us and which should
2503 * be excluded from the generated menu. May be
2505 * Returns : NULL if no memory, else a new map. Caller frees.
2507 *********************************************************************/
2508 struct map *default_exports(const struct client_state *csp, const char *caller)
2512 struct map * exports;
2513 int local_help_exists = 0;
2517 exports = new_map();
2518 if (exports == NULL)
2523 err = map(exports, "version", 1, html_encode(VERSION), 0);
2524 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2525 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2526 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2527 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2528 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2529 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2530 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2531 !strncmpic(csp->config->usermanual, "http", 4))
2533 /* Manual is located somewhere else, just link to it. */
2534 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2538 /* Manual is delivered by Privoxy. */
2539 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2541 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2542 #ifdef FEATURE_TOGGLE
2543 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2545 if (!err) err = map_block_killer(exports, "can-toggle");
2548 snprintf(buf, 20, "%d", csp->config->hport);
2549 if (!err) err = map(exports, "my-port", 1, buf, 1);
2551 if(!strcmp(CODE_STATUS, "stable"))
2553 if (!err) err = map_block_killer(exports, "unstable");
2556 if (csp->config->admin_address != NULL)
2558 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2559 local_help_exists = 1;
2563 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2566 if (csp->config->proxy_info_url != NULL)
2568 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2569 local_help_exists = 1;
2573 if (!err) err = map_block_killer(exports, "have-proxy-info");
2576 if (local_help_exists == 0)
2578 if (!err) err = map_block_killer(exports, "have-help-info");
2591 /*********************************************************************
2593 * Function : map_block_killer
2595 * Description : Convenience function.
2596 * Adds a "killer" for the conditional HTML-template
2597 * block <name>, i.e. a substitution of the regex
2598 * "if-<name>-start.*if-<name>-end" to the given
2602 * 1 : exports = map to extend
2603 * 2 : name = name of conditional block
2605 * Returns : JB_ERR_OK on success
2606 * JB_ERR_MEMORY on out-of-memory error.
2608 *********************************************************************/
2609 jb_err map_block_killer(struct map *exports, const char *name)
2611 char buf[1000]; /* Will do, since the names are hardwired */
2615 assert(strlen(name) < 490);
2617 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2618 return map(exports, buf, 1, "", 1);
2622 /*********************************************************************
2624 * Function : map_block_keep
2626 * Description : Convenience function. Removes the markers used
2627 * by map-block-killer, to save a few bytes.
2628 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2631 * 1 : exports = map to extend
2632 * 2 : name = name of conditional block
2634 * Returns : JB_ERR_OK on success
2635 * JB_ERR_MEMORY on out-of-memory error.
2637 *********************************************************************/
2638 jb_err map_block_keep(struct map *exports, const char *name)
2641 char buf[500]; /* Will do, since the names are hardwired */
2645 assert(strlen(name) < 490);
2647 snprintf(buf, 500, "if-%s-start", name);
2648 err = map(exports, buf, 1, "", 1);
2655 snprintf(buf, 500, "if-%s-end", name);
2656 return map(exports, buf, 1, "", 1);
2660 /*********************************************************************
2662 * Function : map_conditional
2664 * Description : Convenience function.
2665 * Adds an "if-then-else" for the conditional HTML-template
2666 * block <name>, i.e. a substitution of the form:
2673 * The control structure and one of the alternatives
2677 * 1 : exports = map to extend
2678 * 2 : name = name of conditional block
2679 * 3 : choose_first = nonzero for first, zero for second.
2681 * Returns : JB_ERR_OK on success
2682 * JB_ERR_MEMORY on out-of-memory error.
2684 *********************************************************************/
2685 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2687 char buf[1000]; /* Will do, since the names are hardwired */
2692 assert(strlen(name) < 480);
2694 snprintf(buf, 1000, (choose_first
2695 ? "else-not-%s@.*@endif-%s"
2696 : "if-%s-then@.*@else-not-%s"),
2699 err = map(exports, buf, 1, "", 1);
2705 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2706 return map(exports, buf, 1, "", 1);
2710 /*********************************************************************
2712 * Function : make_menu
2714 * Description : Returns an HTML-formatted menu of the available
2715 * unhidden CGIs, excluding the one given in <self>
2716 * and the toggle CGI if toggling is disabled.
2719 * 1 : self = name of CGI to leave out, can be NULL for
2721 * 2 : feature_flags = feature bitmap from csp->config
2724 * Returns : menu string, or NULL on out-of-memory error.
2726 *********************************************************************/
2727 char *make_menu(const char *self, const unsigned feature_flags)
2729 const struct cgi_dispatcher *d;
2730 char *result = strdup("");
2734 self = "NO-SUCH-CGI!";
2737 /* List available unhidden CGI's and export as "other-cgis" */
2738 for (d = cgi_dispatchers; d->name; d++)
2741 #ifdef FEATURE_TOGGLE
2742 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2745 * Suppress the toggle link if remote toggling is disabled.
2749 #endif /* def FEATURE_TOGGLE */
2751 if (d->description && strcmp(d->name, self))
2753 char *html_encoded_prefix;
2756 * Line breaks would be great, but break
2757 * the "blocked" template's JavaScript.
2759 string_append(&result, "<li><a href=\"");
2760 html_encoded_prefix = html_encode(CGI_PREFIX);
2761 if (html_encoded_prefix == NULL)
2767 string_append(&result, html_encoded_prefix);
2768 free(html_encoded_prefix);
2770 string_append(&result, d->name);
2771 string_append(&result, "\">");
2772 string_append(&result, d->description);
2773 string_append(&result, "</a></li>");
2781 /*********************************************************************
2783 * Function : dump_map
2785 * Description : HTML-dump a map for debugging (as table)
2788 * 1 : the_map = map to dump
2790 * Returns : string with HTML
2792 *********************************************************************/
2793 char *dump_map(const struct map *the_map)
2795 struct map_entry *cur_entry;
2796 char *ret = strdup("");
2798 string_append(&ret, "<table>\n");
2800 for (cur_entry = the_map->first;
2801 (cur_entry != NULL) && (ret != NULL);
2802 cur_entry = cur_entry->next)
2804 string_append(&ret, "<tr><td><b>");
2805 string_join (&ret, html_encode(cur_entry->name));
2806 string_append(&ret, "</b></td><td>");
2807 string_join (&ret, html_encode(cur_entry->value));
2808 string_append(&ret, "</td></tr>\n");
2811 string_append(&ret, "</table>\n");