1 const char cgi_rcs[] = "$Id: cgi.c,v 1.89 2007/01/23 15:51:16 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.89 2007/01/23 15:51:16 fabiankeil
42 * Add favicon delivery functions.
44 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
45 * - Map variables that aren't guaranteed to be
46 * pure ASCII html_encoded.
47 * - Use CGI_PREFIX to generate URL for user manual
48 * CGI page to make sure CGI_SITE_2_PATH is included.
50 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
51 * - "Protect" against a rather lame JavaScript-based
52 * Privoxy detection "attack" and check the referrer
53 * before delivering the CGI style sheet.
54 * - Move referrer check for unsafe CGI pages into
55 * referrer_is_safe() and log the result.
56 * - Map @url@ in cgi-error-disabled page.
57 * It's required for the "go there anyway" link.
58 * - Mark *csp as immutable for grep_cgi_referrer().
60 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
61 * Fix strdup() error handling in cgi_error_unknown()
62 * and cgi_error_no_template(). Reported by Markus Elfring.
64 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
65 * Handle pcrs_execute() errors in template_fill() properly.
67 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
68 * Fixed gcc43 conversion warnings and replaced sprintf
69 * calls with snprintf to give OpenBSD's gcc one less reason
72 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
73 * Escape ampersand in Privoxy menu.
75 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
76 * Suppress the toggle link if remote toggling is disabled.
78 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
79 * Fix configure option --disable-toggle.
80 * Thanks to Peter Thoenen for reporting this.
82 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
83 * Don't lose the FORCE_PREFIX in case of
84 * connection problems. Fixes #612235.
86 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
87 * Make pthread mutex locking more generic. Instead of
88 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
89 * and use mutex locking unless there is an _r function
90 * available. Better safe than sorry.
92 * Fixes "./configure --disable-pthread" and should result
93 * in less threading-related problems on pthread-using platforms,
94 * but it still doesn't fix BR#1122404.
96 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
97 * Use CGI_PREFIX to check the referrer.
98 * The check for "http://config.privoxy.org/" fails
99 * if the user modified CGI_SITE_2_HOST.
101 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
102 * Adjusted headers for Privoxy's cgi responses:
103 * Don't set Last-Modified, Expires and Cache-Control
104 * headers for redirects; always set "Connection: close".
106 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
107 * Only predate the Last-Modified header for cgi responses
108 * that are delivered with status code 404 or 503.
110 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
111 * Mark cgi_send_user_manual as harmless,
112 * to fix the access denied problem Hal spotted.
113 * The manual has no secret content, therefore we
114 * don't have to care about "secure" referrers.
116 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
117 * Incorporate modified version of Roland Rosenfeld's patch to
118 * optionally access the user-manual via Privoxy. Closes patch 679075.
120 * Formatting changed to Privoxy style, added call to
121 * cgi_error_no_template if the requested file doesn't
122 * exist and modified check whether or not Privoxy itself
123 * should serve the manual. Should work cross-platform now.
125 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
126 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
128 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
129 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
130 * with what was really the latest development (the v_3_0_branch branch)
132 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
133 * Moved cgi_error_disabled() from cgiedit.c to
134 * cgi.c to re-enable build with --disable-editor.
135 * Fixes Bug #892744. Thanks to Matthew Fischer
138 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
139 * - Added new function cgi_redirect to handle creation of
140 * HTTP redirect messages formerly repeated in the code.
141 * - Send cgi_error_disabled instead of cgi_error_404 when
142 * referrer check fails
143 * - Dynamic content now gets Expires header field with date
146 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
147 * Bugfix: Transparent PNG was not transparent. Thanks to
148 * Dan Razzell of Starfish Systems for notice and new PNG.
150 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
151 * Security fix: dspatch_known_cgi no longer considers an empty
152 * referrer safe for critical CGIs, since malicious links could
153 * reside on https:// locations which browsers don't advertize as
154 * referrers. Closes bug #749916, thanks to Jeff Epler for the
155 * hint. Goodbye One-Click[tm] toggling :-(
157 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
160 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
161 * Killed a compiler warning on OSX
163 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
164 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
165 * (fixes bug #710056)
166 * - Show toggle info only if we have it
168 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
169 * Move declaration of struct tm dummy outside of a control block so it is
170 * accessible later on during snprintf in get_http_time.
172 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
173 * Cosmetic: Renamed cryptic variable
175 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
176 * 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.
178 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
179 * Disable access to critical CGIs via untrusted referrers.
180 * This prevents users from being tricked by malicious websites
181 * into making unintentional configuration changes:
183 * - Added flag to each cgi_dispatcher that allows or denies
185 * - Introduced proviorical function that greps for the
186 * referrer header before regular header parsing happens
187 * - Added safety check to dispatch_known_cgi. CGI is called
188 * if (cgi harmless || no referrer || we are referrer).
189 * Else a) toggle calls are modified not to change status and
190 * b) all other calls are denied.
192 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
193 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
195 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
196 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
198 * Revision 1.70 2002/05/19 11:33:20 jongfoster
199 * If a CGI error was not handled, and propogated back to
200 * dispatch_known_cgi(), then it was assumed to be "out of memory".
201 * This gave a very misleading error message.
203 * Now other errors will cause a simple message giving the error
204 * number and asking the user to report a bug.
207 * http://sourceforge.net/tracker/index.php?func=detail
208 * &aid=557905&group_id=11118&atid=111118
210 * Revision 1.69 2002/05/14 21:28:40 oes
211 * - Fixed add_help_link to link to the (now split) actions
212 * part of the config chapter
213 * - Renamed helplink export to actions-help-prefix
215 * Revision 1.68 2002/05/12 21:36:29 jongfoster
216 * Correcting function comments
218 * Revision 1.67 2002/04/30 12:02:07 oes
219 * Nit: updated a comment
221 * Revision 1.66 2002/04/26 18:32:57 jongfoster
222 * Fixing a memory leak on error
224 * Revision 1.65 2002/04/26 12:53:51 oes
225 * - New function add_help_link
226 * - default_exports now exports links to the user manual
227 * and a prefix for links into the config chapter
229 * Revision 1.64 2002/04/24 02:17:21 oes
230 * - Better descriptions for CGIs
231 * - Hide edit-actions, more shortcuts
232 * - Moved get_char_param, get_string_param and get_number_param here
235 * Revision 1.63 2002/04/15 19:06:43 jongfoster
238 * Revision 1.62 2002/04/10 19:59:46 jongfoster
239 * Fixes to #include in templates:
240 * - Didn't close main file if loading an included template fails.
241 * - I'm paranoid and want to disallow "#include /etc/passwd".
243 * Revision 1.61 2002/04/10 13:37:48 oes
244 * Made templates modular: template_load now recursive with max depth 1
246 * Revision 1.60 2002/04/08 20:50:25 swa
249 * Revision 1.59 2002/04/05 15:51:51 oes
250 * - added send-stylesheet CGI
251 * - bugfix: error-pages now get correct request protocol
253 * - kludged CGI descriptions and menu not to break JS syntax
255 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
256 * Fix Mac OSX compiler warnings
258 * Revision 1.57 2002/03/26 22:29:54 swa
259 * we have a new homepage!
261 * Revision 1.56 2002/03/24 17:50:46 jongfoster
262 * Fixing compile error if actions file editor disabled
264 * Revision 1.55 2002/03/24 16:55:06 oes
265 * Making GIF checkerboard transparent
267 * Revision 1.54 2002/03/24 16:18:15 jongfoster
270 * Revision 1.53 2002/03/24 16:06:00 oes
271 * Correct transparency for checkerboard PNG. Thanks, Magnus!
273 * Revision 1.52 2002/03/24 15:23:33 jongfoster
276 * Revision 1.51 2002/03/24 13:25:43 swa
277 * name change related issues
279 * Revision 1.50 2002/03/16 23:54:06 jongfoster
280 * Adding graceful termination feature, to help look for memory leaks.
281 * If you enable this (which, by design, has to be done by hand
282 * editing config.h) and then go to http://i.j.b/die, then the program
283 * will exit cleanly after the *next* request. It should free all the
284 * memory that was used.
286 * Revision 1.49 2002/03/13 00:27:04 jongfoster
289 * Revision 1.48 2002/03/08 17:47:07 jongfoster
292 * Revision 1.47 2002/03/08 16:41:33 oes
293 * Added GIF images again
295 * Revision 1.46 2002/03/07 03:48:38 oes
296 * - Changed built-in images from GIF to PNG
297 * (with regard to Unisys patent issue)
298 * - Added a 4x4 pattern PNG which is less intrusive
299 * than the logo but also clearly marks the deleted banners
301 * Revision 1.45 2002/03/06 22:54:35 jongfoster
302 * Automated function-comment nitpicking.
304 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
305 * - Better error reporting on OS/2
306 * - Fix double-slash comment (oops)
308 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
309 * - Re-enable OS/2 building after new parms were added
310 * - Fix false out of memory report when resolving CGI templates when no IP
311 * address is available of failed attempt (a la no such domain)
313 * Revision 1.42 2002/01/21 00:33:20 jongfoster
314 * Replacing strsav() with the safer string_append() or string_join().
315 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
316 * Adding missing html_encode() to error message generators.
317 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
319 * Revision 1.41 2002/01/17 20:56:22 jongfoster
320 * Replacing hard references to the URL of the config interface
321 * with #defines from project.h
323 * Revision 1.40 2002/01/09 14:26:46 oes
324 * Added support for thread-safe gmtime_r call.
326 * Revision 1.39 2001/11/16 00:48:13 jongfoster
327 * Fixing a compiler warning
329 * Revision 1.38 2001/11/13 00:31:21 jongfoster
330 * - Adding new CGIs for use by non-JavaScript browsers:
331 * edit-actions-url-form
332 * edit-actions-add-url-form
333 * edit-actions-remove-url-form
334 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
337 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
338 * Show enablement/disablement status in almost all templates.
339 * There is a little trickiness here: apparent recursive resolution of
340 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
341 * the actual enablement status. So a similar construct,
342 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
345 * Revision 1.36 2001/10/26 17:33:27 oes
348 * Revision 1.35 2001/10/23 21:48:19 jongfoster
349 * Cleaning up error handling in CGI functions - they now send back
350 * a HTML error page and should never cause a FATAL error. (Fixes one
351 * potential source of "denial of service" attacks).
353 * CGI actions file editor that works and is actually useful.
355 * Ability to toggle Junkbuster remotely using a CGI call.
357 * You can turn off both the above features in the main configuration
358 * file, e.g. if you are running a multi-user proxy.
360 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
361 * Only show "Local support" on templates conditionally:
362 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
363 * - if not, no Local support section appears
365 * Revision 1.33 2001/10/14 22:28:41 jongfoster
366 * Fixing stupid typo.
368 * Revision 1.32 2001/10/14 22:20:18 jongfoster
369 * - Changes to CGI dispatching method to match CGI names exactly,
370 * rather than doing a prefix match.
371 * - No longer need to count the length of the CGI handler names by hand.
372 * - Adding new handler for 404 error when disptching a CGI, if none of
373 * the handlers match.
374 * - Adding new handlers for CGI actionsfile editor.
376 * Revision 1.31 2001/10/10 10:56:39 oes
377 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
379 * Revision 1.30 2001/10/02 15:30:57 oes
380 * Introduced show-request cgi
382 * Revision 1.29 2001/09/20 15:47:44 steudten
384 * Fix BUG: Modify int size to size_t size in fill_template()
385 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
387 * Revision 1.28 2001/09/19 18:00:37 oes
388 * - Deletef time() FIXME (Can't fail under Linux either, if
389 * the argument is guaranteed to be in out address space,
392 * - Pointer notation cosmetics
393 * - Fixed a minor bug in template_fill(): Failiure of
394 * pcrs_execute() now secure.
396 * Revision 1.27 2001/09/16 17:08:54 jongfoster
397 * Moving simple CGI functions from cgi.c to new file cgisimple.c
399 * Revision 1.26 2001/09/16 15:47:37 jongfoster
400 * First version of CGI-based edit interface. This is very much a
401 * work-in-progress, and you can't actually use it to edit anything
402 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
403 * to have any effect.
405 * Revision 1.25 2001/09/16 15:02:35 jongfoster
406 * Adding i.j.b/robots.txt.
407 * Inlining add_stats() since it's only ever called from one place.
409 * Revision 1.24 2001/09/16 11:38:01 jongfoster
410 * Splitting fill_template() into 2 functions:
411 * template_load() loads the file
412 * template_fill() performs the PCRS regexps.
413 * This is because the CGI edit interface has a "table row"
414 * template which is used many times in the page - this
415 * change means it's only loaded from disk once.
417 * Revision 1.23 2001/09/16 11:16:05 jongfoster
418 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
420 * Revision 1.22 2001/09/16 11:00:10 jongfoster
421 * New function alloc_http_response, for symmetry with free_http_response
423 * Revision 1.21 2001/09/13 23:53:03 jongfoster
424 * Support for both static and dynamically generated CGI pages.
425 * Correctly setting Last-Modified: and Expires: HTTP headers.
427 * Revision 1.20 2001/09/13 23:40:36 jongfoster
428 * (Cosmetic only) Indentation correction
430 * Revision 1.19 2001/09/13 23:31:25 jongfoster
431 * Moving image data to cgi.c rather than cgi.h.
433 * Revision 1.18 2001/08/05 16:06:20 jongfoster
434 * Modifiying "struct map" so that there are now separate header and
435 * "map_entry" structures. This means that functions which modify a
436 * map no longer need to return a pointer to the modified map.
437 * Also, it no longer reverses the order of the entries (which may be
438 * important with some advanced template substitutions).
440 * Revision 1.17 2001/08/05 15:57:38 oes
441 * Adapted finish_http_response to new list_to_text
443 * Revision 1.16 2001/08/01 21:33:18 jongfoster
444 * Changes to fill_template() that reduce memory usage without having
445 * an impact on performance. I also renamed some variables so as not
446 * to clash with the C++ keywords "new" and "template".
448 * Revision 1.15 2001/08/01 21:19:22 jongfoster
449 * Moving file version information to a separate CGI page.
451 * Revision 1.14 2001/08/01 00:19:03 jongfoster
452 * New function: map_conditional() for an if-then-else syntax.
453 * Changing to use new version of show_defines()
455 * Revision 1.13 2001/07/30 22:08:36 jongfoster
456 * Tidying up #defines:
457 * - All feature #defines are now of the form FEATURE_xxx
458 * - Permanently turned off WIN_GUI_EDIT
459 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
461 * Revision 1.12 2001/07/29 18:47:05 jongfoster
462 * Adding missing #include "loadcfg.h"
464 * Revision 1.11 2001/07/18 17:24:37 oes
465 * Changed to conform to new pcrs interface
467 * Revision 1.10 2001/07/13 13:53:13 oes
468 * Removed all #ifdef PCRS and related code
470 * Revision 1.9 2001/06/29 21:45:41 oes
471 * Indentation, CRLF->LF, Tab-> Space
473 * Revision 1.8 2001/06/29 13:21:46 oes
474 * - Cosmetics: renamed and reordered functions, variables,
475 * texts, improved comments etc
477 * - Removed ij_untrusted_url() The relevant
478 * info is now part of the "untrusted" page,
479 * which is generated by filters.c:trust_url()
481 * - Generators of content now call finish_http_response()
482 * themselves, making jcc.c:chat() a little less
485 * - Removed obsolete "Pragma: no-cache" from our headers
487 * - http_responses now know their head length
489 * - fill_template now uses the new interface to pcrs, so that
490 * - long jobs (like whole files) no longer have to be assembled
491 * in a fixed size buffer
492 * - the new T (trivial) option is used, and the replacement may
493 * contain Perl syntax backrefs without confusing pcrs
495 * - Introduced default_exports() which generates a set of exports
496 * common to all CGIs and other content generators
498 * - Introduced convenience function map_block_killer()
500 * - Introduced convenience function make_menu()
502 * - Introduced CGI-like function error_response() which generates
503 * the "No such domain" and "Connect failed" messages using the
506 * - cgi_show_url_info:
507 * - adapted to new CGI features
508 * - form and answers now generated from same template
509 * - http:// prefix in URL now OK
512 * - adapted to new CGI features
513 * - no longer uses csp->init_proxy_args
516 * - moved menu generation to make_menu()
518 * - add_stats now writes single export map entries instead
521 * - Moved redirect_url() to filters.c
523 * - Fixed mem leak in free_http_response(), map_block_killer(),
525 * - Removed logentry from cancelled commit
527 * Revision 1.7 2001/06/09 10:51:58 jongfoster
528 * Changing "show URL info" handler to new style.
529 * Changing BUFSIZ ==> BUFFER_SIZE
531 * Revision 1.6 2001/06/07 23:05:19 jongfoster
532 * Removing code related to old forward and ACL files.
534 * Revision 1.5 2001/06/05 19:59:16 jongfoster
535 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
537 * Revision 1.4 2001/06/04 10:41:52 swa
538 * show version string of cgi.h and cgi.c
540 * Revision 1.3 2001/06/03 19:12:16 oes
541 * introduced new cgi handling
543 * No revisions before 1.3
545 **********************************************************************/
551 #include <sys/types.h>
559 #define snprintf _snprintf
560 #endif /* def _WIN32 */
569 #include "miscutil.h"
570 #include "cgisimple.h"
571 #ifdef FEATURE_CGI_EDIT_ACTIONS
573 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
575 /* loadcfg.h is for global_toggle_state only */
576 #ifdef FEATURE_PTHREAD
578 /* jcc.h is for mutex semaphore globals only */
579 #endif /* def FEATURE_PTHREAD */
580 const char cgi_h_rcs[] = CGI_H_VERSION;
583 * List of CGI functions: name, handler, description
584 * Note: Do NOT use single quotes in the description;
585 * this will break the dynamic "blocked" template!
587 static const struct cgi_dispatcher cgi_dispatchers[] = {
592 #ifdef FEATURE_GRACEFUL_TERMINATION
595 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
596 "this is a one click Denial Of Service attack!!!</em>",
601 #ifdef FEATURE_CGI_EDIT_ACTIONS
602 "View & change the current configuration",
604 "View the current configuration",
609 "View the source code version numbers",
613 "View the request headers.",
617 "Look up which actions apply to a URL and why",
619 #ifdef FEATURE_CGI_EDIT_ACTIONS
620 #ifdef FEATURE_TOGGLE
623 "Toggle Privoxy on or off",
625 #endif /* def FEATURE_TOGGLE */
626 { "edit-actions", /* Edit the actions list */
629 { "eaa", /* Shortcut for edit-actions-add-url-form */
630 cgi_edit_actions_add_url_form,
632 { "eau", /* Shortcut for edit-actions-url-form */
633 cgi_edit_actions_url_form,
635 { "ear", /* Shortcut for edit-actions-remove-url-form */
636 cgi_edit_actions_remove_url_form,
638 { "eal", /* Shortcut for edit-actions-list */
639 cgi_edit_actions_list,
641 { "eafu", /* Shortcut for edit-actions-for-url */
642 cgi_edit_actions_for_url,
644 { "eas", /* Shortcut for edit-actions-submit */
645 cgi_edit_actions_submit,
647 { "easa", /* Shortcut for edit-actions-section-add */
648 cgi_edit_actions_section_add,
650 { "easr", /* Shortcut for edit-actions-section-remove */
651 cgi_edit_actions_section_remove,
653 { "eass", /* Shortcut for edit-actions-section-swap */
654 cgi_edit_actions_section_swap,
656 { "edit-actions-for-url",
657 cgi_edit_actions_for_url,
658 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
659 { "edit-actions-list",
660 cgi_edit_actions_list,
661 NULL, TRUE /* Edit the actions list */ },
662 { "edit-actions-submit",
663 cgi_edit_actions_submit,
664 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
665 { "edit-actions-url",
666 cgi_edit_actions_url,
667 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
668 { "edit-actions-url-form",
669 cgi_edit_actions_url_form,
670 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
671 { "edit-actions-add-url",
672 cgi_edit_actions_add_url,
673 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
674 { "edit-actions-add-url-form",
675 cgi_edit_actions_add_url_form,
676 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
677 { "edit-actions-remove-url",
678 cgi_edit_actions_remove_url,
679 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
680 { "edit-actions-remove-url-form",
681 cgi_edit_actions_remove_url_form,
682 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
683 { "edit-actions-section-add",
684 cgi_edit_actions_section_add,
685 NULL, FALSE /* Remove a section from the actionsfile */ },
686 { "edit-actions-section-remove",
687 cgi_edit_actions_section_remove,
688 NULL, FALSE /* Remove a section from the actionsfile */ },
689 { "edit-actions-section-swap",
690 cgi_edit_actions_section_swap,
691 NULL, FALSE /* Swap two sections in the actionsfile */ },
692 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
693 { "error-favicon.ico",
694 cgi_send_error_favicon,
695 NULL, TRUE /* Sends the favicon image for error pages. */ },
697 cgi_send_default_favicon,
698 NULL, TRUE /* Sends the default favicon image. */ },
701 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
704 NULL, TRUE /* Send a built-in image */ },
707 NULL, FALSE /* Send templates/cgi-style.css */ },
709 cgi_transparent_image,
710 NULL, TRUE /* Send a transparent image (short name) */ },
712 cgi_send_user_manual,
713 NULL, TRUE /* Send user-manual */ },
714 { NULL, /* NULL Indicates end of list and default page */
716 NULL, TRUE /* Unknown CGI page */ }
721 * Built-in images for ad replacement
723 * Hint: You can encode your own images like this:
724 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
727 #ifdef FEATURE_NO_GIFS
730 * Checkerboard pattern, as a PNG.
732 const char image_pattern_data[] =
733 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
734 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
735 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
736 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
737 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
738 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
739 "\000\000\000\111\105\116\104\256\102\140\202";
742 * 1x1 transparant PNG.
744 const char image_blank_data[] =
745 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
746 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
747 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
748 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
749 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
750 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
751 "\000\000\000\000\111\105\116\104\256\102\140\202";
755 * Checkerboard pattern, as a GIF.
757 const char image_pattern_data[] =
758 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
759 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
760 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
761 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
765 * 1x1 transparant GIF.
767 const char image_blank_data[] =
768 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
769 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
770 "\000\001\000\000\002\002D\001\000;";
773 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
774 const size_t image_blank_length = sizeof(image_blank_data) - 1;
777 static struct http_response cgi_error_memory_response[1];
779 static struct http_response *dispatch_known_cgi(struct client_state * csp,
781 static struct map *parse_cgi_parameters(char *argstring);
784 /*********************************************************************
786 * Function : dispatch_cgi
788 * Description : Checks if a request URL has either the magical
789 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
790 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
791 * http://config.privoxy.org/). If so, it passes
792 * the (rest of the) path onto dispatch_known_cgi, which
793 * calls the relevant CGI handler function.
796 * 1 : csp = Current client state (buffers, headers, etc...)
798 * Returns : http_response if match, NULL if nonmatch or handler fail
800 *********************************************************************/
801 struct http_response *dispatch_cgi(struct client_state *csp)
803 const char *host = csp->http->host;
804 const char *path = csp->http->path;
807 * Should we intercept ?
810 /* Note: "example.com" and "example.com." are equivalent hostnames. */
812 /* Either the host matches CGI_SITE_1_HOST ..*/
813 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
814 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
815 && (path[0] == '/') )
817 /* ..then the path will all be for us. Remove leading '/' */
820 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
821 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
822 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
823 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
825 /* take everything following CGI_SITE_2_PATH */
826 path += strlen(CGI_SITE_2_PATH);
829 /* skip the forward slash after CGI_SITE_2_PATH */
832 else if (*path != '\0')
835 * weirdness: URL is /configXXX, where XXX is some string
836 * Do *NOT* intercept.
848 * This is a CGI call.
851 return dispatch_known_cgi(csp, path);
855 /*********************************************************************
857 * Function : grep_cgi_referrer
859 * Description : Ugly provisorical fix that greps the value of the
860 * referer HTTP header field out of a linked list of
861 * strings like found at csp->headers. Will disappear
864 * FIXME: csp->headers ought to be csp->http->headers
865 * FIXME: Parsing all client header lines should
866 * happen right after the request is received!
869 * 1 : csp = Current client state (buffers, headers, etc...)
871 * Returns : pointer to value (no copy!), or NULL if none found.
873 *********************************************************************/
874 char *grep_cgi_referrer(const struct client_state *csp)
876 struct list_entry *p;
878 for (p = csp->headers->first; p != NULL; p = p->next)
880 if (p->str == NULL) continue;
881 if (strncmpic(p->str, "Referer: ", 9) == 0)
883 return ((p->str) + 9);
891 /*********************************************************************
893 * Function : referrer_is_safe
895 * Description : Decides whether we trust the Referer for
896 * CGI pages which are only meant to be reachable
897 * through Privoxy's web interface directly.
900 * 1 : csp = Current client state (buffers, headers, etc...)
902 * Returns : TRUE if the referrer is safe, or
903 * FALSE if the referrer is unsafe or not set.
905 *********************************************************************/
906 int referrer_is_safe (const struct client_state *csp)
909 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
911 referrer = grep_cgi_referrer(csp);
913 if (NULL == referrer)
915 /* No referrer, no access */
916 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
919 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
920 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
922 /* Trustworthy referrer */
923 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
924 csp->http->url, referrer);
930 /* Untrustworthy referrer */
931 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
932 csp->http->url, referrer);
939 /*********************************************************************
941 * Function : dispatch_known_cgi
943 * Description : Processes a CGI once dispatch_cgi has determined that
944 * it matches one of the magic prefixes. Parses the path
945 * as a cgi name plus query string, prepares a map that
946 * maps CGI parameter names to their values, initializes
947 * the http_response struct, and calls the relevant CGI
951 * 1 : csp = Current client state (buffers, headers, etc...)
952 * 2 : path = Path of CGI, with the CGI prefix removed.
953 * Should not have a leading "/".
955 * Returns : http_response, or NULL on handler failure or out of
958 *********************************************************************/
959 static struct http_response *dispatch_known_cgi(struct client_state * csp,
962 const struct cgi_dispatcher *d;
963 struct map *param_list;
964 struct http_response *rsp;
965 char *query_args_start;
969 if (NULL == (path_copy = strdup(path)))
971 return cgi_error_memory();
973 query_args_start = path_copy;
974 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
978 if (*query_args_start == '/')
980 *query_args_start++ = '\0';
981 if ((param_list = new_map()))
983 map(param_list, "file", 1, url_decode(query_args_start), 0);
988 if (*query_args_start == '?')
990 *query_args_start++ = '\0';
992 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
995 return cgi_error_memory();
1001 * path_copy = CGI call name
1002 * param_list = CGI params, as map
1005 /* Get mem for response or fail*/
1006 if (NULL == (rsp = alloc_http_response()))
1009 free_map(param_list);
1010 return cgi_error_memory();
1013 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
1014 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
1015 csp->ip_addr_str, csp->http->cmd);
1018 * Find and start the right CGI function
1020 d = cgi_dispatchers;
1023 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1026 * If the called CGI is either harmless, or referred
1027 * from a trusted source, start it.
1029 if (d->harmless || referrer_is_safe(csp))
1031 err = (d->handler)(csp, rsp, param_list);
1036 * Else, modify toggle calls so that they only display
1037 * the status, and deny all other calls.
1039 if (0 == strcmp(path_copy, "toggle"))
1041 unmap(param_list, "set");
1042 err = (d->handler)(csp, rsp, param_list);
1046 err = cgi_error_disabled(csp, rsp);
1051 free_map(param_list);
1053 if (err == JB_ERR_CGI_PARAMS)
1055 err = cgi_error_bad_param(csp, rsp);
1057 if (err && (err != JB_ERR_MEMORY))
1059 /* Unexpected error! Shouldn't get here */
1060 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1061 err = cgi_error_unknown(csp, rsp, err);
1066 return finish_http_response(rsp);
1070 /* Error in handler, probably out-of-memory */
1071 free_http_response(rsp);
1072 return cgi_error_memory();
1080 /*********************************************************************
1082 * Function : parse_cgi_parameters
1084 * Description : Parse a URL-encoded argument string into name/value
1085 * pairs and store them in a struct map list.
1088 * 1 : argstring = string to be parsed. Will be trashed.
1090 * Returns : pointer to param list, or NULL if out of memory.
1092 *********************************************************************/
1093 static struct map *parse_cgi_parameters(char *argstring)
1096 char *vector[BUFFER_SIZE];
1098 struct map *cgi_params;
1100 if (NULL == (cgi_params = new_map()))
1106 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1107 * the fragment identifier along with the request, so we must
1108 * cut it off here, so it won't pollute the CGI params:
1110 if (NULL != (p = strchr(argstring, '#')))
1115 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1117 for (i = 0; i < pairs; i++)
1119 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1122 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1124 free_map(cgi_params);
1135 /*********************************************************************
1137 * Function : get_char_param
1139 * Description : Get a single-character parameter passed to a CGI
1143 * 1 : parameters = map of cgi parameters
1144 * 2 : param_name = The name of the parameter to read
1146 * Returns : Uppercase character on success, '\0' on error.
1148 *********************************************************************/
1149 char get_char_param(const struct map *parameters,
1150 const char *param_name)
1157 ch = *(lookup(parameters, param_name));
1158 if ((ch >= 'a') && (ch <= 'z'))
1160 ch = (char)(ch - 'a' + 'A');
1167 /*********************************************************************
1169 * Function : get_string_param
1171 * Description : Get a string paramater, to be used as an
1172 * ACTION_STRING or ACTION_MULTI paramater.
1173 * Validates the input to prevent stupid/malicious
1174 * users from corrupting their action file.
1177 * 1 : parameters = map of cgi parameters
1178 * 2 : param_name = The name of the parameter to read
1179 * 3 : pparam = destination for paramater. Allocated as
1180 * part of the map "parameters", so don't free it.
1181 * Set to NULL if not specified.
1183 * Returns : JB_ERR_OK on success, or if the paramater
1184 * was not specified.
1185 * JB_ERR_MEMORY on out-of-memory.
1186 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1188 *********************************************************************/
1189 jb_err get_string_param(const struct map *parameters,
1190 const char *param_name,
1191 const char **pparam)
1203 param = lookup(parameters, param_name);
1209 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1214 * Note that the length limit is arbitrary, it just seems
1215 * sensible to limit it to *something*. There's no
1216 * technical reason for any limit at all.
1218 return JB_ERR_CGI_PARAMS;
1221 /* Check every character to see if it's legal */
1223 while ((ch = *s++) != '\0')
1225 if ( ((unsigned char)ch < (unsigned char)' ')
1228 /* Probable hack attempt, or user accidentally used '}'. */
1229 return JB_ERR_CGI_PARAMS;
1240 /*********************************************************************
1242 * Function : get_number_param
1244 * Description : Get a non-negative integer from the parameters
1245 * passed to a CGI function.
1248 * 1 : csp = Current client state (buffers, headers, etc...)
1249 * 2 : parameters = map of cgi parameters
1250 * 3 : name = Name of CGI parameter to read
1251 * 4 : pvalue = destination for value.
1252 * Set to -1 on error.
1254 * Returns : JB_ERR_OK on success
1255 * JB_ERR_MEMORY on out-of-memory
1256 * JB_ERR_CGI_PARAMS if the parameter was not specified
1259 *********************************************************************/
1260 jb_err get_number_param(struct client_state *csp,
1261 const struct map *parameters,
1276 param = lookup(parameters, name);
1279 return JB_ERR_CGI_PARAMS;
1282 /* We don't use atoi because I want to check this carefully... */
1285 while ((ch = *param++) != '\0')
1287 if ((ch < '0') || (ch > '9'))
1289 return JB_ERR_CGI_PARAMS;
1292 ch = (char)(ch - '0');
1296 * <limits.h> defines UINT_MAX
1298 * (UINT_MAX - ch) / 10 is the largest number that
1299 * can be safely multiplied by 10 then have ch added.
1301 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1303 return JB_ERR_CGI_PARAMS;
1306 value = value * 10 + (unsigned)ch;
1317 /*********************************************************************
1319 * Function : error_response
1321 * Description : returns an http_response that explains the reason
1322 * why a request failed.
1325 * 1 : csp = Current client state (buffers, headers, etc...)
1326 * 2 : templatename = Which template should be used for the answer
1327 * 3 : sys_err = system error number
1329 * Returns : A http_response. If we run out of memory, this
1330 * will be cgi_error_memory().
1332 *********************************************************************/
1333 struct http_response *error_response(struct client_state *csp,
1334 const char *templatename,
1338 struct http_response *rsp;
1339 struct map *exports = default_exports(csp, NULL);
1342 if (exports == NULL)
1344 return cgi_error_memory();
1347 if (NULL == (rsp = alloc_http_response()))
1350 return cgi_error_memory();
1353 if (csp->flags & CSP_FLAG_FORCED)
1355 path = strdup(FORCE_PREFIX);
1361 err = string_append(&path, csp->http->path);
1363 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1364 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1365 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1366 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1367 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1370 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1373 /* Some failures, like "404 no such domain", don't have an IP address. */
1374 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1382 free_http_response(rsp);
1383 return cgi_error_memory();
1386 if (!strcmp(templatename, "no-such-domain"))
1388 rsp->status = strdup("404 No such domain");
1389 if (rsp->status == NULL)
1392 free_http_response(rsp);
1393 return cgi_error_memory();
1396 else if (!strcmp(templatename, "forwarding-failed"))
1398 const struct forward_spec * fwd = forward_url(csp->http, csp);
1401 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1402 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1406 * XXX: While the template is called forwarding-failed,
1407 * it currently only handles socks forwarding failures.
1409 assert(fwd->type != SOCKS_NONE);
1412 * Map failure reason, forwarding type and forwarder.
1414 if (NULL == csp->error_message)
1417 * Either we forgot to record the failure reason,
1418 * or the memory allocation failed.
1420 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1421 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1423 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1424 if (!err) map(exports, "forwarding-type", 1, (fwd->type == SOCKS_4) ?
1425 "socks4-" : "socks4a-", 1);
1426 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1428 if (!err) rsp->status = strdup("503 Forwarding failure");
1429 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1432 free_http_response(rsp);
1433 return cgi_error_memory();
1436 else if (!strcmp(templatename, "connect-failed"))
1438 rsp->status = strdup("503 Connect failed");
1439 if (rsp->status == NULL)
1442 free_http_response(rsp);
1443 return cgi_error_memory();
1447 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1450 free_http_response(rsp);
1451 return cgi_error_memory();
1454 return finish_http_response(rsp);
1458 /*********************************************************************
1460 * Function : cgi_error_disabled
1462 * Description : CGI function that is called to generate an error
1463 * response if the actions editor or toggle CGI are
1464 * accessed despite having being disabled at compile-
1465 * or run-time, or if the user followed an untrusted link
1466 * to access a unsafe CGI feature that is only reachable
1467 * through Privoxy directly.
1470 * 1 : csp = Current client state (buffers, headers, etc...)
1471 * 2 : rsp = http_response data structure for output
1473 * CGI Parameters : none
1475 * Returns : JB_ERR_OK on success
1476 * JB_ERR_MEMORY on out-of-memory error.
1478 *********************************************************************/
1479 jb_err cgi_error_disabled(struct client_state *csp,
1480 struct http_response *rsp)
1482 struct map *exports;
1487 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1489 return JB_ERR_MEMORY;
1491 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1493 /* Not important enough to do anything */
1494 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1497 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1501 /*********************************************************************
1503 * Function : cgi_init_error_messages
1505 * Description : Call at the start of the program to initialize
1506 * the error message used by cgi_error_memory().
1512 *********************************************************************/
1513 void cgi_init_error_messages(void)
1515 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1516 cgi_error_memory_response->head =
1517 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1518 "Content-Type: text/html\r\n"
1520 cgi_error_memory_response->body =
1522 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1524 "<h1>500 Internal Privoxy Error</h1>\r\n"
1525 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1526 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1530 cgi_error_memory_response->head_length =
1531 strlen(cgi_error_memory_response->head);
1532 cgi_error_memory_response->content_length =
1533 strlen(cgi_error_memory_response->body);
1537 /*********************************************************************
1539 * Function : cgi_error_memory
1541 * Description : Called if a CGI function runs out of memory.
1542 * Returns a statically-allocated error response.
1546 * Returns : http_response data structure for output. This is
1547 * statically allocated, for obvious reasons.
1549 *********************************************************************/
1550 struct http_response *cgi_error_memory(void)
1552 /* assert that it's been initialized. */
1553 assert(cgi_error_memory_response->head);
1555 return cgi_error_memory_response;
1559 /*********************************************************************
1561 * Function : cgi_error_no_template
1563 * Description : Almost-CGI function that is called if a template
1564 * cannot be loaded. Note this is not a true CGI,
1565 * it takes a template name rather than a map of
1569 * 1 : csp = Current client state (buffers, headers, etc...)
1570 * 2 : rsp = http_response data structure for output
1571 * 3 : template_name = Name of template that could not
1574 * Returns : JB_ERR_OK on success
1575 * JB_ERR_MEMORY on out-of-memory error.
1577 *********************************************************************/
1578 jb_err cgi_error_no_template(struct client_state *csp,
1579 struct http_response *rsp,
1580 const char *template_name)
1582 static const char status[] =
1583 "500 Internal Privoxy Error";
1584 static const char body_prefix[] =
1586 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1588 "<h1>500 Internal Privoxy Error</h1>\r\n"
1589 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1590 "<p><b>Could not load template file <code>";
1591 static const char body_suffix[] =
1592 "</code> or one of it's included components.</b></p>\r\n"
1593 "<p>Please contact your proxy administrator.</p>\r\n"
1594 "<p>If you are the proxy administrator, please put the required file(s)"
1595 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1596 "location of the <code><i>(confdir)</i></code> directory "
1597 "is specified in the main Privoxy <code>config</code> "
1598 "file. (It's typically the Privoxy install directory"
1600 ", or <code>/etc/privoxy/</code>"
1601 #endif /* ndef _WIN32 */
1608 assert(template_name);
1610 /* Reset rsp, if needed */
1614 rsp->content_length = 0;
1615 rsp->head_length = 0;
1618 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1619 if (rsp->body == NULL)
1621 return JB_ERR_MEMORY;
1623 strcpy(rsp->body, body_prefix);
1624 strcat(rsp->body, template_name);
1625 strcat(rsp->body, body_suffix);
1627 rsp->status = strdup(status);
1628 if (rsp->status == NULL)
1630 return JB_ERR_MEMORY;
1637 /*********************************************************************
1639 * Function : cgi_error_unknown
1641 * Description : Almost-CGI function that is called if an unexpected
1642 * error occurs in the top-level CGI dispatcher.
1643 * In this context, "unexpected" means "anything other
1644 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1645 * expected to handle all other errors internally,
1646 * since they can give more relavent error messages
1649 * Note this is not a true CGI, it takes an error
1650 * code rather than a map of parameters.
1653 * 1 : csp = Current client state (buffers, headers, etc...)
1654 * 2 : rsp = http_response data structure for output
1655 * 3 : error_to_report = Error code to report.
1657 * Returns : JB_ERR_OK on success
1658 * JB_ERR_MEMORY on out-of-memory error.
1660 *********************************************************************/
1661 jb_err cgi_error_unknown(struct client_state *csp,
1662 struct http_response *rsp,
1663 jb_err error_to_report)
1665 static const char status[] =
1666 "500 Internal Privoxy Error";
1667 static const char body_prefix[] =
1669 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1671 "<h1>500 Internal Privoxy Error</h1>\r\n"
1672 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1673 "<p><b>Unexpected internal error: ";
1674 static const char body_suffix[] =
1677 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1678 "file a bug report</a>.</p>\r\n"
1685 /* Reset rsp, if needed */
1689 rsp->content_length = 0;
1690 rsp->head_length = 0;
1693 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1695 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1696 if (rsp->body == NULL)
1698 return JB_ERR_MEMORY;
1700 strcpy(rsp->body, body_prefix);
1701 strcat(rsp->body, errnumbuf);
1702 strcat(rsp->body, body_suffix);
1704 rsp->status = strdup(status);
1705 if (rsp->status == NULL)
1707 return JB_ERR_MEMORY;
1714 /*********************************************************************
1716 * Function : cgi_error_bad_param
1718 * Description : CGI function that is called if the parameters
1719 * (query string) for a CGI were wrong.
1722 * 1 : csp = Current client state (buffers, headers, etc...)
1723 * 2 : rsp = http_response data structure for output
1725 * CGI Parameters : none
1727 * Returns : JB_ERR_OK on success
1728 * JB_ERR_MEMORY on out-of-memory error.
1730 *********************************************************************/
1731 jb_err cgi_error_bad_param(struct client_state *csp,
1732 struct http_response *rsp)
1734 struct map *exports;
1739 if (NULL == (exports = default_exports(csp, NULL)))
1741 return JB_ERR_MEMORY;
1744 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1748 /*********************************************************************
1750 * Function : cgi_redirect
1752 * Description : CGI support function to generate a HTTP redirect
1756 * 1 : rsp = http_response data structure for output
1757 * 2 : target = string with the target URL
1759 * CGI Parameters : None
1761 * Returns : JB_ERR_OK on success
1762 * JB_ERR_MEMORY on out-of-memory error.
1764 *********************************************************************/
1765 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1772 err = enlist_unique_header(rsp->headers, "Location", target);
1774 rsp->status = strdup("302 Local Redirect from Privoxy");
1775 if (rsp->status == NULL)
1777 return JB_ERR_MEMORY;
1784 /*********************************************************************
1786 * Function : add_help_link
1788 * Description : Produce a copy of the string given as item,
1789 * embedded in an HTML link to its corresponding
1790 * section (item name in uppercase) in the actions
1791 * chapter of the user manual, (whose URL is given in
1792 * the config and defaults to our web site).
1794 * FIXME: I currently only work for actions, and would
1795 * like to be generalized for other topics.
1798 * 1 : item = item (will NOT be free()d.)
1799 * It is assumed to be HTML-safe.
1800 * 2 : config = The current configuration.
1802 * Returns : String with item embedded in link, or NULL on
1805 *********************************************************************/
1806 char *add_help_link(const char *item,
1807 struct configuration_spec *config)
1811 if (!item) return NULL;
1813 result = strdup("<a href=\"");
1814 if (!strncmpic(config->usermanual, "file://", 7) ||
1815 !strncmpic(config->usermanual, "http", 4))
1817 string_append(&result, config->usermanual);
1821 string_append(&result, "http://");
1822 string_append(&result, CGI_SITE_2_HOST);
1823 string_append(&result, "/user-manual/");
1825 string_append(&result, ACTIONS_HELP_PREFIX);
1826 string_join (&result, string_toupper(item));
1827 string_append(&result, "\">");
1828 string_append(&result, item);
1829 string_append(&result, "</a> ");
1835 /*********************************************************************
1837 * Function : get_http_time
1839 * Description : Get the time in a format suitable for use in a
1840 * HTTP header - e.g.:
1841 * "Sun, 06 Nov 1994 08:49:37 GMT"
1844 * 1 : time_offset = Time returned will be current time
1845 * plus this number of seconds.
1846 * 2 : buf = Destination for result. Must be long enough
1847 * to hold 29 characters plus a trailing zero.
1851 *********************************************************************/
1852 void get_http_time(int time_offset, char *buf)
1854 static const char day_names[7][4] =
1855 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1856 static const char month_names[12][4] =
1857 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1858 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1861 time_t current_time;
1862 #if defined(HAVE_GMTIME_R)
1864 * Declare dummy up here (instead of inside get/set gmt block) so it
1865 * doesn't go out of scope before it's potentially used in snprintf later.
1866 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1867 * !defined HAVE_GMTIME_R.
1874 time(¤t_time); /* get current time */
1876 current_time += time_offset;
1878 /* get and save the gmt */
1881 t = gmtime_r(¤t_time, &dummy);
1882 #elif FEATURE_PTHREAD
1883 pthread_mutex_lock(&gmtime_mutex);
1884 t = gmtime(¤t_time);
1885 pthread_mutex_unlock(&gmtime_mutex);
1887 t = gmtime(¤t_time);
1891 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1893 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1894 day_names[t->tm_wday],
1896 month_names[t->tm_mon],
1906 /*********************************************************************
1908 * Function : finish_http_response
1910 * Description : Fill in the missing headers in an http response,
1911 * and flatten the headers to an http head.
1914 * 1 : rsp = pointer to http_response to be processed
1916 * Returns : A http_response, usually the rsp parameter.
1917 * On error, free()s rsp and returns cgi_error_memory()
1919 *********************************************************************/
1920 struct http_response *finish_http_response(struct http_response *rsp)
1922 char buf[BUFFER_SIZE];
1925 /* Special case - do NOT change this statically allocated response,
1926 * which is ready for output anyway.
1928 if (rsp == cgi_error_memory_response)
1934 * Fill in the HTTP Status
1936 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1937 err = enlist_first(rsp->headers, buf);
1940 * Set the Content-Length
1942 if (rsp->content_length == 0)
1944 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1948 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1949 err = enlist(rsp->headers, buf);
1952 if (strncmpic(rsp->status, "302", 3))
1955 * If it's not a redirect without any content,
1956 * set the Content-Type to text/html if it's
1957 * not already specified.
1959 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1963 * Fill in the rest of the default headers:
1965 * Date: set to current date/time.
1966 * Last-Modified: set to date/time the page was last changed.
1967 * Expires: set to date/time page next needs reloading.
1968 * Cache-Control: set to "no-cache" if applicable.
1970 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1975 * Set Expires to about 10 min into the future so it'll get reloaded
1976 * occasionally, e.g. if Privoxy gets upgraded.
1981 get_http_time(0, buf);
1982 err = enlist_unique_header(rsp->headers, "Date", buf);
1985 /* Some date in the past. */
1986 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1990 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1991 err = enlist_unique_header(rsp->headers, "Expires", buf);
1994 else if (!strncmpic(rsp->status, "302", 3))
1996 get_http_time(0, buf);
1997 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2002 * Setting "Cache-Control" to "no-cache" and "Expires" to
2003 * the current time doesn't exactly forbid caching, it just
2004 * requires the client to revalidate the cached copy.
2006 * If a temporary problem occurs and the user tries again after
2007 * getting Privoxy's error message, a compliant browser may set the
2008 * If-Modified-Since header with the content of the error page's
2009 * Last-Modified header. More often than not, the document on the server
2010 * is older than Privoxy's error message, the server would send status code
2011 * 304 and the browser would display the outdated error message again and again.
2013 * For documents delivered with status code 404 or 503 we set "Last-Modified"
2014 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2015 * and can be safely used to "revalidate" without getting a status code 304.
2017 * There is no need to let the useless If-Modified-Since header reach the
2018 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2020 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2022 get_http_time(0, buf);
2023 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2024 if (!strncmpic(rsp->status, "404", 3) || !strncmpic(rsp->status, "503", 3))
2026 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2030 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2032 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2033 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2039 * HTTP/1.1 applications that do not support persistent connections MUST
2040 * include the "close" connection option in every message.
2042 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2047 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2049 free_http_response(rsp);
2050 return cgi_error_memory();
2052 rsp->head_length = strlen(rsp->head);
2059 /*********************************************************************
2061 * Function : alloc_http_response
2063 * Description : Allocates a new http_response structure.
2067 * Returns : pointer to a new http_response, or NULL.
2069 *********************************************************************/
2070 struct http_response *alloc_http_response(void)
2072 return (struct http_response *) zalloc(sizeof(struct http_response));
2077 /*********************************************************************
2079 * Function : free_http_response
2081 * Description : Free the memory occupied by an http_response
2082 * and its depandant structures.
2085 * 1 : rsp = pointer to http_response to be freed
2089 *********************************************************************/
2090 void free_http_response(struct http_response *rsp)
2093 * Must special case cgi_error_memory_response, which is never freed.
2095 if (rsp && (rsp != cgi_error_memory_response))
2100 destroy_list(rsp->headers);
2107 /*********************************************************************
2109 * Function : template_load
2111 * Description : CGI support function that loads a given HTML
2112 * template from the confdir, ignoring comment
2113 * lines and following #include statements up to
2117 * 1 : csp = Current client state (buffers, headers, etc...)
2118 * 2 : template_ptr = Destination for pointer to loaded
2120 * 3 : templatename = name of the HTML template to be used
2121 * 4 : recursive = Flag set if this function calls itself
2122 * following an #include statament
2124 * Returns : JB_ERR_OK on success
2125 * JB_ERR_MEMORY on out-of-memory error.
2126 * JB_ERR_FILE if the template file cannot be read
2128 *********************************************************************/
2129 jb_err template_load(struct client_state *csp, char **template_ptr,
2130 const char *templatename, int recursive)
2133 char *templates_dir_path;
2136 char *included_module;
2139 char buf[BUFFER_SIZE];
2142 assert(template_ptr);
2143 assert(templatename);
2145 *template_ptr = NULL;
2147 /* Validate template name. Paranoia. */
2148 for (p = templatename; *p != 0; p++)
2150 if ( ((*p < 'a') || (*p > 'z'))
2151 && ((*p < 'A') || (*p > 'Z'))
2152 && ((*p < '0') || (*p > '9'))
2156 /* Illegal character */
2161 /* Generate full path */
2163 templates_dir_path = make_path(csp->config->confdir, "templates");
2164 if (templates_dir_path == NULL)
2166 return JB_ERR_MEMORY;
2169 full_path = make_path(templates_dir_path, templatename);
2170 free(templates_dir_path);
2171 if (full_path == NULL)
2173 return JB_ERR_MEMORY;
2176 /* Allocate buffer */
2178 file_buffer = strdup("");
2179 if (file_buffer == NULL)
2182 return JB_ERR_MEMORY;
2185 /* Open template file */
2187 if (NULL == (fp = fopen(full_path, "r")))
2189 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2197 * Read the file, ignoring comments, and honoring #include
2198 * statements, unless we're already called recursively.
2200 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2201 * This is unlikely in practise.
2203 while (fgets(buf, BUFFER_SIZE, fp))
2205 if (!recursive && !strncmp(buf, "#include ", 9))
2207 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2214 if (string_join(&file_buffer, included_module))
2217 return JB_ERR_MEMORY;
2223 /* skip lines starting with '#' */
2229 if (string_append(&file_buffer, buf))
2232 return JB_ERR_MEMORY;
2237 *template_ptr = file_buffer;
2243 /*********************************************************************
2245 * Function : template_fill
2247 * Description : CGI support function that fills in a pre-loaded
2248 * HTML template by replacing @name@ with value using
2249 * pcrs, for each item in the output map.
2251 * Note that a leading '$' charachter in the export map's
2252 * values will be stripped and toggle on backreference
2256 * 1 : template_ptr = IN: Template to be filled out.
2258 * OUT: Filled out template.
2259 * Caller must free().
2260 * 2 : exports = map with fill in symbol -> name pairs
2262 * Returns : JB_ERR_OK on success (and for uncritical errors)
2263 * JB_ERR_MEMORY on out-of-memory error
2265 *********************************************************************/
2266 jb_err template_fill(char **template_ptr, const struct map *exports)
2268 struct map_entry *m;
2270 char buf[BUFFER_SIZE];
2271 char *tmp_out_buffer;
2277 assert(template_ptr);
2278 assert(*template_ptr);
2281 file_buffer = *template_ptr;
2282 size = strlen(file_buffer) + 1;
2285 * Assemble pcrs joblist from exports map
2287 for (m = exports->first; m != NULL; m = m->next)
2289 if (*m->name == '$')
2292 * First character of name is '$', so remove this flag
2293 * character and allow backreferences ($1 etc) in the
2294 * "replace with" text.
2296 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2302 * Treat the "replace with" text as a literal string -
2303 * no quoting needed, no backreferences allowed.
2304 * ("Trivial" ['T'] flag).
2308 /* Enclose name in @@ */
2309 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2313 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2315 /* Make and run job. */
2316 job = pcrs_compile(buf, m->value, flags, &error);
2319 if (error == PCRS_ERR_NOMEM)
2322 *template_ptr = NULL;
2323 return JB_ERR_MEMORY;
2327 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2328 /* Hope it wasn't important and silently ignore the invalid job */
2333 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2336 if (NULL == tmp_out_buffer)
2338 *template_ptr = NULL;
2339 return JB_ERR_MEMORY;
2345 * Substitution failed, keep the original buffer,
2346 * log the problem and ignore it.
2348 * The user might see some unresolved @CGI_VARIABLES@,
2349 * but returning a special CGI error page seems unreasonable
2350 * and could mask more important error messages.
2352 free(tmp_out_buffer);
2353 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2354 buf, m->value, flags, pcrs_strerror(error));
2358 /* Substitution succeeded, use modified buffer. */
2360 file_buffer = tmp_out_buffer;
2368 *template_ptr = file_buffer;
2373 /*********************************************************************
2375 * Function : template_fill_for_cgi
2377 * Description : CGI support function that loads a HTML template
2378 * and fills it in. Handles file-not-found errors
2379 * by sending a HTML error message. For convenience,
2380 * this function also frees the passed "exports" map.
2383 * 1 : csp = Client state
2384 * 2 : templatename = name of the HTML template to be used
2385 * 3 : exports = map with fill in symbol -> name pairs.
2386 * Will be freed by this function.
2387 * 4 : rsp = Response structure to fill in.
2389 * Returns : JB_ERR_OK on success
2390 * JB_ERR_MEMORY on out-of-memory error
2392 *********************************************************************/
2393 jb_err template_fill_for_cgi(struct client_state *csp,
2394 const char *templatename,
2395 struct map *exports,
2396 struct http_response *rsp)
2401 assert(templatename);
2405 err = template_load(csp, &rsp->body, templatename, 0);
2406 if (err == JB_ERR_FILE)
2409 return cgi_error_no_template(csp, rsp, templatename);
2414 return err; /* JB_ERR_MEMORY */
2416 err = template_fill(&rsp->body, exports);
2422 /*********************************************************************
2424 * Function : default_exports
2426 * Description : returns a struct map list that contains exports
2427 * which are common to all CGI functions.
2430 * 1 : csp = Current client state (buffers, headers, etc...)
2431 * 2 : caller = name of CGI who calls us and which should
2432 * be excluded from the generated menu. May be
2434 * Returns : NULL if no memory, else a new map. Caller frees.
2436 *********************************************************************/
2437 struct map *default_exports(const struct client_state *csp, const char *caller)
2441 struct map * exports;
2442 int local_help_exists = 0;
2446 exports = new_map();
2447 if (exports == NULL)
2452 err = map(exports, "version", 1, html_encode(VERSION), 0);
2453 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2454 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2455 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2456 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2457 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2458 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2459 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2460 !strncmpic(csp->config->usermanual, "http", 4))
2462 /* Manual is located somewhere else, just link to it. */
2463 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2467 /* Manual is delivered by Privoxy. */
2468 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2470 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2471 #ifdef FEATURE_TOGGLE
2472 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2474 if (!err) err = map_block_killer(exports, "can-toggle");
2477 snprintf(buf, 20, "%d", csp->config->hport);
2478 if (!err) err = map(exports, "my-port", 1, buf, 1);
2480 if(!strcmp(CODE_STATUS, "stable"))
2482 if (!err) err = map_block_killer(exports, "unstable");
2485 if (csp->config->admin_address != NULL)
2487 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2488 local_help_exists = 1;
2492 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2495 if (csp->config->proxy_info_url != NULL)
2497 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2498 local_help_exists = 1;
2502 if (!err) err = map_block_killer(exports, "have-proxy-info");
2505 if (local_help_exists == 0)
2507 if (!err) err = map_block_killer(exports, "have-help-info");
2520 /*********************************************************************
2522 * Function : map_block_killer
2524 * Description : Convenience function.
2525 * Adds a "killer" for the conditional HTML-template
2526 * block <name>, i.e. a substitution of the regex
2527 * "if-<name>-start.*if-<name>-end" to the given
2531 * 1 : exports = map to extend
2532 * 2 : name = name of conditional block
2534 * Returns : JB_ERR_OK on success
2535 * JB_ERR_MEMORY on out-of-memory error.
2537 *********************************************************************/
2538 jb_err map_block_killer(struct map *exports, const char *name)
2540 char buf[1000]; /* Will do, since the names are hardwired */
2544 assert(strlen(name) < 490);
2546 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2547 return map(exports, buf, 1, "", 1);
2551 /*********************************************************************
2553 * Function : map_block_keep
2555 * Description : Convenience function. Removes the markers used
2556 * by map-block-killer, to save a few bytes.
2557 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2560 * 1 : exports = map to extend
2561 * 2 : name = name of conditional block
2563 * Returns : JB_ERR_OK on success
2564 * JB_ERR_MEMORY on out-of-memory error.
2566 *********************************************************************/
2567 jb_err map_block_keep(struct map *exports, const char *name)
2570 char buf[500]; /* Will do, since the names are hardwired */
2574 assert(strlen(name) < 490);
2576 snprintf(buf, 500, "if-%s-start", name);
2577 err = map(exports, buf, 1, "", 1);
2584 snprintf(buf, 500, "if-%s-end", name);
2585 return map(exports, buf, 1, "", 1);
2589 /*********************************************************************
2591 * Function : map_conditional
2593 * Description : Convenience function.
2594 * Adds an "if-then-else" for the conditional HTML-template
2595 * block <name>, i.e. a substitution of the form:
2602 * The control structure and one of the alternatives
2606 * 1 : exports = map to extend
2607 * 2 : name = name of conditional block
2608 * 3 : choose_first = nonzero for first, zero for second.
2610 * Returns : JB_ERR_OK on success
2611 * JB_ERR_MEMORY on out-of-memory error.
2613 *********************************************************************/
2614 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2616 char buf[1000]; /* Will do, since the names are hardwired */
2621 assert(strlen(name) < 480);
2623 snprintf(buf, 1000, (choose_first
2624 ? "else-not-%s@.*@endif-%s"
2625 : "if-%s-then@.*@else-not-%s"),
2628 err = map(exports, buf, 1, "", 1);
2634 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2635 return map(exports, buf, 1, "", 1);
2639 /*********************************************************************
2641 * Function : make_menu
2643 * Description : Returns an HTML-formatted menu of the available
2644 * unhidden CGIs, excluding the one given in <self>
2645 * and the toggle CGI if toggling is disabled.
2648 * 1 : self = name of CGI to leave out, can be NULL for
2650 * 2 : feature_flags = feature bitmap from csp->config
2653 * Returns : menu string, or NULL on out-of-memory error.
2655 *********************************************************************/
2656 char *make_menu(const char *self, const unsigned feature_flags)
2658 const struct cgi_dispatcher *d;
2659 char *result = strdup("");
2663 self = "NO-SUCH-CGI!";
2666 /* List available unhidden CGI's and export as "other-cgis" */
2667 for (d = cgi_dispatchers; d->name; d++)
2670 #ifdef FEATURE_TOGGLE
2671 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2674 * Suppress the toggle link if remote toggling is disabled.
2678 #endif /* def FEATURE_TOGGLE */
2680 if (d->description && strcmp(d->name, self))
2682 char *html_encoded_prefix;
2684 string_append(&result, "<li><a href=\"");
2685 html_encoded_prefix = html_encode(CGI_PREFIX);
2686 if (html_encoded_prefix == NULL)
2692 string_append(&result, html_encoded_prefix);
2693 free(html_encoded_prefix);
2695 string_append(&result, d->name);
2696 string_append(&result, "\">");
2697 string_append(&result, d->description);
2698 string_append(&result, "</a></li>\n");
2706 /*********************************************************************
2708 * Function : dump_map
2710 * Description : HTML-dump a map for debugging (as table)
2713 * 1 : the_map = map to dump
2715 * Returns : string with HTML
2717 *********************************************************************/
2718 char *dump_map(const struct map *the_map)
2720 struct map_entry *cur_entry;
2721 char *ret = strdup("");
2723 string_append(&ret, "<table>\n");
2725 for (cur_entry = the_map->first;
2726 (cur_entry != NULL) && (ret != NULL);
2727 cur_entry = cur_entry->next)
2729 string_append(&ret, "<tr><td><b>");
2730 string_join (&ret, html_encode(cur_entry->name));
2731 string_append(&ret, "</b></td><td>");
2732 string_join (&ret, html_encode(cur_entry->value));
2733 string_append(&ret, "</td></tr>\n");
2736 string_append(&ret, "</table>\n");