1 const char cgi_rcs[] = "$Id: cgi.c,v 1.95 2007/02/10 17:01:37 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.95 2007/02/10 17:01:37 fabiankeil
42 * Don't overlook map result for the forwarding-type.
44 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
45 * Use a transparent background for the PNG replacement pattern.
47 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
48 * - Save the reason for generating http_responses.
49 * - Fix --disable-toggle (again).
50 * - Use TBL birthday hack for 403 responses as well.
51 * - Uglify the @menu@ again to fix JavaScript
52 * errors on the "blocked" template.
53 * - Escape an ampersand in cgi_error_unknown().
55 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
56 * - Add HEAD support to finish_http_response.
57 * - Add error favicon to internal HTML error messages.
59 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
60 * Add new config option "templdir" to
61 * change the templates directory.
63 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
64 * Added "forwarding-failed" template support for error_response().
66 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
67 * Add favicon delivery functions.
69 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
70 * - Map variables that aren't guaranteed to be
71 * pure ASCII html_encoded.
72 * - Use CGI_PREFIX to generate URL for user manual
73 * CGI page to make sure CGI_SITE_2_PATH is included.
75 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
76 * - "Protect" against a rather lame JavaScript-based
77 * Privoxy detection "attack" and check the referrer
78 * before delivering the CGI style sheet.
79 * - Move referrer check for unsafe CGI pages into
80 * referrer_is_safe() and log the result.
81 * - Map @url@ in cgi-error-disabled page.
82 * It's required for the "go there anyway" link.
83 * - Mark *csp as immutable for grep_cgi_referrer().
85 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
86 * Fix strdup() error handling in cgi_error_unknown()
87 * and cgi_error_no_template(). Reported by Markus Elfring.
89 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
90 * Handle pcrs_execute() errors in template_fill() properly.
92 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
93 * Fixed gcc43 conversion warnings and replaced sprintf
94 * calls with snprintf to give OpenBSD's gcc one less reason
97 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
98 * Escape ampersand in Privoxy menu.
100 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
101 * Suppress the toggle link if remote toggling is disabled.
103 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
104 * Fix configure option --disable-toggle.
105 * Thanks to Peter Thoenen for reporting this.
107 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
108 * Don't lose the FORCE_PREFIX in case of
109 * connection problems. Fixes #612235.
111 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
112 * Make pthread mutex locking more generic. Instead of
113 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
114 * and use mutex locking unless there is an _r function
115 * available. Better safe than sorry.
117 * Fixes "./configure --disable-pthread" and should result
118 * in less threading-related problems on pthread-using platforms,
119 * but it still doesn't fix BR#1122404.
121 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
122 * Use CGI_PREFIX to check the referrer.
123 * The check for "http://config.privoxy.org/" fails
124 * if the user modified CGI_SITE_2_HOST.
126 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
127 * Adjusted headers for Privoxy's cgi responses:
128 * Don't set Last-Modified, Expires and Cache-Control
129 * headers for redirects; always set "Connection: close".
131 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
132 * Only predate the Last-Modified header for cgi responses
133 * that are delivered with status code 404 or 503.
135 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
136 * Mark cgi_send_user_manual as harmless,
137 * to fix the access denied problem Hal spotted.
138 * The manual has no secret content, therefore we
139 * don't have to care about "secure" referrers.
141 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
142 * Incorporate modified version of Roland Rosenfeld's patch to
143 * optionally access the user-manual via Privoxy. Closes patch 679075.
145 * Formatting changed to Privoxy style, added call to
146 * cgi_error_no_template if the requested file doesn't
147 * exist and modified check whether or not Privoxy itself
148 * should serve the manual. Should work cross-platform now.
150 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
151 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
153 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
154 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
155 * with what was really the latest development (the v_3_0_branch branch)
157 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
158 * Moved cgi_error_disabled() from cgiedit.c to
159 * cgi.c to re-enable build with --disable-editor.
160 * Fixes Bug #892744. Thanks to Matthew Fischer
163 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
164 * - Added new function cgi_redirect to handle creation of
165 * HTTP redirect messages formerly repeated in the code.
166 * - Send cgi_error_disabled instead of cgi_error_404 when
167 * referrer check fails
168 * - Dynamic content now gets Expires header field with date
171 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
172 * Bugfix: Transparent PNG was not transparent. Thanks to
173 * Dan Razzell of Starfish Systems for notice and new PNG.
175 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
176 * Security fix: dspatch_known_cgi no longer considers an empty
177 * referrer safe for critical CGIs, since malicious links could
178 * reside on https:// locations which browsers don't advertize as
179 * referrers. Closes bug #749916, thanks to Jeff Epler for the
180 * hint. Goodbye One-Click[tm] toggling :-(
182 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
185 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
186 * Killed a compiler warning on OSX
188 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
189 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
190 * (fixes bug #710056)
191 * - Show toggle info only if we have it
193 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
194 * Move declaration of struct tm dummy outside of a control block so it is
195 * accessible later on during snprintf in get_http_time.
197 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
198 * Cosmetic: Renamed cryptic variable
200 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
201 * 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.
203 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
204 * Disable access to critical CGIs via untrusted referrers.
205 * This prevents users from being tricked by malicious websites
206 * into making unintentional configuration changes:
208 * - Added flag to each cgi_dispatcher that allows or denies
210 * - Introduced proviorical function that greps for the
211 * referrer header before regular header parsing happens
212 * - Added safety check to dispatch_known_cgi. CGI is called
213 * if (cgi harmless || no referrer || we are referrer).
214 * Else a) toggle calls are modified not to change status and
215 * b) all other calls are denied.
217 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
218 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
220 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
221 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
223 * Revision 1.70 2002/05/19 11:33:20 jongfoster
224 * If a CGI error was not handled, and propogated back to
225 * dispatch_known_cgi(), then it was assumed to be "out of memory".
226 * This gave a very misleading error message.
228 * Now other errors will cause a simple message giving the error
229 * number and asking the user to report a bug.
232 * http://sourceforge.net/tracker/index.php?func=detail
233 * &aid=557905&group_id=11118&atid=111118
235 * Revision 1.69 2002/05/14 21:28:40 oes
236 * - Fixed add_help_link to link to the (now split) actions
237 * part of the config chapter
238 * - Renamed helplink export to actions-help-prefix
240 * Revision 1.68 2002/05/12 21:36:29 jongfoster
241 * Correcting function comments
243 * Revision 1.67 2002/04/30 12:02:07 oes
244 * Nit: updated a comment
246 * Revision 1.66 2002/04/26 18:32:57 jongfoster
247 * Fixing a memory leak on error
249 * Revision 1.65 2002/04/26 12:53:51 oes
250 * - New function add_help_link
251 * - default_exports now exports links to the user manual
252 * and a prefix for links into the config chapter
254 * Revision 1.64 2002/04/24 02:17:21 oes
255 * - Better descriptions for CGIs
256 * - Hide edit-actions, more shortcuts
257 * - Moved get_char_param, get_string_param and get_number_param here
260 * Revision 1.63 2002/04/15 19:06:43 jongfoster
263 * Revision 1.62 2002/04/10 19:59:46 jongfoster
264 * Fixes to #include in templates:
265 * - Didn't close main file if loading an included template fails.
266 * - I'm paranoid and want to disallow "#include /etc/passwd".
268 * Revision 1.61 2002/04/10 13:37:48 oes
269 * Made templates modular: template_load now recursive with max depth 1
271 * Revision 1.60 2002/04/08 20:50:25 swa
274 * Revision 1.59 2002/04/05 15:51:51 oes
275 * - added send-stylesheet CGI
276 * - bugfix: error-pages now get correct request protocol
278 * - kludged CGI descriptions and menu not to break JS syntax
280 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
281 * Fix Mac OSX compiler warnings
283 * Revision 1.57 2002/03/26 22:29:54 swa
284 * we have a new homepage!
286 * Revision 1.56 2002/03/24 17:50:46 jongfoster
287 * Fixing compile error if actions file editor disabled
289 * Revision 1.55 2002/03/24 16:55:06 oes
290 * Making GIF checkerboard transparent
292 * Revision 1.54 2002/03/24 16:18:15 jongfoster
295 * Revision 1.53 2002/03/24 16:06:00 oes
296 * Correct transparency for checkerboard PNG. Thanks, Magnus!
298 * Revision 1.52 2002/03/24 15:23:33 jongfoster
301 * Revision 1.51 2002/03/24 13:25:43 swa
302 * name change related issues
304 * Revision 1.50 2002/03/16 23:54:06 jongfoster
305 * Adding graceful termination feature, to help look for memory leaks.
306 * If you enable this (which, by design, has to be done by hand
307 * editing config.h) and then go to http://i.j.b/die, then the program
308 * will exit cleanly after the *next* request. It should free all the
309 * memory that was used.
311 * Revision 1.49 2002/03/13 00:27:04 jongfoster
314 * Revision 1.48 2002/03/08 17:47:07 jongfoster
317 * Revision 1.47 2002/03/08 16:41:33 oes
318 * Added GIF images again
320 * Revision 1.46 2002/03/07 03:48:38 oes
321 * - Changed built-in images from GIF to PNG
322 * (with regard to Unisys patent issue)
323 * - Added a 4x4 pattern PNG which is less intrusive
324 * than the logo but also clearly marks the deleted banners
326 * Revision 1.45 2002/03/06 22:54:35 jongfoster
327 * Automated function-comment nitpicking.
329 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
330 * - Better error reporting on OS/2
331 * - Fix double-slash comment (oops)
333 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
334 * - Re-enable OS/2 building after new parms were added
335 * - Fix false out of memory report when resolving CGI templates when no IP
336 * address is available of failed attempt (a la no such domain)
338 * Revision 1.42 2002/01/21 00:33:20 jongfoster
339 * Replacing strsav() with the safer string_append() or string_join().
340 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
341 * Adding missing html_encode() to error message generators.
342 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
344 * Revision 1.41 2002/01/17 20:56:22 jongfoster
345 * Replacing hard references to the URL of the config interface
346 * with #defines from project.h
348 * Revision 1.40 2002/01/09 14:26:46 oes
349 * Added support for thread-safe gmtime_r call.
351 * Revision 1.39 2001/11/16 00:48:13 jongfoster
352 * Fixing a compiler warning
354 * Revision 1.38 2001/11/13 00:31:21 jongfoster
355 * - Adding new CGIs for use by non-JavaScript browsers:
356 * edit-actions-url-form
357 * edit-actions-add-url-form
358 * edit-actions-remove-url-form
359 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
362 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
363 * Show enablement/disablement status in almost all templates.
364 * There is a little trickiness here: apparent recursive resolution of
365 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
366 * the actual enablement status. So a similar construct,
367 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
370 * Revision 1.36 2001/10/26 17:33:27 oes
373 * Revision 1.35 2001/10/23 21:48:19 jongfoster
374 * Cleaning up error handling in CGI functions - they now send back
375 * a HTML error page and should never cause a FATAL error. (Fixes one
376 * potential source of "denial of service" attacks).
378 * CGI actions file editor that works and is actually useful.
380 * Ability to toggle Junkbuster remotely using a CGI call.
382 * You can turn off both the above features in the main configuration
383 * file, e.g. if you are running a multi-user proxy.
385 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
386 * Only show "Local support" on templates conditionally:
387 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
388 * - if not, no Local support section appears
390 * Revision 1.33 2001/10/14 22:28:41 jongfoster
391 * Fixing stupid typo.
393 * Revision 1.32 2001/10/14 22:20:18 jongfoster
394 * - Changes to CGI dispatching method to match CGI names exactly,
395 * rather than doing a prefix match.
396 * - No longer need to count the length of the CGI handler names by hand.
397 * - Adding new handler for 404 error when disptching a CGI, if none of
398 * the handlers match.
399 * - Adding new handlers for CGI actionsfile editor.
401 * Revision 1.31 2001/10/10 10:56:39 oes
402 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
404 * Revision 1.30 2001/10/02 15:30:57 oes
405 * Introduced show-request cgi
407 * Revision 1.29 2001/09/20 15:47:44 steudten
409 * Fix BUG: Modify int size to size_t size in fill_template()
410 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
412 * Revision 1.28 2001/09/19 18:00:37 oes
413 * - Deletef time() FIXME (Can't fail under Linux either, if
414 * the argument is guaranteed to be in out address space,
417 * - Pointer notation cosmetics
418 * - Fixed a minor bug in template_fill(): Failiure of
419 * pcrs_execute() now secure.
421 * Revision 1.27 2001/09/16 17:08:54 jongfoster
422 * Moving simple CGI functions from cgi.c to new file cgisimple.c
424 * Revision 1.26 2001/09/16 15:47:37 jongfoster
425 * First version of CGI-based edit interface. This is very much a
426 * work-in-progress, and you can't actually use it to edit anything
427 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
428 * to have any effect.
430 * Revision 1.25 2001/09/16 15:02:35 jongfoster
431 * Adding i.j.b/robots.txt.
432 * Inlining add_stats() since it's only ever called from one place.
434 * Revision 1.24 2001/09/16 11:38:01 jongfoster
435 * Splitting fill_template() into 2 functions:
436 * template_load() loads the file
437 * template_fill() performs the PCRS regexps.
438 * This is because the CGI edit interface has a "table row"
439 * template which is used many times in the page - this
440 * change means it's only loaded from disk once.
442 * Revision 1.23 2001/09/16 11:16:05 jongfoster
443 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
445 * Revision 1.22 2001/09/16 11:00:10 jongfoster
446 * New function alloc_http_response, for symmetry with free_http_response
448 * Revision 1.21 2001/09/13 23:53:03 jongfoster
449 * Support for both static and dynamically generated CGI pages.
450 * Correctly setting Last-Modified: and Expires: HTTP headers.
452 * Revision 1.20 2001/09/13 23:40:36 jongfoster
453 * (Cosmetic only) Indentation correction
455 * Revision 1.19 2001/09/13 23:31:25 jongfoster
456 * Moving image data to cgi.c rather than cgi.h.
458 * Revision 1.18 2001/08/05 16:06:20 jongfoster
459 * Modifiying "struct map" so that there are now separate header and
460 * "map_entry" structures. This means that functions which modify a
461 * map no longer need to return a pointer to the modified map.
462 * Also, it no longer reverses the order of the entries (which may be
463 * important with some advanced template substitutions).
465 * Revision 1.17 2001/08/05 15:57:38 oes
466 * Adapted finish_http_response to new list_to_text
468 * Revision 1.16 2001/08/01 21:33:18 jongfoster
469 * Changes to fill_template() that reduce memory usage without having
470 * an impact on performance. I also renamed some variables so as not
471 * to clash with the C++ keywords "new" and "template".
473 * Revision 1.15 2001/08/01 21:19:22 jongfoster
474 * Moving file version information to a separate CGI page.
476 * Revision 1.14 2001/08/01 00:19:03 jongfoster
477 * New function: map_conditional() for an if-then-else syntax.
478 * Changing to use new version of show_defines()
480 * Revision 1.13 2001/07/30 22:08:36 jongfoster
481 * Tidying up #defines:
482 * - All feature #defines are now of the form FEATURE_xxx
483 * - Permanently turned off WIN_GUI_EDIT
484 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
486 * Revision 1.12 2001/07/29 18:47:05 jongfoster
487 * Adding missing #include "loadcfg.h"
489 * Revision 1.11 2001/07/18 17:24:37 oes
490 * Changed to conform to new pcrs interface
492 * Revision 1.10 2001/07/13 13:53:13 oes
493 * Removed all #ifdef PCRS and related code
495 * Revision 1.9 2001/06/29 21:45:41 oes
496 * Indentation, CRLF->LF, Tab-> Space
498 * Revision 1.8 2001/06/29 13:21:46 oes
499 * - Cosmetics: renamed and reordered functions, variables,
500 * texts, improved comments etc
502 * - Removed ij_untrusted_url() The relevant
503 * info is now part of the "untrusted" page,
504 * which is generated by filters.c:trust_url()
506 * - Generators of content now call finish_http_response()
507 * themselves, making jcc.c:chat() a little less
510 * - Removed obsolete "Pragma: no-cache" from our headers
512 * - http_responses now know their head length
514 * - fill_template now uses the new interface to pcrs, so that
515 * - long jobs (like whole files) no longer have to be assembled
516 * in a fixed size buffer
517 * - the new T (trivial) option is used, and the replacement may
518 * contain Perl syntax backrefs without confusing pcrs
520 * - Introduced default_exports() which generates a set of exports
521 * common to all CGIs and other content generators
523 * - Introduced convenience function map_block_killer()
525 * - Introduced convenience function make_menu()
527 * - Introduced CGI-like function error_response() which generates
528 * the "No such domain" and "Connect failed" messages using the
531 * - cgi_show_url_info:
532 * - adapted to new CGI features
533 * - form and answers now generated from same template
534 * - http:// prefix in URL now OK
537 * - adapted to new CGI features
538 * - no longer uses csp->init_proxy_args
541 * - moved menu generation to make_menu()
543 * - add_stats now writes single export map entries instead
546 * - Moved redirect_url() to filters.c
548 * - Fixed mem leak in free_http_response(), map_block_killer(),
550 * - Removed logentry from cancelled commit
552 * Revision 1.7 2001/06/09 10:51:58 jongfoster
553 * Changing "show URL info" handler to new style.
554 * Changing BUFSIZ ==> BUFFER_SIZE
556 * Revision 1.6 2001/06/07 23:05:19 jongfoster
557 * Removing code related to old forward and ACL files.
559 * Revision 1.5 2001/06/05 19:59:16 jongfoster
560 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
562 * Revision 1.4 2001/06/04 10:41:52 swa
563 * show version string of cgi.h and cgi.c
565 * Revision 1.3 2001/06/03 19:12:16 oes
566 * introduced new cgi handling
568 * No revisions before 1.3
570 **********************************************************************/
576 #include <sys/types.h>
584 #define snprintf _snprintf
585 #endif /* def _WIN32 */
594 #include "miscutil.h"
595 #include "cgisimple.h"
596 #ifdef FEATURE_CGI_EDIT_ACTIONS
598 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
600 /* loadcfg.h is for global_toggle_state only */
601 #ifdef FEATURE_PTHREAD
603 /* jcc.h is for mutex semaphore globals only */
604 #endif /* def FEATURE_PTHREAD */
605 const char cgi_h_rcs[] = CGI_H_VERSION;
608 * List of CGI functions: name, handler, description
609 * Note: Do NOT use single quotes in the description;
610 * this will break the dynamic "blocked" template!
612 static const struct cgi_dispatcher cgi_dispatchers[] = {
617 #ifdef FEATURE_GRACEFUL_TERMINATION
620 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
621 "this is a one click Denial Of Service attack!!!</em>",
626 #ifdef FEATURE_CGI_EDIT_ACTIONS
627 "View & change the current configuration",
629 "View the current configuration",
634 "View the source code version numbers",
638 "View the request headers.",
642 "Look up which actions apply to a URL and why",
644 #ifdef FEATURE_CGI_EDIT_ACTIONS
645 #ifdef FEATURE_TOGGLE
648 "Toggle Privoxy on or off",
650 #endif /* def FEATURE_TOGGLE */
651 { "edit-actions", /* Edit the actions list */
654 { "eaa", /* Shortcut for edit-actions-add-url-form */
655 cgi_edit_actions_add_url_form,
657 { "eau", /* Shortcut for edit-actions-url-form */
658 cgi_edit_actions_url_form,
660 { "ear", /* Shortcut for edit-actions-remove-url-form */
661 cgi_edit_actions_remove_url_form,
663 { "eal", /* Shortcut for edit-actions-list */
664 cgi_edit_actions_list,
666 { "eafu", /* Shortcut for edit-actions-for-url */
667 cgi_edit_actions_for_url,
669 { "eas", /* Shortcut for edit-actions-submit */
670 cgi_edit_actions_submit,
672 { "easa", /* Shortcut for edit-actions-section-add */
673 cgi_edit_actions_section_add,
675 { "easr", /* Shortcut for edit-actions-section-remove */
676 cgi_edit_actions_section_remove,
678 { "eass", /* Shortcut for edit-actions-section-swap */
679 cgi_edit_actions_section_swap,
681 { "edit-actions-for-url",
682 cgi_edit_actions_for_url,
683 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
684 { "edit-actions-list",
685 cgi_edit_actions_list,
686 NULL, TRUE /* Edit the actions list */ },
687 { "edit-actions-submit",
688 cgi_edit_actions_submit,
689 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
690 { "edit-actions-url",
691 cgi_edit_actions_url,
692 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
693 { "edit-actions-url-form",
694 cgi_edit_actions_url_form,
695 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
696 { "edit-actions-add-url",
697 cgi_edit_actions_add_url,
698 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
699 { "edit-actions-add-url-form",
700 cgi_edit_actions_add_url_form,
701 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
702 { "edit-actions-remove-url",
703 cgi_edit_actions_remove_url,
704 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
705 { "edit-actions-remove-url-form",
706 cgi_edit_actions_remove_url_form,
707 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
708 { "edit-actions-section-add",
709 cgi_edit_actions_section_add,
710 NULL, FALSE /* Remove a section from the actionsfile */ },
711 { "edit-actions-section-remove",
712 cgi_edit_actions_section_remove,
713 NULL, FALSE /* Remove a section from the actionsfile */ },
714 { "edit-actions-section-swap",
715 cgi_edit_actions_section_swap,
716 NULL, FALSE /* Swap two sections in the actionsfile */ },
717 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
718 { "error-favicon.ico",
719 cgi_send_error_favicon,
720 NULL, TRUE /* Sends the favicon image for error pages. */ },
722 cgi_send_default_favicon,
723 NULL, TRUE /* Sends the default favicon image. */ },
726 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
729 NULL, TRUE /* Send a built-in image */ },
732 NULL, FALSE /* Send templates/cgi-style.css */ },
734 cgi_transparent_image,
735 NULL, TRUE /* Send a transparent image (short name) */ },
737 cgi_send_user_manual,
738 NULL, TRUE /* Send user-manual */ },
739 { NULL, /* NULL Indicates end of list and default page */
741 NULL, TRUE /* Unknown CGI page */ }
746 * Built-in images for ad replacement
748 * Hint: You can encode your own images like this:
749 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
752 #ifdef FEATURE_NO_GIFS
755 * Checkerboard pattern, as a PNG.
757 const char image_pattern_data[] =
758 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
759 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
760 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
761 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
762 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
763 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
764 "\000\000\000\000\111\105\116\104\256\102\140\202";
767 * 1x1 transparant PNG.
769 const char image_blank_data[] =
770 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
771 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
772 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
773 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
774 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
775 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
776 "\000\000\000\000\111\105\116\104\256\102\140\202";
780 * Checkerboard pattern, as a GIF.
782 const char image_pattern_data[] =
783 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
784 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
785 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
786 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
790 * 1x1 transparant GIF.
792 const char image_blank_data[] =
793 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
794 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
795 "\000\001\000\000\002\002D\001\000;";
798 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
799 const size_t image_blank_length = sizeof(image_blank_data) - 1;
802 static struct http_response cgi_error_memory_response[1];
804 static struct http_response *dispatch_known_cgi(struct client_state * csp,
806 static struct map *parse_cgi_parameters(char *argstring);
809 /*********************************************************************
811 * Function : dispatch_cgi
813 * Description : Checks if a request URL has either the magical
814 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
815 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
816 * http://config.privoxy.org/). If so, it passes
817 * the (rest of the) path onto dispatch_known_cgi, which
818 * calls the relevant CGI handler function.
821 * 1 : csp = Current client state (buffers, headers, etc...)
823 * Returns : http_response if match, NULL if nonmatch or handler fail
825 *********************************************************************/
826 struct http_response *dispatch_cgi(struct client_state *csp)
828 const char *host = csp->http->host;
829 const char *path = csp->http->path;
832 * Should we intercept ?
835 /* Note: "example.com" and "example.com." are equivalent hostnames. */
837 /* Either the host matches CGI_SITE_1_HOST ..*/
838 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
839 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
840 && (path[0] == '/') )
842 /* ..then the path will all be for us. Remove leading '/' */
845 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
846 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
847 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
848 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
850 /* take everything following CGI_SITE_2_PATH */
851 path += strlen(CGI_SITE_2_PATH);
854 /* skip the forward slash after CGI_SITE_2_PATH */
857 else if (*path != '\0')
860 * weirdness: URL is /configXXX, where XXX is some string
861 * Do *NOT* intercept.
873 * This is a CGI call.
876 return dispatch_known_cgi(csp, path);
880 /*********************************************************************
882 * Function : grep_cgi_referrer
884 * Description : Ugly provisorical fix that greps the value of the
885 * referer HTTP header field out of a linked list of
886 * strings like found at csp->headers. Will disappear
889 * FIXME: csp->headers ought to be csp->http->headers
890 * FIXME: Parsing all client header lines should
891 * happen right after the request is received!
894 * 1 : csp = Current client state (buffers, headers, etc...)
896 * Returns : pointer to value (no copy!), or NULL if none found.
898 *********************************************************************/
899 char *grep_cgi_referrer(const struct client_state *csp)
901 struct list_entry *p;
903 for (p = csp->headers->first; p != NULL; p = p->next)
905 if (p->str == NULL) continue;
906 if (strncmpic(p->str, "Referer: ", 9) == 0)
908 return ((p->str) + 9);
916 /*********************************************************************
918 * Function : referrer_is_safe
920 * Description : Decides whether we trust the Referer for
921 * CGI pages which are only meant to be reachable
922 * through Privoxy's web interface directly.
925 * 1 : csp = Current client state (buffers, headers, etc...)
927 * Returns : TRUE if the referrer is safe, or
928 * FALSE if the referrer is unsafe or not set.
930 *********************************************************************/
931 int referrer_is_safe (const struct client_state *csp)
934 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
936 referrer = grep_cgi_referrer(csp);
938 if (NULL == referrer)
940 /* No referrer, no access */
941 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
944 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
945 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
947 /* Trustworthy referrer */
948 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
949 csp->http->url, referrer);
955 /* Untrustworthy referrer */
956 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
957 csp->http->url, referrer);
964 /*********************************************************************
966 * Function : dispatch_known_cgi
968 * Description : Processes a CGI once dispatch_cgi has determined that
969 * it matches one of the magic prefixes. Parses the path
970 * as a cgi name plus query string, prepares a map that
971 * maps CGI parameter names to their values, initializes
972 * the http_response struct, and calls the relevant CGI
976 * 1 : csp = Current client state (buffers, headers, etc...)
977 * 2 : path = Path of CGI, with the CGI prefix removed.
978 * Should not have a leading "/".
980 * Returns : http_response, or NULL on handler failure or out of
983 *********************************************************************/
984 static struct http_response *dispatch_known_cgi(struct client_state * csp,
987 const struct cgi_dispatcher *d;
988 struct map *param_list;
989 struct http_response *rsp;
990 char *query_args_start;
994 if (NULL == (path_copy = strdup(path)))
996 return cgi_error_memory();
998 query_args_start = path_copy;
999 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1003 if (*query_args_start == '/')
1005 *query_args_start++ = '\0';
1006 if ((param_list = new_map()))
1008 map(param_list, "file", 1, url_decode(query_args_start), 0);
1013 if (*query_args_start == '?')
1015 *query_args_start++ = '\0';
1017 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1020 return cgi_error_memory();
1026 * path_copy = CGI call name
1027 * param_list = CGI params, as map
1030 /* Get mem for response or fail*/
1031 if (NULL == (rsp = alloc_http_response()))
1034 free_map(param_list);
1035 return cgi_error_memory();
1039 * Find and start the right CGI function
1041 d = cgi_dispatchers;
1044 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1047 * If the called CGI is either harmless, or referred
1048 * from a trusted source, start it.
1050 if (d->harmless || referrer_is_safe(csp))
1052 err = (d->handler)(csp, rsp, param_list);
1057 * Else, modify toggle calls so that they only display
1058 * the status, and deny all other calls.
1060 if (0 == strcmp(path_copy, "toggle"))
1062 unmap(param_list, "set");
1063 err = (d->handler)(csp, rsp, param_list);
1067 err = cgi_error_disabled(csp, rsp);
1072 free_map(param_list);
1074 if (err == JB_ERR_CGI_PARAMS)
1076 err = cgi_error_bad_param(csp, rsp);
1078 if (err && (err != JB_ERR_MEMORY))
1080 /* Unexpected error! Shouldn't get here */
1081 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1082 err = cgi_error_unknown(csp, rsp, err);
1087 rsp->reason = RSP_REASON_CGI_CALL;
1088 return finish_http_response(csp, rsp);
1092 /* Error in handler, probably out-of-memory */
1093 free_http_response(rsp);
1094 return cgi_error_memory();
1102 /*********************************************************************
1104 * Function : parse_cgi_parameters
1106 * Description : Parse a URL-encoded argument string into name/value
1107 * pairs and store them in a struct map list.
1110 * 1 : argstring = string to be parsed. Will be trashed.
1112 * Returns : pointer to param list, or NULL if out of memory.
1114 *********************************************************************/
1115 static struct map *parse_cgi_parameters(char *argstring)
1118 char *vector[BUFFER_SIZE];
1120 struct map *cgi_params;
1122 if (NULL == (cgi_params = new_map()))
1128 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1129 * the fragment identifier along with the request, so we must
1130 * cut it off here, so it won't pollute the CGI params:
1132 if (NULL != (p = strchr(argstring, '#')))
1137 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1139 for (i = 0; i < pairs; i++)
1141 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1144 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1146 free_map(cgi_params);
1157 /*********************************************************************
1159 * Function : get_char_param
1161 * Description : Get a single-character parameter passed to a CGI
1165 * 1 : parameters = map of cgi parameters
1166 * 2 : param_name = The name of the parameter to read
1168 * Returns : Uppercase character on success, '\0' on error.
1170 *********************************************************************/
1171 char get_char_param(const struct map *parameters,
1172 const char *param_name)
1179 ch = *(lookup(parameters, param_name));
1180 if ((ch >= 'a') && (ch <= 'z'))
1182 ch = (char)(ch - 'a' + 'A');
1189 /*********************************************************************
1191 * Function : get_string_param
1193 * Description : Get a string paramater, to be used as an
1194 * ACTION_STRING or ACTION_MULTI paramater.
1195 * Validates the input to prevent stupid/malicious
1196 * users from corrupting their action file.
1199 * 1 : parameters = map of cgi parameters
1200 * 2 : param_name = The name of the parameter to read
1201 * 3 : pparam = destination for paramater. Allocated as
1202 * part of the map "parameters", so don't free it.
1203 * Set to NULL if not specified.
1205 * Returns : JB_ERR_OK on success, or if the paramater
1206 * was not specified.
1207 * JB_ERR_MEMORY on out-of-memory.
1208 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1210 *********************************************************************/
1211 jb_err get_string_param(const struct map *parameters,
1212 const char *param_name,
1213 const char **pparam)
1225 param = lookup(parameters, param_name);
1231 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1236 * Note that the length limit is arbitrary, it just seems
1237 * sensible to limit it to *something*. There's no
1238 * technical reason for any limit at all.
1240 return JB_ERR_CGI_PARAMS;
1243 /* Check every character to see if it's legal */
1245 while ((ch = *s++) != '\0')
1247 if ( ((unsigned char)ch < (unsigned char)' ')
1250 /* Probable hack attempt, or user accidentally used '}'. */
1251 return JB_ERR_CGI_PARAMS;
1262 /*********************************************************************
1264 * Function : get_number_param
1266 * Description : Get a non-negative integer from the parameters
1267 * passed to a CGI function.
1270 * 1 : csp = Current client state (buffers, headers, etc...)
1271 * 2 : parameters = map of cgi parameters
1272 * 3 : name = Name of CGI parameter to read
1273 * 4 : pvalue = destination for value.
1274 * Set to -1 on error.
1276 * Returns : JB_ERR_OK on success
1277 * JB_ERR_MEMORY on out-of-memory
1278 * JB_ERR_CGI_PARAMS if the parameter was not specified
1281 *********************************************************************/
1282 jb_err get_number_param(struct client_state *csp,
1283 const struct map *parameters,
1298 param = lookup(parameters, name);
1301 return JB_ERR_CGI_PARAMS;
1304 /* We don't use atoi because I want to check this carefully... */
1307 while ((ch = *param++) != '\0')
1309 if ((ch < '0') || (ch > '9'))
1311 return JB_ERR_CGI_PARAMS;
1314 ch = (char)(ch - '0');
1318 * <limits.h> defines UINT_MAX
1320 * (UINT_MAX - ch) / 10 is the largest number that
1321 * can be safely multiplied by 10 then have ch added.
1323 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1325 return JB_ERR_CGI_PARAMS;
1328 value = value * 10 + (unsigned)ch;
1339 /*********************************************************************
1341 * Function : error_response
1343 * Description : returns an http_response that explains the reason
1344 * why a request failed.
1347 * 1 : csp = Current client state (buffers, headers, etc...)
1348 * 2 : templatename = Which template should be used for the answer
1349 * 3 : sys_err = system error number
1351 * Returns : A http_response. If we run out of memory, this
1352 * will be cgi_error_memory().
1354 *********************************************************************/
1355 struct http_response *error_response(struct client_state *csp,
1356 const char *templatename,
1360 struct http_response *rsp;
1361 struct map *exports = default_exports(csp, NULL);
1364 if (exports == NULL)
1366 return cgi_error_memory();
1369 if (NULL == (rsp = alloc_http_response()))
1372 return cgi_error_memory();
1375 #ifdef FEATURE_FORCE_LOAD
1376 if (csp->flags & CSP_FLAG_FORCED)
1378 path = strdup(FORCE_PREFIX);
1381 #endif /* def FEATURE_FORCE_LOAD */
1385 err = string_append(&path, csp->http->path);
1387 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1388 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1389 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1390 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1391 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1394 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1397 /* Some failures, like "404 no such domain", don't have an IP address. */
1398 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1406 free_http_response(rsp);
1407 return cgi_error_memory();
1410 if (!strcmp(templatename, "no-such-domain"))
1412 rsp->status = strdup("404 No such domain");
1413 if (rsp->status == NULL)
1416 free_http_response(rsp);
1417 return cgi_error_memory();
1419 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1421 else if (!strcmp(templatename, "forwarding-failed"))
1423 const struct forward_spec * fwd = forward_url(csp->http, csp);
1426 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1427 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1431 * XXX: While the template is called forwarding-failed,
1432 * it currently only handles socks forwarding failures.
1434 assert(fwd->type != SOCKS_NONE);
1437 * Map failure reason, forwarding type and forwarder.
1439 if (NULL == csp->error_message)
1442 * Either we forgot to record the failure reason,
1443 * or the memory allocation failed.
1445 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1446 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1448 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1449 if (!err) err = map(exports, "forwarding-type", 1, (fwd->type == SOCKS_4) ?
1450 "socks4-" : "socks4a-", 1);
1451 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1453 if (!err) rsp->status = strdup("503 Forwarding failure");
1454 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1457 free_http_response(rsp);
1458 return cgi_error_memory();
1460 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1462 else if (!strcmp(templatename, "connect-failed"))
1464 rsp->status = strdup("503 Connect failed");
1465 if (rsp->status == NULL)
1468 free_http_response(rsp);
1469 return cgi_error_memory();
1471 rsp->reason = RSP_REASON_CONNECT_FAILED;
1474 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1477 free_http_response(rsp);
1478 return cgi_error_memory();
1481 return finish_http_response(csp, rsp);
1485 /*********************************************************************
1487 * Function : cgi_error_disabled
1489 * Description : CGI function that is called to generate an error
1490 * response if the actions editor or toggle CGI are
1491 * accessed despite having being disabled at compile-
1492 * or run-time, or if the user followed an untrusted link
1493 * to access a unsafe CGI feature that is only reachable
1494 * through Privoxy directly.
1497 * 1 : csp = Current client state (buffers, headers, etc...)
1498 * 2 : rsp = http_response data structure for output
1500 * CGI Parameters : none
1502 * Returns : JB_ERR_OK on success
1503 * JB_ERR_MEMORY on out-of-memory error.
1505 *********************************************************************/
1506 jb_err cgi_error_disabled(struct client_state *csp,
1507 struct http_response *rsp)
1509 struct map *exports;
1514 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1516 return JB_ERR_MEMORY;
1518 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1520 /* Not important enough to do anything */
1521 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1524 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1528 /*********************************************************************
1530 * Function : cgi_init_error_messages
1532 * Description : Call at the start of the program to initialize
1533 * the error message used by cgi_error_memory().
1539 *********************************************************************/
1540 void cgi_init_error_messages(void)
1542 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1543 cgi_error_memory_response->head =
1544 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1545 "Content-Type: text/html\r\n"
1547 cgi_error_memory_response->body =
1550 " <title>500 Internal Privoxy Error</title>\r\n"
1551 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1554 "<h1>500 Internal Privoxy Error</h1>\r\n"
1555 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1556 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1560 cgi_error_memory_response->head_length =
1561 strlen(cgi_error_memory_response->head);
1562 cgi_error_memory_response->content_length =
1563 strlen(cgi_error_memory_response->body);
1564 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1568 /*********************************************************************
1570 * Function : cgi_error_memory
1572 * Description : Called if a CGI function runs out of memory.
1573 * Returns a statically-allocated error response.
1577 * Returns : http_response data structure for output. This is
1578 * statically allocated, for obvious reasons.
1580 *********************************************************************/
1581 struct http_response *cgi_error_memory(void)
1583 /* assert that it's been initialized. */
1584 assert(cgi_error_memory_response->head);
1586 return cgi_error_memory_response;
1590 /*********************************************************************
1592 * Function : cgi_error_no_template
1594 * Description : Almost-CGI function that is called if a template
1595 * cannot be loaded. Note this is not a true CGI,
1596 * it takes a template name rather than a map of
1600 * 1 : csp = Current client state (buffers, headers, etc...)
1601 * 2 : rsp = http_response data structure for output
1602 * 3 : template_name = Name of template that could not
1605 * Returns : JB_ERR_OK on success
1606 * JB_ERR_MEMORY on out-of-memory error.
1608 *********************************************************************/
1609 jb_err cgi_error_no_template(struct client_state *csp,
1610 struct http_response *rsp,
1611 const char *template_name)
1613 static const char status[] =
1614 "500 Internal Privoxy Error";
1615 static const char body_prefix[] =
1618 " <title>500 Internal Privoxy Error</title>\r\n"
1619 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1622 "<h1>500 Internal Privoxy Error</h1>\r\n"
1623 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1624 "<p><b>Could not load template file <code>";
1625 static const char body_suffix[] =
1626 "</code> or one of it's included components.</b></p>\r\n"
1627 "<p>Please contact your proxy administrator.</p>\r\n"
1628 "<p>If you are the proxy administrator, please put the required file(s)"
1629 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1630 "location of the <code><i>(confdir)</i></code> directory "
1631 "is specified in the main Privoxy <code>config</code> "
1632 "file. (It's typically the Privoxy install directory"
1634 ", or <code>/etc/privoxy/</code>"
1635 #endif /* ndef _WIN32 */
1642 assert(template_name);
1644 /* Reset rsp, if needed */
1648 rsp->content_length = 0;
1649 rsp->head_length = 0;
1652 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1653 if (rsp->body == NULL)
1655 return JB_ERR_MEMORY;
1657 strcpy(rsp->body, body_prefix);
1658 strcat(rsp->body, template_name);
1659 strcat(rsp->body, body_suffix);
1661 rsp->status = strdup(status);
1662 if (rsp->status == NULL)
1664 return JB_ERR_MEMORY;
1671 /*********************************************************************
1673 * Function : cgi_error_unknown
1675 * Description : Almost-CGI function that is called if an unexpected
1676 * error occurs in the top-level CGI dispatcher.
1677 * In this context, "unexpected" means "anything other
1678 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1679 * expected to handle all other errors internally,
1680 * since they can give more relavent error messages
1683 * Note this is not a true CGI, it takes an error
1684 * code rather than a map of parameters.
1687 * 1 : csp = Current client state (buffers, headers, etc...)
1688 * 2 : rsp = http_response data structure for output
1689 * 3 : error_to_report = Error code to report.
1691 * Returns : JB_ERR_OK on success
1692 * JB_ERR_MEMORY on out-of-memory error.
1694 *********************************************************************/
1695 jb_err cgi_error_unknown(struct client_state *csp,
1696 struct http_response *rsp,
1697 jb_err error_to_report)
1699 static const char status[] =
1700 "500 Internal Privoxy Error";
1701 static const char body_prefix[] =
1704 " <title>500 Internal Privoxy Error</title>\r\n"
1705 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1708 "<h1>500 Internal Privoxy Error</h1>\r\n"
1709 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1710 "<p><b>Unexpected internal error: ";
1711 static const char body_suffix[] =
1714 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1715 "file a bug report</a>.</p>\r\n"
1722 /* Reset rsp, if needed */
1726 rsp->content_length = 0;
1727 rsp->head_length = 0;
1729 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1731 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1733 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1734 if (rsp->body == NULL)
1736 return JB_ERR_MEMORY;
1738 strcpy(rsp->body, body_prefix);
1739 strcat(rsp->body, errnumbuf);
1740 strcat(rsp->body, body_suffix);
1742 rsp->status = strdup(status);
1743 if (rsp->status == NULL)
1745 return JB_ERR_MEMORY;
1752 /*********************************************************************
1754 * Function : cgi_error_bad_param
1756 * Description : CGI function that is called if the parameters
1757 * (query string) for a CGI were wrong.
1760 * 1 : csp = Current client state (buffers, headers, etc...)
1761 * 2 : rsp = http_response data structure for output
1763 * CGI Parameters : none
1765 * Returns : JB_ERR_OK on success
1766 * JB_ERR_MEMORY on out-of-memory error.
1768 *********************************************************************/
1769 jb_err cgi_error_bad_param(struct client_state *csp,
1770 struct http_response *rsp)
1772 struct map *exports;
1777 if (NULL == (exports = default_exports(csp, NULL)))
1779 return JB_ERR_MEMORY;
1782 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1786 /*********************************************************************
1788 * Function : cgi_redirect
1790 * Description : CGI support function to generate a HTTP redirect
1794 * 1 : rsp = http_response data structure for output
1795 * 2 : target = string with the target URL
1797 * CGI Parameters : None
1799 * Returns : JB_ERR_OK on success
1800 * JB_ERR_MEMORY on out-of-memory error.
1802 *********************************************************************/
1803 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1810 err = enlist_unique_header(rsp->headers, "Location", target);
1812 rsp->status = strdup("302 Local Redirect from Privoxy");
1813 if (rsp->status == NULL)
1815 return JB_ERR_MEMORY;
1822 /*********************************************************************
1824 * Function : add_help_link
1826 * Description : Produce a copy of the string given as item,
1827 * embedded in an HTML link to its corresponding
1828 * section (item name in uppercase) in the actions
1829 * chapter of the user manual, (whose URL is given in
1830 * the config and defaults to our web site).
1832 * FIXME: I currently only work for actions, and would
1833 * like to be generalized for other topics.
1836 * 1 : item = item (will NOT be free()d.)
1837 * It is assumed to be HTML-safe.
1838 * 2 : config = The current configuration.
1840 * Returns : String with item embedded in link, or NULL on
1843 *********************************************************************/
1844 char *add_help_link(const char *item,
1845 struct configuration_spec *config)
1849 if (!item) return NULL;
1851 result = strdup("<a href=\"");
1852 if (!strncmpic(config->usermanual, "file://", 7) ||
1853 !strncmpic(config->usermanual, "http", 4))
1855 string_append(&result, config->usermanual);
1859 string_append(&result, "http://");
1860 string_append(&result, CGI_SITE_2_HOST);
1861 string_append(&result, "/user-manual/");
1863 string_append(&result, ACTIONS_HELP_PREFIX);
1864 string_join (&result, string_toupper(item));
1865 string_append(&result, "\">");
1866 string_append(&result, item);
1867 string_append(&result, "</a> ");
1873 /*********************************************************************
1875 * Function : get_http_time
1877 * Description : Get the time in a format suitable for use in a
1878 * HTTP header - e.g.:
1879 * "Sun, 06 Nov 1994 08:49:37 GMT"
1881 * XXX: Should probably get a third parameter for
1885 * 1 : time_offset = Time returned will be current time
1886 * plus this number of seconds.
1887 * 2 : buf = Destination for result. Must be long enough
1888 * to hold 29 characters plus a trailing zero.
1892 *********************************************************************/
1893 void get_http_time(int time_offset, char *buf)
1895 static const char day_names[7][4] =
1896 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1897 static const char month_names[12][4] =
1898 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1899 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1902 time_t current_time;
1903 #if defined(HAVE_GMTIME_R)
1905 * Declare dummy up here (instead of inside get/set gmt block) so it
1906 * doesn't go out of scope before it's potentially used in snprintf later.
1907 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1908 * !defined HAVE_GMTIME_R.
1915 time(¤t_time); /* get current time */
1917 current_time += time_offset;
1919 /* get and save the gmt */
1922 t = gmtime_r(¤t_time, &dummy);
1923 #elif FEATURE_PTHREAD
1924 pthread_mutex_lock(&gmtime_mutex);
1925 t = gmtime(¤t_time);
1926 pthread_mutex_unlock(&gmtime_mutex);
1928 t = gmtime(¤t_time);
1932 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1934 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1935 day_names[t->tm_wday],
1937 month_names[t->tm_mon],
1947 /*********************************************************************
1949 * Function : finish_http_response
1951 * Description : Fill in the missing headers in an http response,
1952 * and flatten the headers to an http head.
1953 * For HEAD requests the body is freed once
1954 * the Content-Length header is set.
1957 * 1 : rsp = pointer to http_response to be processed
1959 * Returns : A http_response, usually the rsp parameter.
1960 * On error, free()s rsp and returns cgi_error_memory()
1962 *********************************************************************/
1963 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
1965 char buf[BUFFER_SIZE];
1968 /* Special case - do NOT change this statically allocated response,
1969 * which is ready for output anyway.
1971 if (rsp == cgi_error_memory_response)
1977 * Fill in the HTTP Status
1979 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1980 err = enlist_first(rsp->headers, buf);
1983 * Set the Content-Length
1985 if (rsp->content_length == 0)
1987 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1991 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1992 err = enlist(rsp->headers, buf);
1995 if (0 == strcmpic(csp->http->gpc, "head"))
1998 * The client only asked for the head. Dispose
1999 * the body and log an offensive message.
2001 * While it may seem to be a bit inefficient to
2002 * prepare the body if it isn't needed, it's the
2003 * only way to get the Content-Length right for
2004 * dynamic pages. We could have disposed the body
2005 * earlier, but not without duplicating the
2006 * Content-Length setting code above.
2008 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2010 rsp->content_length = 0;
2013 if (strncmpic(rsp->status, "302", 3))
2016 * If it's not a redirect without any content,
2017 * set the Content-Type to text/html if it's
2018 * not already specified.
2020 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2024 * Fill in the rest of the default headers:
2026 * Date: set to current date/time.
2027 * Last-Modified: set to date/time the page was last changed.
2028 * Expires: set to date/time page next needs reloading.
2029 * Cache-Control: set to "no-cache" if applicable.
2031 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2036 * Set Expires to about 10 min into the future so it'll get reloaded
2037 * occasionally, e.g. if Privoxy gets upgraded.
2042 get_http_time(0, buf);
2043 err = enlist_unique_header(rsp->headers, "Date", buf);
2046 /* Some date in the past. */
2047 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2051 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2052 err = enlist_unique_header(rsp->headers, "Expires", buf);
2055 else if (!strncmpic(rsp->status, "302", 3))
2057 get_http_time(0, buf);
2058 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2063 * Setting "Cache-Control" to "no-cache" and "Expires" to
2064 * the current time doesn't exactly forbid caching, it just
2065 * requires the client to revalidate the cached copy.
2067 * If a temporary problem occurs and the user tries again after
2068 * getting Privoxy's error message, a compliant browser may set the
2069 * If-Modified-Since header with the content of the error page's
2070 * Last-Modified header. More often than not, the document on the server
2071 * is older than Privoxy's error message, the server would send status code
2072 * 304 and the browser would display the outdated error message again and again.
2074 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2075 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2076 * and can be safely used to "revalidate" without getting a status code 304.
2078 * There is no need to let the useless If-Modified-Since header reach the
2079 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2081 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2083 get_http_time(0, buf);
2084 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2085 if (!strncmpic(rsp->status, "403", 3)
2086 || !strncmpic(rsp->status, "404", 3)
2087 || !strncmpic(rsp->status, "503", 3))
2089 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2093 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2095 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2096 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2102 * HTTP/1.1 applications that do not support persistent connections MUST
2103 * include the "close" connection option in every message.
2105 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2110 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2112 free_http_response(rsp);
2113 return cgi_error_memory();
2115 rsp->head_length = strlen(rsp->head);
2122 /*********************************************************************
2124 * Function : alloc_http_response
2126 * Description : Allocates a new http_response structure.
2130 * Returns : pointer to a new http_response, or NULL.
2132 *********************************************************************/
2133 struct http_response *alloc_http_response(void)
2135 return (struct http_response *) zalloc(sizeof(struct http_response));
2140 /*********************************************************************
2142 * Function : free_http_response
2144 * Description : Free the memory occupied by an http_response
2145 * and its depandant structures.
2148 * 1 : rsp = pointer to http_response to be freed
2152 *********************************************************************/
2153 void free_http_response(struct http_response *rsp)
2156 * Must special case cgi_error_memory_response, which is never freed.
2158 if (rsp && (rsp != cgi_error_memory_response))
2163 destroy_list(rsp->headers);
2170 /*********************************************************************
2172 * Function : template_load
2174 * Description : CGI support function that loads a given HTML
2175 * template, ignoring comment lines and following
2176 * #include statements up to a depth of 1.
2179 * 1 : csp = Current client state (buffers, headers, etc...)
2180 * 2 : template_ptr = Destination for pointer to loaded
2182 * 3 : templatename = name of the HTML template to be used
2183 * 4 : recursive = Flag set if this function calls itself
2184 * following an #include statament
2186 * Returns : JB_ERR_OK on success
2187 * JB_ERR_MEMORY on out-of-memory error.
2188 * JB_ERR_FILE if the template file cannot be read
2190 *********************************************************************/
2191 jb_err template_load(struct client_state *csp, char **template_ptr,
2192 const char *templatename, int recursive)
2195 char *templates_dir_path;
2198 char *included_module;
2201 char buf[BUFFER_SIZE];
2204 assert(template_ptr);
2205 assert(templatename);
2207 *template_ptr = NULL;
2209 /* Validate template name. Paranoia. */
2210 for (p = templatename; *p != 0; p++)
2212 if ( ((*p < 'a') || (*p > 'z'))
2213 && ((*p < 'A') || (*p > 'Z'))
2214 && ((*p < '0') || (*p > '9'))
2218 /* Illegal character */
2224 * Generate full path using either templdir
2225 * or confdir/templates as base directory.
2227 if (NULL != csp->config->templdir)
2229 templates_dir_path = strdup(csp->config->templdir);
2233 templates_dir_path = make_path(csp->config->confdir, "templates");
2236 if (templates_dir_path == NULL)
2238 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2240 return JB_ERR_MEMORY;
2243 full_path = make_path(templates_dir_path, templatename);
2244 free(templates_dir_path);
2245 if (full_path == NULL)
2247 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2249 return JB_ERR_MEMORY;
2252 /* Allocate buffer */
2254 file_buffer = strdup("");
2255 if (file_buffer == NULL)
2257 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2259 return JB_ERR_MEMORY;
2262 /* Open template file */
2264 if (NULL == (fp = fopen(full_path, "r")))
2266 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2274 * Read the file, ignoring comments, and honoring #include
2275 * statements, unless we're already called recursively.
2277 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2278 * This is unlikely in practise.
2280 while (fgets(buf, BUFFER_SIZE, fp))
2282 if (!recursive && !strncmp(buf, "#include ", 9))
2284 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2291 if (string_join(&file_buffer, included_module))
2294 return JB_ERR_MEMORY;
2300 /* skip lines starting with '#' */
2306 if (string_append(&file_buffer, buf))
2309 return JB_ERR_MEMORY;
2314 *template_ptr = file_buffer;
2320 /*********************************************************************
2322 * Function : template_fill
2324 * Description : CGI support function that fills in a pre-loaded
2325 * HTML template by replacing @name@ with value using
2326 * pcrs, for each item in the output map.
2328 * Note that a leading '$' charachter in the export map's
2329 * values will be stripped and toggle on backreference
2333 * 1 : template_ptr = IN: Template to be filled out.
2335 * OUT: Filled out template.
2336 * Caller must free().
2337 * 2 : exports = map with fill in symbol -> name pairs
2339 * Returns : JB_ERR_OK on success (and for uncritical errors)
2340 * JB_ERR_MEMORY on out-of-memory error
2342 *********************************************************************/
2343 jb_err template_fill(char **template_ptr, const struct map *exports)
2345 struct map_entry *m;
2347 char buf[BUFFER_SIZE];
2348 char *tmp_out_buffer;
2354 assert(template_ptr);
2355 assert(*template_ptr);
2358 file_buffer = *template_ptr;
2359 size = strlen(file_buffer) + 1;
2362 * Assemble pcrs joblist from exports map
2364 for (m = exports->first; m != NULL; m = m->next)
2366 if (*m->name == '$')
2369 * First character of name is '$', so remove this flag
2370 * character and allow backreferences ($1 etc) in the
2371 * "replace with" text.
2373 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2379 * Treat the "replace with" text as a literal string -
2380 * no quoting needed, no backreferences allowed.
2381 * ("Trivial" ['T'] flag).
2385 /* Enclose name in @@ */
2386 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2390 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2392 /* Make and run job. */
2393 job = pcrs_compile(buf, m->value, flags, &error);
2396 if (error == PCRS_ERR_NOMEM)
2399 *template_ptr = NULL;
2400 return JB_ERR_MEMORY;
2404 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2405 /* Hope it wasn't important and silently ignore the invalid job */
2410 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2413 if (NULL == tmp_out_buffer)
2415 *template_ptr = NULL;
2416 return JB_ERR_MEMORY;
2422 * Substitution failed, keep the original buffer,
2423 * log the problem and ignore it.
2425 * The user might see some unresolved @CGI_VARIABLES@,
2426 * but returning a special CGI error page seems unreasonable
2427 * and could mask more important error messages.
2429 free(tmp_out_buffer);
2430 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2431 buf, m->value, flags, pcrs_strerror(error));
2435 /* Substitution succeeded, use modified buffer. */
2437 file_buffer = tmp_out_buffer;
2445 *template_ptr = file_buffer;
2450 /*********************************************************************
2452 * Function : template_fill_for_cgi
2454 * Description : CGI support function that loads a HTML template
2455 * and fills it in. Handles file-not-found errors
2456 * by sending a HTML error message. For convenience,
2457 * this function also frees the passed "exports" map.
2460 * 1 : csp = Client state
2461 * 2 : templatename = name of the HTML template to be used
2462 * 3 : exports = map with fill in symbol -> name pairs.
2463 * Will be freed by this function.
2464 * 4 : rsp = Response structure to fill in.
2466 * Returns : JB_ERR_OK on success
2467 * JB_ERR_MEMORY on out-of-memory error
2469 *********************************************************************/
2470 jb_err template_fill_for_cgi(struct client_state *csp,
2471 const char *templatename,
2472 struct map *exports,
2473 struct http_response *rsp)
2478 assert(templatename);
2482 err = template_load(csp, &rsp->body, templatename, 0);
2483 if (err == JB_ERR_FILE)
2486 return cgi_error_no_template(csp, rsp, templatename);
2491 return err; /* JB_ERR_MEMORY */
2493 err = template_fill(&rsp->body, exports);
2499 /*********************************************************************
2501 * Function : default_exports
2503 * Description : returns a struct map list that contains exports
2504 * which are common to all CGI functions.
2507 * 1 : csp = Current client state (buffers, headers, etc...)
2508 * 2 : caller = name of CGI who calls us and which should
2509 * be excluded from the generated menu. May be
2511 * Returns : NULL if no memory, else a new map. Caller frees.
2513 *********************************************************************/
2514 struct map *default_exports(const struct client_state *csp, const char *caller)
2518 struct map * exports;
2519 int local_help_exists = 0;
2523 exports = new_map();
2524 if (exports == NULL)
2529 err = map(exports, "version", 1, html_encode(VERSION), 0);
2530 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2531 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2532 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2533 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2534 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2535 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2536 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2537 !strncmpic(csp->config->usermanual, "http", 4))
2539 /* Manual is located somewhere else, just link to it. */
2540 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2544 /* Manual is delivered by Privoxy. */
2545 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2547 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2548 #ifdef FEATURE_TOGGLE
2549 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2551 if (!err) err = map_block_killer(exports, "can-toggle");
2554 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2555 if (!err) err = map(exports, "my-port", 1, buf, 1);
2557 if(!strcmp(CODE_STATUS, "stable"))
2559 if (!err) err = map_block_killer(exports, "unstable");
2562 if (csp->config->admin_address != NULL)
2564 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2565 local_help_exists = 1;
2569 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2572 if (csp->config->proxy_info_url != NULL)
2574 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2575 local_help_exists = 1;
2579 if (!err) err = map_block_killer(exports, "have-proxy-info");
2582 if (local_help_exists == 0)
2584 if (!err) err = map_block_killer(exports, "have-help-info");
2597 /*********************************************************************
2599 * Function : map_block_killer
2601 * Description : Convenience function.
2602 * Adds a "killer" for the conditional HTML-template
2603 * block <name>, i.e. a substitution of the regex
2604 * "if-<name>-start.*if-<name>-end" to the given
2608 * 1 : exports = map to extend
2609 * 2 : name = name of conditional block
2611 * Returns : JB_ERR_OK on success
2612 * JB_ERR_MEMORY on out-of-memory error.
2614 *********************************************************************/
2615 jb_err map_block_killer(struct map *exports, const char *name)
2617 char buf[1000]; /* Will do, since the names are hardwired */
2621 assert(strlen(name) < 490);
2623 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2624 return map(exports, buf, 1, "", 1);
2628 /*********************************************************************
2630 * Function : map_block_keep
2632 * Description : Convenience function. Removes the markers used
2633 * by map-block-killer, to save a few bytes.
2634 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2637 * 1 : exports = map to extend
2638 * 2 : name = name of conditional block
2640 * Returns : JB_ERR_OK on success
2641 * JB_ERR_MEMORY on out-of-memory error.
2643 *********************************************************************/
2644 jb_err map_block_keep(struct map *exports, const char *name)
2647 char buf[500]; /* Will do, since the names are hardwired */
2651 assert(strlen(name) < 490);
2653 snprintf(buf, sizeof(buf), "if-%s-start", name);
2654 err = map(exports, buf, 1, "", 1);
2661 snprintf(buf, sizeof(buf), "if-%s-end", name);
2662 return map(exports, buf, 1, "", 1);
2666 /*********************************************************************
2668 * Function : map_conditional
2670 * Description : Convenience function.
2671 * Adds an "if-then-else" for the conditional HTML-template
2672 * block <name>, i.e. a substitution of the form:
2679 * The control structure and one of the alternatives
2683 * 1 : exports = map to extend
2684 * 2 : name = name of conditional block
2685 * 3 : choose_first = nonzero for first, zero for second.
2687 * Returns : JB_ERR_OK on success
2688 * JB_ERR_MEMORY on out-of-memory error.
2690 *********************************************************************/
2691 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2693 char buf[1000]; /* Will do, since the names are hardwired */
2698 assert(strlen(name) < 480);
2700 snprintf(buf, sizeof(buf), (choose_first
2701 ? "else-not-%s@.*@endif-%s"
2702 : "if-%s-then@.*@else-not-%s"),
2705 err = map(exports, buf, 1, "", 1);
2711 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2712 return map(exports, buf, 1, "", 1);
2716 /*********************************************************************
2718 * Function : make_menu
2720 * Description : Returns an HTML-formatted menu of the available
2721 * unhidden CGIs, excluding the one given in <self>
2722 * and the toggle CGI if toggling is disabled.
2725 * 1 : self = name of CGI to leave out, can be NULL for
2727 * 2 : feature_flags = feature bitmap from csp->config
2730 * Returns : menu string, or NULL on out-of-memory error.
2732 *********************************************************************/
2733 char *make_menu(const char *self, const unsigned feature_flags)
2735 const struct cgi_dispatcher *d;
2736 char *result = strdup("");
2740 self = "NO-SUCH-CGI!";
2743 /* List available unhidden CGI's and export as "other-cgis" */
2744 for (d = cgi_dispatchers; d->name; d++)
2747 #ifdef FEATURE_TOGGLE
2748 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2751 * Suppress the toggle link if remote toggling is disabled.
2755 #endif /* def FEATURE_TOGGLE */
2757 if (d->description && strcmp(d->name, self))
2759 char *html_encoded_prefix;
2762 * Line breaks would be great, but break
2763 * the "blocked" template's JavaScript.
2765 string_append(&result, "<li><a href=\"");
2766 html_encoded_prefix = html_encode(CGI_PREFIX);
2767 if (html_encoded_prefix == NULL)
2773 string_append(&result, html_encoded_prefix);
2774 free(html_encoded_prefix);
2776 string_append(&result, d->name);
2777 string_append(&result, "\">");
2778 string_append(&result, d->description);
2779 string_append(&result, "</a></li>");
2787 /*********************************************************************
2789 * Function : dump_map
2791 * Description : HTML-dump a map for debugging (as table)
2794 * 1 : the_map = map to dump
2796 * Returns : string with HTML
2798 *********************************************************************/
2799 char *dump_map(const struct map *the_map)
2801 struct map_entry *cur_entry;
2802 char *ret = strdup("");
2804 string_append(&ret, "<table>\n");
2806 for (cur_entry = the_map->first;
2807 (cur_entry != NULL) && (ret != NULL);
2808 cur_entry = cur_entry->next)
2810 string_append(&ret, "<tr><td><b>");
2811 string_join (&ret, html_encode(cur_entry->name));
2812 string_append(&ret, "</b></td><td>");
2813 string_join (&ret, html_encode(cur_entry->value));
2814 string_append(&ret, "</td></tr>\n");
2817 string_append(&ret, "</table>\n");