1 const char cgi_rcs[] = "$Id: cgi.c,v 1.93 2007/02/07 10:45:22 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.93 2007/02/07 10:45:22 fabiankeil
42 * - Save the reason for generating http_responses.
43 * - Fix --disable-toggle (again).
44 * - Use TBL birthday hack for 403 responses as well.
45 * - Uglify the @menu@ again to fix JavaScript
46 * errors on the "blocked" template.
47 * - Escape an ampersand in cgi_error_unknown().
49 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
50 * - Add HEAD support to finish_http_response.
51 * - Add error favicon to internal HTML error messages.
53 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
54 * Add new config option "templdir" to
55 * change the templates directory.
57 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
58 * Added "forwarding-failed" template support for error_response().
60 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
61 * Add favicon delivery functions.
63 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
64 * - Map variables that aren't guaranteed to be
65 * pure ASCII html_encoded.
66 * - Use CGI_PREFIX to generate URL for user manual
67 * CGI page to make sure CGI_SITE_2_PATH is included.
69 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
70 * - "Protect" against a rather lame JavaScript-based
71 * Privoxy detection "attack" and check the referrer
72 * before delivering the CGI style sheet.
73 * - Move referrer check for unsafe CGI pages into
74 * referrer_is_safe() and log the result.
75 * - Map @url@ in cgi-error-disabled page.
76 * It's required for the "go there anyway" link.
77 * - Mark *csp as immutable for grep_cgi_referrer().
79 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
80 * Fix strdup() error handling in cgi_error_unknown()
81 * and cgi_error_no_template(). Reported by Markus Elfring.
83 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
84 * Handle pcrs_execute() errors in template_fill() properly.
86 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
87 * Fixed gcc43 conversion warnings and replaced sprintf
88 * calls with snprintf to give OpenBSD's gcc one less reason
91 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
92 * Escape ampersand in Privoxy menu.
94 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
95 * Suppress the toggle link if remote toggling is disabled.
97 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
98 * Fix configure option --disable-toggle.
99 * Thanks to Peter Thoenen for reporting this.
101 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
102 * Don't lose the FORCE_PREFIX in case of
103 * connection problems. Fixes #612235.
105 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
106 * Make pthread mutex locking more generic. Instead of
107 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
108 * and use mutex locking unless there is an _r function
109 * available. Better safe than sorry.
111 * Fixes "./configure --disable-pthread" and should result
112 * in less threading-related problems on pthread-using platforms,
113 * but it still doesn't fix BR#1122404.
115 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
116 * Use CGI_PREFIX to check the referrer.
117 * The check for "http://config.privoxy.org/" fails
118 * if the user modified CGI_SITE_2_HOST.
120 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
121 * Adjusted headers for Privoxy's cgi responses:
122 * Don't set Last-Modified, Expires and Cache-Control
123 * headers for redirects; always set "Connection: close".
125 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
126 * Only predate the Last-Modified header for cgi responses
127 * that are delivered with status code 404 or 503.
129 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
130 * Mark cgi_send_user_manual as harmless,
131 * to fix the access denied problem Hal spotted.
132 * The manual has no secret content, therefore we
133 * don't have to care about "secure" referrers.
135 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
136 * Incorporate modified version of Roland Rosenfeld's patch to
137 * optionally access the user-manual via Privoxy. Closes patch 679075.
139 * Formatting changed to Privoxy style, added call to
140 * cgi_error_no_template if the requested file doesn't
141 * exist and modified check whether or not Privoxy itself
142 * should serve the manual. Should work cross-platform now.
144 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
145 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
147 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
148 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
149 * with what was really the latest development (the v_3_0_branch branch)
151 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
152 * Moved cgi_error_disabled() from cgiedit.c to
153 * cgi.c to re-enable build with --disable-editor.
154 * Fixes Bug #892744. Thanks to Matthew Fischer
157 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
158 * - Added new function cgi_redirect to handle creation of
159 * HTTP redirect messages formerly repeated in the code.
160 * - Send cgi_error_disabled instead of cgi_error_404 when
161 * referrer check fails
162 * - Dynamic content now gets Expires header field with date
165 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
166 * Bugfix: Transparent PNG was not transparent. Thanks to
167 * Dan Razzell of Starfish Systems for notice and new PNG.
169 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
170 * Security fix: dspatch_known_cgi no longer considers an empty
171 * referrer safe for critical CGIs, since malicious links could
172 * reside on https:// locations which browsers don't advertize as
173 * referrers. Closes bug #749916, thanks to Jeff Epler for the
174 * hint. Goodbye One-Click[tm] toggling :-(
176 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
179 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
180 * Killed a compiler warning on OSX
182 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
183 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
184 * (fixes bug #710056)
185 * - Show toggle info only if we have it
187 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
188 * Move declaration of struct tm dummy outside of a control block so it is
189 * accessible later on during snprintf in get_http_time.
191 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
192 * Cosmetic: Renamed cryptic variable
194 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
195 * 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.
197 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
198 * Disable access to critical CGIs via untrusted referrers.
199 * This prevents users from being tricked by malicious websites
200 * into making unintentional configuration changes:
202 * - Added flag to each cgi_dispatcher that allows or denies
204 * - Introduced proviorical function that greps for the
205 * referrer header before regular header parsing happens
206 * - Added safety check to dispatch_known_cgi. CGI is called
207 * if (cgi harmless || no referrer || we are referrer).
208 * Else a) toggle calls are modified not to change status and
209 * b) all other calls are denied.
211 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
212 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
214 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
215 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
217 * Revision 1.70 2002/05/19 11:33:20 jongfoster
218 * If a CGI error was not handled, and propogated back to
219 * dispatch_known_cgi(), then it was assumed to be "out of memory".
220 * This gave a very misleading error message.
222 * Now other errors will cause a simple message giving the error
223 * number and asking the user to report a bug.
226 * http://sourceforge.net/tracker/index.php?func=detail
227 * &aid=557905&group_id=11118&atid=111118
229 * Revision 1.69 2002/05/14 21:28:40 oes
230 * - Fixed add_help_link to link to the (now split) actions
231 * part of the config chapter
232 * - Renamed helplink export to actions-help-prefix
234 * Revision 1.68 2002/05/12 21:36:29 jongfoster
235 * Correcting function comments
237 * Revision 1.67 2002/04/30 12:02:07 oes
238 * Nit: updated a comment
240 * Revision 1.66 2002/04/26 18:32:57 jongfoster
241 * Fixing a memory leak on error
243 * Revision 1.65 2002/04/26 12:53:51 oes
244 * - New function add_help_link
245 * - default_exports now exports links to the user manual
246 * and a prefix for links into the config chapter
248 * Revision 1.64 2002/04/24 02:17:21 oes
249 * - Better descriptions for CGIs
250 * - Hide edit-actions, more shortcuts
251 * - Moved get_char_param, get_string_param and get_number_param here
254 * Revision 1.63 2002/04/15 19:06:43 jongfoster
257 * Revision 1.62 2002/04/10 19:59:46 jongfoster
258 * Fixes to #include in templates:
259 * - Didn't close main file if loading an included template fails.
260 * - I'm paranoid and want to disallow "#include /etc/passwd".
262 * Revision 1.61 2002/04/10 13:37:48 oes
263 * Made templates modular: template_load now recursive with max depth 1
265 * Revision 1.60 2002/04/08 20:50:25 swa
268 * Revision 1.59 2002/04/05 15:51:51 oes
269 * - added send-stylesheet CGI
270 * - bugfix: error-pages now get correct request protocol
272 * - kludged CGI descriptions and menu not to break JS syntax
274 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
275 * Fix Mac OSX compiler warnings
277 * Revision 1.57 2002/03/26 22:29:54 swa
278 * we have a new homepage!
280 * Revision 1.56 2002/03/24 17:50:46 jongfoster
281 * Fixing compile error if actions file editor disabled
283 * Revision 1.55 2002/03/24 16:55:06 oes
284 * Making GIF checkerboard transparent
286 * Revision 1.54 2002/03/24 16:18:15 jongfoster
289 * Revision 1.53 2002/03/24 16:06:00 oes
290 * Correct transparency for checkerboard PNG. Thanks, Magnus!
292 * Revision 1.52 2002/03/24 15:23:33 jongfoster
295 * Revision 1.51 2002/03/24 13:25:43 swa
296 * name change related issues
298 * Revision 1.50 2002/03/16 23:54:06 jongfoster
299 * Adding graceful termination feature, to help look for memory leaks.
300 * If you enable this (which, by design, has to be done by hand
301 * editing config.h) and then go to http://i.j.b/die, then the program
302 * will exit cleanly after the *next* request. It should free all the
303 * memory that was used.
305 * Revision 1.49 2002/03/13 00:27:04 jongfoster
308 * Revision 1.48 2002/03/08 17:47:07 jongfoster
311 * Revision 1.47 2002/03/08 16:41:33 oes
312 * Added GIF images again
314 * Revision 1.46 2002/03/07 03:48:38 oes
315 * - Changed built-in images from GIF to PNG
316 * (with regard to Unisys patent issue)
317 * - Added a 4x4 pattern PNG which is less intrusive
318 * than the logo but also clearly marks the deleted banners
320 * Revision 1.45 2002/03/06 22:54:35 jongfoster
321 * Automated function-comment nitpicking.
323 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
324 * - Better error reporting on OS/2
325 * - Fix double-slash comment (oops)
327 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
328 * - Re-enable OS/2 building after new parms were added
329 * - Fix false out of memory report when resolving CGI templates when no IP
330 * address is available of failed attempt (a la no such domain)
332 * Revision 1.42 2002/01/21 00:33:20 jongfoster
333 * Replacing strsav() with the safer string_append() or string_join().
334 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
335 * Adding missing html_encode() to error message generators.
336 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
338 * Revision 1.41 2002/01/17 20:56:22 jongfoster
339 * Replacing hard references to the URL of the config interface
340 * with #defines from project.h
342 * Revision 1.40 2002/01/09 14:26:46 oes
343 * Added support for thread-safe gmtime_r call.
345 * Revision 1.39 2001/11/16 00:48:13 jongfoster
346 * Fixing a compiler warning
348 * Revision 1.38 2001/11/13 00:31:21 jongfoster
349 * - Adding new CGIs for use by non-JavaScript browsers:
350 * edit-actions-url-form
351 * edit-actions-add-url-form
352 * edit-actions-remove-url-form
353 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
356 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
357 * Show enablement/disablement status in almost all templates.
358 * There is a little trickiness here: apparent recursive resolution of
359 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
360 * the actual enablement status. So a similar construct,
361 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
364 * Revision 1.36 2001/10/26 17:33:27 oes
367 * Revision 1.35 2001/10/23 21:48:19 jongfoster
368 * Cleaning up error handling in CGI functions - they now send back
369 * a HTML error page and should never cause a FATAL error. (Fixes one
370 * potential source of "denial of service" attacks).
372 * CGI actions file editor that works and is actually useful.
374 * Ability to toggle Junkbuster remotely using a CGI call.
376 * You can turn off both the above features in the main configuration
377 * file, e.g. if you are running a multi-user proxy.
379 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
380 * Only show "Local support" on templates conditionally:
381 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
382 * - if not, no Local support section appears
384 * Revision 1.33 2001/10/14 22:28:41 jongfoster
385 * Fixing stupid typo.
387 * Revision 1.32 2001/10/14 22:20:18 jongfoster
388 * - Changes to CGI dispatching method to match CGI names exactly,
389 * rather than doing a prefix match.
390 * - No longer need to count the length of the CGI handler names by hand.
391 * - Adding new handler for 404 error when disptching a CGI, if none of
392 * the handlers match.
393 * - Adding new handlers for CGI actionsfile editor.
395 * Revision 1.31 2001/10/10 10:56:39 oes
396 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
398 * Revision 1.30 2001/10/02 15:30:57 oes
399 * Introduced show-request cgi
401 * Revision 1.29 2001/09/20 15:47:44 steudten
403 * Fix BUG: Modify int size to size_t size in fill_template()
404 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
406 * Revision 1.28 2001/09/19 18:00:37 oes
407 * - Deletef time() FIXME (Can't fail under Linux either, if
408 * the argument is guaranteed to be in out address space,
411 * - Pointer notation cosmetics
412 * - Fixed a minor bug in template_fill(): Failiure of
413 * pcrs_execute() now secure.
415 * Revision 1.27 2001/09/16 17:08:54 jongfoster
416 * Moving simple CGI functions from cgi.c to new file cgisimple.c
418 * Revision 1.26 2001/09/16 15:47:37 jongfoster
419 * First version of CGI-based edit interface. This is very much a
420 * work-in-progress, and you can't actually use it to edit anything
421 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
422 * to have any effect.
424 * Revision 1.25 2001/09/16 15:02:35 jongfoster
425 * Adding i.j.b/robots.txt.
426 * Inlining add_stats() since it's only ever called from one place.
428 * Revision 1.24 2001/09/16 11:38:01 jongfoster
429 * Splitting fill_template() into 2 functions:
430 * template_load() loads the file
431 * template_fill() performs the PCRS regexps.
432 * This is because the CGI edit interface has a "table row"
433 * template which is used many times in the page - this
434 * change means it's only loaded from disk once.
436 * Revision 1.23 2001/09/16 11:16:05 jongfoster
437 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
439 * Revision 1.22 2001/09/16 11:00:10 jongfoster
440 * New function alloc_http_response, for symmetry with free_http_response
442 * Revision 1.21 2001/09/13 23:53:03 jongfoster
443 * Support for both static and dynamically generated CGI pages.
444 * Correctly setting Last-Modified: and Expires: HTTP headers.
446 * Revision 1.20 2001/09/13 23:40:36 jongfoster
447 * (Cosmetic only) Indentation correction
449 * Revision 1.19 2001/09/13 23:31:25 jongfoster
450 * Moving image data to cgi.c rather than cgi.h.
452 * Revision 1.18 2001/08/05 16:06:20 jongfoster
453 * Modifiying "struct map" so that there are now separate header and
454 * "map_entry" structures. This means that functions which modify a
455 * map no longer need to return a pointer to the modified map.
456 * Also, it no longer reverses the order of the entries (which may be
457 * important with some advanced template substitutions).
459 * Revision 1.17 2001/08/05 15:57:38 oes
460 * Adapted finish_http_response to new list_to_text
462 * Revision 1.16 2001/08/01 21:33:18 jongfoster
463 * Changes to fill_template() that reduce memory usage without having
464 * an impact on performance. I also renamed some variables so as not
465 * to clash with the C++ keywords "new" and "template".
467 * Revision 1.15 2001/08/01 21:19:22 jongfoster
468 * Moving file version information to a separate CGI page.
470 * Revision 1.14 2001/08/01 00:19:03 jongfoster
471 * New function: map_conditional() for an if-then-else syntax.
472 * Changing to use new version of show_defines()
474 * Revision 1.13 2001/07/30 22:08:36 jongfoster
475 * Tidying up #defines:
476 * - All feature #defines are now of the form FEATURE_xxx
477 * - Permanently turned off WIN_GUI_EDIT
478 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
480 * Revision 1.12 2001/07/29 18:47:05 jongfoster
481 * Adding missing #include "loadcfg.h"
483 * Revision 1.11 2001/07/18 17:24:37 oes
484 * Changed to conform to new pcrs interface
486 * Revision 1.10 2001/07/13 13:53:13 oes
487 * Removed all #ifdef PCRS and related code
489 * Revision 1.9 2001/06/29 21:45:41 oes
490 * Indentation, CRLF->LF, Tab-> Space
492 * Revision 1.8 2001/06/29 13:21:46 oes
493 * - Cosmetics: renamed and reordered functions, variables,
494 * texts, improved comments etc
496 * - Removed ij_untrusted_url() The relevant
497 * info is now part of the "untrusted" page,
498 * which is generated by filters.c:trust_url()
500 * - Generators of content now call finish_http_response()
501 * themselves, making jcc.c:chat() a little less
504 * - Removed obsolete "Pragma: no-cache" from our headers
506 * - http_responses now know their head length
508 * - fill_template now uses the new interface to pcrs, so that
509 * - long jobs (like whole files) no longer have to be assembled
510 * in a fixed size buffer
511 * - the new T (trivial) option is used, and the replacement may
512 * contain Perl syntax backrefs without confusing pcrs
514 * - Introduced default_exports() which generates a set of exports
515 * common to all CGIs and other content generators
517 * - Introduced convenience function map_block_killer()
519 * - Introduced convenience function make_menu()
521 * - Introduced CGI-like function error_response() which generates
522 * the "No such domain" and "Connect failed" messages using the
525 * - cgi_show_url_info:
526 * - adapted to new CGI features
527 * - form and answers now generated from same template
528 * - http:// prefix in URL now OK
531 * - adapted to new CGI features
532 * - no longer uses csp->init_proxy_args
535 * - moved menu generation to make_menu()
537 * - add_stats now writes single export map entries instead
540 * - Moved redirect_url() to filters.c
542 * - Fixed mem leak in free_http_response(), map_block_killer(),
544 * - Removed logentry from cancelled commit
546 * Revision 1.7 2001/06/09 10:51:58 jongfoster
547 * Changing "show URL info" handler to new style.
548 * Changing BUFSIZ ==> BUFFER_SIZE
550 * Revision 1.6 2001/06/07 23:05:19 jongfoster
551 * Removing code related to old forward and ACL files.
553 * Revision 1.5 2001/06/05 19:59:16 jongfoster
554 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
556 * Revision 1.4 2001/06/04 10:41:52 swa
557 * show version string of cgi.h and cgi.c
559 * Revision 1.3 2001/06/03 19:12:16 oes
560 * introduced new cgi handling
562 * No revisions before 1.3
564 **********************************************************************/
570 #include <sys/types.h>
578 #define snprintf _snprintf
579 #endif /* def _WIN32 */
588 #include "miscutil.h"
589 #include "cgisimple.h"
590 #ifdef FEATURE_CGI_EDIT_ACTIONS
592 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
594 /* loadcfg.h is for global_toggle_state only */
595 #ifdef FEATURE_PTHREAD
597 /* jcc.h is for mutex semaphore globals only */
598 #endif /* def FEATURE_PTHREAD */
599 const char cgi_h_rcs[] = CGI_H_VERSION;
602 * List of CGI functions: name, handler, description
603 * Note: Do NOT use single quotes in the description;
604 * this will break the dynamic "blocked" template!
606 static const struct cgi_dispatcher cgi_dispatchers[] = {
611 #ifdef FEATURE_GRACEFUL_TERMINATION
614 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
615 "this is a one click Denial Of Service attack!!!</em>",
620 #ifdef FEATURE_CGI_EDIT_ACTIONS
621 "View & change the current configuration",
623 "View the current configuration",
628 "View the source code version numbers",
632 "View the request headers.",
636 "Look up which actions apply to a URL and why",
638 #ifdef FEATURE_CGI_EDIT_ACTIONS
639 #ifdef FEATURE_TOGGLE
642 "Toggle Privoxy on or off",
644 #endif /* def FEATURE_TOGGLE */
645 { "edit-actions", /* Edit the actions list */
648 { "eaa", /* Shortcut for edit-actions-add-url-form */
649 cgi_edit_actions_add_url_form,
651 { "eau", /* Shortcut for edit-actions-url-form */
652 cgi_edit_actions_url_form,
654 { "ear", /* Shortcut for edit-actions-remove-url-form */
655 cgi_edit_actions_remove_url_form,
657 { "eal", /* Shortcut for edit-actions-list */
658 cgi_edit_actions_list,
660 { "eafu", /* Shortcut for edit-actions-for-url */
661 cgi_edit_actions_for_url,
663 { "eas", /* Shortcut for edit-actions-submit */
664 cgi_edit_actions_submit,
666 { "easa", /* Shortcut for edit-actions-section-add */
667 cgi_edit_actions_section_add,
669 { "easr", /* Shortcut for edit-actions-section-remove */
670 cgi_edit_actions_section_remove,
672 { "eass", /* Shortcut for edit-actions-section-swap */
673 cgi_edit_actions_section_swap,
675 { "edit-actions-for-url",
676 cgi_edit_actions_for_url,
677 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
678 { "edit-actions-list",
679 cgi_edit_actions_list,
680 NULL, TRUE /* Edit the actions list */ },
681 { "edit-actions-submit",
682 cgi_edit_actions_submit,
683 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
684 { "edit-actions-url",
685 cgi_edit_actions_url,
686 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
687 { "edit-actions-url-form",
688 cgi_edit_actions_url_form,
689 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
690 { "edit-actions-add-url",
691 cgi_edit_actions_add_url,
692 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
693 { "edit-actions-add-url-form",
694 cgi_edit_actions_add_url_form,
695 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
696 { "edit-actions-remove-url",
697 cgi_edit_actions_remove_url,
698 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
699 { "edit-actions-remove-url-form",
700 cgi_edit_actions_remove_url_form,
701 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
702 { "edit-actions-section-add",
703 cgi_edit_actions_section_add,
704 NULL, FALSE /* Remove a section from the actionsfile */ },
705 { "edit-actions-section-remove",
706 cgi_edit_actions_section_remove,
707 NULL, FALSE /* Remove a section from the actionsfile */ },
708 { "edit-actions-section-swap",
709 cgi_edit_actions_section_swap,
710 NULL, FALSE /* Swap two sections in the actionsfile */ },
711 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
712 { "error-favicon.ico",
713 cgi_send_error_favicon,
714 NULL, TRUE /* Sends the favicon image for error pages. */ },
716 cgi_send_default_favicon,
717 NULL, TRUE /* Sends the default favicon image. */ },
720 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
723 NULL, TRUE /* Send a built-in image */ },
726 NULL, FALSE /* Send templates/cgi-style.css */ },
728 cgi_transparent_image,
729 NULL, TRUE /* Send a transparent image (short name) */ },
731 cgi_send_user_manual,
732 NULL, TRUE /* Send user-manual */ },
733 { NULL, /* NULL Indicates end of list and default page */
735 NULL, TRUE /* Unknown CGI page */ }
740 * Built-in images for ad replacement
742 * Hint: You can encode your own images like this:
743 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
746 #ifdef FEATURE_NO_GIFS
749 * Checkerboard pattern, as a PNG.
751 const char image_pattern_data[] =
752 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
753 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
754 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
755 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
756 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
757 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
758 "\000\000\000\000\111\105\116\104\256\102\140\202";
761 * 1x1 transparant PNG.
763 const char image_blank_data[] =
764 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
765 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
766 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
767 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
768 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
769 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
770 "\000\000\000\000\111\105\116\104\256\102\140\202";
774 * Checkerboard pattern, as a GIF.
776 const char image_pattern_data[] =
777 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
778 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
779 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
780 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
784 * 1x1 transparant GIF.
786 const char image_blank_data[] =
787 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
788 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
789 "\000\001\000\000\002\002D\001\000;";
792 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
793 const size_t image_blank_length = sizeof(image_blank_data) - 1;
796 static struct http_response cgi_error_memory_response[1];
798 static struct http_response *dispatch_known_cgi(struct client_state * csp,
800 static struct map *parse_cgi_parameters(char *argstring);
803 /*********************************************************************
805 * Function : dispatch_cgi
807 * Description : Checks if a request URL has either the magical
808 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
809 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
810 * http://config.privoxy.org/). If so, it passes
811 * the (rest of the) path onto dispatch_known_cgi, which
812 * calls the relevant CGI handler function.
815 * 1 : csp = Current client state (buffers, headers, etc...)
817 * Returns : http_response if match, NULL if nonmatch or handler fail
819 *********************************************************************/
820 struct http_response *dispatch_cgi(struct client_state *csp)
822 const char *host = csp->http->host;
823 const char *path = csp->http->path;
826 * Should we intercept ?
829 /* Note: "example.com" and "example.com." are equivalent hostnames. */
831 /* Either the host matches CGI_SITE_1_HOST ..*/
832 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
833 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
834 && (path[0] == '/') )
836 /* ..then the path will all be for us. Remove leading '/' */
839 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
840 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
841 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
842 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
844 /* take everything following CGI_SITE_2_PATH */
845 path += strlen(CGI_SITE_2_PATH);
848 /* skip the forward slash after CGI_SITE_2_PATH */
851 else if (*path != '\0')
854 * weirdness: URL is /configXXX, where XXX is some string
855 * Do *NOT* intercept.
867 * This is a CGI call.
870 return dispatch_known_cgi(csp, path);
874 /*********************************************************************
876 * Function : grep_cgi_referrer
878 * Description : Ugly provisorical fix that greps the value of the
879 * referer HTTP header field out of a linked list of
880 * strings like found at csp->headers. Will disappear
883 * FIXME: csp->headers ought to be csp->http->headers
884 * FIXME: Parsing all client header lines should
885 * happen right after the request is received!
888 * 1 : csp = Current client state (buffers, headers, etc...)
890 * Returns : pointer to value (no copy!), or NULL if none found.
892 *********************************************************************/
893 char *grep_cgi_referrer(const struct client_state *csp)
895 struct list_entry *p;
897 for (p = csp->headers->first; p != NULL; p = p->next)
899 if (p->str == NULL) continue;
900 if (strncmpic(p->str, "Referer: ", 9) == 0)
902 return ((p->str) + 9);
910 /*********************************************************************
912 * Function : referrer_is_safe
914 * Description : Decides whether we trust the Referer for
915 * CGI pages which are only meant to be reachable
916 * through Privoxy's web interface directly.
919 * 1 : csp = Current client state (buffers, headers, etc...)
921 * Returns : TRUE if the referrer is safe, or
922 * FALSE if the referrer is unsafe or not set.
924 *********************************************************************/
925 int referrer_is_safe (const struct client_state *csp)
928 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
930 referrer = grep_cgi_referrer(csp);
932 if (NULL == referrer)
934 /* No referrer, no access */
935 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
938 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
939 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
941 /* Trustworthy referrer */
942 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
943 csp->http->url, referrer);
949 /* Untrustworthy referrer */
950 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
951 csp->http->url, referrer);
958 /*********************************************************************
960 * Function : dispatch_known_cgi
962 * Description : Processes a CGI once dispatch_cgi has determined that
963 * it matches one of the magic prefixes. Parses the path
964 * as a cgi name plus query string, prepares a map that
965 * maps CGI parameter names to their values, initializes
966 * the http_response struct, and calls the relevant CGI
970 * 1 : csp = Current client state (buffers, headers, etc...)
971 * 2 : path = Path of CGI, with the CGI prefix removed.
972 * Should not have a leading "/".
974 * Returns : http_response, or NULL on handler failure or out of
977 *********************************************************************/
978 static struct http_response *dispatch_known_cgi(struct client_state * csp,
981 const struct cgi_dispatcher *d;
982 struct map *param_list;
983 struct http_response *rsp;
984 char *query_args_start;
988 if (NULL == (path_copy = strdup(path)))
990 return cgi_error_memory();
992 query_args_start = path_copy;
993 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
997 if (*query_args_start == '/')
999 *query_args_start++ = '\0';
1000 if ((param_list = new_map()))
1002 map(param_list, "file", 1, url_decode(query_args_start), 0);
1007 if (*query_args_start == '?')
1009 *query_args_start++ = '\0';
1011 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1014 return cgi_error_memory();
1020 * path_copy = CGI call name
1021 * param_list = CGI params, as map
1024 /* Get mem for response or fail*/
1025 if (NULL == (rsp = alloc_http_response()))
1028 free_map(param_list);
1029 return cgi_error_memory();
1033 * Find and start the right CGI function
1035 d = cgi_dispatchers;
1038 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1041 * If the called CGI is either harmless, or referred
1042 * from a trusted source, start it.
1044 if (d->harmless || referrer_is_safe(csp))
1046 err = (d->handler)(csp, rsp, param_list);
1051 * Else, modify toggle calls so that they only display
1052 * the status, and deny all other calls.
1054 if (0 == strcmp(path_copy, "toggle"))
1056 unmap(param_list, "set");
1057 err = (d->handler)(csp, rsp, param_list);
1061 err = cgi_error_disabled(csp, rsp);
1066 free_map(param_list);
1068 if (err == JB_ERR_CGI_PARAMS)
1070 err = cgi_error_bad_param(csp, rsp);
1072 if (err && (err != JB_ERR_MEMORY))
1074 /* Unexpected error! Shouldn't get here */
1075 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1076 err = cgi_error_unknown(csp, rsp, err);
1081 rsp->reason = RSP_REASON_CGI_CALL;
1082 return finish_http_response(csp, rsp);
1086 /* Error in handler, probably out-of-memory */
1087 free_http_response(rsp);
1088 return cgi_error_memory();
1096 /*********************************************************************
1098 * Function : parse_cgi_parameters
1100 * Description : Parse a URL-encoded argument string into name/value
1101 * pairs and store them in a struct map list.
1104 * 1 : argstring = string to be parsed. Will be trashed.
1106 * Returns : pointer to param list, or NULL if out of memory.
1108 *********************************************************************/
1109 static struct map *parse_cgi_parameters(char *argstring)
1112 char *vector[BUFFER_SIZE];
1114 struct map *cgi_params;
1116 if (NULL == (cgi_params = new_map()))
1122 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1123 * the fragment identifier along with the request, so we must
1124 * cut it off here, so it won't pollute the CGI params:
1126 if (NULL != (p = strchr(argstring, '#')))
1131 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1133 for (i = 0; i < pairs; i++)
1135 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1138 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1140 free_map(cgi_params);
1151 /*********************************************************************
1153 * Function : get_char_param
1155 * Description : Get a single-character parameter passed to a CGI
1159 * 1 : parameters = map of cgi parameters
1160 * 2 : param_name = The name of the parameter to read
1162 * Returns : Uppercase character on success, '\0' on error.
1164 *********************************************************************/
1165 char get_char_param(const struct map *parameters,
1166 const char *param_name)
1173 ch = *(lookup(parameters, param_name));
1174 if ((ch >= 'a') && (ch <= 'z'))
1176 ch = (char)(ch - 'a' + 'A');
1183 /*********************************************************************
1185 * Function : get_string_param
1187 * Description : Get a string paramater, to be used as an
1188 * ACTION_STRING or ACTION_MULTI paramater.
1189 * Validates the input to prevent stupid/malicious
1190 * users from corrupting their action file.
1193 * 1 : parameters = map of cgi parameters
1194 * 2 : param_name = The name of the parameter to read
1195 * 3 : pparam = destination for paramater. Allocated as
1196 * part of the map "parameters", so don't free it.
1197 * Set to NULL if not specified.
1199 * Returns : JB_ERR_OK on success, or if the paramater
1200 * was not specified.
1201 * JB_ERR_MEMORY on out-of-memory.
1202 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1204 *********************************************************************/
1205 jb_err get_string_param(const struct map *parameters,
1206 const char *param_name,
1207 const char **pparam)
1219 param = lookup(parameters, param_name);
1225 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1230 * Note that the length limit is arbitrary, it just seems
1231 * sensible to limit it to *something*. There's no
1232 * technical reason for any limit at all.
1234 return JB_ERR_CGI_PARAMS;
1237 /* Check every character to see if it's legal */
1239 while ((ch = *s++) != '\0')
1241 if ( ((unsigned char)ch < (unsigned char)' ')
1244 /* Probable hack attempt, or user accidentally used '}'. */
1245 return JB_ERR_CGI_PARAMS;
1256 /*********************************************************************
1258 * Function : get_number_param
1260 * Description : Get a non-negative integer from the parameters
1261 * passed to a CGI function.
1264 * 1 : csp = Current client state (buffers, headers, etc...)
1265 * 2 : parameters = map of cgi parameters
1266 * 3 : name = Name of CGI parameter to read
1267 * 4 : pvalue = destination for value.
1268 * Set to -1 on error.
1270 * Returns : JB_ERR_OK on success
1271 * JB_ERR_MEMORY on out-of-memory
1272 * JB_ERR_CGI_PARAMS if the parameter was not specified
1275 *********************************************************************/
1276 jb_err get_number_param(struct client_state *csp,
1277 const struct map *parameters,
1292 param = lookup(parameters, name);
1295 return JB_ERR_CGI_PARAMS;
1298 /* We don't use atoi because I want to check this carefully... */
1301 while ((ch = *param++) != '\0')
1303 if ((ch < '0') || (ch > '9'))
1305 return JB_ERR_CGI_PARAMS;
1308 ch = (char)(ch - '0');
1312 * <limits.h> defines UINT_MAX
1314 * (UINT_MAX - ch) / 10 is the largest number that
1315 * can be safely multiplied by 10 then have ch added.
1317 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1319 return JB_ERR_CGI_PARAMS;
1322 value = value * 10 + (unsigned)ch;
1333 /*********************************************************************
1335 * Function : error_response
1337 * Description : returns an http_response that explains the reason
1338 * why a request failed.
1341 * 1 : csp = Current client state (buffers, headers, etc...)
1342 * 2 : templatename = Which template should be used for the answer
1343 * 3 : sys_err = system error number
1345 * Returns : A http_response. If we run out of memory, this
1346 * will be cgi_error_memory().
1348 *********************************************************************/
1349 struct http_response *error_response(struct client_state *csp,
1350 const char *templatename,
1354 struct http_response *rsp;
1355 struct map *exports = default_exports(csp, NULL);
1358 if (exports == NULL)
1360 return cgi_error_memory();
1363 if (NULL == (rsp = alloc_http_response()))
1366 return cgi_error_memory();
1369 #ifdef FEATURE_FORCE_LOAD
1370 if (csp->flags & CSP_FLAG_FORCED)
1372 path = strdup(FORCE_PREFIX);
1375 #endif /* def FEATURE_FORCE_LOAD */
1379 err = string_append(&path, csp->http->path);
1381 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1382 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1383 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1384 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1385 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1388 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1391 /* Some failures, like "404 no such domain", don't have an IP address. */
1392 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1400 free_http_response(rsp);
1401 return cgi_error_memory();
1404 if (!strcmp(templatename, "no-such-domain"))
1406 rsp->status = strdup("404 No such domain");
1407 if (rsp->status == NULL)
1410 free_http_response(rsp);
1411 return cgi_error_memory();
1413 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1415 else if (!strcmp(templatename, "forwarding-failed"))
1417 const struct forward_spec * fwd = forward_url(csp->http, csp);
1420 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1421 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1425 * XXX: While the template is called forwarding-failed,
1426 * it currently only handles socks forwarding failures.
1428 assert(fwd->type != SOCKS_NONE);
1431 * Map failure reason, forwarding type and forwarder.
1433 if (NULL == csp->error_message)
1436 * Either we forgot to record the failure reason,
1437 * or the memory allocation failed.
1439 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1440 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1442 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1443 if (!err) map(exports, "forwarding-type", 1, (fwd->type == SOCKS_4) ?
1444 "socks4-" : "socks4a-", 1);
1445 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1447 if (!err) rsp->status = strdup("503 Forwarding failure");
1448 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1451 free_http_response(rsp);
1452 return cgi_error_memory();
1454 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1456 else if (!strcmp(templatename, "connect-failed"))
1458 rsp->status = strdup("503 Connect failed");
1459 if (rsp->status == NULL)
1462 free_http_response(rsp);
1463 return cgi_error_memory();
1465 rsp->reason = RSP_REASON_CONNECT_FAILED;
1468 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1471 free_http_response(rsp);
1472 return cgi_error_memory();
1475 return finish_http_response(csp, rsp);
1479 /*********************************************************************
1481 * Function : cgi_error_disabled
1483 * Description : CGI function that is called to generate an error
1484 * response if the actions editor or toggle CGI are
1485 * accessed despite having being disabled at compile-
1486 * or run-time, or if the user followed an untrusted link
1487 * to access a unsafe CGI feature that is only reachable
1488 * through Privoxy directly.
1491 * 1 : csp = Current client state (buffers, headers, etc...)
1492 * 2 : rsp = http_response data structure for output
1494 * CGI Parameters : none
1496 * Returns : JB_ERR_OK on success
1497 * JB_ERR_MEMORY on out-of-memory error.
1499 *********************************************************************/
1500 jb_err cgi_error_disabled(struct client_state *csp,
1501 struct http_response *rsp)
1503 struct map *exports;
1508 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1510 return JB_ERR_MEMORY;
1512 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1514 /* Not important enough to do anything */
1515 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1518 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1522 /*********************************************************************
1524 * Function : cgi_init_error_messages
1526 * Description : Call at the start of the program to initialize
1527 * the error message used by cgi_error_memory().
1533 *********************************************************************/
1534 void cgi_init_error_messages(void)
1536 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1537 cgi_error_memory_response->head =
1538 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1539 "Content-Type: text/html\r\n"
1541 cgi_error_memory_response->body =
1544 " <title>500 Internal Privoxy Error</title>\r\n"
1545 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1548 "<h1>500 Internal Privoxy Error</h1>\r\n"
1549 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1550 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1554 cgi_error_memory_response->head_length =
1555 strlen(cgi_error_memory_response->head);
1556 cgi_error_memory_response->content_length =
1557 strlen(cgi_error_memory_response->body);
1558 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1562 /*********************************************************************
1564 * Function : cgi_error_memory
1566 * Description : Called if a CGI function runs out of memory.
1567 * Returns a statically-allocated error response.
1571 * Returns : http_response data structure for output. This is
1572 * statically allocated, for obvious reasons.
1574 *********************************************************************/
1575 struct http_response *cgi_error_memory(void)
1577 /* assert that it's been initialized. */
1578 assert(cgi_error_memory_response->head);
1580 return cgi_error_memory_response;
1584 /*********************************************************************
1586 * Function : cgi_error_no_template
1588 * Description : Almost-CGI function that is called if a template
1589 * cannot be loaded. Note this is not a true CGI,
1590 * it takes a template name rather than a map of
1594 * 1 : csp = Current client state (buffers, headers, etc...)
1595 * 2 : rsp = http_response data structure for output
1596 * 3 : template_name = Name of template that could not
1599 * Returns : JB_ERR_OK on success
1600 * JB_ERR_MEMORY on out-of-memory error.
1602 *********************************************************************/
1603 jb_err cgi_error_no_template(struct client_state *csp,
1604 struct http_response *rsp,
1605 const char *template_name)
1607 static const char status[] =
1608 "500 Internal Privoxy Error";
1609 static const char body_prefix[] =
1612 " <title>500 Internal Privoxy Error</title>\r\n"
1613 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1616 "<h1>500 Internal Privoxy Error</h1>\r\n"
1617 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1618 "<p><b>Could not load template file <code>";
1619 static const char body_suffix[] =
1620 "</code> or one of it's included components.</b></p>\r\n"
1621 "<p>Please contact your proxy administrator.</p>\r\n"
1622 "<p>If you are the proxy administrator, please put the required file(s)"
1623 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1624 "location of the <code><i>(confdir)</i></code> directory "
1625 "is specified in the main Privoxy <code>config</code> "
1626 "file. (It's typically the Privoxy install directory"
1628 ", or <code>/etc/privoxy/</code>"
1629 #endif /* ndef _WIN32 */
1636 assert(template_name);
1638 /* Reset rsp, if needed */
1642 rsp->content_length = 0;
1643 rsp->head_length = 0;
1646 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1647 if (rsp->body == NULL)
1649 return JB_ERR_MEMORY;
1651 strcpy(rsp->body, body_prefix);
1652 strcat(rsp->body, template_name);
1653 strcat(rsp->body, body_suffix);
1655 rsp->status = strdup(status);
1656 if (rsp->status == NULL)
1658 return JB_ERR_MEMORY;
1665 /*********************************************************************
1667 * Function : cgi_error_unknown
1669 * Description : Almost-CGI function that is called if an unexpected
1670 * error occurs in the top-level CGI dispatcher.
1671 * In this context, "unexpected" means "anything other
1672 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1673 * expected to handle all other errors internally,
1674 * since they can give more relavent error messages
1677 * Note this is not a true CGI, it takes an error
1678 * code rather than a map of parameters.
1681 * 1 : csp = Current client state (buffers, headers, etc...)
1682 * 2 : rsp = http_response data structure for output
1683 * 3 : error_to_report = Error code to report.
1685 * Returns : JB_ERR_OK on success
1686 * JB_ERR_MEMORY on out-of-memory error.
1688 *********************************************************************/
1689 jb_err cgi_error_unknown(struct client_state *csp,
1690 struct http_response *rsp,
1691 jb_err error_to_report)
1693 static const char status[] =
1694 "500 Internal Privoxy Error";
1695 static const char body_prefix[] =
1698 " <title>500 Internal Privoxy Error</title>\r\n"
1699 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1702 "<h1>500 Internal Privoxy Error</h1>\r\n"
1703 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1704 "<p><b>Unexpected internal error: ";
1705 static const char body_suffix[] =
1708 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1709 "file a bug report</a>.</p>\r\n"
1716 /* Reset rsp, if needed */
1720 rsp->content_length = 0;
1721 rsp->head_length = 0;
1723 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1725 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1727 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1728 if (rsp->body == NULL)
1730 return JB_ERR_MEMORY;
1732 strcpy(rsp->body, body_prefix);
1733 strcat(rsp->body, errnumbuf);
1734 strcat(rsp->body, body_suffix);
1736 rsp->status = strdup(status);
1737 if (rsp->status == NULL)
1739 return JB_ERR_MEMORY;
1746 /*********************************************************************
1748 * Function : cgi_error_bad_param
1750 * Description : CGI function that is called if the parameters
1751 * (query string) for a CGI were wrong.
1754 * 1 : csp = Current client state (buffers, headers, etc...)
1755 * 2 : rsp = http_response data structure for output
1757 * CGI Parameters : none
1759 * Returns : JB_ERR_OK on success
1760 * JB_ERR_MEMORY on out-of-memory error.
1762 *********************************************************************/
1763 jb_err cgi_error_bad_param(struct client_state *csp,
1764 struct http_response *rsp)
1766 struct map *exports;
1771 if (NULL == (exports = default_exports(csp, NULL)))
1773 return JB_ERR_MEMORY;
1776 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1780 /*********************************************************************
1782 * Function : cgi_redirect
1784 * Description : CGI support function to generate a HTTP redirect
1788 * 1 : rsp = http_response data structure for output
1789 * 2 : target = string with the target URL
1791 * CGI Parameters : None
1793 * Returns : JB_ERR_OK on success
1794 * JB_ERR_MEMORY on out-of-memory error.
1796 *********************************************************************/
1797 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1804 err = enlist_unique_header(rsp->headers, "Location", target);
1806 rsp->status = strdup("302 Local Redirect from Privoxy");
1807 if (rsp->status == NULL)
1809 return JB_ERR_MEMORY;
1816 /*********************************************************************
1818 * Function : add_help_link
1820 * Description : Produce a copy of the string given as item,
1821 * embedded in an HTML link to its corresponding
1822 * section (item name in uppercase) in the actions
1823 * chapter of the user manual, (whose URL is given in
1824 * the config and defaults to our web site).
1826 * FIXME: I currently only work for actions, and would
1827 * like to be generalized for other topics.
1830 * 1 : item = item (will NOT be free()d.)
1831 * It is assumed to be HTML-safe.
1832 * 2 : config = The current configuration.
1834 * Returns : String with item embedded in link, or NULL on
1837 *********************************************************************/
1838 char *add_help_link(const char *item,
1839 struct configuration_spec *config)
1843 if (!item) return NULL;
1845 result = strdup("<a href=\"");
1846 if (!strncmpic(config->usermanual, "file://", 7) ||
1847 !strncmpic(config->usermanual, "http", 4))
1849 string_append(&result, config->usermanual);
1853 string_append(&result, "http://");
1854 string_append(&result, CGI_SITE_2_HOST);
1855 string_append(&result, "/user-manual/");
1857 string_append(&result, ACTIONS_HELP_PREFIX);
1858 string_join (&result, string_toupper(item));
1859 string_append(&result, "\">");
1860 string_append(&result, item);
1861 string_append(&result, "</a> ");
1867 /*********************************************************************
1869 * Function : get_http_time
1871 * Description : Get the time in a format suitable for use in a
1872 * HTTP header - e.g.:
1873 * "Sun, 06 Nov 1994 08:49:37 GMT"
1876 * 1 : time_offset = Time returned will be current time
1877 * plus this number of seconds.
1878 * 2 : buf = Destination for result. Must be long enough
1879 * to hold 29 characters plus a trailing zero.
1883 *********************************************************************/
1884 void get_http_time(int time_offset, char *buf)
1886 static const char day_names[7][4] =
1887 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1888 static const char month_names[12][4] =
1889 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1890 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1893 time_t current_time;
1894 #if defined(HAVE_GMTIME_R)
1896 * Declare dummy up here (instead of inside get/set gmt block) so it
1897 * doesn't go out of scope before it's potentially used in snprintf later.
1898 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1899 * !defined HAVE_GMTIME_R.
1906 time(¤t_time); /* get current time */
1908 current_time += time_offset;
1910 /* get and save the gmt */
1913 t = gmtime_r(¤t_time, &dummy);
1914 #elif FEATURE_PTHREAD
1915 pthread_mutex_lock(&gmtime_mutex);
1916 t = gmtime(¤t_time);
1917 pthread_mutex_unlock(&gmtime_mutex);
1919 t = gmtime(¤t_time);
1923 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1925 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1926 day_names[t->tm_wday],
1928 month_names[t->tm_mon],
1938 /*********************************************************************
1940 * Function : finish_http_response
1942 * Description : Fill in the missing headers in an http response,
1943 * and flatten the headers to an http head.
1944 * For HEAD requests the body is freed once
1945 * the Content-Length header is set.
1948 * 1 : rsp = pointer to http_response to be processed
1950 * Returns : A http_response, usually the rsp parameter.
1951 * On error, free()s rsp and returns cgi_error_memory()
1953 *********************************************************************/
1954 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
1956 char buf[BUFFER_SIZE];
1959 /* Special case - do NOT change this statically allocated response,
1960 * which is ready for output anyway.
1962 if (rsp == cgi_error_memory_response)
1968 * Fill in the HTTP Status
1970 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1971 err = enlist_first(rsp->headers, buf);
1974 * Set the Content-Length
1976 if (rsp->content_length == 0)
1978 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1982 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1983 err = enlist(rsp->headers, buf);
1986 if (0 == strcmpic(csp->http->gpc, "head"))
1989 * The client only asked for the head. Dispose
1990 * the body and log an offensive message.
1992 * While it may seem to be a bit inefficient to
1993 * prepare the body if it isn't needed, it's the
1994 * only way to get the Content-Length right for
1995 * dynamic pages. We could have disposed the body
1996 * earlier, but not without duplicating the
1997 * Content-Length setting code above.
1999 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2001 rsp->content_length = 0;
2004 if (strncmpic(rsp->status, "302", 3))
2007 * If it's not a redirect without any content,
2008 * set the Content-Type to text/html if it's
2009 * not already specified.
2011 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2015 * Fill in the rest of the default headers:
2017 * Date: set to current date/time.
2018 * Last-Modified: set to date/time the page was last changed.
2019 * Expires: set to date/time page next needs reloading.
2020 * Cache-Control: set to "no-cache" if applicable.
2022 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2027 * Set Expires to about 10 min into the future so it'll get reloaded
2028 * occasionally, e.g. if Privoxy gets upgraded.
2033 get_http_time(0, buf);
2034 err = enlist_unique_header(rsp->headers, "Date", buf);
2037 /* Some date in the past. */
2038 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2042 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2043 err = enlist_unique_header(rsp->headers, "Expires", buf);
2046 else if (!strncmpic(rsp->status, "302", 3))
2048 get_http_time(0, buf);
2049 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2054 * Setting "Cache-Control" to "no-cache" and "Expires" to
2055 * the current time doesn't exactly forbid caching, it just
2056 * requires the client to revalidate the cached copy.
2058 * If a temporary problem occurs and the user tries again after
2059 * getting Privoxy's error message, a compliant browser may set the
2060 * If-Modified-Since header with the content of the error page's
2061 * Last-Modified header. More often than not, the document on the server
2062 * is older than Privoxy's error message, the server would send status code
2063 * 304 and the browser would display the outdated error message again and again.
2065 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2066 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2067 * and can be safely used to "revalidate" without getting a status code 304.
2069 * There is no need to let the useless If-Modified-Since header reach the
2070 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2072 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2074 get_http_time(0, buf);
2075 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2076 if (!strncmpic(rsp->status, "403", 3)
2077 || !strncmpic(rsp->status, "404", 3)
2078 || !strncmpic(rsp->status, "503", 3))
2080 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2084 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2086 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2087 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2093 * HTTP/1.1 applications that do not support persistent connections MUST
2094 * include the "close" connection option in every message.
2096 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2101 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2103 free_http_response(rsp);
2104 return cgi_error_memory();
2106 rsp->head_length = strlen(rsp->head);
2113 /*********************************************************************
2115 * Function : alloc_http_response
2117 * Description : Allocates a new http_response structure.
2121 * Returns : pointer to a new http_response, or NULL.
2123 *********************************************************************/
2124 struct http_response *alloc_http_response(void)
2126 return (struct http_response *) zalloc(sizeof(struct http_response));
2131 /*********************************************************************
2133 * Function : free_http_response
2135 * Description : Free the memory occupied by an http_response
2136 * and its depandant structures.
2139 * 1 : rsp = pointer to http_response to be freed
2143 *********************************************************************/
2144 void free_http_response(struct http_response *rsp)
2147 * Must special case cgi_error_memory_response, which is never freed.
2149 if (rsp && (rsp != cgi_error_memory_response))
2154 destroy_list(rsp->headers);
2161 /*********************************************************************
2163 * Function : template_load
2165 * Description : CGI support function that loads a given HTML
2166 * template, ignoring comment lines and following
2167 * #include statements up to a depth of 1.
2170 * 1 : csp = Current client state (buffers, headers, etc...)
2171 * 2 : template_ptr = Destination for pointer to loaded
2173 * 3 : templatename = name of the HTML template to be used
2174 * 4 : recursive = Flag set if this function calls itself
2175 * following an #include statament
2177 * Returns : JB_ERR_OK on success
2178 * JB_ERR_MEMORY on out-of-memory error.
2179 * JB_ERR_FILE if the template file cannot be read
2181 *********************************************************************/
2182 jb_err template_load(struct client_state *csp, char **template_ptr,
2183 const char *templatename, int recursive)
2186 char *templates_dir_path;
2189 char *included_module;
2192 char buf[BUFFER_SIZE];
2195 assert(template_ptr);
2196 assert(templatename);
2198 *template_ptr = NULL;
2200 /* Validate template name. Paranoia. */
2201 for (p = templatename; *p != 0; p++)
2203 if ( ((*p < 'a') || (*p > 'z'))
2204 && ((*p < 'A') || (*p > 'Z'))
2205 && ((*p < '0') || (*p > '9'))
2209 /* Illegal character */
2215 * Generate full path using either templdir
2216 * or confdir/templates as base directory.
2218 if (NULL != csp->config->templdir)
2220 templates_dir_path = strdup(csp->config->templdir);
2224 templates_dir_path = make_path(csp->config->confdir, "templates");
2227 if (templates_dir_path == NULL)
2229 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2231 return JB_ERR_MEMORY;
2234 full_path = make_path(templates_dir_path, templatename);
2235 free(templates_dir_path);
2236 if (full_path == NULL)
2238 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2240 return JB_ERR_MEMORY;
2243 /* Allocate buffer */
2245 file_buffer = strdup("");
2246 if (file_buffer == NULL)
2248 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2250 return JB_ERR_MEMORY;
2253 /* Open template file */
2255 if (NULL == (fp = fopen(full_path, "r")))
2257 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2265 * Read the file, ignoring comments, and honoring #include
2266 * statements, unless we're already called recursively.
2268 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2269 * This is unlikely in practise.
2271 while (fgets(buf, BUFFER_SIZE, fp))
2273 if (!recursive && !strncmp(buf, "#include ", 9))
2275 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2282 if (string_join(&file_buffer, included_module))
2285 return JB_ERR_MEMORY;
2291 /* skip lines starting with '#' */
2297 if (string_append(&file_buffer, buf))
2300 return JB_ERR_MEMORY;
2305 *template_ptr = file_buffer;
2311 /*********************************************************************
2313 * Function : template_fill
2315 * Description : CGI support function that fills in a pre-loaded
2316 * HTML template by replacing @name@ with value using
2317 * pcrs, for each item in the output map.
2319 * Note that a leading '$' charachter in the export map's
2320 * values will be stripped and toggle on backreference
2324 * 1 : template_ptr = IN: Template to be filled out.
2326 * OUT: Filled out template.
2327 * Caller must free().
2328 * 2 : exports = map with fill in symbol -> name pairs
2330 * Returns : JB_ERR_OK on success (and for uncritical errors)
2331 * JB_ERR_MEMORY on out-of-memory error
2333 *********************************************************************/
2334 jb_err template_fill(char **template_ptr, const struct map *exports)
2336 struct map_entry *m;
2338 char buf[BUFFER_SIZE];
2339 char *tmp_out_buffer;
2345 assert(template_ptr);
2346 assert(*template_ptr);
2349 file_buffer = *template_ptr;
2350 size = strlen(file_buffer) + 1;
2353 * Assemble pcrs joblist from exports map
2355 for (m = exports->first; m != NULL; m = m->next)
2357 if (*m->name == '$')
2360 * First character of name is '$', so remove this flag
2361 * character and allow backreferences ($1 etc) in the
2362 * "replace with" text.
2364 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2370 * Treat the "replace with" text as a literal string -
2371 * no quoting needed, no backreferences allowed.
2372 * ("Trivial" ['T'] flag).
2376 /* Enclose name in @@ */
2377 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2381 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2383 /* Make and run job. */
2384 job = pcrs_compile(buf, m->value, flags, &error);
2387 if (error == PCRS_ERR_NOMEM)
2390 *template_ptr = NULL;
2391 return JB_ERR_MEMORY;
2395 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2396 /* Hope it wasn't important and silently ignore the invalid job */
2401 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2404 if (NULL == tmp_out_buffer)
2406 *template_ptr = NULL;
2407 return JB_ERR_MEMORY;
2413 * Substitution failed, keep the original buffer,
2414 * log the problem and ignore it.
2416 * The user might see some unresolved @CGI_VARIABLES@,
2417 * but returning a special CGI error page seems unreasonable
2418 * and could mask more important error messages.
2420 free(tmp_out_buffer);
2421 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2422 buf, m->value, flags, pcrs_strerror(error));
2426 /* Substitution succeeded, use modified buffer. */
2428 file_buffer = tmp_out_buffer;
2436 *template_ptr = file_buffer;
2441 /*********************************************************************
2443 * Function : template_fill_for_cgi
2445 * Description : CGI support function that loads a HTML template
2446 * and fills it in. Handles file-not-found errors
2447 * by sending a HTML error message. For convenience,
2448 * this function also frees the passed "exports" map.
2451 * 1 : csp = Client state
2452 * 2 : templatename = name of the HTML template to be used
2453 * 3 : exports = map with fill in symbol -> name pairs.
2454 * Will be freed by this function.
2455 * 4 : rsp = Response structure to fill in.
2457 * Returns : JB_ERR_OK on success
2458 * JB_ERR_MEMORY on out-of-memory error
2460 *********************************************************************/
2461 jb_err template_fill_for_cgi(struct client_state *csp,
2462 const char *templatename,
2463 struct map *exports,
2464 struct http_response *rsp)
2469 assert(templatename);
2473 err = template_load(csp, &rsp->body, templatename, 0);
2474 if (err == JB_ERR_FILE)
2477 return cgi_error_no_template(csp, rsp, templatename);
2482 return err; /* JB_ERR_MEMORY */
2484 err = template_fill(&rsp->body, exports);
2490 /*********************************************************************
2492 * Function : default_exports
2494 * Description : returns a struct map list that contains exports
2495 * which are common to all CGI functions.
2498 * 1 : csp = Current client state (buffers, headers, etc...)
2499 * 2 : caller = name of CGI who calls us and which should
2500 * be excluded from the generated menu. May be
2502 * Returns : NULL if no memory, else a new map. Caller frees.
2504 *********************************************************************/
2505 struct map *default_exports(const struct client_state *csp, const char *caller)
2509 struct map * exports;
2510 int local_help_exists = 0;
2514 exports = new_map();
2515 if (exports == NULL)
2520 err = map(exports, "version", 1, html_encode(VERSION), 0);
2521 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2522 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2523 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2524 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2525 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2526 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2527 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2528 !strncmpic(csp->config->usermanual, "http", 4))
2530 /* Manual is located somewhere else, just link to it. */
2531 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2535 /* Manual is delivered by Privoxy. */
2536 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2538 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2539 #ifdef FEATURE_TOGGLE
2540 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2542 if (!err) err = map_block_killer(exports, "can-toggle");
2545 snprintf(buf, 20, "%d", csp->config->hport);
2546 if (!err) err = map(exports, "my-port", 1, buf, 1);
2548 if(!strcmp(CODE_STATUS, "stable"))
2550 if (!err) err = map_block_killer(exports, "unstable");
2553 if (csp->config->admin_address != NULL)
2555 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2556 local_help_exists = 1;
2560 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2563 if (csp->config->proxy_info_url != NULL)
2565 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2566 local_help_exists = 1;
2570 if (!err) err = map_block_killer(exports, "have-proxy-info");
2573 if (local_help_exists == 0)
2575 if (!err) err = map_block_killer(exports, "have-help-info");
2588 /*********************************************************************
2590 * Function : map_block_killer
2592 * Description : Convenience function.
2593 * Adds a "killer" for the conditional HTML-template
2594 * block <name>, i.e. a substitution of the regex
2595 * "if-<name>-start.*if-<name>-end" to the given
2599 * 1 : exports = map to extend
2600 * 2 : name = name of conditional block
2602 * Returns : JB_ERR_OK on success
2603 * JB_ERR_MEMORY on out-of-memory error.
2605 *********************************************************************/
2606 jb_err map_block_killer(struct map *exports, const char *name)
2608 char buf[1000]; /* Will do, since the names are hardwired */
2612 assert(strlen(name) < 490);
2614 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2615 return map(exports, buf, 1, "", 1);
2619 /*********************************************************************
2621 * Function : map_block_keep
2623 * Description : Convenience function. Removes the markers used
2624 * by map-block-killer, to save a few bytes.
2625 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2628 * 1 : exports = map to extend
2629 * 2 : name = name of conditional block
2631 * Returns : JB_ERR_OK on success
2632 * JB_ERR_MEMORY on out-of-memory error.
2634 *********************************************************************/
2635 jb_err map_block_keep(struct map *exports, const char *name)
2638 char buf[500]; /* Will do, since the names are hardwired */
2642 assert(strlen(name) < 490);
2644 snprintf(buf, 500, "if-%s-start", name);
2645 err = map(exports, buf, 1, "", 1);
2652 snprintf(buf, 500, "if-%s-end", name);
2653 return map(exports, buf, 1, "", 1);
2657 /*********************************************************************
2659 * Function : map_conditional
2661 * Description : Convenience function.
2662 * Adds an "if-then-else" for the conditional HTML-template
2663 * block <name>, i.e. a substitution of the form:
2670 * The control structure and one of the alternatives
2674 * 1 : exports = map to extend
2675 * 2 : name = name of conditional block
2676 * 3 : choose_first = nonzero for first, zero for second.
2678 * Returns : JB_ERR_OK on success
2679 * JB_ERR_MEMORY on out-of-memory error.
2681 *********************************************************************/
2682 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2684 char buf[1000]; /* Will do, since the names are hardwired */
2689 assert(strlen(name) < 480);
2691 snprintf(buf, 1000, (choose_first
2692 ? "else-not-%s@.*@endif-%s"
2693 : "if-%s-then@.*@else-not-%s"),
2696 err = map(exports, buf, 1, "", 1);
2702 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2703 return map(exports, buf, 1, "", 1);
2707 /*********************************************************************
2709 * Function : make_menu
2711 * Description : Returns an HTML-formatted menu of the available
2712 * unhidden CGIs, excluding the one given in <self>
2713 * and the toggle CGI if toggling is disabled.
2716 * 1 : self = name of CGI to leave out, can be NULL for
2718 * 2 : feature_flags = feature bitmap from csp->config
2721 * Returns : menu string, or NULL on out-of-memory error.
2723 *********************************************************************/
2724 char *make_menu(const char *self, const unsigned feature_flags)
2726 const struct cgi_dispatcher *d;
2727 char *result = strdup("");
2731 self = "NO-SUCH-CGI!";
2734 /* List available unhidden CGI's and export as "other-cgis" */
2735 for (d = cgi_dispatchers; d->name; d++)
2738 #ifdef FEATURE_TOGGLE
2739 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2742 * Suppress the toggle link if remote toggling is disabled.
2746 #endif /* def FEATURE_TOGGLE */
2748 if (d->description && strcmp(d->name, self))
2750 char *html_encoded_prefix;
2753 * Line breaks would be great, but break
2754 * the "blocked" template's JavaScript.
2756 string_append(&result, "<li><a href=\"");
2757 html_encoded_prefix = html_encode(CGI_PREFIX);
2758 if (html_encoded_prefix == NULL)
2764 string_append(&result, html_encoded_prefix);
2765 free(html_encoded_prefix);
2767 string_append(&result, d->name);
2768 string_append(&result, "\">");
2769 string_append(&result, d->description);
2770 string_append(&result, "</a></li>");
2778 /*********************************************************************
2780 * Function : dump_map
2782 * Description : HTML-dump a map for debugging (as table)
2785 * 1 : the_map = map to dump
2787 * Returns : string with HTML
2789 *********************************************************************/
2790 char *dump_map(const struct map *the_map)
2792 struct map_entry *cur_entry;
2793 char *ret = strdup("");
2795 string_append(&ret, "<table>\n");
2797 for (cur_entry = the_map->first;
2798 (cur_entry != NULL) && (ret != NULL);
2799 cur_entry = cur_entry->next)
2801 string_append(&ret, "<tr><td><b>");
2802 string_join (&ret, html_encode(cur_entry->name));
2803 string_append(&ret, "</b></td><td>");
2804 string_join (&ret, html_encode(cur_entry->value));
2805 string_append(&ret, "</td></tr>\n");
2808 string_append(&ret, "</table>\n");