1 const char cgi_rcs[] = "$Id: cgi.c,v 1.62 2002/04/10 19:59:46 jongfoster 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 the SourceForge
15 * 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.62 2002/04/10 19:59:46 jongfoster
42 * Fixes to #include in templates:
43 * - Didn't close main file if loading an included template fails.
44 * - I'm paranoid and want to disallow "#include /etc/passwd".
46 * Revision 1.61 2002/04/10 13:37:48 oes
47 * Made templates modular: template_load now recursive with max depth 1
49 * Revision 1.60 2002/04/08 20:50:25 swa
52 * Revision 1.59 2002/04/05 15:51:51 oes
53 * - added send-stylesheet CGI
54 * - bugfix: error-pages now get correct request protocol
56 * - kludged CGI descriptions and menu not to break JS syntax
58 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
59 * Fix Mac OSX compiler warnings
61 * Revision 1.57 2002/03/26 22:29:54 swa
62 * we have a new homepage!
64 * Revision 1.56 2002/03/24 17:50:46 jongfoster
65 * Fixing compile error if actions file editor disabled
67 * Revision 1.55 2002/03/24 16:55:06 oes
68 * Making GIF checkerboard transparent
70 * Revision 1.54 2002/03/24 16:18:15 jongfoster
73 * Revision 1.53 2002/03/24 16:06:00 oes
74 * Correct transparency for checkerboard PNG. Thanks, Magnus!
76 * Revision 1.52 2002/03/24 15:23:33 jongfoster
79 * Revision 1.51 2002/03/24 13:25:43 swa
80 * name change related issues
82 * Revision 1.50 2002/03/16 23:54:06 jongfoster
83 * Adding graceful termination feature, to help look for memory leaks.
84 * If you enable this (which, by design, has to be done by hand
85 * editing config.h) and then go to http://i.j.b/die, then the program
86 * will exit cleanly after the *next* request. It should free all the
87 * memory that was used.
89 * Revision 1.49 2002/03/13 00:27:04 jongfoster
92 * Revision 1.48 2002/03/08 17:47:07 jongfoster
95 * Revision 1.47 2002/03/08 16:41:33 oes
96 * Added GIF images again
98 * Revision 1.46 2002/03/07 03:48:38 oes
99 * - Changed built-in images from GIF to PNG
100 * (with regard to Unisys patent issue)
101 * - Added a 4x4 pattern PNG which is less intrusive
102 * than the logo but also clearly marks the deleted banners
104 * Revision 1.45 2002/03/06 22:54:35 jongfoster
105 * Automated function-comment nitpicking.
107 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
108 * - Better error reporting on OS/2
109 * - Fix double-slash comment (oops)
111 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
112 * - Re-enable OS/2 building after new parms were added
113 * - Fix false out of memory report when resolving CGI templates when no IP
114 * address is available of failed attempt (a la no such domain)
116 * Revision 1.42 2002/01/21 00:33:20 jongfoster
117 * Replacing strsav() with the safer string_append() or string_join().
118 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
119 * Adding missing html_encode() to error message generators.
120 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
122 * Revision 1.41 2002/01/17 20:56:22 jongfoster
123 * Replacing hard references to the URL of the config interface
124 * with #defines from project.h
126 * Revision 1.40 2002/01/09 14:26:46 oes
127 * Added support for thread-safe gmtime_r call.
129 * Revision 1.39 2001/11/16 00:48:13 jongfoster
130 * Fixing a compiler warning
132 * Revision 1.38 2001/11/13 00:31:21 jongfoster
133 * - Adding new CGIs for use by non-JavaScript browsers:
134 * edit-actions-url-form
135 * edit-actions-add-url-form
136 * edit-actions-remove-url-form
137 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
140 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
141 * Show enablement/disablement status in almost all templates.
142 * There is a little trickiness here: apparent recursive resolution of
143 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
144 * the actual enablement status. So a similar construct,
145 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
148 * Revision 1.36 2001/10/26 17:33:27 oes
151 * Revision 1.35 2001/10/23 21:48:19 jongfoster
152 * Cleaning up error handling in CGI functions - they now send back
153 * a HTML error page and should never cause a FATAL error. (Fixes one
154 * potential source of "denial of service" attacks).
156 * CGI actions file editor that works and is actually useful.
158 * Ability to toggle Junkbuster remotely using a CGI call.
160 * You can turn off both the above features in the main configuration
161 * file, e.g. if you are running a multi-user proxy.
163 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
164 * Only show "Local support" on templates conditionally:
165 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
166 * - if not, no Local support section appears
168 * Revision 1.33 2001/10/14 22:28:41 jongfoster
169 * Fixing stupid typo.
171 * Revision 1.32 2001/10/14 22:20:18 jongfoster
172 * - Changes to CGI dispatching method to match CGI names exactly,
173 * rather than doing a prefix match.
174 * - No longer need to count the length of the CGI handler names by hand.
175 * - Adding new handler for 404 error when disptching a CGI, if none of
176 * the handlers match.
177 * - Adding new handlers for CGI actionsfile editor.
179 * Revision 1.31 2001/10/10 10:56:39 oes
180 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
182 * Revision 1.30 2001/10/02 15:30:57 oes
183 * Introduced show-request cgi
185 * Revision 1.29 2001/09/20 15:47:44 steudten
187 * Fix BUG: Modify int size to size_t size in fill_template()
188 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
190 * Revision 1.28 2001/09/19 18:00:37 oes
191 * - Deletef time() FIXME (Can't fail under Linux either, if
192 * the argument is guaranteed to be in out address space,
195 * - Pointer notation cosmetics
196 * - Fixed a minor bug in template_fill(): Failiure of
197 * pcrs_execute() now secure.
199 * Revision 1.27 2001/09/16 17:08:54 jongfoster
200 * Moving simple CGI functions from cgi.c to new file cgisimple.c
202 * Revision 1.26 2001/09/16 15:47:37 jongfoster
203 * First version of CGI-based edit interface. This is very much a
204 * work-in-progress, and you can't actually use it to edit anything
205 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
206 * to have any effect.
208 * Revision 1.25 2001/09/16 15:02:35 jongfoster
209 * Adding i.j.b/robots.txt.
210 * Inlining add_stats() since it's only ever called from one place.
212 * Revision 1.24 2001/09/16 11:38:01 jongfoster
213 * Splitting fill_template() into 2 functions:
214 * template_load() loads the file
215 * template_fill() performs the PCRS regexps.
216 * This is because the CGI edit interface has a "table row"
217 * template which is used many times in the page - this
218 * change means it's only loaded from disk once.
220 * Revision 1.23 2001/09/16 11:16:05 jongfoster
221 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
223 * Revision 1.22 2001/09/16 11:00:10 jongfoster
224 * New function alloc_http_response, for symmetry with free_http_response
226 * Revision 1.21 2001/09/13 23:53:03 jongfoster
227 * Support for both static and dynamically generated CGI pages.
228 * Correctly setting Last-Modified: and Expires: HTTP headers.
230 * Revision 1.20 2001/09/13 23:40:36 jongfoster
231 * (Cosmetic only) Indentation correction
233 * Revision 1.19 2001/09/13 23:31:25 jongfoster
234 * Moving image data to cgi.c rather than cgi.h.
236 * Revision 1.18 2001/08/05 16:06:20 jongfoster
237 * Modifiying "struct map" so that there are now separate header and
238 * "map_entry" structures. This means that functions which modify a
239 * map no longer need to return a pointer to the modified map.
240 * Also, it no longer reverses the order of the entries (which may be
241 * important with some advanced template substitutions).
243 * Revision 1.17 2001/08/05 15:57:38 oes
244 * Adapted finish_http_response to new list_to_text
246 * Revision 1.16 2001/08/01 21:33:18 jongfoster
247 * Changes to fill_template() that reduce memory usage without having
248 * an impact on performance. I also renamed some variables so as not
249 * to clash with the C++ keywords "new" and "template".
251 * Revision 1.15 2001/08/01 21:19:22 jongfoster
252 * Moving file version information to a separate CGI page.
254 * Revision 1.14 2001/08/01 00:19:03 jongfoster
255 * New function: map_conditional() for an if-then-else syntax.
256 * Changing to use new version of show_defines()
258 * Revision 1.13 2001/07/30 22:08:36 jongfoster
259 * Tidying up #defines:
260 * - All feature #defines are now of the form FEATURE_xxx
261 * - Permanently turned off WIN_GUI_EDIT
262 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
264 * Revision 1.12 2001/07/29 18:47:05 jongfoster
265 * Adding missing #include "loadcfg.h"
267 * Revision 1.11 2001/07/18 17:24:37 oes
268 * Changed to conform to new pcrs interface
270 * Revision 1.10 2001/07/13 13:53:13 oes
271 * Removed all #ifdef PCRS and related code
273 * Revision 1.9 2001/06/29 21:45:41 oes
274 * Indentation, CRLF->LF, Tab-> Space
276 * Revision 1.8 2001/06/29 13:21:46 oes
277 * - Cosmetics: renamed and reordered functions, variables,
278 * texts, improved comments etc
280 * - Removed ij_untrusted_url() The relevant
281 * info is now part of the "untrusted" page,
282 * which is generated by filters.c:trust_url()
284 * - Generators of content now call finish_http_response()
285 * themselves, making jcc.c:chat() a little less
288 * - Removed obsolete "Pragma: no-cache" from our headers
290 * - http_responses now know their head length
292 * - fill_template now uses the new interface to pcrs, so that
293 * - long jobs (like whole files) no longer have to be assembled
294 * in a fixed size buffer
295 * - the new T (trivial) option is used, and the replacement may
296 * contain Perl syntax backrefs without confusing pcrs
298 * - Introduced default_exports() which generates a set of exports
299 * common to all CGIs and other content generators
301 * - Introduced convenience function map_block_killer()
303 * - Introduced convenience function make_menu()
305 * - Introduced CGI-like function error_response() which generates
306 * the "No such domain" and "Connect failed" messages using the
309 * - cgi_show_url_info:
310 * - adapted to new CGI features
311 * - form and answers now generated from same template
312 * - http:// prefix in URL now OK
315 * - adapted to new CGI features
316 * - no longer uses csp->init_proxy_args
319 * - moved menu generation to make_menu()
321 * - add_stats now writes single export map entries instead
324 * - Moved redirect_url() to filters.c
326 * - Fixed mem leak in free_http_response(), map_block_killer(),
328 * - Removed logentry from cancelled commit
330 * Revision 1.7 2001/06/09 10:51:58 jongfoster
331 * Changing "show URL info" handler to new style.
332 * Changing BUFSIZ ==> BUFFER_SIZE
334 * Revision 1.6 2001/06/07 23:05:19 jongfoster
335 * Removing code related to old forward and ACL files.
337 * Revision 1.5 2001/06/05 19:59:16 jongfoster
338 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
340 * Revision 1.4 2001/06/04 10:41:52 swa
341 * show version string of cgi.h and cgi.c
343 * Revision 1.3 2001/06/03 19:12:16 oes
344 * introduced new cgi handling
346 * No revisions before 1.3
348 **********************************************************************/
354 #include <sys/types.h>
361 #define snprintf _snprintf
362 #endif /* def _WIN32 */
370 #include "miscutil.h"
371 #include "cgisimple.h"
372 #ifdef FEATURE_CGI_EDIT_ACTIONS
374 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
376 /* loadcfg.h is for g_bToggleIJB only */
378 const char cgi_h_rcs[] = CGI_H_VERSION;
381 * List of CGI functions: name, handler, description
382 * Note: Do NOT use single quotes in the description;
383 * this will break the dynamic "blocked" template!
385 static const struct cgi_dispatcher cgi_dispatchers[] = {
388 "Privoxy main page" },
389 #ifdef FEATURE_GRACEFUL_TERMINATION
392 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
393 "this is a one click Denial Of Service attack!!!</em>" },
397 "Show information about the current configuration" },
400 "Show the source code version numbers" },
403 "Show the request headers." },
406 "Show which actions apply to a URL and why" },
407 #ifdef FEATURE_CGI_EDIT_ACTIONS
410 "Toggle Privoxy on or off" },
413 "Edit the actions list" },
416 { "eaa", /* Shortcut for edit-actions-add-url-form */
417 cgi_edit_actions_add_url_form,
419 { "eau", /* Shortcut for edit-actions-url-form */
420 cgi_edit_actions_url_form,
422 { "ear", /* Shortcut for edit-actions-remove-url-form */
423 cgi_edit_actions_remove_url_form,
425 { "eas", /* Shortcut for edit-actions-for-url */
426 cgi_edit_actions_for_url,
428 { "easa", /* Shortcut for edit-actions-section-add */
429 cgi_edit_actions_section_add,
431 { "easr", /* Shortcut for edit-actions-section-remove */
432 cgi_edit_actions_section_remove,
434 { "eass", /* Shortcut for edit-actions-section-swap */
435 cgi_edit_actions_section_swap,
437 { "edit-actions-for-url",
438 cgi_edit_actions_for_url,
439 NULL /* Edit the actions for (a) specified URL(s) */ },
440 { "edit-actions-list",
441 cgi_edit_actions_list,
442 NULL /* Edit the actions list */ },
443 { "edit-actions-submit",
444 cgi_edit_actions_submit,
445 NULL /* Change the actions for (a) specified URL(s) */ },
446 { "edit-actions-url",
447 cgi_edit_actions_url,
448 NULL /* Change a URL pattern in the actionsfile */ },
449 { "edit-actions-url-form",
450 cgi_edit_actions_url_form,
451 NULL /* Form to change a URL pattern in the actionsfile */ },
452 { "edit-actions-add-url",
453 cgi_edit_actions_add_url,
454 NULL /* Add a URL pattern to the actionsfile */ },
455 { "edit-actions-add-url-form",
456 cgi_edit_actions_add_url_form,
457 NULL /* Form to add a URL pattern to the actionsfile */ },
458 { "edit-actions-remove-url",
459 cgi_edit_actions_remove_url,
460 NULL /* Remove a URL pattern from the actionsfile */ },
461 { "edit-actions-remove-url-form",
462 cgi_edit_actions_remove_url_form,
463 NULL /* Form to remove a URL pattern from the actionsfile */ },
464 { "edit-actions-section-add",
465 cgi_edit_actions_section_add,
466 NULL /* Remove a section from the actionsfile */ },
467 { "edit-actions-section-remove",
468 cgi_edit_actions_section_remove,
469 NULL /* Remove a section from the actionsfile */ },
470 { "edit-actions-section-swap",
471 cgi_edit_actions_section_swap,
472 NULL /* Swap two sections in the actionsfile */ },
473 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
476 NULL /* Sends a robots.txt file to tell robots to go away. */ },
479 NULL /* Send a built-in image */ },
482 NULL /* Send templates/cgi-style.css */ },
484 cgi_transparent_image,
485 NULL /* Send a transparent image (short name) */ },
486 { NULL, /* NULL Indicates end of list and default page */
488 NULL /* Unknown CGI page */ }
493 * Bulit-in images for ad replacement
495 * Hint: You can encode your own images like this:
496 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
499 #ifdef FEATURE_NO_GIFS
502 * Checkerboard pattern, as a PNG.
504 const char image_pattern_data[] =
505 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
506 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
507 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
508 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
509 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
510 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
511 "\000\000\000\111\105\116\104\256\102\140\202";
514 * 1x1 transparant PNG.
516 const char image_blank_data[] =
517 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
518 "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236"
519 "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070"
520 "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022"
521 "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115"
522 "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101"
523 "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006"
524 "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110"
525 "\000\000\000\000\111\105\116\104\256\102\140\202";
529 * Checkerboard pattern, as a GIF.
531 const char image_pattern_data[] =
532 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
533 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
534 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
535 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
539 * 1x1 transparant GIF.
541 const char image_blank_data[] =
542 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
543 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
544 "\000\001\000\000\002\002D\001\000;";
547 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
548 const size_t image_blank_length = sizeof(image_blank_data) - 1;
551 static struct http_response cgi_error_memory_response[1];
553 static struct http_response *dispatch_known_cgi(struct client_state * csp,
555 static struct map *parse_cgi_parameters(char *argstring);
558 /*********************************************************************
560 * Function : dispatch_cgi
562 * Description : Checks if a request URL has either the magical
563 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
564 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
565 * http://ijbswa.sourceforge.net/config). If so, it passes
566 * the (rest of the) path onto dispatch_known_cgi, which
567 * calls the relevant CGI handler function.
570 * 1 : csp = Current client state (buffers, headers, etc...)
572 * Returns : http_response if match, NULL if nonmatch or handler fail
574 *********************************************************************/
575 struct http_response *dispatch_cgi(struct client_state *csp)
577 const char *host = csp->http->host;
578 const char *path = csp->http->path;
581 * Should we intercept ?
584 /* Note: "example.com" and "example.com." are equivalent hostnames. */
586 /* Either the host matches CGI_SITE_1_HOST ..*/
587 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
588 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
589 && (path[0] == '/') )
591 /* ..then the path will all be for us. Remove leading '/' */
594 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
595 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
596 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
597 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
599 /* take everything following CGI_SITE_2_PATH */
600 path += strlen(CGI_SITE_2_PATH);
603 /* skip the forward slash after CGI_SITE_2_PATH */
606 else if (*path != '\0')
609 * wierdness: URL is /configXXX, where XXX is some string
610 * Do *NOT* intercept.
622 * This is a CGI call.
625 return dispatch_known_cgi(csp, path);
629 /*********************************************************************
631 * Function : dispatch_known_cgi
633 * Description : Processes a CGI once dispatch_cgi has determined that
634 * it matches one of the magic prefixes. Parses the path
635 * as a cgi name plus query string, prepares a map that
636 * maps CGI parameter names to their values, initializes
637 * the http_response struct, and calls the relevant CGI
641 * 1 : csp = Current client state (buffers, headers, etc...)
642 * 2 : path = Path of CGI, with the CGI prefix removed.
643 * Should not have a leading "/".
645 * Returns : http_response, or NULL on handler failure or out of
648 *********************************************************************/
649 static struct http_response *dispatch_known_cgi(struct client_state * csp,
652 const struct cgi_dispatcher *d;
653 struct map *param_list;
654 struct http_response *rsp;
655 char *query_args_start;
659 if (NULL == (path_copy = strdup(path)))
661 return cgi_error_memory();
664 query_args_start = path_copy;
665 while (*query_args_start && *query_args_start != '?')
669 if (*query_args_start == '?')
671 *query_args_start++ = '\0';
674 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
677 return cgi_error_memory();
683 * path_copy = CGI call name
684 * param_list = CGI params, as map
687 /* Get mem for response or fail*/
688 if (NULL == (rsp = alloc_http_response()))
691 free_map(param_list);
692 return cgi_error_memory();
695 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
696 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
697 csp->ip_addr_str, csp->http->cmd);
699 /* Find and start the right CGI function*/
703 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
705 err = (d->handler)(csp, rsp, param_list);
707 free_map(param_list);
708 if (err == JB_ERR_CGI_PARAMS)
710 err = cgi_error_bad_param(csp, rsp);
715 return finish_http_response(rsp);
719 /* Error in handler, probably out-of-memory */
720 free_http_response(rsp);
721 return cgi_error_memory();
729 /*********************************************************************
731 * Function : parse_cgi_parameters
733 * Description : Parse a URL-encoded argument string into name/value
734 * pairs and store them in a struct map list.
737 * 1 : string = string to be parsed. Will be trashed.
739 * Returns : pointer to param list, or NULL if out of memory.
741 *********************************************************************/
742 static struct map *parse_cgi_parameters(char *argstring)
745 char *vector[BUFFER_SIZE];
747 struct map *cgi_params;
749 if (NULL == (cgi_params = new_map()))
754 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
756 for (i = 0; i < pairs; i++)
758 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
761 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
763 free_map(cgi_params);
774 /*********************************************************************
776 * Function : error_response
778 * Description : returns an http_response that explains the reason
779 * why a request failed.
782 * 1 : csp = Current client state (buffers, headers, etc...)
783 * 2 : templatename = Which template should be used for the answer
784 * 3 : sys_err = system error number
786 * Returns : A http_response. If we run out of memory, this
787 * will be cgi_error_memory().
789 *********************************************************************/
790 struct http_response *error_response(struct client_state *csp,
791 const char *templatename,
795 struct http_response *rsp;
796 struct map * exports = default_exports(csp, NULL);
799 return cgi_error_memory();
802 if (NULL == (rsp = alloc_http_response()))
805 return cgi_error_memory();
808 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
809 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
810 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
811 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
812 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
815 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
818 /* Some failures, like "404 no such domain", don't have an IP address. */
819 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
827 free_http_response(rsp);
828 return cgi_error_memory();
831 if (!strcmp(templatename, "no-such-domain"))
833 rsp->status = strdup("404 No such domain");
834 if (rsp->status == NULL)
837 free_http_response(rsp);
838 return cgi_error_memory();
841 else if (!strcmp(templatename, "connect-failed"))
843 rsp->status = strdup("503 Connect failed");
844 if (rsp->status == NULL)
847 free_http_response(rsp);
848 return cgi_error_memory();
852 err = template_fill_for_cgi(csp, templatename, exports, rsp);
855 free_http_response(rsp);
856 return cgi_error_memory();
859 return finish_http_response(rsp);
863 /*********************************************************************
865 * Function : cgi_init_error_messages
867 * Description : Call at the start of the program to initialize
868 * the error message used by cgi_error_memory().
874 *********************************************************************/
875 void cgi_init_error_messages(void)
877 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
878 cgi_error_memory_response->head =
879 "HTTP/1.0 500 Internal Privoxy Error\r\n"
880 "Content-Type: text/html\r\n"
882 cgi_error_memory_response->body =
884 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
886 "<h1>500 Internal Privoxy Error</h1>\r\n"
887 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
888 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
892 cgi_error_memory_response->head_length =
893 strlen(cgi_error_memory_response->head);
894 cgi_error_memory_response->content_length =
895 strlen(cgi_error_memory_response->body);
899 /*********************************************************************
901 * Function : cgi_error_memory
903 * Description : Called if a CGI function runs out of memory.
904 * Returns a statically-allocated error response.
907 * 1 : csp = Current client state (buffers, headers, etc...)
908 * 2 : rsp = http_response data structure for output
909 * 3 : template_name = Name of template that could not
912 * Returns : JB_ERR_OK on success
913 * JB_ERR_MEMORY on out-of-memory error.
915 *********************************************************************/
916 struct http_response *cgi_error_memory(void)
918 /* assert that it's been initialized. */
919 assert(cgi_error_memory_response->head);
921 return cgi_error_memory_response;
925 /*********************************************************************
927 * Function : cgi_error_no_template
929 * Description : Almost-CGI function that is called if a templae
930 * cannot be loaded. Note this is not a true CGI,
931 * it takes a template name rather than a map of
935 * 1 : csp = Current client state (buffers, headers, etc...)
936 * 2 : rsp = http_response data structure for output
937 * 3 : template_name = Name of template that could not
940 * Returns : JB_ERR_OK on success
941 * JB_ERR_MEMORY on out-of-memory error.
943 *********************************************************************/
944 jb_err cgi_error_no_template(struct client_state *csp,
945 struct http_response *rsp,
946 const char *template_name)
948 static const char status[] =
949 "500 Internal Privoxy Error";
950 static const char body_prefix[] =
952 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
954 "<h1>500 Internal Privoxy Error</h1>\r\n"
955 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
956 "<p><b>Could not load template file <code>";
957 static const char body_suffix[] =
958 "</code> or one of it's included components.</b></p>\r\n"
959 "<p>Please contact your proxy administrator.</p>\r\n"
960 "<p>If you are the proxy administrator, please put the required file(s)"
961 "in the <code><i>(confdir)</i>/templates</code> directory. The "
962 "location of the <code><i>(confdir)</i></code> directory "
963 "is specified in the main Privoxy <code>config</code> "
964 "file. (It's typically the Privoxy install directory"
966 ", or <code>/etc/privoxy/</code>"
967 #endif /* ndef _WIN32 */
974 assert(template_name);
976 /* Reset rsp, if needed */
980 rsp->content_length = 0;
981 rsp->head_length = 0;
984 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
985 if (rsp->body == NULL)
987 return JB_ERR_MEMORY;
989 strcpy(rsp->body, body_prefix);
990 strcat(rsp->body, template_name);
991 strcat(rsp->body, body_suffix);
993 rsp->status = strdup(status);
994 if (rsp->body == NULL)
996 return JB_ERR_MEMORY;
1003 /*********************************************************************
1005 * Function : cgi_error_bad_param
1007 * Description : CGI function that is called if the parameters
1008 * (query string) for a CGI were wrong.
1011 * 1 : csp = Current client state (buffers, headers, etc...)
1012 * 2 : rsp = http_response data structure for output
1014 * CGI Parameters : none
1016 * Returns : JB_ERR_OK on success
1017 * JB_ERR_MEMORY on out-of-memory error.
1019 *********************************************************************/
1020 jb_err cgi_error_bad_param(struct client_state *csp,
1021 struct http_response *rsp)
1023 struct map *exports;
1028 if (NULL == (exports = default_exports(csp, NULL)))
1030 return JB_ERR_MEMORY;
1033 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1037 /*********************************************************************
1039 * Function : get_http_time
1041 * Description : Get the time in a format suitable for use in a
1042 * HTTP header - e.g.:
1043 * "Sun, 06 Nov 1994 08:49:37 GMT"
1046 * 1 : time_offset = Time returned will be current time
1047 * plus this number of seconds.
1048 * 2 : buf = Destination for result. Must be long enough
1049 * to hold 29 characters plus a trailing zero.
1053 *********************************************************************/
1054 void get_http_time(int time_offset, char *buf)
1056 static const char day_names[7][4] =
1057 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1058 static const char month_names[12][4] =
1059 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1060 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1063 time_t current_time;
1067 time(¤t_time); /* get current time */
1069 current_time += time_offset;
1071 /* get and save the gmt */
1073 #ifdef HAVE_GMTIME_R
1075 t = gmtime_r(¤t_time, &dummy);
1077 t = gmtime(¤t_time);
1081 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1083 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1084 day_names[t->tm_wday],
1086 month_names[t->tm_mon],
1096 /*********************************************************************
1098 * Function : finish_http_response
1100 * Description : Fill in the missing headers in an http response,
1101 * and flatten the headers to an http head.
1104 * 1 : rsp = pointer to http_response to be processed
1106 * Returns : A http_response, usually the rsp parameter.
1107 * On error, free()s rsp and returns cgi_error_memory()
1109 *********************************************************************/
1110 struct http_response *finish_http_response(struct http_response *rsp)
1112 char buf[BUFFER_SIZE];
1115 /* Special case - do NOT change this statically allocated response,
1116 * which is ready for output anyway.
1118 if (rsp == cgi_error_memory_response)
1124 * Fill in the HTTP Status
1126 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1127 err = enlist_first(rsp->headers, buf);
1130 * Set the Content-Length
1132 if (rsp->content_length == 0)
1134 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1138 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1139 err = enlist(rsp->headers, buf);
1143 * Fill in the default headers:
1145 * Content-Type: default to text/html if not already specified.
1146 * Date: set to current date/time.
1147 * Last-Modified: set to date/time the page was last changed.
1148 * Expires: set to date/time page next needs reloading.
1149 * Cache-Control: set to "no-cache" if applicable.
1151 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1153 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1158 * Set Expires to about 10 min into the future so it'll get reloaded
1159 * occasionally, e.g. if Privoxy gets upgraded.
1164 get_http_time(0, buf);
1165 err = enlist_unique_header(rsp->headers, "Date", buf);
1168 /* Some date in the past. */
1169 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1173 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1174 err = enlist_unique_header(rsp->headers, "Expires", buf);
1180 * Compliant browsers should not cache this due to the "Cache-Control"
1181 * setting. However, to be certain, we also set both "Last-Modified"
1182 * and "Expires" to the current time.
1184 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1186 get_http_time(0, buf);
1187 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1188 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1189 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1196 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1198 free_http_response(rsp);
1199 return cgi_error_memory();
1201 rsp->head_length = strlen(rsp->head);
1208 /*********************************************************************
1210 * Function : alloc_http_response
1212 * Description : Allocates a new http_response structure.
1216 * Returns : pointer to a new http_response, or NULL.
1218 *********************************************************************/
1219 struct http_response *alloc_http_response(void)
1221 return (struct http_response *) zalloc(sizeof(struct http_response));
1226 /*********************************************************************
1228 * Function : free_http_response
1230 * Description : Free the memory occupied by an http_response
1231 * and its depandant structures.
1234 * 1 : rsp = pointer to http_response to be freed
1238 *********************************************************************/
1239 void free_http_response(struct http_response *rsp)
1242 * Must special case cgi_error_memory_response, which is never freed.
1244 if (rsp && (rsp != cgi_error_memory_response))
1249 destroy_list(rsp->headers);
1256 /*********************************************************************
1258 * Function : template_load
1260 * Description : CGI support function that loads a given HTML
1261 * template from the confdir, ignoring comment
1262 * lines and following #include statements up to
1266 * 1 : csp = Current client state (buffers, headers, etc...)
1267 * 2 : template_ptr = Destination for pointer to loaded
1269 * 3 : template = name of the HTML template to be used
1270 * 4 : recursive = Flag set if this function calls itself
1271 * following an #include statament
1273 * Returns : JB_ERR_OK on success
1274 * JB_ERR_MEMORY on out-of-memory error.
1275 * JB_ERR_FILE if the template file cannot be read
1277 *********************************************************************/
1278 jb_err template_load(struct client_state *csp, char **template_ptr,
1279 const char *templatename, int recursive)
1282 char *templates_dir_path;
1285 char *included_module;
1288 char buf[BUFFER_SIZE];
1291 assert(template_ptr);
1292 assert(templatename);
1294 *template_ptr = NULL;
1296 /* Validate template name. Paranoia. */
1297 for (p = templatename; *p != 0; p++)
1299 if ( ((*p < 'a') || (*p > 'z'))
1300 && ((*p < 'A') || (*p > 'Z'))
1301 && ((*p < '0') || (*p > '9'))
1305 /* Illegal character */
1310 /* Generate full path */
1312 templates_dir_path = make_path(csp->config->confdir, "templates");
1313 if (templates_dir_path == NULL)
1315 return JB_ERR_MEMORY;
1318 full_path = make_path(templates_dir_path, templatename);
1319 free(templates_dir_path);
1320 if (full_path == NULL)
1322 return JB_ERR_MEMORY;
1325 /* Allocate buffer */
1327 file_buffer = strdup("");
1328 if (file_buffer == NULL)
1331 return JB_ERR_MEMORY;
1334 /* Open template file */
1336 if (NULL == (fp = fopen(full_path, "r")))
1338 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1346 * Read the file, ignoring comments, and honoring #include
1347 * statements, unless we're already called recursively.
1349 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1350 * This is unlikely in practise.
1352 while (fgets(buf, BUFFER_SIZE, fp))
1354 if (!recursive && !strncmp(buf, "#include ", 9))
1356 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1363 if (string_join(&file_buffer, included_module))
1366 return JB_ERR_MEMORY;
1372 /* skip lines starting with '#' */
1378 if (string_append(&file_buffer, buf))
1381 return JB_ERR_MEMORY;
1386 *template_ptr = file_buffer;
1392 /*********************************************************************
1394 * Function : template_fill
1396 * Description : CGI support function that fills in a pre-loaded
1397 * HTML template by replacing @name@ with value using
1398 * pcrs, for each item in the output map.
1400 * Note that a leading '$' charachter in the export map's
1401 * values will be stripped and toggle on backreference
1405 * 1 : template_ptr = IN: Template to be filled out.
1407 * OUT: Filled out template.
1408 * Caller must free().
1409 * 2 : exports = map with fill in symbol -> name pairs
1411 * Returns : JB_ERR_OK on success
1412 * JB_ERR_MEMORY on out-of-memory error
1414 *********************************************************************/
1415 jb_err template_fill(char **template_ptr, const struct map *exports)
1417 struct map_entry *m;
1419 char buf[BUFFER_SIZE];
1420 char *tmp_out_buffer;
1426 assert(template_ptr);
1427 assert(*template_ptr);
1430 file_buffer = *template_ptr;
1431 size = strlen(file_buffer) + 1;
1434 * Assemble pcrs joblist from exports map
1436 for (m = exports->first; m != NULL; m = m->next)
1438 if (*m->name == '$')
1441 * First character of name is '$', so remove this flag
1442 * character and allow backreferences ($1 etc) in the
1443 * "replace with" text.
1445 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1451 * Treat the "replace with" text as a literal string -
1452 * no quoting needed, no backreferences allowed.
1453 * ("Trivial" ['T'] flag).
1457 /* Enclose name in @@ */
1458 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1462 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
1464 /* Make and run job. */
1465 job = pcrs_compile(buf, m->value, flags, &error);
1468 if (error == PCRS_ERR_NOMEM)
1471 *template_ptr = NULL;
1472 return JB_ERR_MEMORY;
1476 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
1477 /* Hope it wasn't important and silently ignore the invalid job */
1482 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
1485 if (NULL == tmp_out_buffer)
1487 *template_ptr = NULL;
1488 return JB_ERR_MEMORY;
1490 file_buffer = tmp_out_buffer;
1497 *template_ptr = file_buffer;
1502 /*********************************************************************
1504 * Function : template_fill_for_cgi
1506 * Description : CGI support function that loads a HTML template
1507 * and fills it in. Handles file-not-found errors
1508 * by sending a HTML error message. For convenience,
1509 * this function also frees the passed "exports" map.
1512 * 1 : csp = Client state
1513 * 2 : templatename = name of the HTML template to be used
1514 * 3 : exports = map with fill in symbol -> name pairs.
1515 * Will be freed by this function.
1517 * Returns : JB_ERR_OK on success
1518 * JB_ERR_MEMORY on out-of-memory error
1520 *********************************************************************/
1521 jb_err template_fill_for_cgi(struct client_state *csp,
1522 const char *templatename,
1523 struct map *exports,
1524 struct http_response *rsp)
1529 assert(templatename);
1533 err = template_load(csp, &rsp->body, templatename, 0);
1534 if (err == JB_ERR_FILE)
1537 return cgi_error_no_template(csp, rsp, templatename);
1542 return err; /* JB_ERR_MEMORY */
1544 err = template_fill(&rsp->body, exports);
1550 /*********************************************************************
1552 * Function : default_exports
1554 * Description : returns a struct map list that contains exports
1555 * which are common to all CGI functions.
1558 * 1 : csp = Current client state (buffers, headers, etc...)
1559 * 2 : caller = name of CGI who calls us and which should
1560 * be excluded from the generated menu. May be
1562 * Returns : NULL if no memory, else a new map. Caller frees.
1564 *********************************************************************/
1565 struct map *default_exports(const struct client_state *csp, const char *caller)
1569 struct map * exports;
1570 int local_help_exists = 0;
1574 exports = new_map();
1575 if (exports == NULL)
1580 err = map(exports, "version", 1, html_encode(VERSION), 0);
1581 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
1582 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
1583 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
1584 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
1585 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
1586 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
1587 if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB);
1589 snprintf(buf, 20, "%d", csp->config->hport);
1590 if (!err) err = map(exports, "my-port", 1, buf, 1);
1592 if(!strcmp(CODE_STATUS, "stable"))
1594 if (!err) err = map_block_killer(exports, "unstable");
1597 if (csp->config->admin_address != NULL)
1599 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
1600 local_help_exists = 1;
1604 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
1607 if (csp->config->proxy_info_url != NULL)
1609 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
1610 local_help_exists = 1;
1614 if (!err) err = map_block_killer(exports, "have-proxy-info");
1617 if (local_help_exists == 0)
1619 if (!err) err = map_block_killer(exports, "have-help-info");
1632 /*********************************************************************
1634 * Function : map_block_killer
1636 * Description : Convenience function.
1637 * Adds a "killer" for the conditional HTML-template
1638 * block <name>, i.e. a substitution of the regex
1639 * "if-<name>-start.*if-<name>-end" to the given
1643 * 1 : exports = map to extend
1644 * 2 : name = name of conditional block
1646 * Returns : JB_ERR_OK on success
1647 * JB_ERR_MEMORY on out-of-memory error.
1649 *********************************************************************/
1650 jb_err map_block_killer(struct map *exports, const char *name)
1652 char buf[1000]; /* Will do, since the names are hardwired */
1656 assert(strlen(name) < 490);
1658 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
1659 return map(exports, buf, 1, "", 1);
1663 /*********************************************************************
1665 * Function : map_block_keep
1667 * Description : Convenience function. Removes the markers used
1668 * by map-block-killer, to save a few bytes.
1669 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
1672 * 1 : exports = map to extend
1673 * 2 : name = name of conditional block
1675 * Returns : JB_ERR_OK on success
1676 * JB_ERR_MEMORY on out-of-memory error.
1678 *********************************************************************/
1679 jb_err map_block_keep(struct map *exports, const char *name)
1682 char buf[500]; /* Will do, since the names are hardwired */
1686 assert(strlen(name) < 490);
1688 snprintf(buf, 500, "if-%s-start", name);
1689 err = map(exports, buf, 1, "", 1);
1696 snprintf(buf, 500, "if-%s-end", name);
1697 return map(exports, buf, 1, "", 1);
1701 /*********************************************************************
1703 * Function : map_conditional
1705 * Description : Convenience function.
1706 * Adds an "if-then-else" for the conditional HTML-template
1707 * block <name>, i.e. a substitution of the form:
1714 * The control structure and one of the alternatives
1718 * 1 : exports = map to extend
1719 * 2 : name = name of conditional block
1720 * 3 : choose_first = nonzero for first, zero for second.
1722 * Returns : JB_ERR_OK on success
1723 * JB_ERR_MEMORY on out-of-memory error.
1725 *********************************************************************/
1726 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
1728 char buf[1000]; /* Will do, since the names are hardwired */
1733 assert(strlen(name) < 480);
1735 snprintf(buf, 1000, (choose_first
1736 ? "else-not-%s@.*@endif-%s"
1737 : "if-%s-then@.*@else-not-%s"),
1740 err = map(exports, buf, 1, "", 1);
1746 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
1747 return map(exports, buf, 1, "", 1);
1751 /*********************************************************************
1753 * Function : make_menu
1755 * Description : Returns an HTML-formatted menu of the available
1756 * unhidden CGIs, excluding the one given in <self>.
1758 * Parameters : self = name of CGI to leave out, can be NULL
1760 * Returns : menu string, or NULL on out-of-memory error.
1762 *********************************************************************/
1763 char *make_menu(const char *self)
1765 const struct cgi_dispatcher *d;
1766 char *result = strdup("");
1770 self = "NO-SUCH-CGI!";
1773 /* List available unhidden CGI's and export as "other-cgis" */
1774 for (d = cgi_dispatchers; d->name; d++)
1776 if (d->description && strcmp(d->name, self))
1778 string_append(&result, "<li><a href=\"" CGI_PREFIX);
1779 string_append(&result, d->name);
1780 string_append(&result, "\">");
1781 string_append(&result, d->description);
1782 string_append(&result, "</a></li>");
1790 /*********************************************************************
1792 * Function : dump_map
1794 * Description : HTML-dump a map for debugging
1797 * 1 : the_map = map to dump
1799 * Returns : string with HTML
1801 *********************************************************************/
1802 char *dump_map(const struct map *the_map)
1804 struct map_entry *cur_entry;
1805 char *ret = strdup("");
1807 string_append(&ret, "<table>\n");
1809 for (cur_entry = the_map->first;
1810 (cur_entry != NULL) && (ret != NULL);
1811 cur_entry = cur_entry->next)
1813 string_append(&ret, "<tr><td><b>");
1814 string_join (&ret, html_encode(cur_entry->name));
1815 string_append(&ret, "</b></td><td>");
1816 string_join (&ret, html_encode(cur_entry->value));
1817 string_append(&ret, "</td></tr>\n");
1820 string_append(&ret, "</table>\n");