1 const char cgi_rcs[] = "$Id: cgi.c,v 1.92 2007/01/28 13:41:17 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.92 2007/01/28 13:41:17 fabiankeil
42 * - Add HEAD support to finish_http_response.
43 * - Add error favicon to internal HTML error messages.
45 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
46 * Add new config option "templdir" to
47 * change the templates directory.
49 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
50 * Added "forwarding-failed" template support for error_response().
52 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
53 * Add favicon delivery functions.
55 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
56 * - Map variables that aren't guaranteed to be
57 * pure ASCII html_encoded.
58 * - Use CGI_PREFIX to generate URL for user manual
59 * CGI page to make sure CGI_SITE_2_PATH is included.
61 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
62 * - "Protect" against a rather lame JavaScript-based
63 * Privoxy detection "attack" and check the referrer
64 * before delivering the CGI style sheet.
65 * - Move referrer check for unsafe CGI pages into
66 * referrer_is_safe() and log the result.
67 * - Map @url@ in cgi-error-disabled page.
68 * It's required for the "go there anyway" link.
69 * - Mark *csp as immutable for grep_cgi_referrer().
71 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
72 * Fix strdup() error handling in cgi_error_unknown()
73 * and cgi_error_no_template(). Reported by Markus Elfring.
75 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
76 * Handle pcrs_execute() errors in template_fill() properly.
78 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
79 * Fixed gcc43 conversion warnings and replaced sprintf
80 * calls with snprintf to give OpenBSD's gcc one less reason
83 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
84 * Escape ampersand in Privoxy menu.
86 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
87 * Suppress the toggle link if remote toggling is disabled.
89 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
90 * Fix configure option --disable-toggle.
91 * Thanks to Peter Thoenen for reporting this.
93 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
94 * Don't lose the FORCE_PREFIX in case of
95 * connection problems. Fixes #612235.
97 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
98 * Make pthread mutex locking more generic. Instead of
99 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
100 * and use mutex locking unless there is an _r function
101 * available. Better safe than sorry.
103 * Fixes "./configure --disable-pthread" and should result
104 * in less threading-related problems on pthread-using platforms,
105 * but it still doesn't fix BR#1122404.
107 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
108 * Use CGI_PREFIX to check the referrer.
109 * The check for "http://config.privoxy.org/" fails
110 * if the user modified CGI_SITE_2_HOST.
112 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
113 * Adjusted headers for Privoxy's cgi responses:
114 * Don't set Last-Modified, Expires and Cache-Control
115 * headers for redirects; always set "Connection: close".
117 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
118 * Only predate the Last-Modified header for cgi responses
119 * that are delivered with status code 404 or 503.
121 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
122 * Mark cgi_send_user_manual as harmless,
123 * to fix the access denied problem Hal spotted.
124 * The manual has no secret content, therefore we
125 * don't have to care about "secure" referrers.
127 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
128 * Incorporate modified version of Roland Rosenfeld's patch to
129 * optionally access the user-manual via Privoxy. Closes patch 679075.
131 * Formatting changed to Privoxy style, added call to
132 * cgi_error_no_template if the requested file doesn't
133 * exist and modified check whether or not Privoxy itself
134 * should serve the manual. Should work cross-platform now.
136 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
137 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
139 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
140 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
141 * with what was really the latest development (the v_3_0_branch branch)
143 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
144 * Moved cgi_error_disabled() from cgiedit.c to
145 * cgi.c to re-enable build with --disable-editor.
146 * Fixes Bug #892744. Thanks to Matthew Fischer
149 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
150 * - Added new function cgi_redirect to handle creation of
151 * HTTP redirect messages formerly repeated in the code.
152 * - Send cgi_error_disabled instead of cgi_error_404 when
153 * referrer check fails
154 * - Dynamic content now gets Expires header field with date
157 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
158 * Bugfix: Transparent PNG was not transparent. Thanks to
159 * Dan Razzell of Starfish Systems for notice and new PNG.
161 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
162 * Security fix: dspatch_known_cgi no longer considers an empty
163 * referrer safe for critical CGIs, since malicious links could
164 * reside on https:// locations which browsers don't advertize as
165 * referrers. Closes bug #749916, thanks to Jeff Epler for the
166 * hint. Goodbye One-Click[tm] toggling :-(
168 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
171 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
172 * Killed a compiler warning on OSX
174 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
175 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
176 * (fixes bug #710056)
177 * - Show toggle info only if we have it
179 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
180 * Move declaration of struct tm dummy outside of a control block so it is
181 * accessible later on during snprintf in get_http_time.
183 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
184 * Cosmetic: Renamed cryptic variable
186 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
187 * 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.
189 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
190 * Disable access to critical CGIs via untrusted referrers.
191 * This prevents users from being tricked by malicious websites
192 * into making unintentional configuration changes:
194 * - Added flag to each cgi_dispatcher that allows or denies
196 * - Introduced proviorical function that greps for the
197 * referrer header before regular header parsing happens
198 * - Added safety check to dispatch_known_cgi. CGI is called
199 * if (cgi harmless || no referrer || we are referrer).
200 * Else a) toggle calls are modified not to change status and
201 * b) all other calls are denied.
203 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
204 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
206 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
207 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
209 * Revision 1.70 2002/05/19 11:33:20 jongfoster
210 * If a CGI error was not handled, and propogated back to
211 * dispatch_known_cgi(), then it was assumed to be "out of memory".
212 * This gave a very misleading error message.
214 * Now other errors will cause a simple message giving the error
215 * number and asking the user to report a bug.
218 * http://sourceforge.net/tracker/index.php?func=detail
219 * &aid=557905&group_id=11118&atid=111118
221 * Revision 1.69 2002/05/14 21:28:40 oes
222 * - Fixed add_help_link to link to the (now split) actions
223 * part of the config chapter
224 * - Renamed helplink export to actions-help-prefix
226 * Revision 1.68 2002/05/12 21:36:29 jongfoster
227 * Correcting function comments
229 * Revision 1.67 2002/04/30 12:02:07 oes
230 * Nit: updated a comment
232 * Revision 1.66 2002/04/26 18:32:57 jongfoster
233 * Fixing a memory leak on error
235 * Revision 1.65 2002/04/26 12:53:51 oes
236 * - New function add_help_link
237 * - default_exports now exports links to the user manual
238 * and a prefix for links into the config chapter
240 * Revision 1.64 2002/04/24 02:17:21 oes
241 * - Better descriptions for CGIs
242 * - Hide edit-actions, more shortcuts
243 * - Moved get_char_param, get_string_param and get_number_param here
246 * Revision 1.63 2002/04/15 19:06:43 jongfoster
249 * Revision 1.62 2002/04/10 19:59:46 jongfoster
250 * Fixes to #include in templates:
251 * - Didn't close main file if loading an included template fails.
252 * - I'm paranoid and want to disallow "#include /etc/passwd".
254 * Revision 1.61 2002/04/10 13:37:48 oes
255 * Made templates modular: template_load now recursive with max depth 1
257 * Revision 1.60 2002/04/08 20:50:25 swa
260 * Revision 1.59 2002/04/05 15:51:51 oes
261 * - added send-stylesheet CGI
262 * - bugfix: error-pages now get correct request protocol
264 * - kludged CGI descriptions and menu not to break JS syntax
266 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
267 * Fix Mac OSX compiler warnings
269 * Revision 1.57 2002/03/26 22:29:54 swa
270 * we have a new homepage!
272 * Revision 1.56 2002/03/24 17:50:46 jongfoster
273 * Fixing compile error if actions file editor disabled
275 * Revision 1.55 2002/03/24 16:55:06 oes
276 * Making GIF checkerboard transparent
278 * Revision 1.54 2002/03/24 16:18:15 jongfoster
281 * Revision 1.53 2002/03/24 16:06:00 oes
282 * Correct transparency for checkerboard PNG. Thanks, Magnus!
284 * Revision 1.52 2002/03/24 15:23:33 jongfoster
287 * Revision 1.51 2002/03/24 13:25:43 swa
288 * name change related issues
290 * Revision 1.50 2002/03/16 23:54:06 jongfoster
291 * Adding graceful termination feature, to help look for memory leaks.
292 * If you enable this (which, by design, has to be done by hand
293 * editing config.h) and then go to http://i.j.b/die, then the program
294 * will exit cleanly after the *next* request. It should free all the
295 * memory that was used.
297 * Revision 1.49 2002/03/13 00:27:04 jongfoster
300 * Revision 1.48 2002/03/08 17:47:07 jongfoster
303 * Revision 1.47 2002/03/08 16:41:33 oes
304 * Added GIF images again
306 * Revision 1.46 2002/03/07 03:48:38 oes
307 * - Changed built-in images from GIF to PNG
308 * (with regard to Unisys patent issue)
309 * - Added a 4x4 pattern PNG which is less intrusive
310 * than the logo but also clearly marks the deleted banners
312 * Revision 1.45 2002/03/06 22:54:35 jongfoster
313 * Automated function-comment nitpicking.
315 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
316 * - Better error reporting on OS/2
317 * - Fix double-slash comment (oops)
319 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
320 * - Re-enable OS/2 building after new parms were added
321 * - Fix false out of memory report when resolving CGI templates when no IP
322 * address is available of failed attempt (a la no such domain)
324 * Revision 1.42 2002/01/21 00:33:20 jongfoster
325 * Replacing strsav() with the safer string_append() or string_join().
326 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
327 * Adding missing html_encode() to error message generators.
328 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
330 * Revision 1.41 2002/01/17 20:56:22 jongfoster
331 * Replacing hard references to the URL of the config interface
332 * with #defines from project.h
334 * Revision 1.40 2002/01/09 14:26:46 oes
335 * Added support for thread-safe gmtime_r call.
337 * Revision 1.39 2001/11/16 00:48:13 jongfoster
338 * Fixing a compiler warning
340 * Revision 1.38 2001/11/13 00:31:21 jongfoster
341 * - Adding new CGIs for use by non-JavaScript browsers:
342 * edit-actions-url-form
343 * edit-actions-add-url-form
344 * edit-actions-remove-url-form
345 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
348 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
349 * Show enablement/disablement status in almost all templates.
350 * There is a little trickiness here: apparent recursive resolution of
351 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
352 * the actual enablement status. So a similar construct,
353 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
356 * Revision 1.36 2001/10/26 17:33:27 oes
359 * Revision 1.35 2001/10/23 21:48:19 jongfoster
360 * Cleaning up error handling in CGI functions - they now send back
361 * a HTML error page and should never cause a FATAL error. (Fixes one
362 * potential source of "denial of service" attacks).
364 * CGI actions file editor that works and is actually useful.
366 * Ability to toggle Junkbuster remotely using a CGI call.
368 * You can turn off both the above features in the main configuration
369 * file, e.g. if you are running a multi-user proxy.
371 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
372 * Only show "Local support" on templates conditionally:
373 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
374 * - if not, no Local support section appears
376 * Revision 1.33 2001/10/14 22:28:41 jongfoster
377 * Fixing stupid typo.
379 * Revision 1.32 2001/10/14 22:20:18 jongfoster
380 * - Changes to CGI dispatching method to match CGI names exactly,
381 * rather than doing a prefix match.
382 * - No longer need to count the length of the CGI handler names by hand.
383 * - Adding new handler for 404 error when disptching a CGI, if none of
384 * the handlers match.
385 * - Adding new handlers for CGI actionsfile editor.
387 * Revision 1.31 2001/10/10 10:56:39 oes
388 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
390 * Revision 1.30 2001/10/02 15:30:57 oes
391 * Introduced show-request cgi
393 * Revision 1.29 2001/09/20 15:47:44 steudten
395 * Fix BUG: Modify int size to size_t size in fill_template()
396 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
398 * Revision 1.28 2001/09/19 18:00:37 oes
399 * - Deletef time() FIXME (Can't fail under Linux either, if
400 * the argument is guaranteed to be in out address space,
403 * - Pointer notation cosmetics
404 * - Fixed a minor bug in template_fill(): Failiure of
405 * pcrs_execute() now secure.
407 * Revision 1.27 2001/09/16 17:08:54 jongfoster
408 * Moving simple CGI functions from cgi.c to new file cgisimple.c
410 * Revision 1.26 2001/09/16 15:47:37 jongfoster
411 * First version of CGI-based edit interface. This is very much a
412 * work-in-progress, and you can't actually use it to edit anything
413 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
414 * to have any effect.
416 * Revision 1.25 2001/09/16 15:02:35 jongfoster
417 * Adding i.j.b/robots.txt.
418 * Inlining add_stats() since it's only ever called from one place.
420 * Revision 1.24 2001/09/16 11:38:01 jongfoster
421 * Splitting fill_template() into 2 functions:
422 * template_load() loads the file
423 * template_fill() performs the PCRS regexps.
424 * This is because the CGI edit interface has a "table row"
425 * template which is used many times in the page - this
426 * change means it's only loaded from disk once.
428 * Revision 1.23 2001/09/16 11:16:05 jongfoster
429 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
431 * Revision 1.22 2001/09/16 11:00:10 jongfoster
432 * New function alloc_http_response, for symmetry with free_http_response
434 * Revision 1.21 2001/09/13 23:53:03 jongfoster
435 * Support for both static and dynamically generated CGI pages.
436 * Correctly setting Last-Modified: and Expires: HTTP headers.
438 * Revision 1.20 2001/09/13 23:40:36 jongfoster
439 * (Cosmetic only) Indentation correction
441 * Revision 1.19 2001/09/13 23:31:25 jongfoster
442 * Moving image data to cgi.c rather than cgi.h.
444 * Revision 1.18 2001/08/05 16:06:20 jongfoster
445 * Modifiying "struct map" so that there are now separate header and
446 * "map_entry" structures. This means that functions which modify a
447 * map no longer need to return a pointer to the modified map.
448 * Also, it no longer reverses the order of the entries (which may be
449 * important with some advanced template substitutions).
451 * Revision 1.17 2001/08/05 15:57:38 oes
452 * Adapted finish_http_response to new list_to_text
454 * Revision 1.16 2001/08/01 21:33:18 jongfoster
455 * Changes to fill_template() that reduce memory usage without having
456 * an impact on performance. I also renamed some variables so as not
457 * to clash with the C++ keywords "new" and "template".
459 * Revision 1.15 2001/08/01 21:19:22 jongfoster
460 * Moving file version information to a separate CGI page.
462 * Revision 1.14 2001/08/01 00:19:03 jongfoster
463 * New function: map_conditional() for an if-then-else syntax.
464 * Changing to use new version of show_defines()
466 * Revision 1.13 2001/07/30 22:08:36 jongfoster
467 * Tidying up #defines:
468 * - All feature #defines are now of the form FEATURE_xxx
469 * - Permanently turned off WIN_GUI_EDIT
470 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
472 * Revision 1.12 2001/07/29 18:47:05 jongfoster
473 * Adding missing #include "loadcfg.h"
475 * Revision 1.11 2001/07/18 17:24:37 oes
476 * Changed to conform to new pcrs interface
478 * Revision 1.10 2001/07/13 13:53:13 oes
479 * Removed all #ifdef PCRS and related code
481 * Revision 1.9 2001/06/29 21:45:41 oes
482 * Indentation, CRLF->LF, Tab-> Space
484 * Revision 1.8 2001/06/29 13:21:46 oes
485 * - Cosmetics: renamed and reordered functions, variables,
486 * texts, improved comments etc
488 * - Removed ij_untrusted_url() The relevant
489 * info is now part of the "untrusted" page,
490 * which is generated by filters.c:trust_url()
492 * - Generators of content now call finish_http_response()
493 * themselves, making jcc.c:chat() a little less
496 * - Removed obsolete "Pragma: no-cache" from our headers
498 * - http_responses now know their head length
500 * - fill_template now uses the new interface to pcrs, so that
501 * - long jobs (like whole files) no longer have to be assembled
502 * in a fixed size buffer
503 * - the new T (trivial) option is used, and the replacement may
504 * contain Perl syntax backrefs without confusing pcrs
506 * - Introduced default_exports() which generates a set of exports
507 * common to all CGIs and other content generators
509 * - Introduced convenience function map_block_killer()
511 * - Introduced convenience function make_menu()
513 * - Introduced CGI-like function error_response() which generates
514 * the "No such domain" and "Connect failed" messages using the
517 * - cgi_show_url_info:
518 * - adapted to new CGI features
519 * - form and answers now generated from same template
520 * - http:// prefix in URL now OK
523 * - adapted to new CGI features
524 * - no longer uses csp->init_proxy_args
527 * - moved menu generation to make_menu()
529 * - add_stats now writes single export map entries instead
532 * - Moved redirect_url() to filters.c
534 * - Fixed mem leak in free_http_response(), map_block_killer(),
536 * - Removed logentry from cancelled commit
538 * Revision 1.7 2001/06/09 10:51:58 jongfoster
539 * Changing "show URL info" handler to new style.
540 * Changing BUFSIZ ==> BUFFER_SIZE
542 * Revision 1.6 2001/06/07 23:05:19 jongfoster
543 * Removing code related to old forward and ACL files.
545 * Revision 1.5 2001/06/05 19:59:16 jongfoster
546 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
548 * Revision 1.4 2001/06/04 10:41:52 swa
549 * show version string of cgi.h and cgi.c
551 * Revision 1.3 2001/06/03 19:12:16 oes
552 * introduced new cgi handling
554 * No revisions before 1.3
556 **********************************************************************/
562 #include <sys/types.h>
570 #define snprintf _snprintf
571 #endif /* def _WIN32 */
580 #include "miscutil.h"
581 #include "cgisimple.h"
582 #ifdef FEATURE_CGI_EDIT_ACTIONS
584 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
586 /* loadcfg.h is for global_toggle_state only */
587 #ifdef FEATURE_PTHREAD
589 /* jcc.h is for mutex semaphore globals only */
590 #endif /* def FEATURE_PTHREAD */
591 const char cgi_h_rcs[] = CGI_H_VERSION;
594 * List of CGI functions: name, handler, description
595 * Note: Do NOT use single quotes in the description;
596 * this will break the dynamic "blocked" template!
598 static const struct cgi_dispatcher cgi_dispatchers[] = {
603 #ifdef FEATURE_GRACEFUL_TERMINATION
606 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
607 "this is a one click Denial Of Service attack!!!</em>",
612 #ifdef FEATURE_CGI_EDIT_ACTIONS
613 "View & change the current configuration",
615 "View the current configuration",
620 "View the source code version numbers",
624 "View the request headers.",
628 "Look up which actions apply to a URL and why",
630 #ifdef FEATURE_CGI_EDIT_ACTIONS
631 #ifdef FEATURE_TOGGLE
634 "Toggle Privoxy on or off",
636 #endif /* def FEATURE_TOGGLE */
637 { "edit-actions", /* Edit the actions list */
640 { "eaa", /* Shortcut for edit-actions-add-url-form */
641 cgi_edit_actions_add_url_form,
643 { "eau", /* Shortcut for edit-actions-url-form */
644 cgi_edit_actions_url_form,
646 { "ear", /* Shortcut for edit-actions-remove-url-form */
647 cgi_edit_actions_remove_url_form,
649 { "eal", /* Shortcut for edit-actions-list */
650 cgi_edit_actions_list,
652 { "eafu", /* Shortcut for edit-actions-for-url */
653 cgi_edit_actions_for_url,
655 { "eas", /* Shortcut for edit-actions-submit */
656 cgi_edit_actions_submit,
658 { "easa", /* Shortcut for edit-actions-section-add */
659 cgi_edit_actions_section_add,
661 { "easr", /* Shortcut for edit-actions-section-remove */
662 cgi_edit_actions_section_remove,
664 { "eass", /* Shortcut for edit-actions-section-swap */
665 cgi_edit_actions_section_swap,
667 { "edit-actions-for-url",
668 cgi_edit_actions_for_url,
669 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
670 { "edit-actions-list",
671 cgi_edit_actions_list,
672 NULL, TRUE /* Edit the actions list */ },
673 { "edit-actions-submit",
674 cgi_edit_actions_submit,
675 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
676 { "edit-actions-url",
677 cgi_edit_actions_url,
678 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
679 { "edit-actions-url-form",
680 cgi_edit_actions_url_form,
681 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
682 { "edit-actions-add-url",
683 cgi_edit_actions_add_url,
684 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
685 { "edit-actions-add-url-form",
686 cgi_edit_actions_add_url_form,
687 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
688 { "edit-actions-remove-url",
689 cgi_edit_actions_remove_url,
690 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
691 { "edit-actions-remove-url-form",
692 cgi_edit_actions_remove_url_form,
693 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
694 { "edit-actions-section-add",
695 cgi_edit_actions_section_add,
696 NULL, FALSE /* Remove a section from the actionsfile */ },
697 { "edit-actions-section-remove",
698 cgi_edit_actions_section_remove,
699 NULL, FALSE /* Remove a section from the actionsfile */ },
700 { "edit-actions-section-swap",
701 cgi_edit_actions_section_swap,
702 NULL, FALSE /* Swap two sections in the actionsfile */ },
703 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
704 { "error-favicon.ico",
705 cgi_send_error_favicon,
706 NULL, TRUE /* Sends the favicon image for error pages. */ },
708 cgi_send_default_favicon,
709 NULL, TRUE /* Sends the default favicon image. */ },
712 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
715 NULL, TRUE /* Send a built-in image */ },
718 NULL, FALSE /* Send templates/cgi-style.css */ },
720 cgi_transparent_image,
721 NULL, TRUE /* Send a transparent image (short name) */ },
723 cgi_send_user_manual,
724 NULL, TRUE /* Send user-manual */ },
725 { NULL, /* NULL Indicates end of list and default page */
727 NULL, TRUE /* Unknown CGI page */ }
732 * Built-in images for ad replacement
734 * Hint: You can encode your own images like this:
735 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
738 #ifdef FEATURE_NO_GIFS
741 * Checkerboard pattern, as a PNG.
743 const char image_pattern_data[] =
744 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
745 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
746 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
747 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
748 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
749 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
750 "\000\000\000\111\105\116\104\256\102\140\202";
753 * 1x1 transparant PNG.
755 const char image_blank_data[] =
756 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
757 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
758 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
759 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
760 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
761 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
762 "\000\000\000\000\111\105\116\104\256\102\140\202";
766 * Checkerboard pattern, as a GIF.
768 const char image_pattern_data[] =
769 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
770 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
771 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
772 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
776 * 1x1 transparant GIF.
778 const char image_blank_data[] =
779 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
780 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
781 "\000\001\000\000\002\002D\001\000;";
784 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
785 const size_t image_blank_length = sizeof(image_blank_data) - 1;
788 static struct http_response cgi_error_memory_response[1];
790 static struct http_response *dispatch_known_cgi(struct client_state * csp,
792 static struct map *parse_cgi_parameters(char *argstring);
795 /*********************************************************************
797 * Function : dispatch_cgi
799 * Description : Checks if a request URL has either the magical
800 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
801 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
802 * http://config.privoxy.org/). If so, it passes
803 * the (rest of the) path onto dispatch_known_cgi, which
804 * calls the relevant CGI handler function.
807 * 1 : csp = Current client state (buffers, headers, etc...)
809 * Returns : http_response if match, NULL if nonmatch or handler fail
811 *********************************************************************/
812 struct http_response *dispatch_cgi(struct client_state *csp)
814 const char *host = csp->http->host;
815 const char *path = csp->http->path;
818 * Should we intercept ?
821 /* Note: "example.com" and "example.com." are equivalent hostnames. */
823 /* Either the host matches CGI_SITE_1_HOST ..*/
824 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
825 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
826 && (path[0] == '/') )
828 /* ..then the path will all be for us. Remove leading '/' */
831 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
832 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
833 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
834 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
836 /* take everything following CGI_SITE_2_PATH */
837 path += strlen(CGI_SITE_2_PATH);
840 /* skip the forward slash after CGI_SITE_2_PATH */
843 else if (*path != '\0')
846 * weirdness: URL is /configXXX, where XXX is some string
847 * Do *NOT* intercept.
859 * This is a CGI call.
862 return dispatch_known_cgi(csp, path);
866 /*********************************************************************
868 * Function : grep_cgi_referrer
870 * Description : Ugly provisorical fix that greps the value of the
871 * referer HTTP header field out of a linked list of
872 * strings like found at csp->headers. Will disappear
875 * FIXME: csp->headers ought to be csp->http->headers
876 * FIXME: Parsing all client header lines should
877 * happen right after the request is received!
880 * 1 : csp = Current client state (buffers, headers, etc...)
882 * Returns : pointer to value (no copy!), or NULL if none found.
884 *********************************************************************/
885 char *grep_cgi_referrer(const struct client_state *csp)
887 struct list_entry *p;
889 for (p = csp->headers->first; p != NULL; p = p->next)
891 if (p->str == NULL) continue;
892 if (strncmpic(p->str, "Referer: ", 9) == 0)
894 return ((p->str) + 9);
902 /*********************************************************************
904 * Function : referrer_is_safe
906 * Description : Decides whether we trust the Referer for
907 * CGI pages which are only meant to be reachable
908 * through Privoxy's web interface directly.
911 * 1 : csp = Current client state (buffers, headers, etc...)
913 * Returns : TRUE if the referrer is safe, or
914 * FALSE if the referrer is unsafe or not set.
916 *********************************************************************/
917 int referrer_is_safe (const struct client_state *csp)
920 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
922 referrer = grep_cgi_referrer(csp);
924 if (NULL == referrer)
926 /* No referrer, no access */
927 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
930 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
931 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
933 /* Trustworthy referrer */
934 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
935 csp->http->url, referrer);
941 /* Untrustworthy referrer */
942 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
943 csp->http->url, referrer);
950 /*********************************************************************
952 * Function : dispatch_known_cgi
954 * Description : Processes a CGI once dispatch_cgi has determined that
955 * it matches one of the magic prefixes. Parses the path
956 * as a cgi name plus query string, prepares a map that
957 * maps CGI parameter names to their values, initializes
958 * the http_response struct, and calls the relevant CGI
962 * 1 : csp = Current client state (buffers, headers, etc...)
963 * 2 : path = Path of CGI, with the CGI prefix removed.
964 * Should not have a leading "/".
966 * Returns : http_response, or NULL on handler failure or out of
969 *********************************************************************/
970 static struct http_response *dispatch_known_cgi(struct client_state * csp,
973 const struct cgi_dispatcher *d;
974 struct map *param_list;
975 struct http_response *rsp;
976 char *query_args_start;
980 if (NULL == (path_copy = strdup(path)))
982 return cgi_error_memory();
984 query_args_start = path_copy;
985 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
989 if (*query_args_start == '/')
991 *query_args_start++ = '\0';
992 if ((param_list = new_map()))
994 map(param_list, "file", 1, url_decode(query_args_start), 0);
999 if (*query_args_start == '?')
1001 *query_args_start++ = '\0';
1003 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1006 return cgi_error_memory();
1012 * path_copy = CGI call name
1013 * param_list = CGI params, as map
1016 /* Get mem for response or fail*/
1017 if (NULL == (rsp = alloc_http_response()))
1020 free_map(param_list);
1021 return cgi_error_memory();
1025 * Find and start the right CGI function
1027 d = cgi_dispatchers;
1030 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1033 * If the called CGI is either harmless, or referred
1034 * from a trusted source, start it.
1036 if (d->harmless || referrer_is_safe(csp))
1038 err = (d->handler)(csp, rsp, param_list);
1043 * Else, modify toggle calls so that they only display
1044 * the status, and deny all other calls.
1046 if (0 == strcmp(path_copy, "toggle"))
1048 unmap(param_list, "set");
1049 err = (d->handler)(csp, rsp, param_list);
1053 err = cgi_error_disabled(csp, rsp);
1058 free_map(param_list);
1060 if (err == JB_ERR_CGI_PARAMS)
1062 err = cgi_error_bad_param(csp, rsp);
1064 if (err && (err != JB_ERR_MEMORY))
1066 /* Unexpected error! Shouldn't get here */
1067 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1068 err = cgi_error_unknown(csp, rsp, err);
1073 rsp->reason = RSP_REASON_CGI_CALL;
1074 return finish_http_response(csp, rsp);
1078 /* Error in handler, probably out-of-memory */
1079 free_http_response(rsp);
1080 return cgi_error_memory();
1088 /*********************************************************************
1090 * Function : parse_cgi_parameters
1092 * Description : Parse a URL-encoded argument string into name/value
1093 * pairs and store them in a struct map list.
1096 * 1 : argstring = string to be parsed. Will be trashed.
1098 * Returns : pointer to param list, or NULL if out of memory.
1100 *********************************************************************/
1101 static struct map *parse_cgi_parameters(char *argstring)
1104 char *vector[BUFFER_SIZE];
1106 struct map *cgi_params;
1108 if (NULL == (cgi_params = new_map()))
1114 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1115 * the fragment identifier along with the request, so we must
1116 * cut it off here, so it won't pollute the CGI params:
1118 if (NULL != (p = strchr(argstring, '#')))
1123 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1125 for (i = 0; i < pairs; i++)
1127 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1130 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1132 free_map(cgi_params);
1143 /*********************************************************************
1145 * Function : get_char_param
1147 * Description : Get a single-character parameter passed to a CGI
1151 * 1 : parameters = map of cgi parameters
1152 * 2 : param_name = The name of the parameter to read
1154 * Returns : Uppercase character on success, '\0' on error.
1156 *********************************************************************/
1157 char get_char_param(const struct map *parameters,
1158 const char *param_name)
1165 ch = *(lookup(parameters, param_name));
1166 if ((ch >= 'a') && (ch <= 'z'))
1168 ch = (char)(ch - 'a' + 'A');
1175 /*********************************************************************
1177 * Function : get_string_param
1179 * Description : Get a string paramater, to be used as an
1180 * ACTION_STRING or ACTION_MULTI paramater.
1181 * Validates the input to prevent stupid/malicious
1182 * users from corrupting their action file.
1185 * 1 : parameters = map of cgi parameters
1186 * 2 : param_name = The name of the parameter to read
1187 * 3 : pparam = destination for paramater. Allocated as
1188 * part of the map "parameters", so don't free it.
1189 * Set to NULL if not specified.
1191 * Returns : JB_ERR_OK on success, or if the paramater
1192 * was not specified.
1193 * JB_ERR_MEMORY on out-of-memory.
1194 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1196 *********************************************************************/
1197 jb_err get_string_param(const struct map *parameters,
1198 const char *param_name,
1199 const char **pparam)
1211 param = lookup(parameters, param_name);
1217 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1222 * Note that the length limit is arbitrary, it just seems
1223 * sensible to limit it to *something*. There's no
1224 * technical reason for any limit at all.
1226 return JB_ERR_CGI_PARAMS;
1229 /* Check every character to see if it's legal */
1231 while ((ch = *s++) != '\0')
1233 if ( ((unsigned char)ch < (unsigned char)' ')
1236 /* Probable hack attempt, or user accidentally used '}'. */
1237 return JB_ERR_CGI_PARAMS;
1248 /*********************************************************************
1250 * Function : get_number_param
1252 * Description : Get a non-negative integer from the parameters
1253 * passed to a CGI function.
1256 * 1 : csp = Current client state (buffers, headers, etc...)
1257 * 2 : parameters = map of cgi parameters
1258 * 3 : name = Name of CGI parameter to read
1259 * 4 : pvalue = destination for value.
1260 * Set to -1 on error.
1262 * Returns : JB_ERR_OK on success
1263 * JB_ERR_MEMORY on out-of-memory
1264 * JB_ERR_CGI_PARAMS if the parameter was not specified
1267 *********************************************************************/
1268 jb_err get_number_param(struct client_state *csp,
1269 const struct map *parameters,
1284 param = lookup(parameters, name);
1287 return JB_ERR_CGI_PARAMS;
1290 /* We don't use atoi because I want to check this carefully... */
1293 while ((ch = *param++) != '\0')
1295 if ((ch < '0') || (ch > '9'))
1297 return JB_ERR_CGI_PARAMS;
1300 ch = (char)(ch - '0');
1304 * <limits.h> defines UINT_MAX
1306 * (UINT_MAX - ch) / 10 is the largest number that
1307 * can be safely multiplied by 10 then have ch added.
1309 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1311 return JB_ERR_CGI_PARAMS;
1314 value = value * 10 + (unsigned)ch;
1325 /*********************************************************************
1327 * Function : error_response
1329 * Description : returns an http_response that explains the reason
1330 * why a request failed.
1333 * 1 : csp = Current client state (buffers, headers, etc...)
1334 * 2 : templatename = Which template should be used for the answer
1335 * 3 : sys_err = system error number
1337 * Returns : A http_response. If we run out of memory, this
1338 * will be cgi_error_memory().
1340 *********************************************************************/
1341 struct http_response *error_response(struct client_state *csp,
1342 const char *templatename,
1346 struct http_response *rsp;
1347 struct map *exports = default_exports(csp, NULL);
1350 if (exports == NULL)
1352 return cgi_error_memory();
1355 if (NULL == (rsp = alloc_http_response()))
1358 return cgi_error_memory();
1361 #ifdef FEATURE_FORCE_LOAD
1362 if (csp->flags & CSP_FLAG_FORCED)
1364 path = strdup(FORCE_PREFIX);
1367 #endif /* def FEATURE_FORCE_LOAD */
1371 err = string_append(&path, csp->http->path);
1373 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1374 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1375 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1376 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1377 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1380 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1383 /* Some failures, like "404 no such domain", don't have an IP address. */
1384 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1392 free_http_response(rsp);
1393 return cgi_error_memory();
1396 if (!strcmp(templatename, "no-such-domain"))
1398 rsp->status = strdup("404 No such domain");
1399 if (rsp->status == NULL)
1402 free_http_response(rsp);
1403 return cgi_error_memory();
1405 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1407 else if (!strcmp(templatename, "forwarding-failed"))
1409 const struct forward_spec * fwd = forward_url(csp->http, csp);
1412 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1413 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1417 * XXX: While the template is called forwarding-failed,
1418 * it currently only handles socks forwarding failures.
1420 assert(fwd->type != SOCKS_NONE);
1423 * Map failure reason, forwarding type and forwarder.
1425 if (NULL == csp->error_message)
1428 * Either we forgot to record the failure reason,
1429 * or the memory allocation failed.
1431 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1432 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1434 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1435 if (!err) map(exports, "forwarding-type", 1, (fwd->type == SOCKS_4) ?
1436 "socks4-" : "socks4a-", 1);
1437 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1439 if (!err) rsp->status = strdup("503 Forwarding failure");
1440 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1443 free_http_response(rsp);
1444 return cgi_error_memory();
1446 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1448 else if (!strcmp(templatename, "connect-failed"))
1450 rsp->status = strdup("503 Connect failed");
1451 if (rsp->status == NULL)
1454 free_http_response(rsp);
1455 return cgi_error_memory();
1457 rsp->reason = RSP_REASON_CONNECT_FAILED;
1460 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1463 free_http_response(rsp);
1464 return cgi_error_memory();
1467 return finish_http_response(csp, rsp);
1471 /*********************************************************************
1473 * Function : cgi_error_disabled
1475 * Description : CGI function that is called to generate an error
1476 * response if the actions editor or toggle CGI are
1477 * accessed despite having being disabled at compile-
1478 * or run-time, or if the user followed an untrusted link
1479 * to access a unsafe CGI feature that is only reachable
1480 * through Privoxy directly.
1483 * 1 : csp = Current client state (buffers, headers, etc...)
1484 * 2 : rsp = http_response data structure for output
1486 * CGI Parameters : none
1488 * Returns : JB_ERR_OK on success
1489 * JB_ERR_MEMORY on out-of-memory error.
1491 *********************************************************************/
1492 jb_err cgi_error_disabled(struct client_state *csp,
1493 struct http_response *rsp)
1495 struct map *exports;
1500 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1502 return JB_ERR_MEMORY;
1504 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1506 /* Not important enough to do anything */
1507 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1510 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1514 /*********************************************************************
1516 * Function : cgi_init_error_messages
1518 * Description : Call at the start of the program to initialize
1519 * the error message used by cgi_error_memory().
1525 *********************************************************************/
1526 void cgi_init_error_messages(void)
1528 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1529 cgi_error_memory_response->head =
1530 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1531 "Content-Type: text/html\r\n"
1533 cgi_error_memory_response->body =
1536 " <title>500 Internal Privoxy Error</title>\r\n"
1537 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1540 "<h1>500 Internal Privoxy Error</h1>\r\n"
1541 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1542 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1546 cgi_error_memory_response->head_length =
1547 strlen(cgi_error_memory_response->head);
1548 cgi_error_memory_response->content_length =
1549 strlen(cgi_error_memory_response->body);
1550 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1554 /*********************************************************************
1556 * Function : cgi_error_memory
1558 * Description : Called if a CGI function runs out of memory.
1559 * Returns a statically-allocated error response.
1563 * Returns : http_response data structure for output. This is
1564 * statically allocated, for obvious reasons.
1566 *********************************************************************/
1567 struct http_response *cgi_error_memory(void)
1569 /* assert that it's been initialized. */
1570 assert(cgi_error_memory_response->head);
1572 return cgi_error_memory_response;
1576 /*********************************************************************
1578 * Function : cgi_error_no_template
1580 * Description : Almost-CGI function that is called if a template
1581 * cannot be loaded. Note this is not a true CGI,
1582 * it takes a template name rather than a map of
1586 * 1 : csp = Current client state (buffers, headers, etc...)
1587 * 2 : rsp = http_response data structure for output
1588 * 3 : template_name = Name of template that could not
1591 * Returns : JB_ERR_OK on success
1592 * JB_ERR_MEMORY on out-of-memory error.
1594 *********************************************************************/
1595 jb_err cgi_error_no_template(struct client_state *csp,
1596 struct http_response *rsp,
1597 const char *template_name)
1599 static const char status[] =
1600 "500 Internal Privoxy Error";
1601 static const char body_prefix[] =
1604 " <title>500 Internal Privoxy Error</title>\r\n"
1605 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1608 "<h1>500 Internal Privoxy Error</h1>\r\n"
1609 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1610 "<p><b>Could not load template file <code>";
1611 static const char body_suffix[] =
1612 "</code> or one of it's included components.</b></p>\r\n"
1613 "<p>Please contact your proxy administrator.</p>\r\n"
1614 "<p>If you are the proxy administrator, please put the required file(s)"
1615 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1616 "location of the <code><i>(confdir)</i></code> directory "
1617 "is specified in the main Privoxy <code>config</code> "
1618 "file. (It's typically the Privoxy install directory"
1620 ", or <code>/etc/privoxy/</code>"
1621 #endif /* ndef _WIN32 */
1628 assert(template_name);
1630 /* Reset rsp, if needed */
1634 rsp->content_length = 0;
1635 rsp->head_length = 0;
1638 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1639 if (rsp->body == NULL)
1641 return JB_ERR_MEMORY;
1643 strcpy(rsp->body, body_prefix);
1644 strcat(rsp->body, template_name);
1645 strcat(rsp->body, body_suffix);
1647 rsp->status = strdup(status);
1648 if (rsp->status == NULL)
1650 return JB_ERR_MEMORY;
1657 /*********************************************************************
1659 * Function : cgi_error_unknown
1661 * Description : Almost-CGI function that is called if an unexpected
1662 * error occurs in the top-level CGI dispatcher.
1663 * In this context, "unexpected" means "anything other
1664 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1665 * expected to handle all other errors internally,
1666 * since they can give more relavent error messages
1669 * Note this is not a true CGI, it takes an error
1670 * code rather than a map of parameters.
1673 * 1 : csp = Current client state (buffers, headers, etc...)
1674 * 2 : rsp = http_response data structure for output
1675 * 3 : error_to_report = Error code to report.
1677 * Returns : JB_ERR_OK on success
1678 * JB_ERR_MEMORY on out-of-memory error.
1680 *********************************************************************/
1681 jb_err cgi_error_unknown(struct client_state *csp,
1682 struct http_response *rsp,
1683 jb_err error_to_report)
1685 static const char status[] =
1686 "500 Internal Privoxy Error";
1687 static const char body_prefix[] =
1690 " <title>500 Internal Privoxy Error</title>\r\n"
1691 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1694 "<h1>500 Internal Privoxy Error</h1>\r\n"
1695 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1696 "<p><b>Unexpected internal error: ";
1697 static const char body_suffix[] =
1700 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1701 "file a bug report</a>.</p>\r\n"
1708 /* Reset rsp, if needed */
1712 rsp->content_length = 0;
1713 rsp->head_length = 0;
1715 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1717 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1719 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1720 if (rsp->body == NULL)
1722 return JB_ERR_MEMORY;
1724 strcpy(rsp->body, body_prefix);
1725 strcat(rsp->body, errnumbuf);
1726 strcat(rsp->body, body_suffix);
1728 rsp->status = strdup(status);
1729 if (rsp->status == NULL)
1731 return JB_ERR_MEMORY;
1738 /*********************************************************************
1740 * Function : cgi_error_bad_param
1742 * Description : CGI function that is called if the parameters
1743 * (query string) for a CGI were wrong.
1746 * 1 : csp = Current client state (buffers, headers, etc...)
1747 * 2 : rsp = http_response data structure for output
1749 * CGI Parameters : none
1751 * Returns : JB_ERR_OK on success
1752 * JB_ERR_MEMORY on out-of-memory error.
1754 *********************************************************************/
1755 jb_err cgi_error_bad_param(struct client_state *csp,
1756 struct http_response *rsp)
1758 struct map *exports;
1763 if (NULL == (exports = default_exports(csp, NULL)))
1765 return JB_ERR_MEMORY;
1768 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1772 /*********************************************************************
1774 * Function : cgi_redirect
1776 * Description : CGI support function to generate a HTTP redirect
1780 * 1 : rsp = http_response data structure for output
1781 * 2 : target = string with the target URL
1783 * CGI Parameters : None
1785 * Returns : JB_ERR_OK on success
1786 * JB_ERR_MEMORY on out-of-memory error.
1788 *********************************************************************/
1789 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1796 err = enlist_unique_header(rsp->headers, "Location", target);
1798 rsp->status = strdup("302 Local Redirect from Privoxy");
1799 if (rsp->status == NULL)
1801 return JB_ERR_MEMORY;
1808 /*********************************************************************
1810 * Function : add_help_link
1812 * Description : Produce a copy of the string given as item,
1813 * embedded in an HTML link to its corresponding
1814 * section (item name in uppercase) in the actions
1815 * chapter of the user manual, (whose URL is given in
1816 * the config and defaults to our web site).
1818 * FIXME: I currently only work for actions, and would
1819 * like to be generalized for other topics.
1822 * 1 : item = item (will NOT be free()d.)
1823 * It is assumed to be HTML-safe.
1824 * 2 : config = The current configuration.
1826 * Returns : String with item embedded in link, or NULL on
1829 *********************************************************************/
1830 char *add_help_link(const char *item,
1831 struct configuration_spec *config)
1835 if (!item) return NULL;
1837 result = strdup("<a href=\"");
1838 if (!strncmpic(config->usermanual, "file://", 7) ||
1839 !strncmpic(config->usermanual, "http", 4))
1841 string_append(&result, config->usermanual);
1845 string_append(&result, "http://");
1846 string_append(&result, CGI_SITE_2_HOST);
1847 string_append(&result, "/user-manual/");
1849 string_append(&result, ACTIONS_HELP_PREFIX);
1850 string_join (&result, string_toupper(item));
1851 string_append(&result, "\">");
1852 string_append(&result, item);
1853 string_append(&result, "</a> ");
1859 /*********************************************************************
1861 * Function : get_http_time
1863 * Description : Get the time in a format suitable for use in a
1864 * HTTP header - e.g.:
1865 * "Sun, 06 Nov 1994 08:49:37 GMT"
1868 * 1 : time_offset = Time returned will be current time
1869 * plus this number of seconds.
1870 * 2 : buf = Destination for result. Must be long enough
1871 * to hold 29 characters plus a trailing zero.
1875 *********************************************************************/
1876 void get_http_time(int time_offset, char *buf)
1878 static const char day_names[7][4] =
1879 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1880 static const char month_names[12][4] =
1881 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1882 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1885 time_t current_time;
1886 #if defined(HAVE_GMTIME_R)
1888 * Declare dummy up here (instead of inside get/set gmt block) so it
1889 * doesn't go out of scope before it's potentially used in snprintf later.
1890 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1891 * !defined HAVE_GMTIME_R.
1898 time(¤t_time); /* get current time */
1900 current_time += time_offset;
1902 /* get and save the gmt */
1905 t = gmtime_r(¤t_time, &dummy);
1906 #elif FEATURE_PTHREAD
1907 pthread_mutex_lock(&gmtime_mutex);
1908 t = gmtime(¤t_time);
1909 pthread_mutex_unlock(&gmtime_mutex);
1911 t = gmtime(¤t_time);
1915 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1917 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1918 day_names[t->tm_wday],
1920 month_names[t->tm_mon],
1930 /*********************************************************************
1932 * Function : finish_http_response
1934 * Description : Fill in the missing headers in an http response,
1935 * and flatten the headers to an http head.
1936 * For HEAD requests the body is freed once
1937 * the Content-Length header is set.
1940 * 1 : rsp = pointer to http_response to be processed
1942 * Returns : A http_response, usually the rsp parameter.
1943 * On error, free()s rsp and returns cgi_error_memory()
1945 *********************************************************************/
1946 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
1948 char buf[BUFFER_SIZE];
1951 /* Special case - do NOT change this statically allocated response,
1952 * which is ready for output anyway.
1954 if (rsp == cgi_error_memory_response)
1960 * Fill in the HTTP Status
1962 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1963 err = enlist_first(rsp->headers, buf);
1966 * Set the Content-Length
1968 if (rsp->content_length == 0)
1970 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1974 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1975 err = enlist(rsp->headers, buf);
1978 if (0 == strcmpic(csp->http->gpc, "head"))
1981 * The client only asked for the head. Dispose
1982 * the body and log an offensive message.
1984 * While it may seem to be a bit inefficient to
1985 * prepare the body if it isn't needed, it's the
1986 * only way to get the Content-Length right for
1987 * dynamic pages. We could have disposed the body
1988 * earlier, but not without duplicating the
1989 * Content-Length setting code above.
1991 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
1993 rsp->content_length = 0;
1996 if (strncmpic(rsp->status, "302", 3))
1999 * If it's not a redirect without any content,
2000 * set the Content-Type to text/html if it's
2001 * not already specified.
2003 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2007 * Fill in the rest of the default headers:
2009 * Date: set to current date/time.
2010 * Last-Modified: set to date/time the page was last changed.
2011 * Expires: set to date/time page next needs reloading.
2012 * Cache-Control: set to "no-cache" if applicable.
2014 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2019 * Set Expires to about 10 min into the future so it'll get reloaded
2020 * occasionally, e.g. if Privoxy gets upgraded.
2025 get_http_time(0, buf);
2026 err = enlist_unique_header(rsp->headers, "Date", buf);
2029 /* Some date in the past. */
2030 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2034 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2035 err = enlist_unique_header(rsp->headers, "Expires", buf);
2038 else if (!strncmpic(rsp->status, "302", 3))
2040 get_http_time(0, buf);
2041 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2046 * Setting "Cache-Control" to "no-cache" and "Expires" to
2047 * the current time doesn't exactly forbid caching, it just
2048 * requires the client to revalidate the cached copy.
2050 * If a temporary problem occurs and the user tries again after
2051 * getting Privoxy's error message, a compliant browser may set the
2052 * If-Modified-Since header with the content of the error page's
2053 * Last-Modified header. More often than not, the document on the server
2054 * is older than Privoxy's error message, the server would send status code
2055 * 304 and the browser would display the outdated error message again and again.
2057 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2058 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2059 * and can be safely used to "revalidate" without getting a status code 304.
2061 * There is no need to let the useless If-Modified-Since header reach the
2062 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2064 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2066 get_http_time(0, buf);
2067 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2068 if (!strncmpic(rsp->status, "403", 3)
2069 || !strncmpic(rsp->status, "404", 3)
2070 || !strncmpic(rsp->status, "503", 3))
2072 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2076 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2078 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2079 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2085 * HTTP/1.1 applications that do not support persistent connections MUST
2086 * include the "close" connection option in every message.
2088 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2093 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2095 free_http_response(rsp);
2096 return cgi_error_memory();
2098 rsp->head_length = strlen(rsp->head);
2105 /*********************************************************************
2107 * Function : alloc_http_response
2109 * Description : Allocates a new http_response structure.
2113 * Returns : pointer to a new http_response, or NULL.
2115 *********************************************************************/
2116 struct http_response *alloc_http_response(void)
2118 return (struct http_response *) zalloc(sizeof(struct http_response));
2123 /*********************************************************************
2125 * Function : free_http_response
2127 * Description : Free the memory occupied by an http_response
2128 * and its depandant structures.
2131 * 1 : rsp = pointer to http_response to be freed
2135 *********************************************************************/
2136 void free_http_response(struct http_response *rsp)
2139 * Must special case cgi_error_memory_response, which is never freed.
2141 if (rsp && (rsp != cgi_error_memory_response))
2146 destroy_list(rsp->headers);
2153 /*********************************************************************
2155 * Function : template_load
2157 * Description : CGI support function that loads a given HTML
2158 * template, ignoring comment lines and following
2159 * #include statements up to a depth of 1.
2162 * 1 : csp = Current client state (buffers, headers, etc...)
2163 * 2 : template_ptr = Destination for pointer to loaded
2165 * 3 : templatename = name of the HTML template to be used
2166 * 4 : recursive = Flag set if this function calls itself
2167 * following an #include statament
2169 * Returns : JB_ERR_OK on success
2170 * JB_ERR_MEMORY on out-of-memory error.
2171 * JB_ERR_FILE if the template file cannot be read
2173 *********************************************************************/
2174 jb_err template_load(struct client_state *csp, char **template_ptr,
2175 const char *templatename, int recursive)
2178 char *templates_dir_path;
2181 char *included_module;
2184 char buf[BUFFER_SIZE];
2187 assert(template_ptr);
2188 assert(templatename);
2190 *template_ptr = NULL;
2192 /* Validate template name. Paranoia. */
2193 for (p = templatename; *p != 0; p++)
2195 if ( ((*p < 'a') || (*p > 'z'))
2196 && ((*p < 'A') || (*p > 'Z'))
2197 && ((*p < '0') || (*p > '9'))
2201 /* Illegal character */
2207 * Generate full path using either templdir
2208 * or confdir/templates as base directory.
2210 if (NULL != csp->config->templdir)
2212 templates_dir_path = strdup(csp->config->templdir);
2216 templates_dir_path = make_path(csp->config->confdir, "templates");
2219 if (templates_dir_path == NULL)
2221 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2223 return JB_ERR_MEMORY;
2226 full_path = make_path(templates_dir_path, templatename);
2227 free(templates_dir_path);
2228 if (full_path == NULL)
2230 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2232 return JB_ERR_MEMORY;
2235 /* Allocate buffer */
2237 file_buffer = strdup("");
2238 if (file_buffer == NULL)
2240 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2242 return JB_ERR_MEMORY;
2245 /* Open template file */
2247 if (NULL == (fp = fopen(full_path, "r")))
2249 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2257 * Read the file, ignoring comments, and honoring #include
2258 * statements, unless we're already called recursively.
2260 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2261 * This is unlikely in practise.
2263 while (fgets(buf, BUFFER_SIZE, fp))
2265 if (!recursive && !strncmp(buf, "#include ", 9))
2267 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2274 if (string_join(&file_buffer, included_module))
2277 return JB_ERR_MEMORY;
2283 /* skip lines starting with '#' */
2289 if (string_append(&file_buffer, buf))
2292 return JB_ERR_MEMORY;
2297 *template_ptr = file_buffer;
2303 /*********************************************************************
2305 * Function : template_fill
2307 * Description : CGI support function that fills in a pre-loaded
2308 * HTML template by replacing @name@ with value using
2309 * pcrs, for each item in the output map.
2311 * Note that a leading '$' charachter in the export map's
2312 * values will be stripped and toggle on backreference
2316 * 1 : template_ptr = IN: Template to be filled out.
2318 * OUT: Filled out template.
2319 * Caller must free().
2320 * 2 : exports = map with fill in symbol -> name pairs
2322 * Returns : JB_ERR_OK on success (and for uncritical errors)
2323 * JB_ERR_MEMORY on out-of-memory error
2325 *********************************************************************/
2326 jb_err template_fill(char **template_ptr, const struct map *exports)
2328 struct map_entry *m;
2330 char buf[BUFFER_SIZE];
2331 char *tmp_out_buffer;
2337 assert(template_ptr);
2338 assert(*template_ptr);
2341 file_buffer = *template_ptr;
2342 size = strlen(file_buffer) + 1;
2345 * Assemble pcrs joblist from exports map
2347 for (m = exports->first; m != NULL; m = m->next)
2349 if (*m->name == '$')
2352 * First character of name is '$', so remove this flag
2353 * character and allow backreferences ($1 etc) in the
2354 * "replace with" text.
2356 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2362 * Treat the "replace with" text as a literal string -
2363 * no quoting needed, no backreferences allowed.
2364 * ("Trivial" ['T'] flag).
2368 /* Enclose name in @@ */
2369 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2373 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2375 /* Make and run job. */
2376 job = pcrs_compile(buf, m->value, flags, &error);
2379 if (error == PCRS_ERR_NOMEM)
2382 *template_ptr = NULL;
2383 return JB_ERR_MEMORY;
2387 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2388 /* Hope it wasn't important and silently ignore the invalid job */
2393 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2396 if (NULL == tmp_out_buffer)
2398 *template_ptr = NULL;
2399 return JB_ERR_MEMORY;
2405 * Substitution failed, keep the original buffer,
2406 * log the problem and ignore it.
2408 * The user might see some unresolved @CGI_VARIABLES@,
2409 * but returning a special CGI error page seems unreasonable
2410 * and could mask more important error messages.
2412 free(tmp_out_buffer);
2413 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2414 buf, m->value, flags, pcrs_strerror(error));
2418 /* Substitution succeeded, use modified buffer. */
2420 file_buffer = tmp_out_buffer;
2428 *template_ptr = file_buffer;
2433 /*********************************************************************
2435 * Function : template_fill_for_cgi
2437 * Description : CGI support function that loads a HTML template
2438 * and fills it in. Handles file-not-found errors
2439 * by sending a HTML error message. For convenience,
2440 * this function also frees the passed "exports" map.
2443 * 1 : csp = Client state
2444 * 2 : templatename = name of the HTML template to be used
2445 * 3 : exports = map with fill in symbol -> name pairs.
2446 * Will be freed by this function.
2447 * 4 : rsp = Response structure to fill in.
2449 * Returns : JB_ERR_OK on success
2450 * JB_ERR_MEMORY on out-of-memory error
2452 *********************************************************************/
2453 jb_err template_fill_for_cgi(struct client_state *csp,
2454 const char *templatename,
2455 struct map *exports,
2456 struct http_response *rsp)
2461 assert(templatename);
2465 err = template_load(csp, &rsp->body, templatename, 0);
2466 if (err == JB_ERR_FILE)
2469 return cgi_error_no_template(csp, rsp, templatename);
2474 return err; /* JB_ERR_MEMORY */
2476 err = template_fill(&rsp->body, exports);
2482 /*********************************************************************
2484 * Function : default_exports
2486 * Description : returns a struct map list that contains exports
2487 * which are common to all CGI functions.
2490 * 1 : csp = Current client state (buffers, headers, etc...)
2491 * 2 : caller = name of CGI who calls us and which should
2492 * be excluded from the generated menu. May be
2494 * Returns : NULL if no memory, else a new map. Caller frees.
2496 *********************************************************************/
2497 struct map *default_exports(const struct client_state *csp, const char *caller)
2501 struct map * exports;
2502 int local_help_exists = 0;
2506 exports = new_map();
2507 if (exports == NULL)
2512 err = map(exports, "version", 1, html_encode(VERSION), 0);
2513 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2514 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2515 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2516 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2517 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2518 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2519 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2520 !strncmpic(csp->config->usermanual, "http", 4))
2522 /* Manual is located somewhere else, just link to it. */
2523 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2527 /* Manual is delivered by Privoxy. */
2528 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2530 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2531 #ifdef FEATURE_TOGGLE
2532 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2534 if (!err) err = map_block_killer(exports, "can-toggle");
2537 snprintf(buf, 20, "%d", csp->config->hport);
2538 if (!err) err = map(exports, "my-port", 1, buf, 1);
2540 if(!strcmp(CODE_STATUS, "stable"))
2542 if (!err) err = map_block_killer(exports, "unstable");
2545 if (csp->config->admin_address != NULL)
2547 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2548 local_help_exists = 1;
2552 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2555 if (csp->config->proxy_info_url != NULL)
2557 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2558 local_help_exists = 1;
2562 if (!err) err = map_block_killer(exports, "have-proxy-info");
2565 if (local_help_exists == 0)
2567 if (!err) err = map_block_killer(exports, "have-help-info");
2580 /*********************************************************************
2582 * Function : map_block_killer
2584 * Description : Convenience function.
2585 * Adds a "killer" for the conditional HTML-template
2586 * block <name>, i.e. a substitution of the regex
2587 * "if-<name>-start.*if-<name>-end" to the given
2591 * 1 : exports = map to extend
2592 * 2 : name = name of conditional block
2594 * Returns : JB_ERR_OK on success
2595 * JB_ERR_MEMORY on out-of-memory error.
2597 *********************************************************************/
2598 jb_err map_block_killer(struct map *exports, const char *name)
2600 char buf[1000]; /* Will do, since the names are hardwired */
2604 assert(strlen(name) < 490);
2606 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2607 return map(exports, buf, 1, "", 1);
2611 /*********************************************************************
2613 * Function : map_block_keep
2615 * Description : Convenience function. Removes the markers used
2616 * by map-block-killer, to save a few bytes.
2617 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2620 * 1 : exports = map to extend
2621 * 2 : name = name of conditional block
2623 * Returns : JB_ERR_OK on success
2624 * JB_ERR_MEMORY on out-of-memory error.
2626 *********************************************************************/
2627 jb_err map_block_keep(struct map *exports, const char *name)
2630 char buf[500]; /* Will do, since the names are hardwired */
2634 assert(strlen(name) < 490);
2636 snprintf(buf, 500, "if-%s-start", name);
2637 err = map(exports, buf, 1, "", 1);
2644 snprintf(buf, 500, "if-%s-end", name);
2645 return map(exports, buf, 1, "", 1);
2649 /*********************************************************************
2651 * Function : map_conditional
2653 * Description : Convenience function.
2654 * Adds an "if-then-else" for the conditional HTML-template
2655 * block <name>, i.e. a substitution of the form:
2662 * The control structure and one of the alternatives
2666 * 1 : exports = map to extend
2667 * 2 : name = name of conditional block
2668 * 3 : choose_first = nonzero for first, zero for second.
2670 * Returns : JB_ERR_OK on success
2671 * JB_ERR_MEMORY on out-of-memory error.
2673 *********************************************************************/
2674 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2676 char buf[1000]; /* Will do, since the names are hardwired */
2681 assert(strlen(name) < 480);
2683 snprintf(buf, 1000, (choose_first
2684 ? "else-not-%s@.*@endif-%s"
2685 : "if-%s-then@.*@else-not-%s"),
2688 err = map(exports, buf, 1, "", 1);
2694 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2695 return map(exports, buf, 1, "", 1);
2699 /*********************************************************************
2701 * Function : make_menu
2703 * Description : Returns an HTML-formatted menu of the available
2704 * unhidden CGIs, excluding the one given in <self>
2705 * and the toggle CGI if toggling is disabled.
2708 * 1 : self = name of CGI to leave out, can be NULL for
2710 * 2 : feature_flags = feature bitmap from csp->config
2713 * Returns : menu string, or NULL on out-of-memory error.
2715 *********************************************************************/
2716 char *make_menu(const char *self, const unsigned feature_flags)
2718 const struct cgi_dispatcher *d;
2719 char *result = strdup("");
2723 self = "NO-SUCH-CGI!";
2726 /* List available unhidden CGI's and export as "other-cgis" */
2727 for (d = cgi_dispatchers; d->name; d++)
2730 #ifdef FEATURE_TOGGLE
2731 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2734 * Suppress the toggle link if remote toggling is disabled.
2738 #endif /* def FEATURE_TOGGLE */
2740 if (d->description && strcmp(d->name, self))
2742 char *html_encoded_prefix;
2745 * Line breaks would be great, but break
2746 * the "blocked" template's JavaScript.
2748 string_append(&result, "<li><a href=\"");
2749 html_encoded_prefix = html_encode(CGI_PREFIX);
2750 if (html_encoded_prefix == NULL)
2756 string_append(&result, html_encoded_prefix);
2757 free(html_encoded_prefix);
2759 string_append(&result, d->name);
2760 string_append(&result, "\">");
2761 string_append(&result, d->description);
2762 string_append(&result, "</a></li>");
2770 /*********************************************************************
2772 * Function : dump_map
2774 * Description : HTML-dump a map for debugging (as table)
2777 * 1 : the_map = map to dump
2779 * Returns : string with HTML
2781 *********************************************************************/
2782 char *dump_map(const struct map *the_map)
2784 struct map_entry *cur_entry;
2785 char *ret = strdup("");
2787 string_append(&ret, "<table>\n");
2789 for (cur_entry = the_map->first;
2790 (cur_entry != NULL) && (ret != NULL);
2791 cur_entry = cur_entry->next)
2793 string_append(&ret, "<tr><td><b>");
2794 string_join (&ret, html_encode(cur_entry->name));
2795 string_append(&ret, "</b></td><td>");
2796 string_join (&ret, html_encode(cur_entry->value));
2797 string_append(&ret, "</td></tr>\n");
2800 string_append(&ret, "</table>\n");