1 const char cgi_rcs[] = "$Id: cgi.c,v 1.87 2007/01/22 15:34:13 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.87 2007/01/22 15:34:13 fabiankeil
42 * - "Protect" against a rather lame JavaScript-based
43 * Privoxy detection "attack" and check the referrer
44 * before delivering the CGI style sheet.
45 * - Move referrer check for unsafe CGI pages into
46 * referrer_is_safe() and log the result.
47 * - Map @url@ in cgi-error-disabled page.
48 * It's required for the "go there anyway" link.
49 * - Mark *csp as immutable for grep_cgi_referrer().
51 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
52 * Fix strdup() error handling in cgi_error_unknown()
53 * and cgi_error_no_template(). Reported by Markus Elfring.
55 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
56 * Handle pcrs_execute() errors in template_fill() properly.
58 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
59 * Fixed gcc43 conversion warnings and replaced sprintf
60 * calls with snprintf to give OpenBSD's gcc one less reason
63 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
64 * Escape ampersand in Privoxy menu.
66 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
67 * Suppress the toggle link if remote toggling is disabled.
69 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
70 * Fix configure option --disable-toggle.
71 * Thanks to Peter Thoenen for reporting this.
73 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
74 * Don't lose the FORCE_PREFIX in case of
75 * connection problems. Fixes #612235.
77 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
78 * Make pthread mutex locking more generic. Instead of
79 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
80 * and use mutex locking unless there is an _r function
81 * available. Better safe than sorry.
83 * Fixes "./configure --disable-pthread" and should result
84 * in less threading-related problems on pthread-using platforms,
85 * but it still doesn't fix BR#1122404.
87 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
88 * Use CGI_PREFIX to check the referrer.
89 * The check for "http://config.privoxy.org/" fails
90 * if the user modified CGI_SITE_2_HOST.
92 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
93 * Adjusted headers for Privoxy's cgi responses:
94 * Don't set Last-Modified, Expires and Cache-Control
95 * headers for redirects; always set "Connection: close".
97 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
98 * Only predate the Last-Modified header for cgi responses
99 * that are delivered with status code 404 or 503.
101 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
102 * Mark cgi_send_user_manual as harmless,
103 * to fix the access denied problem Hal spotted.
104 * The manual has no secret content, therefore we
105 * don't have to care about "secure" referrers.
107 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
108 * Incorporate modified version of Roland Rosenfeld's patch to
109 * optionally access the user-manual via Privoxy. Closes patch 679075.
111 * Formatting changed to Privoxy style, added call to
112 * cgi_error_no_template if the requested file doesn't
113 * exist and modified check whether or not Privoxy itself
114 * should serve the manual. Should work cross-platform now.
116 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
117 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
119 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
120 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
121 * with what was really the latest development (the v_3_0_branch branch)
123 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
124 * Moved cgi_error_disabled() from cgiedit.c to
125 * cgi.c to re-enable build with --disable-editor.
126 * Fixes Bug #892744. Thanks to Matthew Fischer
129 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
130 * - Added new function cgi_redirect to handle creation of
131 * HTTP redirect messages formerly repeated in the code.
132 * - Send cgi_error_disabled instead of cgi_error_404 when
133 * referrer check fails
134 * - Dynamic content now gets Expires header field with date
137 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
138 * Bugfix: Transparent PNG was not transparent. Thanks to
139 * Dan Razzell of Starfish Systems for notice and new PNG.
141 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
142 * Security fix: dspatch_known_cgi no longer considers an empty
143 * referrer safe for critical CGIs, since malicious links could
144 * reside on https:// locations which browsers don't advertize as
145 * referrers. Closes bug #749916, thanks to Jeff Epler for the
146 * hint. Goodbye One-Click[tm] toggling :-(
148 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
151 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
152 * Killed a compiler warning on OSX
154 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
155 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
156 * (fixes bug #710056)
157 * - Show toggle info only if we have it
159 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
160 * Move declaration of struct tm dummy outside of a control block so it is
161 * accessible later on during snprintf in get_http_time.
163 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
164 * Cosmetic: Renamed cryptic variable
166 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
167 * 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.
169 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
170 * Disable access to critical CGIs via untrusted referrers.
171 * This prevents users from being tricked by malicious websites
172 * into making unintentional configuration changes:
174 * - Added flag to each cgi_dispatcher that allows or denies
176 * - Introduced proviorical function that greps for the
177 * referrer header before regular header parsing happens
178 * - Added safety check to dispatch_known_cgi. CGI is called
179 * if (cgi harmless || no referrer || we are referrer).
180 * Else a) toggle calls are modified not to change status and
181 * b) all other calls are denied.
183 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
184 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
186 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
187 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
189 * Revision 1.70 2002/05/19 11:33:20 jongfoster
190 * If a CGI error was not handled, and propogated back to
191 * dispatch_known_cgi(), then it was assumed to be "out of memory".
192 * This gave a very misleading error message.
194 * Now other errors will cause a simple message giving the error
195 * number and asking the user to report a bug.
198 * http://sourceforge.net/tracker/index.php?func=detail
199 * &aid=557905&group_id=11118&atid=111118
201 * Revision 1.69 2002/05/14 21:28:40 oes
202 * - Fixed add_help_link to link to the (now split) actions
203 * part of the config chapter
204 * - Renamed helplink export to actions-help-prefix
206 * Revision 1.68 2002/05/12 21:36:29 jongfoster
207 * Correcting function comments
209 * Revision 1.67 2002/04/30 12:02:07 oes
210 * Nit: updated a comment
212 * Revision 1.66 2002/04/26 18:32:57 jongfoster
213 * Fixing a memory leak on error
215 * Revision 1.65 2002/04/26 12:53:51 oes
216 * - New function add_help_link
217 * - default_exports now exports links to the user manual
218 * and a prefix for links into the config chapter
220 * Revision 1.64 2002/04/24 02:17:21 oes
221 * - Better descriptions for CGIs
222 * - Hide edit-actions, more shortcuts
223 * - Moved get_char_param, get_string_param and get_number_param here
226 * Revision 1.63 2002/04/15 19:06:43 jongfoster
229 * Revision 1.62 2002/04/10 19:59:46 jongfoster
230 * Fixes to #include in templates:
231 * - Didn't close main file if loading an included template fails.
232 * - I'm paranoid and want to disallow "#include /etc/passwd".
234 * Revision 1.61 2002/04/10 13:37:48 oes
235 * Made templates modular: template_load now recursive with max depth 1
237 * Revision 1.60 2002/04/08 20:50:25 swa
240 * Revision 1.59 2002/04/05 15:51:51 oes
241 * - added send-stylesheet CGI
242 * - bugfix: error-pages now get correct request protocol
244 * - kludged CGI descriptions and menu not to break JS syntax
246 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
247 * Fix Mac OSX compiler warnings
249 * Revision 1.57 2002/03/26 22:29:54 swa
250 * we have a new homepage!
252 * Revision 1.56 2002/03/24 17:50:46 jongfoster
253 * Fixing compile error if actions file editor disabled
255 * Revision 1.55 2002/03/24 16:55:06 oes
256 * Making GIF checkerboard transparent
258 * Revision 1.54 2002/03/24 16:18:15 jongfoster
261 * Revision 1.53 2002/03/24 16:06:00 oes
262 * Correct transparency for checkerboard PNG. Thanks, Magnus!
264 * Revision 1.52 2002/03/24 15:23:33 jongfoster
267 * Revision 1.51 2002/03/24 13:25:43 swa
268 * name change related issues
270 * Revision 1.50 2002/03/16 23:54:06 jongfoster
271 * Adding graceful termination feature, to help look for memory leaks.
272 * If you enable this (which, by design, has to be done by hand
273 * editing config.h) and then go to http://i.j.b/die, then the program
274 * will exit cleanly after the *next* request. It should free all the
275 * memory that was used.
277 * Revision 1.49 2002/03/13 00:27:04 jongfoster
280 * Revision 1.48 2002/03/08 17:47:07 jongfoster
283 * Revision 1.47 2002/03/08 16:41:33 oes
284 * Added GIF images again
286 * Revision 1.46 2002/03/07 03:48:38 oes
287 * - Changed built-in images from GIF to PNG
288 * (with regard to Unisys patent issue)
289 * - Added a 4x4 pattern PNG which is less intrusive
290 * than the logo but also clearly marks the deleted banners
292 * Revision 1.45 2002/03/06 22:54:35 jongfoster
293 * Automated function-comment nitpicking.
295 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
296 * - Better error reporting on OS/2
297 * - Fix double-slash comment (oops)
299 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
300 * - Re-enable OS/2 building after new parms were added
301 * - Fix false out of memory report when resolving CGI templates when no IP
302 * address is available of failed attempt (a la no such domain)
304 * Revision 1.42 2002/01/21 00:33:20 jongfoster
305 * Replacing strsav() with the safer string_append() or string_join().
306 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
307 * Adding missing html_encode() to error message generators.
308 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
310 * Revision 1.41 2002/01/17 20:56:22 jongfoster
311 * Replacing hard references to the URL of the config interface
312 * with #defines from project.h
314 * Revision 1.40 2002/01/09 14:26:46 oes
315 * Added support for thread-safe gmtime_r call.
317 * Revision 1.39 2001/11/16 00:48:13 jongfoster
318 * Fixing a compiler warning
320 * Revision 1.38 2001/11/13 00:31:21 jongfoster
321 * - Adding new CGIs for use by non-JavaScript browsers:
322 * edit-actions-url-form
323 * edit-actions-add-url-form
324 * edit-actions-remove-url-form
325 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
328 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
329 * Show enablement/disablement status in almost all templates.
330 * There is a little trickiness here: apparent recursive resolution of
331 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
332 * the actual enablement status. So a similar construct,
333 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
336 * Revision 1.36 2001/10/26 17:33:27 oes
339 * Revision 1.35 2001/10/23 21:48:19 jongfoster
340 * Cleaning up error handling in CGI functions - they now send back
341 * a HTML error page and should never cause a FATAL error. (Fixes one
342 * potential source of "denial of service" attacks).
344 * CGI actions file editor that works and is actually useful.
346 * Ability to toggle Junkbuster remotely using a CGI call.
348 * You can turn off both the above features in the main configuration
349 * file, e.g. if you are running a multi-user proxy.
351 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
352 * Only show "Local support" on templates conditionally:
353 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
354 * - if not, no Local support section appears
356 * Revision 1.33 2001/10/14 22:28:41 jongfoster
357 * Fixing stupid typo.
359 * Revision 1.32 2001/10/14 22:20:18 jongfoster
360 * - Changes to CGI dispatching method to match CGI names exactly,
361 * rather than doing a prefix match.
362 * - No longer need to count the length of the CGI handler names by hand.
363 * - Adding new handler for 404 error when disptching a CGI, if none of
364 * the handlers match.
365 * - Adding new handlers for CGI actionsfile editor.
367 * Revision 1.31 2001/10/10 10:56:39 oes
368 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
370 * Revision 1.30 2001/10/02 15:30:57 oes
371 * Introduced show-request cgi
373 * Revision 1.29 2001/09/20 15:47:44 steudten
375 * Fix BUG: Modify int size to size_t size in fill_template()
376 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
378 * Revision 1.28 2001/09/19 18:00:37 oes
379 * - Deletef time() FIXME (Can't fail under Linux either, if
380 * the argument is guaranteed to be in out address space,
383 * - Pointer notation cosmetics
384 * - Fixed a minor bug in template_fill(): Failiure of
385 * pcrs_execute() now secure.
387 * Revision 1.27 2001/09/16 17:08:54 jongfoster
388 * Moving simple CGI functions from cgi.c to new file cgisimple.c
390 * Revision 1.26 2001/09/16 15:47:37 jongfoster
391 * First version of CGI-based edit interface. This is very much a
392 * work-in-progress, and you can't actually use it to edit anything
393 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
394 * to have any effect.
396 * Revision 1.25 2001/09/16 15:02:35 jongfoster
397 * Adding i.j.b/robots.txt.
398 * Inlining add_stats() since it's only ever called from one place.
400 * Revision 1.24 2001/09/16 11:38:01 jongfoster
401 * Splitting fill_template() into 2 functions:
402 * template_load() loads the file
403 * template_fill() performs the PCRS regexps.
404 * This is because the CGI edit interface has a "table row"
405 * template which is used many times in the page - this
406 * change means it's only loaded from disk once.
408 * Revision 1.23 2001/09/16 11:16:05 jongfoster
409 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
411 * Revision 1.22 2001/09/16 11:00:10 jongfoster
412 * New function alloc_http_response, for symmetry with free_http_response
414 * Revision 1.21 2001/09/13 23:53:03 jongfoster
415 * Support for both static and dynamically generated CGI pages.
416 * Correctly setting Last-Modified: and Expires: HTTP headers.
418 * Revision 1.20 2001/09/13 23:40:36 jongfoster
419 * (Cosmetic only) Indentation correction
421 * Revision 1.19 2001/09/13 23:31:25 jongfoster
422 * Moving image data to cgi.c rather than cgi.h.
424 * Revision 1.18 2001/08/05 16:06:20 jongfoster
425 * Modifiying "struct map" so that there are now separate header and
426 * "map_entry" structures. This means that functions which modify a
427 * map no longer need to return a pointer to the modified map.
428 * Also, it no longer reverses the order of the entries (which may be
429 * important with some advanced template substitutions).
431 * Revision 1.17 2001/08/05 15:57:38 oes
432 * Adapted finish_http_response to new list_to_text
434 * Revision 1.16 2001/08/01 21:33:18 jongfoster
435 * Changes to fill_template() that reduce memory usage without having
436 * an impact on performance. I also renamed some variables so as not
437 * to clash with the C++ keywords "new" and "template".
439 * Revision 1.15 2001/08/01 21:19:22 jongfoster
440 * Moving file version information to a separate CGI page.
442 * Revision 1.14 2001/08/01 00:19:03 jongfoster
443 * New function: map_conditional() for an if-then-else syntax.
444 * Changing to use new version of show_defines()
446 * Revision 1.13 2001/07/30 22:08:36 jongfoster
447 * Tidying up #defines:
448 * - All feature #defines are now of the form FEATURE_xxx
449 * - Permanently turned off WIN_GUI_EDIT
450 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
452 * Revision 1.12 2001/07/29 18:47:05 jongfoster
453 * Adding missing #include "loadcfg.h"
455 * Revision 1.11 2001/07/18 17:24:37 oes
456 * Changed to conform to new pcrs interface
458 * Revision 1.10 2001/07/13 13:53:13 oes
459 * Removed all #ifdef PCRS and related code
461 * Revision 1.9 2001/06/29 21:45:41 oes
462 * Indentation, CRLF->LF, Tab-> Space
464 * Revision 1.8 2001/06/29 13:21:46 oes
465 * - Cosmetics: renamed and reordered functions, variables,
466 * texts, improved comments etc
468 * - Removed ij_untrusted_url() The relevant
469 * info is now part of the "untrusted" page,
470 * which is generated by filters.c:trust_url()
472 * - Generators of content now call finish_http_response()
473 * themselves, making jcc.c:chat() a little less
476 * - Removed obsolete "Pragma: no-cache" from our headers
478 * - http_responses now know their head length
480 * - fill_template now uses the new interface to pcrs, so that
481 * - long jobs (like whole files) no longer have to be assembled
482 * in a fixed size buffer
483 * - the new T (trivial) option is used, and the replacement may
484 * contain Perl syntax backrefs without confusing pcrs
486 * - Introduced default_exports() which generates a set of exports
487 * common to all CGIs and other content generators
489 * - Introduced convenience function map_block_killer()
491 * - Introduced convenience function make_menu()
493 * - Introduced CGI-like function error_response() which generates
494 * the "No such domain" and "Connect failed" messages using the
497 * - cgi_show_url_info:
498 * - adapted to new CGI features
499 * - form and answers now generated from same template
500 * - http:// prefix in URL now OK
503 * - adapted to new CGI features
504 * - no longer uses csp->init_proxy_args
507 * - moved menu generation to make_menu()
509 * - add_stats now writes single export map entries instead
512 * - Moved redirect_url() to filters.c
514 * - Fixed mem leak in free_http_response(), map_block_killer(),
516 * - Removed logentry from cancelled commit
518 * Revision 1.7 2001/06/09 10:51:58 jongfoster
519 * Changing "show URL info" handler to new style.
520 * Changing BUFSIZ ==> BUFFER_SIZE
522 * Revision 1.6 2001/06/07 23:05:19 jongfoster
523 * Removing code related to old forward and ACL files.
525 * Revision 1.5 2001/06/05 19:59:16 jongfoster
526 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
528 * Revision 1.4 2001/06/04 10:41:52 swa
529 * show version string of cgi.h and cgi.c
531 * Revision 1.3 2001/06/03 19:12:16 oes
532 * introduced new cgi handling
534 * No revisions before 1.3
536 **********************************************************************/
542 #include <sys/types.h>
550 #define snprintf _snprintf
551 #endif /* def _WIN32 */
559 #include "miscutil.h"
560 #include "cgisimple.h"
561 #ifdef FEATURE_CGI_EDIT_ACTIONS
563 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
565 /* loadcfg.h is for global_toggle_state only */
566 #ifdef FEATURE_PTHREAD
568 /* jcc.h is for mutex semaphore globals only */
569 #endif /* def FEATURE_PTHREAD */
570 const char cgi_h_rcs[] = CGI_H_VERSION;
573 * List of CGI functions: name, handler, description
574 * Note: Do NOT use single quotes in the description;
575 * this will break the dynamic "blocked" template!
577 static const struct cgi_dispatcher cgi_dispatchers[] = {
582 #ifdef FEATURE_GRACEFUL_TERMINATION
585 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
586 "this is a one click Denial Of Service attack!!!</em>",
591 #ifdef FEATURE_CGI_EDIT_ACTIONS
592 "View & change the current configuration",
594 "View the current configuration",
599 "View the source code version numbers",
603 "View the request headers.",
607 "Look up which actions apply to a URL and why",
609 #ifdef FEATURE_CGI_EDIT_ACTIONS
610 #ifdef FEATURE_TOGGLE
613 "Toggle Privoxy on or off",
615 #endif /* def FEATURE_TOGGLE */
616 { "edit-actions", /* Edit the actions list */
619 { "eaa", /* Shortcut for edit-actions-add-url-form */
620 cgi_edit_actions_add_url_form,
622 { "eau", /* Shortcut for edit-actions-url-form */
623 cgi_edit_actions_url_form,
625 { "ear", /* Shortcut for edit-actions-remove-url-form */
626 cgi_edit_actions_remove_url_form,
628 { "eal", /* Shortcut for edit-actions-list */
629 cgi_edit_actions_list,
631 { "eafu", /* Shortcut for edit-actions-for-url */
632 cgi_edit_actions_for_url,
634 { "eas", /* Shortcut for edit-actions-submit */
635 cgi_edit_actions_submit,
637 { "easa", /* Shortcut for edit-actions-section-add */
638 cgi_edit_actions_section_add,
640 { "easr", /* Shortcut for edit-actions-section-remove */
641 cgi_edit_actions_section_remove,
643 { "eass", /* Shortcut for edit-actions-section-swap */
644 cgi_edit_actions_section_swap,
646 { "edit-actions-for-url",
647 cgi_edit_actions_for_url,
648 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
649 { "edit-actions-list",
650 cgi_edit_actions_list,
651 NULL, TRUE /* Edit the actions list */ },
652 { "edit-actions-submit",
653 cgi_edit_actions_submit,
654 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
655 { "edit-actions-url",
656 cgi_edit_actions_url,
657 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
658 { "edit-actions-url-form",
659 cgi_edit_actions_url_form,
660 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
661 { "edit-actions-add-url",
662 cgi_edit_actions_add_url,
663 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
664 { "edit-actions-add-url-form",
665 cgi_edit_actions_add_url_form,
666 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
667 { "edit-actions-remove-url",
668 cgi_edit_actions_remove_url,
669 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
670 { "edit-actions-remove-url-form",
671 cgi_edit_actions_remove_url_form,
672 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
673 { "edit-actions-section-add",
674 cgi_edit_actions_section_add,
675 NULL, FALSE /* Remove a section from the actionsfile */ },
676 { "edit-actions-section-remove",
677 cgi_edit_actions_section_remove,
678 NULL, FALSE /* Remove a section from the actionsfile */ },
679 { "edit-actions-section-swap",
680 cgi_edit_actions_section_swap,
681 NULL, FALSE /* Swap two sections in the actionsfile */ },
682 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
685 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
688 NULL, TRUE /* Send a built-in image */ },
691 NULL, FALSE /* Send templates/cgi-style.css */ },
693 cgi_transparent_image,
694 NULL, TRUE /* Send a transparent image (short name) */ },
696 cgi_send_user_manual,
697 NULL, TRUE /* Send user-manual */ },
698 { NULL, /* NULL Indicates end of list and default page */
700 NULL, TRUE /* Unknown CGI page */ }
705 * Built-in images for ad replacement
707 * Hint: You can encode your own images like this:
708 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
711 #ifdef FEATURE_NO_GIFS
714 * Checkerboard pattern, as a PNG.
716 const char image_pattern_data[] =
717 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
718 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
719 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
720 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
721 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
722 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
723 "\000\000\000\111\105\116\104\256\102\140\202";
726 * 1x1 transparant PNG.
728 const char image_blank_data[] =
729 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
730 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
731 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
732 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
733 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
734 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
735 "\000\000\000\000\111\105\116\104\256\102\140\202";
739 * Checkerboard pattern, as a GIF.
741 const char image_pattern_data[] =
742 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
743 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
744 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
745 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
749 * 1x1 transparant GIF.
751 const char image_blank_data[] =
752 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
753 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
754 "\000\001\000\000\002\002D\001\000;";
757 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
758 const size_t image_blank_length = sizeof(image_blank_data) - 1;
761 static struct http_response cgi_error_memory_response[1];
763 static struct http_response *dispatch_known_cgi(struct client_state * csp,
765 static struct map *parse_cgi_parameters(char *argstring);
768 /*********************************************************************
770 * Function : dispatch_cgi
772 * Description : Checks if a request URL has either the magical
773 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
774 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
775 * http://config.privoxy.org/). If so, it passes
776 * the (rest of the) path onto dispatch_known_cgi, which
777 * calls the relevant CGI handler function.
780 * 1 : csp = Current client state (buffers, headers, etc...)
782 * Returns : http_response if match, NULL if nonmatch or handler fail
784 *********************************************************************/
785 struct http_response *dispatch_cgi(struct client_state *csp)
787 const char *host = csp->http->host;
788 const char *path = csp->http->path;
791 * Should we intercept ?
794 /* Note: "example.com" and "example.com." are equivalent hostnames. */
796 /* Either the host matches CGI_SITE_1_HOST ..*/
797 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
798 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
799 && (path[0] == '/') )
801 /* ..then the path will all be for us. Remove leading '/' */
804 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
805 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
806 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
807 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
809 /* take everything following CGI_SITE_2_PATH */
810 path += strlen(CGI_SITE_2_PATH);
813 /* skip the forward slash after CGI_SITE_2_PATH */
816 else if (*path != '\0')
819 * weirdness: URL is /configXXX, where XXX is some string
820 * Do *NOT* intercept.
832 * This is a CGI call.
835 return dispatch_known_cgi(csp, path);
839 /*********************************************************************
841 * Function : grep_cgi_referrer
843 * Description : Ugly provisorical fix that greps the value of the
844 * referer HTTP header field out of a linked list of
845 * strings like found at csp->headers. Will disappear
848 * FIXME: csp->headers ought to be csp->http->headers
849 * FIXME: Parsing all client header lines should
850 * happen right after the request is received!
853 * 1 : csp = Current client state (buffers, headers, etc...)
855 * Returns : pointer to value (no copy!), or NULL if none found.
857 *********************************************************************/
858 char *grep_cgi_referrer(const struct client_state *csp)
860 struct list_entry *p;
862 for (p = csp->headers->first; p != NULL; p = p->next)
864 if (p->str == NULL) continue;
865 if (strncmpic(p->str, "Referer: ", 9) == 0)
867 return ((p->str) + 9);
875 /*********************************************************************
877 * Function : referrer_is_safe
879 * Description : Decides whether we trust the Referer for
880 * CGI pages which are only meant to be reachable
881 * through Privoxy's web interface directly.
884 * 1 : csp = Current client state (buffers, headers, etc...)
886 * Returns : TRUE if the referrer is safe, or
887 * FALSE if the referrer is unsafe or not set.
889 *********************************************************************/
890 int referrer_is_safe (const struct client_state *csp)
893 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
895 referrer = grep_cgi_referrer(csp);
897 if (NULL == referrer)
899 /* No referrer, no access */
900 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
903 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
904 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
906 /* Trustworthy referrer */
907 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
908 csp->http->url, referrer);
914 /* Untrustworthy referrer */
915 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
916 csp->http->url, referrer);
923 /*********************************************************************
925 * Function : dispatch_known_cgi
927 * Description : Processes a CGI once dispatch_cgi has determined that
928 * it matches one of the magic prefixes. Parses the path
929 * as a cgi name plus query string, prepares a map that
930 * maps CGI parameter names to their values, initializes
931 * the http_response struct, and calls the relevant CGI
935 * 1 : csp = Current client state (buffers, headers, etc...)
936 * 2 : path = Path of CGI, with the CGI prefix removed.
937 * Should not have a leading "/".
939 * Returns : http_response, or NULL on handler failure or out of
942 *********************************************************************/
943 static struct http_response *dispatch_known_cgi(struct client_state * csp,
946 const struct cgi_dispatcher *d;
947 struct map *param_list;
948 struct http_response *rsp;
949 char *query_args_start;
953 if (NULL == (path_copy = strdup(path)))
955 return cgi_error_memory();
957 query_args_start = path_copy;
958 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
962 if (*query_args_start == '/')
964 *query_args_start++ = '\0';
965 if ((param_list = new_map()))
967 map(param_list, "file", 1, url_decode(query_args_start), 0);
972 if (*query_args_start == '?')
974 *query_args_start++ = '\0';
976 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
979 return cgi_error_memory();
985 * path_copy = CGI call name
986 * param_list = CGI params, as map
989 /* Get mem for response or fail*/
990 if (NULL == (rsp = alloc_http_response()))
993 free_map(param_list);
994 return cgi_error_memory();
997 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
998 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
999 csp->ip_addr_str, csp->http->cmd);
1002 * Find and start the right CGI function
1004 d = cgi_dispatchers;
1007 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1010 * If the called CGI is either harmless, or referred
1011 * from a trusted source, start it.
1013 if (d->harmless || referrer_is_safe(csp))
1015 err = (d->handler)(csp, rsp, param_list);
1020 * Else, modify toggle calls so that they only display
1021 * the status, and deny all other calls.
1023 if (0 == strcmp(path_copy, "toggle"))
1025 unmap(param_list, "set");
1026 err = (d->handler)(csp, rsp, param_list);
1030 err = cgi_error_disabled(csp, rsp);
1035 free_map(param_list);
1037 if (err == JB_ERR_CGI_PARAMS)
1039 err = cgi_error_bad_param(csp, rsp);
1041 if (err && (err != JB_ERR_MEMORY))
1043 /* Unexpected error! Shouldn't get here */
1044 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1045 err = cgi_error_unknown(csp, rsp, err);
1050 return finish_http_response(rsp);
1054 /* Error in handler, probably out-of-memory */
1055 free_http_response(rsp);
1056 return cgi_error_memory();
1064 /*********************************************************************
1066 * Function : parse_cgi_parameters
1068 * Description : Parse a URL-encoded argument string into name/value
1069 * pairs and store them in a struct map list.
1072 * 1 : argstring = string to be parsed. Will be trashed.
1074 * Returns : pointer to param list, or NULL if out of memory.
1076 *********************************************************************/
1077 static struct map *parse_cgi_parameters(char *argstring)
1080 char *vector[BUFFER_SIZE];
1082 struct map *cgi_params;
1084 if (NULL == (cgi_params = new_map()))
1090 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1091 * the fragment identifier along with the request, so we must
1092 * cut it off here, so it won't pollute the CGI params:
1094 if (NULL != (p = strchr(argstring, '#')))
1099 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1101 for (i = 0; i < pairs; i++)
1103 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1106 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1108 free_map(cgi_params);
1119 /*********************************************************************
1121 * Function : get_char_param
1123 * Description : Get a single-character parameter passed to a CGI
1127 * 1 : parameters = map of cgi parameters
1128 * 2 : param_name = The name of the parameter to read
1130 * Returns : Uppercase character on success, '\0' on error.
1132 *********************************************************************/
1133 char get_char_param(const struct map *parameters,
1134 const char *param_name)
1141 ch = *(lookup(parameters, param_name));
1142 if ((ch >= 'a') && (ch <= 'z'))
1144 ch = (char)(ch - 'a' + 'A');
1151 /*********************************************************************
1153 * Function : get_string_param
1155 * Description : Get a string paramater, to be used as an
1156 * ACTION_STRING or ACTION_MULTI paramater.
1157 * Validates the input to prevent stupid/malicious
1158 * users from corrupting their action file.
1161 * 1 : parameters = map of cgi parameters
1162 * 2 : param_name = The name of the parameter to read
1163 * 3 : pparam = destination for paramater. Allocated as
1164 * part of the map "parameters", so don't free it.
1165 * Set to NULL if not specified.
1167 * Returns : JB_ERR_OK on success, or if the paramater
1168 * was not specified.
1169 * JB_ERR_MEMORY on out-of-memory.
1170 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1172 *********************************************************************/
1173 jb_err get_string_param(const struct map *parameters,
1174 const char *param_name,
1175 const char **pparam)
1187 param = lookup(parameters, param_name);
1193 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1198 * Note that the length limit is arbitrary, it just seems
1199 * sensible to limit it to *something*. There's no
1200 * technical reason for any limit at all.
1202 return JB_ERR_CGI_PARAMS;
1205 /* Check every character to see if it's legal */
1207 while ((ch = *s++) != '\0')
1209 if ( ((unsigned char)ch < (unsigned char)' ')
1212 /* Probable hack attempt, or user accidentally used '}'. */
1213 return JB_ERR_CGI_PARAMS;
1224 /*********************************************************************
1226 * Function : get_number_param
1228 * Description : Get a non-negative integer from the parameters
1229 * passed to a CGI function.
1232 * 1 : csp = Current client state (buffers, headers, etc...)
1233 * 2 : parameters = map of cgi parameters
1234 * 3 : name = Name of CGI parameter to read
1235 * 4 : pvalue = destination for value.
1236 * Set to -1 on error.
1238 * Returns : JB_ERR_OK on success
1239 * JB_ERR_MEMORY on out-of-memory
1240 * JB_ERR_CGI_PARAMS if the parameter was not specified
1243 *********************************************************************/
1244 jb_err get_number_param(struct client_state *csp,
1245 const struct map *parameters,
1260 param = lookup(parameters, name);
1263 return JB_ERR_CGI_PARAMS;
1266 /* We don't use atoi because I want to check this carefully... */
1269 while ((ch = *param++) != '\0')
1271 if ((ch < '0') || (ch > '9'))
1273 return JB_ERR_CGI_PARAMS;
1276 ch = (char)(ch - '0');
1280 * <limits.h> defines UINT_MAX
1282 * (UINT_MAX - ch) / 10 is the largest number that
1283 * can be safely multiplied by 10 then have ch added.
1285 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1287 return JB_ERR_CGI_PARAMS;
1290 value = value * 10 + (unsigned)ch;
1301 /*********************************************************************
1303 * Function : error_response
1305 * Description : returns an http_response that explains the reason
1306 * why a request failed.
1309 * 1 : csp = Current client state (buffers, headers, etc...)
1310 * 2 : templatename = Which template should be used for the answer
1311 * 3 : sys_err = system error number
1313 * Returns : A http_response. If we run out of memory, this
1314 * will be cgi_error_memory().
1316 *********************************************************************/
1317 struct http_response *error_response(struct client_state *csp,
1318 const char *templatename,
1322 struct http_response *rsp;
1323 struct map *exports = default_exports(csp, NULL);
1326 if (exports == NULL)
1328 return cgi_error_memory();
1331 if (NULL == (rsp = alloc_http_response()))
1334 return cgi_error_memory();
1337 if (csp->flags & CSP_FLAG_FORCED)
1339 path = strdup(FORCE_PREFIX);
1345 err = string_append(&path, csp->http->path);
1347 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1348 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1349 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1350 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1351 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1354 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1357 /* Some failures, like "404 no such domain", don't have an IP address. */
1358 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1366 free_http_response(rsp);
1367 return cgi_error_memory();
1370 if (!strcmp(templatename, "no-such-domain"))
1372 rsp->status = strdup("404 No such domain");
1373 if (rsp->status == NULL)
1376 free_http_response(rsp);
1377 return cgi_error_memory();
1380 else if (!strcmp(templatename, "connect-failed"))
1382 rsp->status = strdup("503 Connect failed");
1383 if (rsp->status == NULL)
1386 free_http_response(rsp);
1387 return cgi_error_memory();
1391 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1394 free_http_response(rsp);
1395 return cgi_error_memory();
1398 return finish_http_response(rsp);
1402 /*********************************************************************
1404 * Function : cgi_error_disabled
1406 * Description : CGI function that is called to generate an error
1407 * response if the actions editor or toggle CGI are
1408 * accessed despite having being disabled at compile-
1409 * or run-time, or if the user followed an untrusted link
1410 * to access a unsafe CGI feature that is only reachable
1411 * through Privoxy directly.
1414 * 1 : csp = Current client state (buffers, headers, etc...)
1415 * 2 : rsp = http_response data structure for output
1417 * CGI Parameters : none
1419 * Returns : JB_ERR_OK on success
1420 * JB_ERR_MEMORY on out-of-memory error.
1422 *********************************************************************/
1423 jb_err cgi_error_disabled(struct client_state *csp,
1424 struct http_response *rsp)
1426 struct map *exports;
1431 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1433 return JB_ERR_MEMORY;
1435 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1437 /* Not important enough to do anything */
1438 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1441 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1445 /*********************************************************************
1447 * Function : cgi_init_error_messages
1449 * Description : Call at the start of the program to initialize
1450 * the error message used by cgi_error_memory().
1456 *********************************************************************/
1457 void cgi_init_error_messages(void)
1459 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1460 cgi_error_memory_response->head =
1461 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1462 "Content-Type: text/html\r\n"
1464 cgi_error_memory_response->body =
1466 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1468 "<h1>500 Internal Privoxy Error</h1>\r\n"
1469 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1470 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1474 cgi_error_memory_response->head_length =
1475 strlen(cgi_error_memory_response->head);
1476 cgi_error_memory_response->content_length =
1477 strlen(cgi_error_memory_response->body);
1481 /*********************************************************************
1483 * Function : cgi_error_memory
1485 * Description : Called if a CGI function runs out of memory.
1486 * Returns a statically-allocated error response.
1490 * Returns : http_response data structure for output. This is
1491 * statically allocated, for obvious reasons.
1493 *********************************************************************/
1494 struct http_response *cgi_error_memory(void)
1496 /* assert that it's been initialized. */
1497 assert(cgi_error_memory_response->head);
1499 return cgi_error_memory_response;
1503 /*********************************************************************
1505 * Function : cgi_error_no_template
1507 * Description : Almost-CGI function that is called if a template
1508 * cannot be loaded. Note this is not a true CGI,
1509 * it takes a template name rather than a map of
1513 * 1 : csp = Current client state (buffers, headers, etc...)
1514 * 2 : rsp = http_response data structure for output
1515 * 3 : template_name = Name of template that could not
1518 * Returns : JB_ERR_OK on success
1519 * JB_ERR_MEMORY on out-of-memory error.
1521 *********************************************************************/
1522 jb_err cgi_error_no_template(struct client_state *csp,
1523 struct http_response *rsp,
1524 const char *template_name)
1526 static const char status[] =
1527 "500 Internal Privoxy Error";
1528 static const char body_prefix[] =
1530 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1532 "<h1>500 Internal Privoxy Error</h1>\r\n"
1533 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1534 "<p><b>Could not load template file <code>";
1535 static const char body_suffix[] =
1536 "</code> or one of it's included components.</b></p>\r\n"
1537 "<p>Please contact your proxy administrator.</p>\r\n"
1538 "<p>If you are the proxy administrator, please put the required file(s)"
1539 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1540 "location of the <code><i>(confdir)</i></code> directory "
1541 "is specified in the main Privoxy <code>config</code> "
1542 "file. (It's typically the Privoxy install directory"
1544 ", or <code>/etc/privoxy/</code>"
1545 #endif /* ndef _WIN32 */
1552 assert(template_name);
1554 /* Reset rsp, if needed */
1558 rsp->content_length = 0;
1559 rsp->head_length = 0;
1562 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1563 if (rsp->body == NULL)
1565 return JB_ERR_MEMORY;
1567 strcpy(rsp->body, body_prefix);
1568 strcat(rsp->body, template_name);
1569 strcat(rsp->body, body_suffix);
1571 rsp->status = strdup(status);
1572 if (rsp->status == NULL)
1574 return JB_ERR_MEMORY;
1581 /*********************************************************************
1583 * Function : cgi_error_unknown
1585 * Description : Almost-CGI function that is called if an unexpected
1586 * error occurs in the top-level CGI dispatcher.
1587 * In this context, "unexpected" means "anything other
1588 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1589 * expected to handle all other errors internally,
1590 * since they can give more relavent error messages
1593 * Note this is not a true CGI, it takes an error
1594 * code rather than a map of parameters.
1597 * 1 : csp = Current client state (buffers, headers, etc...)
1598 * 2 : rsp = http_response data structure for output
1599 * 3 : error_to_report = Error code to report.
1601 * Returns : JB_ERR_OK on success
1602 * JB_ERR_MEMORY on out-of-memory error.
1604 *********************************************************************/
1605 jb_err cgi_error_unknown(struct client_state *csp,
1606 struct http_response *rsp,
1607 jb_err error_to_report)
1609 static const char status[] =
1610 "500 Internal Privoxy Error";
1611 static const char body_prefix[] =
1613 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1615 "<h1>500 Internal Privoxy Error</h1>\r\n"
1616 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1617 "<p><b>Unexpected internal error: ";
1618 static const char body_suffix[] =
1621 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1622 "file a bug report</a>.</p>\r\n"
1629 /* Reset rsp, if needed */
1633 rsp->content_length = 0;
1634 rsp->head_length = 0;
1637 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1639 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1640 if (rsp->body == NULL)
1642 return JB_ERR_MEMORY;
1644 strcpy(rsp->body, body_prefix);
1645 strcat(rsp->body, errnumbuf);
1646 strcat(rsp->body, body_suffix);
1648 rsp->status = strdup(status);
1649 if (rsp->status == NULL)
1651 return JB_ERR_MEMORY;
1658 /*********************************************************************
1660 * Function : cgi_error_bad_param
1662 * Description : CGI function that is called if the parameters
1663 * (query string) for a CGI were wrong.
1666 * 1 : csp = Current client state (buffers, headers, etc...)
1667 * 2 : rsp = http_response data structure for output
1669 * CGI Parameters : none
1671 * Returns : JB_ERR_OK on success
1672 * JB_ERR_MEMORY on out-of-memory error.
1674 *********************************************************************/
1675 jb_err cgi_error_bad_param(struct client_state *csp,
1676 struct http_response *rsp)
1678 struct map *exports;
1683 if (NULL == (exports = default_exports(csp, NULL)))
1685 return JB_ERR_MEMORY;
1688 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1692 /*********************************************************************
1694 * Function : cgi_redirect
1696 * Description : CGI support function to generate a HTTP redirect
1700 * 1 : rsp = http_response data structure for output
1701 * 2 : target = string with the target URL
1703 * CGI Parameters : None
1705 * Returns : JB_ERR_OK on success
1706 * JB_ERR_MEMORY on out-of-memory error.
1708 *********************************************************************/
1709 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1716 err = enlist_unique_header(rsp->headers, "Location", target);
1718 rsp->status = strdup("302 Local Redirect from Privoxy");
1719 if (rsp->status == NULL)
1721 return JB_ERR_MEMORY;
1728 /*********************************************************************
1730 * Function : add_help_link
1732 * Description : Produce a copy of the string given as item,
1733 * embedded in an HTML link to its corresponding
1734 * section (item name in uppercase) in the actions
1735 * chapter of the user manual, (whose URL is given in
1736 * the config and defaults to our web site).
1738 * FIXME: I currently only work for actions, and would
1739 * like to be generalized for other topics.
1742 * 1 : item = item (will NOT be free()d.)
1743 * It is assumed to be HTML-safe.
1744 * 2 : config = The current configuration.
1746 * Returns : String with item embedded in link, or NULL on
1749 *********************************************************************/
1750 char *add_help_link(const char *item,
1751 struct configuration_spec *config)
1755 if (!item) return NULL;
1757 result = strdup("<a href=\"");
1758 if (!strncmpic(config->usermanual, "file://", 7) ||
1759 !strncmpic(config->usermanual, "http", 4))
1761 string_append(&result, config->usermanual);
1765 string_append(&result, "http://");
1766 string_append(&result, CGI_SITE_2_HOST);
1767 string_append(&result, "/user-manual/");
1769 string_append(&result, ACTIONS_HELP_PREFIX);
1770 string_join (&result, string_toupper(item));
1771 string_append(&result, "\">");
1772 string_append(&result, item);
1773 string_append(&result, "</a> ");
1779 /*********************************************************************
1781 * Function : get_http_time
1783 * Description : Get the time in a format suitable for use in a
1784 * HTTP header - e.g.:
1785 * "Sun, 06 Nov 1994 08:49:37 GMT"
1788 * 1 : time_offset = Time returned will be current time
1789 * plus this number of seconds.
1790 * 2 : buf = Destination for result. Must be long enough
1791 * to hold 29 characters plus a trailing zero.
1795 *********************************************************************/
1796 void get_http_time(int time_offset, char *buf)
1798 static const char day_names[7][4] =
1799 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1800 static const char month_names[12][4] =
1801 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1802 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1805 time_t current_time;
1806 #if defined(HAVE_GMTIME_R)
1808 * Declare dummy up here (instead of inside get/set gmt block) so it
1809 * doesn't go out of scope before it's potentially used in snprintf later.
1810 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1811 * !defined HAVE_GMTIME_R.
1818 time(¤t_time); /* get current time */
1820 current_time += time_offset;
1822 /* get and save the gmt */
1825 t = gmtime_r(¤t_time, &dummy);
1826 #elif FEATURE_PTHREAD
1827 pthread_mutex_lock(&gmtime_mutex);
1828 t = gmtime(¤t_time);
1829 pthread_mutex_unlock(&gmtime_mutex);
1831 t = gmtime(¤t_time);
1835 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1837 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1838 day_names[t->tm_wday],
1840 month_names[t->tm_mon],
1850 /*********************************************************************
1852 * Function : finish_http_response
1854 * Description : Fill in the missing headers in an http response,
1855 * and flatten the headers to an http head.
1858 * 1 : rsp = pointer to http_response to be processed
1860 * Returns : A http_response, usually the rsp parameter.
1861 * On error, free()s rsp and returns cgi_error_memory()
1863 *********************************************************************/
1864 struct http_response *finish_http_response(struct http_response *rsp)
1866 char buf[BUFFER_SIZE];
1869 /* Special case - do NOT change this statically allocated response,
1870 * which is ready for output anyway.
1872 if (rsp == cgi_error_memory_response)
1878 * Fill in the HTTP Status
1880 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1881 err = enlist_first(rsp->headers, buf);
1884 * Set the Content-Length
1886 if (rsp->content_length == 0)
1888 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1892 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1893 err = enlist(rsp->headers, buf);
1896 if (strncmpic(rsp->status, "302", 3))
1899 * If it's not a redirect without any content,
1900 * set the Content-Type to text/html if it's
1901 * not already specified.
1903 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1907 * Fill in the rest of the default headers:
1909 * Date: set to current date/time.
1910 * Last-Modified: set to date/time the page was last changed.
1911 * Expires: set to date/time page next needs reloading.
1912 * Cache-Control: set to "no-cache" if applicable.
1914 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1919 * Set Expires to about 10 min into the future so it'll get reloaded
1920 * occasionally, e.g. if Privoxy gets upgraded.
1925 get_http_time(0, buf);
1926 err = enlist_unique_header(rsp->headers, "Date", buf);
1929 /* Some date in the past. */
1930 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1934 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1935 err = enlist_unique_header(rsp->headers, "Expires", buf);
1938 else if (!strncmpic(rsp->status, "302", 3))
1940 get_http_time(0, buf);
1941 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1946 * Setting "Cache-Control" to "no-cache" and "Expires" to
1947 * the current time doesn't exactly forbid caching, it just
1948 * requires the client to revalidate the cached copy.
1950 * If a temporary problem occurs and the user tries again after
1951 * getting Privoxy's error message, a compliant browser may set the
1952 * If-Modified-Since header with the content of the error page's
1953 * Last-Modified header. More often than not, the document on the server
1954 * is older than Privoxy's error message, the server would send status code
1955 * 304 and the browser would display the outdated error message again and again.
1957 * For documents delivered with status code 404 or 503 we set "Last-Modified"
1958 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1959 * and can be safely used to "revalidate" without getting a status code 304.
1961 * There is no need to let the useless If-Modified-Since header reach the
1962 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1964 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1966 get_http_time(0, buf);
1967 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1968 if (!strncmpic(rsp->status, "404", 3) || !strncmpic(rsp->status, "503", 3))
1970 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1974 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1976 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1977 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1983 * HTTP/1.1 applications that do not support persistent connections MUST
1984 * include the "close" connection option in every message.
1986 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
1991 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1993 free_http_response(rsp);
1994 return cgi_error_memory();
1996 rsp->head_length = strlen(rsp->head);
2003 /*********************************************************************
2005 * Function : alloc_http_response
2007 * Description : Allocates a new http_response structure.
2011 * Returns : pointer to a new http_response, or NULL.
2013 *********************************************************************/
2014 struct http_response *alloc_http_response(void)
2016 return (struct http_response *) zalloc(sizeof(struct http_response));
2021 /*********************************************************************
2023 * Function : free_http_response
2025 * Description : Free the memory occupied by an http_response
2026 * and its depandant structures.
2029 * 1 : rsp = pointer to http_response to be freed
2033 *********************************************************************/
2034 void free_http_response(struct http_response *rsp)
2037 * Must special case cgi_error_memory_response, which is never freed.
2039 if (rsp && (rsp != cgi_error_memory_response))
2044 destroy_list(rsp->headers);
2051 /*********************************************************************
2053 * Function : template_load
2055 * Description : CGI support function that loads a given HTML
2056 * template from the confdir, ignoring comment
2057 * lines and following #include statements up to
2061 * 1 : csp = Current client state (buffers, headers, etc...)
2062 * 2 : template_ptr = Destination for pointer to loaded
2064 * 3 : templatename = name of the HTML template to be used
2065 * 4 : recursive = Flag set if this function calls itself
2066 * following an #include statament
2068 * Returns : JB_ERR_OK on success
2069 * JB_ERR_MEMORY on out-of-memory error.
2070 * JB_ERR_FILE if the template file cannot be read
2072 *********************************************************************/
2073 jb_err template_load(struct client_state *csp, char **template_ptr,
2074 const char *templatename, int recursive)
2077 char *templates_dir_path;
2080 char *included_module;
2083 char buf[BUFFER_SIZE];
2086 assert(template_ptr);
2087 assert(templatename);
2089 *template_ptr = NULL;
2091 /* Validate template name. Paranoia. */
2092 for (p = templatename; *p != 0; p++)
2094 if ( ((*p < 'a') || (*p > 'z'))
2095 && ((*p < 'A') || (*p > 'Z'))
2096 && ((*p < '0') || (*p > '9'))
2100 /* Illegal character */
2105 /* Generate full path */
2107 templates_dir_path = make_path(csp->config->confdir, "templates");
2108 if (templates_dir_path == NULL)
2110 return JB_ERR_MEMORY;
2113 full_path = make_path(templates_dir_path, templatename);
2114 free(templates_dir_path);
2115 if (full_path == NULL)
2117 return JB_ERR_MEMORY;
2120 /* Allocate buffer */
2122 file_buffer = strdup("");
2123 if (file_buffer == NULL)
2126 return JB_ERR_MEMORY;
2129 /* Open template file */
2131 if (NULL == (fp = fopen(full_path, "r")))
2133 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2141 * Read the file, ignoring comments, and honoring #include
2142 * statements, unless we're already called recursively.
2144 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2145 * This is unlikely in practise.
2147 while (fgets(buf, BUFFER_SIZE, fp))
2149 if (!recursive && !strncmp(buf, "#include ", 9))
2151 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2158 if (string_join(&file_buffer, included_module))
2161 return JB_ERR_MEMORY;
2167 /* skip lines starting with '#' */
2173 if (string_append(&file_buffer, buf))
2176 return JB_ERR_MEMORY;
2181 *template_ptr = file_buffer;
2187 /*********************************************************************
2189 * Function : template_fill
2191 * Description : CGI support function that fills in a pre-loaded
2192 * HTML template by replacing @name@ with value using
2193 * pcrs, for each item in the output map.
2195 * Note that a leading '$' charachter in the export map's
2196 * values will be stripped and toggle on backreference
2200 * 1 : template_ptr = IN: Template to be filled out.
2202 * OUT: Filled out template.
2203 * Caller must free().
2204 * 2 : exports = map with fill in symbol -> name pairs
2206 * Returns : JB_ERR_OK on success (and for uncritical errors)
2207 * JB_ERR_MEMORY on out-of-memory error
2209 *********************************************************************/
2210 jb_err template_fill(char **template_ptr, const struct map *exports)
2212 struct map_entry *m;
2214 char buf[BUFFER_SIZE];
2215 char *tmp_out_buffer;
2221 assert(template_ptr);
2222 assert(*template_ptr);
2225 file_buffer = *template_ptr;
2226 size = strlen(file_buffer) + 1;
2229 * Assemble pcrs joblist from exports map
2231 for (m = exports->first; m != NULL; m = m->next)
2233 if (*m->name == '$')
2236 * First character of name is '$', so remove this flag
2237 * character and allow backreferences ($1 etc) in the
2238 * "replace with" text.
2240 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2246 * Treat the "replace with" text as a literal string -
2247 * no quoting needed, no backreferences allowed.
2248 * ("Trivial" ['T'] flag).
2252 /* Enclose name in @@ */
2253 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2257 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2259 /* Make and run job. */
2260 job = pcrs_compile(buf, m->value, flags, &error);
2263 if (error == PCRS_ERR_NOMEM)
2266 *template_ptr = NULL;
2267 return JB_ERR_MEMORY;
2271 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2272 /* Hope it wasn't important and silently ignore the invalid job */
2277 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2280 if (NULL == tmp_out_buffer)
2282 *template_ptr = NULL;
2283 return JB_ERR_MEMORY;
2289 * Substitution failed, keep the original buffer,
2290 * log the problem and ignore it.
2292 * The user might see some unresolved @CGI_VARIABLES@,
2293 * but returning a special CGI error page seems unreasonable
2294 * and could mask more important error messages.
2296 free(tmp_out_buffer);
2297 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2298 buf, m->value, flags, pcrs_strerror(error));
2302 /* Substitution succeeded, use modified buffer. */
2304 file_buffer = tmp_out_buffer;
2312 *template_ptr = file_buffer;
2317 /*********************************************************************
2319 * Function : template_fill_for_cgi
2321 * Description : CGI support function that loads a HTML template
2322 * and fills it in. Handles file-not-found errors
2323 * by sending a HTML error message. For convenience,
2324 * this function also frees the passed "exports" map.
2327 * 1 : csp = Client state
2328 * 2 : templatename = name of the HTML template to be used
2329 * 3 : exports = map with fill in symbol -> name pairs.
2330 * Will be freed by this function.
2331 * 4 : rsp = Response structure to fill in.
2333 * Returns : JB_ERR_OK on success
2334 * JB_ERR_MEMORY on out-of-memory error
2336 *********************************************************************/
2337 jb_err template_fill_for_cgi(struct client_state *csp,
2338 const char *templatename,
2339 struct map *exports,
2340 struct http_response *rsp)
2345 assert(templatename);
2349 err = template_load(csp, &rsp->body, templatename, 0);
2350 if (err == JB_ERR_FILE)
2353 return cgi_error_no_template(csp, rsp, templatename);
2358 return err; /* JB_ERR_MEMORY */
2360 err = template_fill(&rsp->body, exports);
2366 /*********************************************************************
2368 * Function : default_exports
2370 * Description : returns a struct map list that contains exports
2371 * which are common to all CGI functions.
2374 * 1 : csp = Current client state (buffers, headers, etc...)
2375 * 2 : caller = name of CGI who calls us and which should
2376 * be excluded from the generated menu. May be
2378 * Returns : NULL if no memory, else a new map. Caller frees.
2380 *********************************************************************/
2381 struct map *default_exports(const struct client_state *csp, const char *caller)
2385 struct map * exports;
2386 int local_help_exists = 0;
2390 exports = new_map();
2391 if (exports == NULL)
2396 err = map(exports, "version", 1, html_encode(VERSION), 0);
2397 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2398 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2399 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2400 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2401 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2402 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2403 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2404 !strncmpic(csp->config->usermanual, "http", 4))
2406 /* Manual is located somewhere else, just link to it. */
2407 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2411 /* Manual is delivered by Privoxy. */
2412 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2414 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2415 #ifdef FEATURE_TOGGLE
2416 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2418 if (!err) err = map_block_killer(exports, "can-toggle");
2421 snprintf(buf, 20, "%d", csp->config->hport);
2422 if (!err) err = map(exports, "my-port", 1, buf, 1);
2424 if(!strcmp(CODE_STATUS, "stable"))
2426 if (!err) err = map_block_killer(exports, "unstable");
2429 if (csp->config->admin_address != NULL)
2431 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2432 local_help_exists = 1;
2436 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2439 if (csp->config->proxy_info_url != NULL)
2441 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2442 local_help_exists = 1;
2446 if (!err) err = map_block_killer(exports, "have-proxy-info");
2449 if (local_help_exists == 0)
2451 if (!err) err = map_block_killer(exports, "have-help-info");
2464 /*********************************************************************
2466 * Function : map_block_killer
2468 * Description : Convenience function.
2469 * Adds a "killer" for the conditional HTML-template
2470 * block <name>, i.e. a substitution of the regex
2471 * "if-<name>-start.*if-<name>-end" to the given
2475 * 1 : exports = map to extend
2476 * 2 : name = name of conditional block
2478 * Returns : JB_ERR_OK on success
2479 * JB_ERR_MEMORY on out-of-memory error.
2481 *********************************************************************/
2482 jb_err map_block_killer(struct map *exports, const char *name)
2484 char buf[1000]; /* Will do, since the names are hardwired */
2488 assert(strlen(name) < 490);
2490 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2491 return map(exports, buf, 1, "", 1);
2495 /*********************************************************************
2497 * Function : map_block_keep
2499 * Description : Convenience function. Removes the markers used
2500 * by map-block-killer, to save a few bytes.
2501 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2504 * 1 : exports = map to extend
2505 * 2 : name = name of conditional block
2507 * Returns : JB_ERR_OK on success
2508 * JB_ERR_MEMORY on out-of-memory error.
2510 *********************************************************************/
2511 jb_err map_block_keep(struct map *exports, const char *name)
2514 char buf[500]; /* Will do, since the names are hardwired */
2518 assert(strlen(name) < 490);
2520 snprintf(buf, 500, "if-%s-start", name);
2521 err = map(exports, buf, 1, "", 1);
2528 snprintf(buf, 500, "if-%s-end", name);
2529 return map(exports, buf, 1, "", 1);
2533 /*********************************************************************
2535 * Function : map_conditional
2537 * Description : Convenience function.
2538 * Adds an "if-then-else" for the conditional HTML-template
2539 * block <name>, i.e. a substitution of the form:
2546 * The control structure and one of the alternatives
2550 * 1 : exports = map to extend
2551 * 2 : name = name of conditional block
2552 * 3 : choose_first = nonzero for first, zero for second.
2554 * Returns : JB_ERR_OK on success
2555 * JB_ERR_MEMORY on out-of-memory error.
2557 *********************************************************************/
2558 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2560 char buf[1000]; /* Will do, since the names are hardwired */
2565 assert(strlen(name) < 480);
2567 snprintf(buf, 1000, (choose_first
2568 ? "else-not-%s@.*@endif-%s"
2569 : "if-%s-then@.*@else-not-%s"),
2572 err = map(exports, buf, 1, "", 1);
2578 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2579 return map(exports, buf, 1, "", 1);
2583 /*********************************************************************
2585 * Function : make_menu
2587 * Description : Returns an HTML-formatted menu of the available
2588 * unhidden CGIs, excluding the one given in <self>
2589 * and the toggle CGI if toggling is disabled.
2592 * 1 : self = name of CGI to leave out, can be NULL for
2594 * 2 : feature_flags = feature bitmap from csp->config
2597 * Returns : menu string, or NULL on out-of-memory error.
2599 *********************************************************************/
2600 char *make_menu(const char *self, const unsigned feature_flags)
2602 const struct cgi_dispatcher *d;
2603 char *result = strdup("");
2607 self = "NO-SUCH-CGI!";
2610 /* List available unhidden CGI's and export as "other-cgis" */
2611 for (d = cgi_dispatchers; d->name; d++)
2614 #ifdef FEATURE_TOGGLE
2615 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2618 * Suppress the toggle link if remote toggling is disabled.
2622 #endif /* def FEATURE_TOGGLE */
2624 if (d->description && strcmp(d->name, self))
2626 char *html_encoded_prefix;
2628 string_append(&result, "<li><a href=\"");
2629 html_encoded_prefix = html_encode(CGI_PREFIX);
2630 if (html_encoded_prefix == NULL)
2636 string_append(&result, html_encoded_prefix);
2637 free(html_encoded_prefix);
2639 string_append(&result, d->name);
2640 string_append(&result, "\">");
2641 string_append(&result, d->description);
2642 string_append(&result, "</a></li>\n");
2650 /*********************************************************************
2652 * Function : dump_map
2654 * Description : HTML-dump a map for debugging (as table)
2657 * 1 : the_map = map to dump
2659 * Returns : string with HTML
2661 *********************************************************************/
2662 char *dump_map(const struct map *the_map)
2664 struct map_entry *cur_entry;
2665 char *ret = strdup("");
2667 string_append(&ret, "<table>\n");
2669 for (cur_entry = the_map->first;
2670 (cur_entry != NULL) && (ret != NULL);
2671 cur_entry = cur_entry->next)
2673 string_append(&ret, "<tr><td><b>");
2674 string_join (&ret, html_encode(cur_entry->name));
2675 string_append(&ret, "</b></td><td>");
2676 string_join (&ret, html_encode(cur_entry->value));
2677 string_append(&ret, "</td></tr>\n");
2680 string_append(&ret, "</table>\n");