1 const char cgi_rcs[] = "$Id: cgi.c,v 1.86 2007/01/09 11:54:26 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.86 2007/01/09 11:54:26 fabiankeil
42 * Fix strdup() error handling in cgi_error_unknown()
43 * and cgi_error_no_template(). Reported by Markus Elfring.
45 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
46 * Handle pcrs_execute() errors in template_fill() properly.
48 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
49 * Fixed gcc43 conversion warnings and replaced sprintf
50 * calls with snprintf to give OpenBSD's gcc one less reason
53 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
54 * Escape ampersand in Privoxy menu.
56 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
57 * Suppress the toggle link if remote toggling is disabled.
59 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
60 * Fix configure option --disable-toggle.
61 * Thanks to Peter Thoenen for reporting this.
63 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
64 * Don't lose the FORCE_PREFIX in case of
65 * connection problems. Fixes #612235.
67 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
68 * Make pthread mutex locking more generic. Instead of
69 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
70 * and use mutex locking unless there is an _r function
71 * available. Better safe than sorry.
73 * Fixes "./configure --disable-pthread" and should result
74 * in less threading-related problems on pthread-using platforms,
75 * but it still doesn't fix BR#1122404.
77 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
78 * Use CGI_PREFIX to check the referrer.
79 * The check for "http://config.privoxy.org/" fails
80 * if the user modified CGI_SITE_2_HOST.
82 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
83 * Adjusted headers for Privoxy's cgi responses:
84 * Don't set Last-Modified, Expires and Cache-Control
85 * headers for redirects; always set "Connection: close".
87 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
88 * Only predate the Last-Modified header for cgi responses
89 * that are delivered with status code 404 or 503.
91 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
92 * Mark cgi_send_user_manual as harmless,
93 * to fix the access denied problem Hal spotted.
94 * The manual has no secret content, therefore we
95 * don't have to care about "secure" referrers.
97 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
98 * Incorporate modified version of Roland Rosenfeld's patch to
99 * optionally access the user-manual via Privoxy. Closes patch 679075.
101 * Formatting changed to Privoxy style, added call to
102 * cgi_error_no_template if the requested file doesn't
103 * exist and modified check whether or not Privoxy itself
104 * should serve the manual. Should work cross-platform now.
106 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
107 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
109 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
110 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
111 * with what was really the latest development (the v_3_0_branch branch)
113 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
114 * Moved cgi_error_disabled() from cgiedit.c to
115 * cgi.c to re-enable build with --disable-editor.
116 * Fixes Bug #892744. Thanks to Matthew Fischer
119 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
120 * - Added new function cgi_redirect to handle creation of
121 * HTTP redirect messages formerly repeated in the code.
122 * - Send cgi_error_disabled instead of cgi_error_404 when
123 * referrer check fails
124 * - Dynamic content now gets Expires header field with date
127 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
128 * Bugfix: Transparent PNG was not transparent. Thanks to
129 * Dan Razzell of Starfish Systems for notice and new PNG.
131 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
132 * Security fix: dspatch_known_cgi no longer considers an empty
133 * referrer safe for critical CGIs, since malicious links could
134 * reside on https:// locations which browsers don't advertize as
135 * referrers. Closes bug #749916, thanks to Jeff Epler for the
136 * hint. Goodbye One-Click[tm] toggling :-(
138 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
141 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
142 * Killed a compiler warning on OSX
144 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
145 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
146 * (fixes bug #710056)
147 * - Show toggle info only if we have it
149 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
150 * Move declaration of struct tm dummy outside of a control block so it is
151 * accessible later on during snprintf in get_http_time.
153 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
154 * Cosmetic: Renamed cryptic variable
156 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
157 * 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.
159 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
160 * Disable access to critical CGIs via untrusted referrers.
161 * This prevents users from being tricked by malicious websites
162 * into making unintentional configuration changes:
164 * - Added flag to each cgi_dispatcher that allows or denies
166 * - Introduced proviorical function that greps for the
167 * referrer header before regular header parsing happens
168 * - Added safety check to dispatch_known_cgi. CGI is called
169 * if (cgi harmless || no referrer || we are referrer).
170 * Else a) toggle calls are modified not to change status and
171 * b) all other calls are denied.
173 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
174 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
176 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
177 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
179 * Revision 1.70 2002/05/19 11:33:20 jongfoster
180 * If a CGI error was not handled, and propogated back to
181 * dispatch_known_cgi(), then it was assumed to be "out of memory".
182 * This gave a very misleading error message.
184 * Now other errors will cause a simple message giving the error
185 * number and asking the user to report a bug.
188 * http://sourceforge.net/tracker/index.php?func=detail
189 * &aid=557905&group_id=11118&atid=111118
191 * Revision 1.69 2002/05/14 21:28:40 oes
192 * - Fixed add_help_link to link to the (now split) actions
193 * part of the config chapter
194 * - Renamed helplink export to actions-help-prefix
196 * Revision 1.68 2002/05/12 21:36:29 jongfoster
197 * Correcting function comments
199 * Revision 1.67 2002/04/30 12:02:07 oes
200 * Nit: updated a comment
202 * Revision 1.66 2002/04/26 18:32:57 jongfoster
203 * Fixing a memory leak on error
205 * Revision 1.65 2002/04/26 12:53:51 oes
206 * - New function add_help_link
207 * - default_exports now exports links to the user manual
208 * and a prefix for links into the config chapter
210 * Revision 1.64 2002/04/24 02:17:21 oes
211 * - Better descriptions for CGIs
212 * - Hide edit-actions, more shortcuts
213 * - Moved get_char_param, get_string_param and get_number_param here
216 * Revision 1.63 2002/04/15 19:06:43 jongfoster
219 * Revision 1.62 2002/04/10 19:59:46 jongfoster
220 * Fixes to #include in templates:
221 * - Didn't close main file if loading an included template fails.
222 * - I'm paranoid and want to disallow "#include /etc/passwd".
224 * Revision 1.61 2002/04/10 13:37:48 oes
225 * Made templates modular: template_load now recursive with max depth 1
227 * Revision 1.60 2002/04/08 20:50:25 swa
230 * Revision 1.59 2002/04/05 15:51:51 oes
231 * - added send-stylesheet CGI
232 * - bugfix: error-pages now get correct request protocol
234 * - kludged CGI descriptions and menu not to break JS syntax
236 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
237 * Fix Mac OSX compiler warnings
239 * Revision 1.57 2002/03/26 22:29:54 swa
240 * we have a new homepage!
242 * Revision 1.56 2002/03/24 17:50:46 jongfoster
243 * Fixing compile error if actions file editor disabled
245 * Revision 1.55 2002/03/24 16:55:06 oes
246 * Making GIF checkerboard transparent
248 * Revision 1.54 2002/03/24 16:18:15 jongfoster
251 * Revision 1.53 2002/03/24 16:06:00 oes
252 * Correct transparency for checkerboard PNG. Thanks, Magnus!
254 * Revision 1.52 2002/03/24 15:23:33 jongfoster
257 * Revision 1.51 2002/03/24 13:25:43 swa
258 * name change related issues
260 * Revision 1.50 2002/03/16 23:54:06 jongfoster
261 * Adding graceful termination feature, to help look for memory leaks.
262 * If you enable this (which, by design, has to be done by hand
263 * editing config.h) and then go to http://i.j.b/die, then the program
264 * will exit cleanly after the *next* request. It should free all the
265 * memory that was used.
267 * Revision 1.49 2002/03/13 00:27:04 jongfoster
270 * Revision 1.48 2002/03/08 17:47:07 jongfoster
273 * Revision 1.47 2002/03/08 16:41:33 oes
274 * Added GIF images again
276 * Revision 1.46 2002/03/07 03:48:38 oes
277 * - Changed built-in images from GIF to PNG
278 * (with regard to Unisys patent issue)
279 * - Added a 4x4 pattern PNG which is less intrusive
280 * than the logo but also clearly marks the deleted banners
282 * Revision 1.45 2002/03/06 22:54:35 jongfoster
283 * Automated function-comment nitpicking.
285 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
286 * - Better error reporting on OS/2
287 * - Fix double-slash comment (oops)
289 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
290 * - Re-enable OS/2 building after new parms were added
291 * - Fix false out of memory report when resolving CGI templates when no IP
292 * address is available of failed attempt (a la no such domain)
294 * Revision 1.42 2002/01/21 00:33:20 jongfoster
295 * Replacing strsav() with the safer string_append() or string_join().
296 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
297 * Adding missing html_encode() to error message generators.
298 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
300 * Revision 1.41 2002/01/17 20:56:22 jongfoster
301 * Replacing hard references to the URL of the config interface
302 * with #defines from project.h
304 * Revision 1.40 2002/01/09 14:26:46 oes
305 * Added support for thread-safe gmtime_r call.
307 * Revision 1.39 2001/11/16 00:48:13 jongfoster
308 * Fixing a compiler warning
310 * Revision 1.38 2001/11/13 00:31:21 jongfoster
311 * - Adding new CGIs for use by non-JavaScript browsers:
312 * edit-actions-url-form
313 * edit-actions-add-url-form
314 * edit-actions-remove-url-form
315 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
318 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
319 * Show enablement/disablement status in almost all templates.
320 * There is a little trickiness here: apparent recursive resolution of
321 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
322 * the actual enablement status. So a similar construct,
323 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
326 * Revision 1.36 2001/10/26 17:33:27 oes
329 * Revision 1.35 2001/10/23 21:48:19 jongfoster
330 * Cleaning up error handling in CGI functions - they now send back
331 * a HTML error page and should never cause a FATAL error. (Fixes one
332 * potential source of "denial of service" attacks).
334 * CGI actions file editor that works and is actually useful.
336 * Ability to toggle Junkbuster remotely using a CGI call.
338 * You can turn off both the above features in the main configuration
339 * file, e.g. if you are running a multi-user proxy.
341 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
342 * Only show "Local support" on templates conditionally:
343 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
344 * - if not, no Local support section appears
346 * Revision 1.33 2001/10/14 22:28:41 jongfoster
347 * Fixing stupid typo.
349 * Revision 1.32 2001/10/14 22:20:18 jongfoster
350 * - Changes to CGI dispatching method to match CGI names exactly,
351 * rather than doing a prefix match.
352 * - No longer need to count the length of the CGI handler names by hand.
353 * - Adding new handler for 404 error when disptching a CGI, if none of
354 * the handlers match.
355 * - Adding new handlers for CGI actionsfile editor.
357 * Revision 1.31 2001/10/10 10:56:39 oes
358 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
360 * Revision 1.30 2001/10/02 15:30:57 oes
361 * Introduced show-request cgi
363 * Revision 1.29 2001/09/20 15:47:44 steudten
365 * Fix BUG: Modify int size to size_t size in fill_template()
366 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
368 * Revision 1.28 2001/09/19 18:00:37 oes
369 * - Deletef time() FIXME (Can't fail under Linux either, if
370 * the argument is guaranteed to be in out address space,
373 * - Pointer notation cosmetics
374 * - Fixed a minor bug in template_fill(): Failiure of
375 * pcrs_execute() now secure.
377 * Revision 1.27 2001/09/16 17:08:54 jongfoster
378 * Moving simple CGI functions from cgi.c to new file cgisimple.c
380 * Revision 1.26 2001/09/16 15:47:37 jongfoster
381 * First version of CGI-based edit interface. This is very much a
382 * work-in-progress, and you can't actually use it to edit anything
383 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
384 * to have any effect.
386 * Revision 1.25 2001/09/16 15:02:35 jongfoster
387 * Adding i.j.b/robots.txt.
388 * Inlining add_stats() since it's only ever called from one place.
390 * Revision 1.24 2001/09/16 11:38:01 jongfoster
391 * Splitting fill_template() into 2 functions:
392 * template_load() loads the file
393 * template_fill() performs the PCRS regexps.
394 * This is because the CGI edit interface has a "table row"
395 * template which is used many times in the page - this
396 * change means it's only loaded from disk once.
398 * Revision 1.23 2001/09/16 11:16:05 jongfoster
399 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
401 * Revision 1.22 2001/09/16 11:00:10 jongfoster
402 * New function alloc_http_response, for symmetry with free_http_response
404 * Revision 1.21 2001/09/13 23:53:03 jongfoster
405 * Support for both static and dynamically generated CGI pages.
406 * Correctly setting Last-Modified: and Expires: HTTP headers.
408 * Revision 1.20 2001/09/13 23:40:36 jongfoster
409 * (Cosmetic only) Indentation correction
411 * Revision 1.19 2001/09/13 23:31:25 jongfoster
412 * Moving image data to cgi.c rather than cgi.h.
414 * Revision 1.18 2001/08/05 16:06:20 jongfoster
415 * Modifiying "struct map" so that there are now separate header and
416 * "map_entry" structures. This means that functions which modify a
417 * map no longer need to return a pointer to the modified map.
418 * Also, it no longer reverses the order of the entries (which may be
419 * important with some advanced template substitutions).
421 * Revision 1.17 2001/08/05 15:57:38 oes
422 * Adapted finish_http_response to new list_to_text
424 * Revision 1.16 2001/08/01 21:33:18 jongfoster
425 * Changes to fill_template() that reduce memory usage without having
426 * an impact on performance. I also renamed some variables so as not
427 * to clash with the C++ keywords "new" and "template".
429 * Revision 1.15 2001/08/01 21:19:22 jongfoster
430 * Moving file version information to a separate CGI page.
432 * Revision 1.14 2001/08/01 00:19:03 jongfoster
433 * New function: map_conditional() for an if-then-else syntax.
434 * Changing to use new version of show_defines()
436 * Revision 1.13 2001/07/30 22:08:36 jongfoster
437 * Tidying up #defines:
438 * - All feature #defines are now of the form FEATURE_xxx
439 * - Permanently turned off WIN_GUI_EDIT
440 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
442 * Revision 1.12 2001/07/29 18:47:05 jongfoster
443 * Adding missing #include "loadcfg.h"
445 * Revision 1.11 2001/07/18 17:24:37 oes
446 * Changed to conform to new pcrs interface
448 * Revision 1.10 2001/07/13 13:53:13 oes
449 * Removed all #ifdef PCRS and related code
451 * Revision 1.9 2001/06/29 21:45:41 oes
452 * Indentation, CRLF->LF, Tab-> Space
454 * Revision 1.8 2001/06/29 13:21:46 oes
455 * - Cosmetics: renamed and reordered functions, variables,
456 * texts, improved comments etc
458 * - Removed ij_untrusted_url() The relevant
459 * info is now part of the "untrusted" page,
460 * which is generated by filters.c:trust_url()
462 * - Generators of content now call finish_http_response()
463 * themselves, making jcc.c:chat() a little less
466 * - Removed obsolete "Pragma: no-cache" from our headers
468 * - http_responses now know their head length
470 * - fill_template now uses the new interface to pcrs, so that
471 * - long jobs (like whole files) no longer have to be assembled
472 * in a fixed size buffer
473 * - the new T (trivial) option is used, and the replacement may
474 * contain Perl syntax backrefs without confusing pcrs
476 * - Introduced default_exports() which generates a set of exports
477 * common to all CGIs and other content generators
479 * - Introduced convenience function map_block_killer()
481 * - Introduced convenience function make_menu()
483 * - Introduced CGI-like function error_response() which generates
484 * the "No such domain" and "Connect failed" messages using the
487 * - cgi_show_url_info:
488 * - adapted to new CGI features
489 * - form and answers now generated from same template
490 * - http:// prefix in URL now OK
493 * - adapted to new CGI features
494 * - no longer uses csp->init_proxy_args
497 * - moved menu generation to make_menu()
499 * - add_stats now writes single export map entries instead
502 * - Moved redirect_url() to filters.c
504 * - Fixed mem leak in free_http_response(), map_block_killer(),
506 * - Removed logentry from cancelled commit
508 * Revision 1.7 2001/06/09 10:51:58 jongfoster
509 * Changing "show URL info" handler to new style.
510 * Changing BUFSIZ ==> BUFFER_SIZE
512 * Revision 1.6 2001/06/07 23:05:19 jongfoster
513 * Removing code related to old forward and ACL files.
515 * Revision 1.5 2001/06/05 19:59:16 jongfoster
516 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
518 * Revision 1.4 2001/06/04 10:41:52 swa
519 * show version string of cgi.h and cgi.c
521 * Revision 1.3 2001/06/03 19:12:16 oes
522 * introduced new cgi handling
524 * No revisions before 1.3
526 **********************************************************************/
532 #include <sys/types.h>
540 #define snprintf _snprintf
541 #endif /* def _WIN32 */
549 #include "miscutil.h"
550 #include "cgisimple.h"
551 #ifdef FEATURE_CGI_EDIT_ACTIONS
553 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
555 /* loadcfg.h is for global_toggle_state only */
556 #ifdef FEATURE_PTHREAD
558 /* jcc.h is for mutex semaphore globals only */
559 #endif /* def FEATURE_PTHREAD */
560 const char cgi_h_rcs[] = CGI_H_VERSION;
563 * List of CGI functions: name, handler, description
564 * Note: Do NOT use single quotes in the description;
565 * this will break the dynamic "blocked" template!
567 static const struct cgi_dispatcher cgi_dispatchers[] = {
572 #ifdef FEATURE_GRACEFUL_TERMINATION
575 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
576 "this is a one click Denial Of Service attack!!!</em>",
581 #ifdef FEATURE_CGI_EDIT_ACTIONS
582 "View & change the current configuration",
584 "View the current configuration",
589 "View the source code version numbers",
593 "View the request headers.",
597 "Look up which actions apply to a URL and why",
599 #ifdef FEATURE_CGI_EDIT_ACTIONS
600 #ifdef FEATURE_TOGGLE
603 "Toggle Privoxy on or off",
605 #endif /* def FEATURE_TOGGLE */
606 { "edit-actions", /* Edit the actions list */
609 { "eaa", /* Shortcut for edit-actions-add-url-form */
610 cgi_edit_actions_add_url_form,
612 { "eau", /* Shortcut for edit-actions-url-form */
613 cgi_edit_actions_url_form,
615 { "ear", /* Shortcut for edit-actions-remove-url-form */
616 cgi_edit_actions_remove_url_form,
618 { "eal", /* Shortcut for edit-actions-list */
619 cgi_edit_actions_list,
621 { "eafu", /* Shortcut for edit-actions-for-url */
622 cgi_edit_actions_for_url,
624 { "eas", /* Shortcut for edit-actions-submit */
625 cgi_edit_actions_submit,
627 { "easa", /* Shortcut for edit-actions-section-add */
628 cgi_edit_actions_section_add,
630 { "easr", /* Shortcut for edit-actions-section-remove */
631 cgi_edit_actions_section_remove,
633 { "eass", /* Shortcut for edit-actions-section-swap */
634 cgi_edit_actions_section_swap,
636 { "edit-actions-for-url",
637 cgi_edit_actions_for_url,
638 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
639 { "edit-actions-list",
640 cgi_edit_actions_list,
641 NULL, TRUE /* Edit the actions list */ },
642 { "edit-actions-submit",
643 cgi_edit_actions_submit,
644 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
645 { "edit-actions-url",
646 cgi_edit_actions_url,
647 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
648 { "edit-actions-url-form",
649 cgi_edit_actions_url_form,
650 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
651 { "edit-actions-add-url",
652 cgi_edit_actions_add_url,
653 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
654 { "edit-actions-add-url-form",
655 cgi_edit_actions_add_url_form,
656 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
657 { "edit-actions-remove-url",
658 cgi_edit_actions_remove_url,
659 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
660 { "edit-actions-remove-url-form",
661 cgi_edit_actions_remove_url_form,
662 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
663 { "edit-actions-section-add",
664 cgi_edit_actions_section_add,
665 NULL, FALSE /* Remove a section from the actionsfile */ },
666 { "edit-actions-section-remove",
667 cgi_edit_actions_section_remove,
668 NULL, FALSE /* Remove a section from the actionsfile */ },
669 { "edit-actions-section-swap",
670 cgi_edit_actions_section_swap,
671 NULL, FALSE /* Swap two sections in the actionsfile */ },
672 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
675 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
678 NULL, TRUE /* Send a built-in image */ },
681 NULL, FALSE /* Send templates/cgi-style.css */ },
683 cgi_transparent_image,
684 NULL, TRUE /* Send a transparent image (short name) */ },
686 cgi_send_user_manual,
687 NULL, TRUE /* Send user-manual */ },
688 { NULL, /* NULL Indicates end of list and default page */
690 NULL, TRUE /* Unknown CGI page */ }
695 * Built-in images for ad replacement
697 * Hint: You can encode your own images like this:
698 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
701 #ifdef FEATURE_NO_GIFS
704 * Checkerboard pattern, as a PNG.
706 const char image_pattern_data[] =
707 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
708 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
709 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
710 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
711 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
712 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
713 "\000\000\000\111\105\116\104\256\102\140\202";
716 * 1x1 transparant PNG.
718 const char image_blank_data[] =
719 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
720 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
721 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
722 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
723 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
724 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
725 "\000\000\000\000\111\105\116\104\256\102\140\202";
729 * Checkerboard pattern, as a GIF.
731 const char image_pattern_data[] =
732 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
733 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
734 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
735 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
739 * 1x1 transparant GIF.
741 const char image_blank_data[] =
742 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
743 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
744 "\000\001\000\000\002\002D\001\000;";
747 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
748 const size_t image_blank_length = sizeof(image_blank_data) - 1;
751 static struct http_response cgi_error_memory_response[1];
753 static struct http_response *dispatch_known_cgi(struct client_state * csp,
755 static struct map *parse_cgi_parameters(char *argstring);
758 /*********************************************************************
760 * Function : dispatch_cgi
762 * Description : Checks if a request URL has either the magical
763 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
764 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
765 * http://config.privoxy.org/). If so, it passes
766 * the (rest of the) path onto dispatch_known_cgi, which
767 * calls the relevant CGI handler function.
770 * 1 : csp = Current client state (buffers, headers, etc...)
772 * Returns : http_response if match, NULL if nonmatch or handler fail
774 *********************************************************************/
775 struct http_response *dispatch_cgi(struct client_state *csp)
777 const char *host = csp->http->host;
778 const char *path = csp->http->path;
781 * Should we intercept ?
784 /* Note: "example.com" and "example.com." are equivalent hostnames. */
786 /* Either the host matches CGI_SITE_1_HOST ..*/
787 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
788 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
789 && (path[0] == '/') )
791 /* ..then the path will all be for us. Remove leading '/' */
794 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
795 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
796 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
797 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
799 /* take everything following CGI_SITE_2_PATH */
800 path += strlen(CGI_SITE_2_PATH);
803 /* skip the forward slash after CGI_SITE_2_PATH */
806 else if (*path != '\0')
809 * weirdness: URL is /configXXX, where XXX is some string
810 * Do *NOT* intercept.
822 * This is a CGI call.
825 return dispatch_known_cgi(csp, path);
829 /*********************************************************************
831 * Function : grep_cgi_referrer
833 * Description : Ugly provisorical fix that greps the value of the
834 * referer HTTP header field out of a linked list of
835 * strings like found at csp->headers. Will disappear
838 * FIXME: csp->headers ought to be csp->http->headers
839 * FIXME: Parsing all client header lines should
840 * happen right after the request is received!
843 * 1 : csp = Current client state (buffers, headers, etc...)
845 * Returns : pointer to value (no copy!), or NULL if none found.
847 *********************************************************************/
848 char *grep_cgi_referrer(const struct client_state *csp)
850 struct list_entry *p;
852 for (p = csp->headers->first; p != NULL; p = p->next)
854 if (p->str == NULL) continue;
855 if (strncmpic(p->str, "Referer: ", 9) == 0)
857 return ((p->str) + 9);
865 /*********************************************************************
867 * Function : referrer_is_safe
869 * Description : Decides whether we trust the Referer for
870 * CGI pages which are only meant to be reachable
871 * through Privoxy's web interface directly.
874 * 1 : csp = Current client state (buffers, headers, etc...)
876 * Returns : TRUE if the referrer is safe, or
877 * FALSE if the referrer is unsafe or not set.
879 *********************************************************************/
880 int referrer_is_safe (const struct client_state *csp)
883 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
885 referrer = grep_cgi_referrer(csp);
887 if (NULL == referrer)
889 /* No referrer, no access */
890 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
893 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
894 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
896 /* Trustworthy referrer */
897 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
898 csp->http->url, referrer);
904 /* Untrustworthy referrer */
905 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
906 csp->http->url, referrer);
913 /*********************************************************************
915 * Function : dispatch_known_cgi
917 * Description : Processes a CGI once dispatch_cgi has determined that
918 * it matches one of the magic prefixes. Parses the path
919 * as a cgi name plus query string, prepares a map that
920 * maps CGI parameter names to their values, initializes
921 * the http_response struct, and calls the relevant CGI
925 * 1 : csp = Current client state (buffers, headers, etc...)
926 * 2 : path = Path of CGI, with the CGI prefix removed.
927 * Should not have a leading "/".
929 * Returns : http_response, or NULL on handler failure or out of
932 *********************************************************************/
933 static struct http_response *dispatch_known_cgi(struct client_state * csp,
936 const struct cgi_dispatcher *d;
937 struct map *param_list;
938 struct http_response *rsp;
939 char *query_args_start;
943 if (NULL == (path_copy = strdup(path)))
945 return cgi_error_memory();
947 query_args_start = path_copy;
948 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
952 if (*query_args_start == '/')
954 *query_args_start++ = '\0';
955 if ((param_list = new_map()))
957 map(param_list, "file", 1, url_decode(query_args_start), 0);
962 if (*query_args_start == '?')
964 *query_args_start++ = '\0';
966 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
969 return cgi_error_memory();
975 * path_copy = CGI call name
976 * param_list = CGI params, as map
979 /* Get mem for response or fail*/
980 if (NULL == (rsp = alloc_http_response()))
983 free_map(param_list);
984 return cgi_error_memory();
987 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
988 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
989 csp->ip_addr_str, csp->http->cmd);
992 * Find and start the right CGI function
997 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1000 * If the called CGI is either harmless, or referred
1001 * from a trusted source, start it.
1003 if (d->harmless || referrer_is_safe(csp))
1005 err = (d->handler)(csp, rsp, param_list);
1010 * Else, modify toggle calls so that they only display
1011 * the status, and deny all other calls.
1013 if (0 == strcmp(path_copy, "toggle"))
1015 unmap(param_list, "set");
1016 err = (d->handler)(csp, rsp, param_list);
1020 err = cgi_error_disabled(csp, rsp);
1025 free_map(param_list);
1027 if (err == JB_ERR_CGI_PARAMS)
1029 err = cgi_error_bad_param(csp, rsp);
1031 if (err && (err != JB_ERR_MEMORY))
1033 /* Unexpected error! Shouldn't get here */
1034 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1035 err = cgi_error_unknown(csp, rsp, err);
1040 return finish_http_response(rsp);
1044 /* Error in handler, probably out-of-memory */
1045 free_http_response(rsp);
1046 return cgi_error_memory();
1054 /*********************************************************************
1056 * Function : parse_cgi_parameters
1058 * Description : Parse a URL-encoded argument string into name/value
1059 * pairs and store them in a struct map list.
1062 * 1 : argstring = string to be parsed. Will be trashed.
1064 * Returns : pointer to param list, or NULL if out of memory.
1066 *********************************************************************/
1067 static struct map *parse_cgi_parameters(char *argstring)
1070 char *vector[BUFFER_SIZE];
1072 struct map *cgi_params;
1074 if (NULL == (cgi_params = new_map()))
1080 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1081 * the fragment identifier along with the request, so we must
1082 * cut it off here, so it won't pollute the CGI params:
1084 if (NULL != (p = strchr(argstring, '#')))
1089 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1091 for (i = 0; i < pairs; i++)
1093 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1096 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1098 free_map(cgi_params);
1109 /*********************************************************************
1111 * Function : get_char_param
1113 * Description : Get a single-character parameter passed to a CGI
1117 * 1 : parameters = map of cgi parameters
1118 * 2 : param_name = The name of the parameter to read
1120 * Returns : Uppercase character on success, '\0' on error.
1122 *********************************************************************/
1123 char get_char_param(const struct map *parameters,
1124 const char *param_name)
1131 ch = *(lookup(parameters, param_name));
1132 if ((ch >= 'a') && (ch <= 'z'))
1134 ch = (char)(ch - 'a' + 'A');
1141 /*********************************************************************
1143 * Function : get_string_param
1145 * Description : Get a string paramater, to be used as an
1146 * ACTION_STRING or ACTION_MULTI paramater.
1147 * Validates the input to prevent stupid/malicious
1148 * users from corrupting their action file.
1151 * 1 : parameters = map of cgi parameters
1152 * 2 : param_name = The name of the parameter to read
1153 * 3 : pparam = destination for paramater. Allocated as
1154 * part of the map "parameters", so don't free it.
1155 * Set to NULL if not specified.
1157 * Returns : JB_ERR_OK on success, or if the paramater
1158 * was not specified.
1159 * JB_ERR_MEMORY on out-of-memory.
1160 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1162 *********************************************************************/
1163 jb_err get_string_param(const struct map *parameters,
1164 const char *param_name,
1165 const char **pparam)
1177 param = lookup(parameters, param_name);
1183 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1188 * Note that the length limit is arbitrary, it just seems
1189 * sensible to limit it to *something*. There's no
1190 * technical reason for any limit at all.
1192 return JB_ERR_CGI_PARAMS;
1195 /* Check every character to see if it's legal */
1197 while ((ch = *s++) != '\0')
1199 if ( ((unsigned char)ch < (unsigned char)' ')
1202 /* Probable hack attempt, or user accidentally used '}'. */
1203 return JB_ERR_CGI_PARAMS;
1214 /*********************************************************************
1216 * Function : get_number_param
1218 * Description : Get a non-negative integer from the parameters
1219 * passed to a CGI function.
1222 * 1 : csp = Current client state (buffers, headers, etc...)
1223 * 2 : parameters = map of cgi parameters
1224 * 3 : name = Name of CGI parameter to read
1225 * 4 : pvalue = destination for value.
1226 * Set to -1 on error.
1228 * Returns : JB_ERR_OK on success
1229 * JB_ERR_MEMORY on out-of-memory
1230 * JB_ERR_CGI_PARAMS if the parameter was not specified
1233 *********************************************************************/
1234 jb_err get_number_param(struct client_state *csp,
1235 const struct map *parameters,
1250 param = lookup(parameters, name);
1253 return JB_ERR_CGI_PARAMS;
1256 /* We don't use atoi because I want to check this carefully... */
1259 while ((ch = *param++) != '\0')
1261 if ((ch < '0') || (ch > '9'))
1263 return JB_ERR_CGI_PARAMS;
1266 ch = (char)(ch - '0');
1270 * <limits.h> defines UINT_MAX
1272 * (UINT_MAX - ch) / 10 is the largest number that
1273 * can be safely multiplied by 10 then have ch added.
1275 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1277 return JB_ERR_CGI_PARAMS;
1280 value = value * 10 + (unsigned)ch;
1291 /*********************************************************************
1293 * Function : error_response
1295 * Description : returns an http_response that explains the reason
1296 * why a request failed.
1299 * 1 : csp = Current client state (buffers, headers, etc...)
1300 * 2 : templatename = Which template should be used for the answer
1301 * 3 : sys_err = system error number
1303 * Returns : A http_response. If we run out of memory, this
1304 * will be cgi_error_memory().
1306 *********************************************************************/
1307 struct http_response *error_response(struct client_state *csp,
1308 const char *templatename,
1312 struct http_response *rsp;
1313 struct map *exports = default_exports(csp, NULL);
1316 if (exports == NULL)
1318 return cgi_error_memory();
1321 if (NULL == (rsp = alloc_http_response()))
1324 return cgi_error_memory();
1327 if (csp->flags & CSP_FLAG_FORCED)
1329 path = strdup(FORCE_PREFIX);
1335 err = string_append(&path, csp->http->path);
1337 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1338 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1339 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1340 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1341 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1344 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1347 /* Some failures, like "404 no such domain", don't have an IP address. */
1348 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1356 free_http_response(rsp);
1357 return cgi_error_memory();
1360 if (!strcmp(templatename, "no-such-domain"))
1362 rsp->status = strdup("404 No such domain");
1363 if (rsp->status == NULL)
1366 free_http_response(rsp);
1367 return cgi_error_memory();
1370 else if (!strcmp(templatename, "connect-failed"))
1372 rsp->status = strdup("503 Connect failed");
1373 if (rsp->status == NULL)
1376 free_http_response(rsp);
1377 return cgi_error_memory();
1381 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1384 free_http_response(rsp);
1385 return cgi_error_memory();
1388 return finish_http_response(rsp);
1392 /*********************************************************************
1394 * Function : cgi_error_disabled
1396 * Description : CGI function that is called to generate an error
1397 * response if the actions editor or toggle CGI are
1398 * accessed despite having being disabled at compile-
1399 * or run-time, or if the user followed an untrusted link
1400 * to access a unsafe CGI feature that is only reachable
1401 * through Privoxy directly.
1404 * 1 : csp = Current client state (buffers, headers, etc...)
1405 * 2 : rsp = http_response data structure for output
1407 * CGI Parameters : none
1409 * Returns : JB_ERR_OK on success
1410 * JB_ERR_MEMORY on out-of-memory error.
1412 *********************************************************************/
1413 jb_err cgi_error_disabled(struct client_state *csp,
1414 struct http_response *rsp)
1416 struct map *exports;
1421 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1423 return JB_ERR_MEMORY;
1425 if (map(exports, "url", 1, csp->http->url, 1))
1427 /* Not important enough to do anything */
1428 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1431 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1435 /*********************************************************************
1437 * Function : cgi_init_error_messages
1439 * Description : Call at the start of the program to initialize
1440 * the error message used by cgi_error_memory().
1446 *********************************************************************/
1447 void cgi_init_error_messages(void)
1449 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1450 cgi_error_memory_response->head =
1451 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1452 "Content-Type: text/html\r\n"
1454 cgi_error_memory_response->body =
1456 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1458 "<h1>500 Internal Privoxy Error</h1>\r\n"
1459 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1460 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1464 cgi_error_memory_response->head_length =
1465 strlen(cgi_error_memory_response->head);
1466 cgi_error_memory_response->content_length =
1467 strlen(cgi_error_memory_response->body);
1471 /*********************************************************************
1473 * Function : cgi_error_memory
1475 * Description : Called if a CGI function runs out of memory.
1476 * Returns a statically-allocated error response.
1480 * Returns : http_response data structure for output. This is
1481 * statically allocated, for obvious reasons.
1483 *********************************************************************/
1484 struct http_response *cgi_error_memory(void)
1486 /* assert that it's been initialized. */
1487 assert(cgi_error_memory_response->head);
1489 return cgi_error_memory_response;
1493 /*********************************************************************
1495 * Function : cgi_error_no_template
1497 * Description : Almost-CGI function that is called if a template
1498 * cannot be loaded. Note this is not a true CGI,
1499 * it takes a template name rather than a map of
1503 * 1 : csp = Current client state (buffers, headers, etc...)
1504 * 2 : rsp = http_response data structure for output
1505 * 3 : template_name = Name of template that could not
1508 * Returns : JB_ERR_OK on success
1509 * JB_ERR_MEMORY on out-of-memory error.
1511 *********************************************************************/
1512 jb_err cgi_error_no_template(struct client_state *csp,
1513 struct http_response *rsp,
1514 const char *template_name)
1516 static const char status[] =
1517 "500 Internal Privoxy Error";
1518 static const char body_prefix[] =
1520 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1522 "<h1>500 Internal Privoxy Error</h1>\r\n"
1523 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1524 "<p><b>Could not load template file <code>";
1525 static const char body_suffix[] =
1526 "</code> or one of it's included components.</b></p>\r\n"
1527 "<p>Please contact your proxy administrator.</p>\r\n"
1528 "<p>If you are the proxy administrator, please put the required file(s)"
1529 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1530 "location of the <code><i>(confdir)</i></code> directory "
1531 "is specified in the main Privoxy <code>config</code> "
1532 "file. (It's typically the Privoxy install directory"
1534 ", or <code>/etc/privoxy/</code>"
1535 #endif /* ndef _WIN32 */
1542 assert(template_name);
1544 /* Reset rsp, if needed */
1548 rsp->content_length = 0;
1549 rsp->head_length = 0;
1552 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1553 if (rsp->body == NULL)
1555 return JB_ERR_MEMORY;
1557 strcpy(rsp->body, body_prefix);
1558 strcat(rsp->body, template_name);
1559 strcat(rsp->body, body_suffix);
1561 rsp->status = strdup(status);
1562 if (rsp->status == NULL)
1564 return JB_ERR_MEMORY;
1571 /*********************************************************************
1573 * Function : cgi_error_unknown
1575 * Description : Almost-CGI function that is called if an unexpected
1576 * error occurs in the top-level CGI dispatcher.
1577 * In this context, "unexpected" means "anything other
1578 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1579 * expected to handle all other errors internally,
1580 * since they can give more relavent error messages
1583 * Note this is not a true CGI, it takes an error
1584 * code rather than a map of parameters.
1587 * 1 : csp = Current client state (buffers, headers, etc...)
1588 * 2 : rsp = http_response data structure for output
1589 * 3 : error_to_report = Error code to report.
1591 * Returns : JB_ERR_OK on success
1592 * JB_ERR_MEMORY on out-of-memory error.
1594 *********************************************************************/
1595 jb_err cgi_error_unknown(struct client_state *csp,
1596 struct http_response *rsp,
1597 jb_err error_to_report)
1599 static const char status[] =
1600 "500 Internal Privoxy Error";
1601 static const char body_prefix[] =
1603 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1605 "<h1>500 Internal Privoxy Error</h1>\r\n"
1606 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1607 "<p><b>Unexpected internal error: ";
1608 static const char body_suffix[] =
1611 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1612 "file a bug report</a>.</p>\r\n"
1619 /* Reset rsp, if needed */
1623 rsp->content_length = 0;
1624 rsp->head_length = 0;
1627 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1629 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1630 if (rsp->body == NULL)
1632 return JB_ERR_MEMORY;
1634 strcpy(rsp->body, body_prefix);
1635 strcat(rsp->body, errnumbuf);
1636 strcat(rsp->body, body_suffix);
1638 rsp->status = strdup(status);
1639 if (rsp->status == NULL)
1641 return JB_ERR_MEMORY;
1648 /*********************************************************************
1650 * Function : cgi_error_bad_param
1652 * Description : CGI function that is called if the parameters
1653 * (query string) for a CGI were wrong.
1656 * 1 : csp = Current client state (buffers, headers, etc...)
1657 * 2 : rsp = http_response data structure for output
1659 * CGI Parameters : none
1661 * Returns : JB_ERR_OK on success
1662 * JB_ERR_MEMORY on out-of-memory error.
1664 *********************************************************************/
1665 jb_err cgi_error_bad_param(struct client_state *csp,
1666 struct http_response *rsp)
1668 struct map *exports;
1673 if (NULL == (exports = default_exports(csp, NULL)))
1675 return JB_ERR_MEMORY;
1678 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1682 /*********************************************************************
1684 * Function : cgi_redirect
1686 * Description : CGI support function to generate a HTTP redirect
1690 * 1 : rsp = http_response data structure for output
1691 * 2 : target = string with the target URL
1693 * CGI Parameters : None
1695 * Returns : JB_ERR_OK on success
1696 * JB_ERR_MEMORY on out-of-memory error.
1698 *********************************************************************/
1699 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1706 err = enlist_unique_header(rsp->headers, "Location", target);
1708 rsp->status = strdup("302 Local Redirect from Privoxy");
1709 if (rsp->status == NULL)
1711 return JB_ERR_MEMORY;
1718 /*********************************************************************
1720 * Function : add_help_link
1722 * Description : Produce a copy of the string given as item,
1723 * embedded in an HTML link to its corresponding
1724 * section (item name in uppercase) in the actions
1725 * chapter of the user manual, (whose URL is given in
1726 * the config and defaults to our web site).
1728 * FIXME: I currently only work for actions, and would
1729 * like to be generalized for other topics.
1732 * 1 : item = item (will NOT be free()d.)
1733 * It is assumed to be HTML-safe.
1734 * 2 : config = The current configuration.
1736 * Returns : String with item embedded in link, or NULL on
1739 *********************************************************************/
1740 char *add_help_link(const char *item,
1741 struct configuration_spec *config)
1745 if (!item) return NULL;
1747 result = strdup("<a href=\"");
1748 if (!strncmpic(config->usermanual, "file://", 7) ||
1749 !strncmpic(config->usermanual, "http", 4))
1751 string_append(&result, config->usermanual);
1755 string_append(&result, "http://");
1756 string_append(&result, CGI_SITE_2_HOST);
1757 string_append(&result, "/user-manual/");
1759 string_append(&result, ACTIONS_HELP_PREFIX);
1760 string_join (&result, string_toupper(item));
1761 string_append(&result, "\">");
1762 string_append(&result, item);
1763 string_append(&result, "</a> ");
1769 /*********************************************************************
1771 * Function : get_http_time
1773 * Description : Get the time in a format suitable for use in a
1774 * HTTP header - e.g.:
1775 * "Sun, 06 Nov 1994 08:49:37 GMT"
1778 * 1 : time_offset = Time returned will be current time
1779 * plus this number of seconds.
1780 * 2 : buf = Destination for result. Must be long enough
1781 * to hold 29 characters plus a trailing zero.
1785 *********************************************************************/
1786 void get_http_time(int time_offset, char *buf)
1788 static const char day_names[7][4] =
1789 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1790 static const char month_names[12][4] =
1791 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1792 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1795 time_t current_time;
1796 #if defined(HAVE_GMTIME_R)
1798 * Declare dummy up here (instead of inside get/set gmt block) so it
1799 * doesn't go out of scope before it's potentially used in snprintf later.
1800 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1801 * !defined HAVE_GMTIME_R.
1808 time(¤t_time); /* get current time */
1810 current_time += time_offset;
1812 /* get and save the gmt */
1815 t = gmtime_r(¤t_time, &dummy);
1816 #elif FEATURE_PTHREAD
1817 pthread_mutex_lock(&gmtime_mutex);
1818 t = gmtime(¤t_time);
1819 pthread_mutex_unlock(&gmtime_mutex);
1821 t = gmtime(¤t_time);
1825 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1827 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1828 day_names[t->tm_wday],
1830 month_names[t->tm_mon],
1840 /*********************************************************************
1842 * Function : finish_http_response
1844 * Description : Fill in the missing headers in an http response,
1845 * and flatten the headers to an http head.
1848 * 1 : rsp = pointer to http_response to be processed
1850 * Returns : A http_response, usually the rsp parameter.
1851 * On error, free()s rsp and returns cgi_error_memory()
1853 *********************************************************************/
1854 struct http_response *finish_http_response(struct http_response *rsp)
1856 char buf[BUFFER_SIZE];
1859 /* Special case - do NOT change this statically allocated response,
1860 * which is ready for output anyway.
1862 if (rsp == cgi_error_memory_response)
1868 * Fill in the HTTP Status
1870 snprintf(buf, sizeof(buf), "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1871 err = enlist_first(rsp->headers, buf);
1874 * Set the Content-Length
1876 if (rsp->content_length == 0)
1878 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1882 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
1883 err = enlist(rsp->headers, buf);
1886 if (strncmpic(rsp->status, "302", 3))
1889 * If it's not a redirect without any content,
1890 * set the Content-Type to text/html if it's
1891 * not already specified.
1893 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1897 * Fill in the rest of the default headers:
1899 * Date: set to current date/time.
1900 * Last-Modified: set to date/time the page was last changed.
1901 * Expires: set to date/time page next needs reloading.
1902 * Cache-Control: set to "no-cache" if applicable.
1904 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1909 * Set Expires to about 10 min into the future so it'll get reloaded
1910 * occasionally, e.g. if Privoxy gets upgraded.
1915 get_http_time(0, buf);
1916 err = enlist_unique_header(rsp->headers, "Date", buf);
1919 /* Some date in the past. */
1920 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1924 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1925 err = enlist_unique_header(rsp->headers, "Expires", buf);
1928 else if (!strncmpic(rsp->status, "302", 3))
1930 get_http_time(0, buf);
1931 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1936 * Setting "Cache-Control" to "no-cache" and "Expires" to
1937 * the current time doesn't exactly forbid caching, it just
1938 * requires the client to revalidate the cached copy.
1940 * If a temporary problem occurs and the user tries again after
1941 * getting Privoxy's error message, a compliant browser may set the
1942 * If-Modified-Since header with the content of the error page's
1943 * Last-Modified header. More often than not, the document on the server
1944 * is older than Privoxy's error message, the server would send status code
1945 * 304 and the browser would display the outdated error message again and again.
1947 * For documents delivered with status code 404 or 503 we set "Last-Modified"
1948 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1949 * and can be safely used to "revalidate" without getting a status code 304.
1951 * There is no need to let the useless If-Modified-Since header reach the
1952 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1954 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1956 get_http_time(0, buf);
1957 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1958 if (!strncmpic(rsp->status, "404", 3) || !strncmpic(rsp->status, "503", 3))
1960 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1964 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1966 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1967 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1973 * HTTP/1.1 applications that do not support persistent connections MUST
1974 * include the "close" connection option in every message.
1976 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
1981 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1983 free_http_response(rsp);
1984 return cgi_error_memory();
1986 rsp->head_length = strlen(rsp->head);
1993 /*********************************************************************
1995 * Function : alloc_http_response
1997 * Description : Allocates a new http_response structure.
2001 * Returns : pointer to a new http_response, or NULL.
2003 *********************************************************************/
2004 struct http_response *alloc_http_response(void)
2006 return (struct http_response *) zalloc(sizeof(struct http_response));
2011 /*********************************************************************
2013 * Function : free_http_response
2015 * Description : Free the memory occupied by an http_response
2016 * and its depandant structures.
2019 * 1 : rsp = pointer to http_response to be freed
2023 *********************************************************************/
2024 void free_http_response(struct http_response *rsp)
2027 * Must special case cgi_error_memory_response, which is never freed.
2029 if (rsp && (rsp != cgi_error_memory_response))
2034 destroy_list(rsp->headers);
2041 /*********************************************************************
2043 * Function : template_load
2045 * Description : CGI support function that loads a given HTML
2046 * template from the confdir, ignoring comment
2047 * lines and following #include statements up to
2051 * 1 : csp = Current client state (buffers, headers, etc...)
2052 * 2 : template_ptr = Destination for pointer to loaded
2054 * 3 : templatename = name of the HTML template to be used
2055 * 4 : recursive = Flag set if this function calls itself
2056 * following an #include statament
2058 * Returns : JB_ERR_OK on success
2059 * JB_ERR_MEMORY on out-of-memory error.
2060 * JB_ERR_FILE if the template file cannot be read
2062 *********************************************************************/
2063 jb_err template_load(struct client_state *csp, char **template_ptr,
2064 const char *templatename, int recursive)
2067 char *templates_dir_path;
2070 char *included_module;
2073 char buf[BUFFER_SIZE];
2076 assert(template_ptr);
2077 assert(templatename);
2079 *template_ptr = NULL;
2081 /* Validate template name. Paranoia. */
2082 for (p = templatename; *p != 0; p++)
2084 if ( ((*p < 'a') || (*p > 'z'))
2085 && ((*p < 'A') || (*p > 'Z'))
2086 && ((*p < '0') || (*p > '9'))
2090 /* Illegal character */
2095 /* Generate full path */
2097 templates_dir_path = make_path(csp->config->confdir, "templates");
2098 if (templates_dir_path == NULL)
2100 return JB_ERR_MEMORY;
2103 full_path = make_path(templates_dir_path, templatename);
2104 free(templates_dir_path);
2105 if (full_path == NULL)
2107 return JB_ERR_MEMORY;
2110 /* Allocate buffer */
2112 file_buffer = strdup("");
2113 if (file_buffer == NULL)
2116 return JB_ERR_MEMORY;
2119 /* Open template file */
2121 if (NULL == (fp = fopen(full_path, "r")))
2123 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2131 * Read the file, ignoring comments, and honoring #include
2132 * statements, unless we're already called recursively.
2134 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2135 * This is unlikely in practise.
2137 while (fgets(buf, BUFFER_SIZE, fp))
2139 if (!recursive && !strncmp(buf, "#include ", 9))
2141 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2148 if (string_join(&file_buffer, included_module))
2151 return JB_ERR_MEMORY;
2157 /* skip lines starting with '#' */
2163 if (string_append(&file_buffer, buf))
2166 return JB_ERR_MEMORY;
2171 *template_ptr = file_buffer;
2177 /*********************************************************************
2179 * Function : template_fill
2181 * Description : CGI support function that fills in a pre-loaded
2182 * HTML template by replacing @name@ with value using
2183 * pcrs, for each item in the output map.
2185 * Note that a leading '$' charachter in the export map's
2186 * values will be stripped and toggle on backreference
2190 * 1 : template_ptr = IN: Template to be filled out.
2192 * OUT: Filled out template.
2193 * Caller must free().
2194 * 2 : exports = map with fill in symbol -> name pairs
2196 * Returns : JB_ERR_OK on success (and for uncritical errors)
2197 * JB_ERR_MEMORY on out-of-memory error
2199 *********************************************************************/
2200 jb_err template_fill(char **template_ptr, const struct map *exports)
2202 struct map_entry *m;
2204 char buf[BUFFER_SIZE];
2205 char *tmp_out_buffer;
2211 assert(template_ptr);
2212 assert(*template_ptr);
2215 file_buffer = *template_ptr;
2216 size = strlen(file_buffer) + 1;
2219 * Assemble pcrs joblist from exports map
2221 for (m = exports->first; m != NULL; m = m->next)
2223 if (*m->name == '$')
2226 * First character of name is '$', so remove this flag
2227 * character and allow backreferences ($1 etc) in the
2228 * "replace with" text.
2230 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2236 * Treat the "replace with" text as a literal string -
2237 * no quoting needed, no backreferences allowed.
2238 * ("Trivial" ['T'] flag).
2242 /* Enclose name in @@ */
2243 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2247 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2249 /* Make and run job. */
2250 job = pcrs_compile(buf, m->value, flags, &error);
2253 if (error == PCRS_ERR_NOMEM)
2256 *template_ptr = NULL;
2257 return JB_ERR_MEMORY;
2261 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2262 /* Hope it wasn't important and silently ignore the invalid job */
2267 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2270 if (NULL == tmp_out_buffer)
2272 *template_ptr = NULL;
2273 return JB_ERR_MEMORY;
2279 * Substitution failed, keep the original buffer,
2280 * log the problem and ignore it.
2282 * The user might see some unresolved @CGI_VARIABLES@,
2283 * but returning a special CGI error page seems unreasonable
2284 * and could mask more important error messages.
2286 free(tmp_out_buffer);
2287 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2288 buf, m->value, flags, pcrs_strerror(error));
2292 /* Substitution succeeded, use modified buffer. */
2294 file_buffer = tmp_out_buffer;
2302 *template_ptr = file_buffer;
2307 /*********************************************************************
2309 * Function : template_fill_for_cgi
2311 * Description : CGI support function that loads a HTML template
2312 * and fills it in. Handles file-not-found errors
2313 * by sending a HTML error message. For convenience,
2314 * this function also frees the passed "exports" map.
2317 * 1 : csp = Client state
2318 * 2 : templatename = name of the HTML template to be used
2319 * 3 : exports = map with fill in symbol -> name pairs.
2320 * Will be freed by this function.
2321 * 4 : rsp = Response structure to fill in.
2323 * Returns : JB_ERR_OK on success
2324 * JB_ERR_MEMORY on out-of-memory error
2326 *********************************************************************/
2327 jb_err template_fill_for_cgi(struct client_state *csp,
2328 const char *templatename,
2329 struct map *exports,
2330 struct http_response *rsp)
2335 assert(templatename);
2339 err = template_load(csp, &rsp->body, templatename, 0);
2340 if (err == JB_ERR_FILE)
2343 return cgi_error_no_template(csp, rsp, templatename);
2348 return err; /* JB_ERR_MEMORY */
2350 err = template_fill(&rsp->body, exports);
2356 /*********************************************************************
2358 * Function : default_exports
2360 * Description : returns a struct map list that contains exports
2361 * which are common to all CGI functions.
2364 * 1 : csp = Current client state (buffers, headers, etc...)
2365 * 2 : caller = name of CGI who calls us and which should
2366 * be excluded from the generated menu. May be
2368 * Returns : NULL if no memory, else a new map. Caller frees.
2370 *********************************************************************/
2371 struct map *default_exports(const struct client_state *csp, const char *caller)
2375 struct map * exports;
2376 int local_help_exists = 0;
2380 exports = new_map();
2381 if (exports == NULL)
2386 err = map(exports, "version", 1, html_encode(VERSION), 0);
2387 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2388 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2389 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2390 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2391 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2392 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2393 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2394 !strncmpic(csp->config->usermanual, "http", 4))
2396 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2400 if (!err) err = map(exports, "user-manual", 1, "http://"CGI_SITE_2_HOST"/user-manual/" ,1);
2402 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2403 #ifdef FEATURE_TOGGLE
2404 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2406 if (!err) err = map_block_killer(exports, "can-toggle");
2409 snprintf(buf, 20, "%d", csp->config->hport);
2410 if (!err) err = map(exports, "my-port", 1, buf, 1);
2412 if(!strcmp(CODE_STATUS, "stable"))
2414 if (!err) err = map_block_killer(exports, "unstable");
2417 if (csp->config->admin_address != NULL)
2419 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2420 local_help_exists = 1;
2424 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2427 if (csp->config->proxy_info_url != NULL)
2429 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2430 local_help_exists = 1;
2434 if (!err) err = map_block_killer(exports, "have-proxy-info");
2437 if (local_help_exists == 0)
2439 if (!err) err = map_block_killer(exports, "have-help-info");
2452 /*********************************************************************
2454 * Function : map_block_killer
2456 * Description : Convenience function.
2457 * Adds a "killer" for the conditional HTML-template
2458 * block <name>, i.e. a substitution of the regex
2459 * "if-<name>-start.*if-<name>-end" to the given
2463 * 1 : exports = map to extend
2464 * 2 : name = name of conditional block
2466 * Returns : JB_ERR_OK on success
2467 * JB_ERR_MEMORY on out-of-memory error.
2469 *********************************************************************/
2470 jb_err map_block_killer(struct map *exports, const char *name)
2472 char buf[1000]; /* Will do, since the names are hardwired */
2476 assert(strlen(name) < 490);
2478 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2479 return map(exports, buf, 1, "", 1);
2483 /*********************************************************************
2485 * Function : map_block_keep
2487 * Description : Convenience function. Removes the markers used
2488 * by map-block-killer, to save a few bytes.
2489 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2492 * 1 : exports = map to extend
2493 * 2 : name = name of conditional block
2495 * Returns : JB_ERR_OK on success
2496 * JB_ERR_MEMORY on out-of-memory error.
2498 *********************************************************************/
2499 jb_err map_block_keep(struct map *exports, const char *name)
2502 char buf[500]; /* Will do, since the names are hardwired */
2506 assert(strlen(name) < 490);
2508 snprintf(buf, 500, "if-%s-start", name);
2509 err = map(exports, buf, 1, "", 1);
2516 snprintf(buf, 500, "if-%s-end", name);
2517 return map(exports, buf, 1, "", 1);
2521 /*********************************************************************
2523 * Function : map_conditional
2525 * Description : Convenience function.
2526 * Adds an "if-then-else" for the conditional HTML-template
2527 * block <name>, i.e. a substitution of the form:
2534 * The control structure and one of the alternatives
2538 * 1 : exports = map to extend
2539 * 2 : name = name of conditional block
2540 * 3 : choose_first = nonzero for first, zero for second.
2542 * Returns : JB_ERR_OK on success
2543 * JB_ERR_MEMORY on out-of-memory error.
2545 *********************************************************************/
2546 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2548 char buf[1000]; /* Will do, since the names are hardwired */
2553 assert(strlen(name) < 480);
2555 snprintf(buf, 1000, (choose_first
2556 ? "else-not-%s@.*@endif-%s"
2557 : "if-%s-then@.*@else-not-%s"),
2560 err = map(exports, buf, 1, "", 1);
2566 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2567 return map(exports, buf, 1, "", 1);
2571 /*********************************************************************
2573 * Function : make_menu
2575 * Description : Returns an HTML-formatted menu of the available
2576 * unhidden CGIs, excluding the one given in <self>
2577 * and the toggle CGI if toggling is disabled.
2580 * 1 : self = name of CGI to leave out, can be NULL for
2582 * 2 : feature_flags = feature bitmap from csp->config
2585 * Returns : menu string, or NULL on out-of-memory error.
2587 *********************************************************************/
2588 char *make_menu(const char *self, const unsigned feature_flags)
2590 const struct cgi_dispatcher *d;
2591 char *result = strdup("");
2595 self = "NO-SUCH-CGI!";
2598 /* List available unhidden CGI's and export as "other-cgis" */
2599 for (d = cgi_dispatchers; d->name; d++)
2602 #ifdef FEATURE_TOGGLE
2603 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2606 * Suppress the toggle link if remote toggling is disabled.
2610 #endif /* def FEATURE_TOGGLE */
2612 if (d->description && strcmp(d->name, self))
2614 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2615 string_append(&result, d->name);
2616 string_append(&result, "\">");
2617 string_append(&result, d->description);
2618 string_append(&result, "</a></li>");
2626 /*********************************************************************
2628 * Function : dump_map
2630 * Description : HTML-dump a map for debugging (as table)
2633 * 1 : the_map = map to dump
2635 * Returns : string with HTML
2637 *********************************************************************/
2638 char *dump_map(const struct map *the_map)
2640 struct map_entry *cur_entry;
2641 char *ret = strdup("");
2643 string_append(&ret, "<table>\n");
2645 for (cur_entry = the_map->first;
2646 (cur_entry != NULL) && (ret != NULL);
2647 cur_entry = cur_entry->next)
2649 string_append(&ret, "<tr><td><b>");
2650 string_join (&ret, html_encode(cur_entry->name));
2651 string_append(&ret, "</b></td><td>");
2652 string_join (&ret, html_encode(cur_entry->value));
2653 string_append(&ret, "</td></tr>\n");
2656 string_append(&ret, "</table>\n");