1 const char cgi_rcs[] = "$Id: cgi.c,v 2.0 2002/06/04 14:34:21 jongfoster Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/src/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 2.0 2002/06/04 14:34:21 jongfoster
42 * Moving source files to src/
44 * Revision 1.70 2002/05/19 11:33:20 jongfoster
45 * If a CGI error was not handled, and propogated back to
46 * dispatch_known_cgi(), then it was assumed to be "out of memory".
47 * This gave a very misleading error message.
49 * Now other errors will cause a simple message giving the error
50 * number and asking the user to report a bug.
53 * http://sourceforge.net/tracker/index.php?func=detail
54 * &aid=557905&group_id=11118&atid=111118
56 * Revision 1.69 2002/05/14 21:28:40 oes
57 * - Fixed add_help_link to link to the (now split) actions
58 * part of the config chapter
59 * - Renamed helplink export to actions-help-prefix
61 * Revision 1.68 2002/05/12 21:36:29 jongfoster
62 * Correcting function comments
64 * Revision 1.67 2002/04/30 12:02:07 oes
65 * Nit: updated a comment
67 * Revision 1.66 2002/04/26 18:32:57 jongfoster
68 * Fixing a memory leak on error
70 * Revision 1.65 2002/04/26 12:53:51 oes
71 * - New function add_help_link
72 * - default_exports now exports links to the user manual
73 * and a prefix for links into the config chapter
75 * Revision 1.64 2002/04/24 02:17:21 oes
76 * - Better descriptions for CGIs
77 * - Hide edit-actions, more shortcuts
78 * - Moved get_char_param, get_string_param and get_number_param here
81 * Revision 1.63 2002/04/15 19:06:43 jongfoster
84 * Revision 1.62 2002/04/10 19:59:46 jongfoster
85 * Fixes to #include in templates:
86 * - Didn't close main file if loading an included template fails.
87 * - I'm paranoid and want to disallow "#include /etc/passwd".
89 * Revision 1.61 2002/04/10 13:37:48 oes
90 * Made templates modular: template_load now recursive with max depth 1
92 * Revision 1.60 2002/04/08 20:50:25 swa
95 * Revision 1.59 2002/04/05 15:51:51 oes
96 * - added send-stylesheet CGI
97 * - bugfix: error-pages now get correct request protocol
99 * - kludged CGI descriptions and menu not to break JS syntax
101 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
102 * Fix Mac OSX compiler warnings
104 * Revision 1.57 2002/03/26 22:29:54 swa
105 * we have a new homepage!
107 * Revision 1.56 2002/03/24 17:50:46 jongfoster
108 * Fixing compile error if actions file editor disabled
110 * Revision 1.55 2002/03/24 16:55:06 oes
111 * Making GIF checkerboard transparent
113 * Revision 1.54 2002/03/24 16:18:15 jongfoster
116 * Revision 1.53 2002/03/24 16:06:00 oes
117 * Correct transparency for checkerboard PNG. Thanks, Magnus!
119 * Revision 1.52 2002/03/24 15:23:33 jongfoster
122 * Revision 1.51 2002/03/24 13:25:43 swa
123 * name change related issues
125 * Revision 1.50 2002/03/16 23:54:06 jongfoster
126 * Adding graceful termination feature, to help look for memory leaks.
127 * If you enable this (which, by design, has to be done by hand
128 * editing config.h) and then go to http://i.j.b/die, then the program
129 * will exit cleanly after the *next* request. It should free all the
130 * memory that was used.
132 * Revision 1.49 2002/03/13 00:27:04 jongfoster
135 * Revision 1.48 2002/03/08 17:47:07 jongfoster
138 * Revision 1.47 2002/03/08 16:41:33 oes
139 * Added GIF images again
141 * Revision 1.46 2002/03/07 03:48:38 oes
142 * - Changed built-in images from GIF to PNG
143 * (with regard to Unisys patent issue)
144 * - Added a 4x4 pattern PNG which is less intrusive
145 * than the logo but also clearly marks the deleted banners
147 * Revision 1.45 2002/03/06 22:54:35 jongfoster
148 * Automated function-comment nitpicking.
150 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
151 * - Better error reporting on OS/2
152 * - Fix double-slash comment (oops)
154 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
155 * - Re-enable OS/2 building after new parms were added
156 * - Fix false out of memory report when resolving CGI templates when no IP
157 * address is available of failed attempt (a la no such domain)
159 * Revision 1.42 2002/01/21 00:33:20 jongfoster
160 * Replacing strsav() with the safer string_append() or string_join().
161 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
162 * Adding missing html_encode() to error message generators.
163 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
165 * Revision 1.41 2002/01/17 20:56:22 jongfoster
166 * Replacing hard references to the URL of the config interface
167 * with #defines from project.h
169 * Revision 1.40 2002/01/09 14:26:46 oes
170 * Added support for thread-safe gmtime_r call.
172 * Revision 1.39 2001/11/16 00:48:13 jongfoster
173 * Fixing a compiler warning
175 * Revision 1.38 2001/11/13 00:31:21 jongfoster
176 * - Adding new CGIs for use by non-JavaScript browsers:
177 * edit-actions-url-form
178 * edit-actions-add-url-form
179 * edit-actions-remove-url-form
180 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
183 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
184 * Show enablement/disablement status in almost all templates.
185 * There is a little trickiness here: apparent recursive resolution of
186 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
187 * the actual enablement status. So a similar construct,
188 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
191 * Revision 1.36 2001/10/26 17:33:27 oes
194 * Revision 1.35 2001/10/23 21:48:19 jongfoster
195 * Cleaning up error handling in CGI functions - they now send back
196 * a HTML error page and should never cause a FATAL error. (Fixes one
197 * potential source of "denial of service" attacks).
199 * CGI actions file editor that works and is actually useful.
201 * Ability to toggle Junkbuster remotely using a CGI call.
203 * You can turn off both the above features in the main configuration
204 * file, e.g. if you are running a multi-user proxy.
206 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
207 * Only show "Local support" on templates conditionally:
208 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
209 * - if not, no Local support section appears
211 * Revision 1.33 2001/10/14 22:28:41 jongfoster
212 * Fixing stupid typo.
214 * Revision 1.32 2001/10/14 22:20:18 jongfoster
215 * - Changes to CGI dispatching method to match CGI names exactly,
216 * rather than doing a prefix match.
217 * - No longer need to count the length of the CGI handler names by hand.
218 * - Adding new handler for 404 error when disptching a CGI, if none of
219 * the handlers match.
220 * - Adding new handlers for CGI actionsfile editor.
222 * Revision 1.31 2001/10/10 10:56:39 oes
223 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
225 * Revision 1.30 2001/10/02 15:30:57 oes
226 * Introduced show-request cgi
228 * Revision 1.29 2001/09/20 15:47:44 steudten
230 * Fix BUG: Modify int size to size_t size in fill_template()
231 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
233 * Revision 1.28 2001/09/19 18:00:37 oes
234 * - Deletef time() FIXME (Can't fail under Linux either, if
235 * the argument is guaranteed to be in out address space,
238 * - Pointer notation cosmetics
239 * - Fixed a minor bug in template_fill(): Failiure of
240 * pcrs_execute() now secure.
242 * Revision 1.27 2001/09/16 17:08:54 jongfoster
243 * Moving simple CGI functions from cgi.c to new file cgisimple.c
245 * Revision 1.26 2001/09/16 15:47:37 jongfoster
246 * First version of CGI-based edit interface. This is very much a
247 * work-in-progress, and you can't actually use it to edit anything
248 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
249 * to have any effect.
251 * Revision 1.25 2001/09/16 15:02:35 jongfoster
252 * Adding i.j.b/robots.txt.
253 * Inlining add_stats() since it's only ever called from one place.
255 * Revision 1.24 2001/09/16 11:38:01 jongfoster
256 * Splitting fill_template() into 2 functions:
257 * template_load() loads the file
258 * template_fill() performs the PCRS regexps.
259 * This is because the CGI edit interface has a "table row"
260 * template which is used many times in the page - this
261 * change means it's only loaded from disk once.
263 * Revision 1.23 2001/09/16 11:16:05 jongfoster
264 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
266 * Revision 1.22 2001/09/16 11:00:10 jongfoster
267 * New function alloc_http_response, for symmetry with free_http_response
269 * Revision 1.21 2001/09/13 23:53:03 jongfoster
270 * Support for both static and dynamically generated CGI pages.
271 * Correctly setting Last-Modified: and Expires: HTTP headers.
273 * Revision 1.20 2001/09/13 23:40:36 jongfoster
274 * (Cosmetic only) Indentation correction
276 * Revision 1.19 2001/09/13 23:31:25 jongfoster
277 * Moving image data to cgi.c rather than cgi.h.
279 * Revision 1.18 2001/08/05 16:06:20 jongfoster
280 * Modifiying "struct map" so that there are now separate header and
281 * "map_entry" structures. This means that functions which modify a
282 * map no longer need to return a pointer to the modified map.
283 * Also, it no longer reverses the order of the entries (which may be
284 * important with some advanced template substitutions).
286 * Revision 1.17 2001/08/05 15:57:38 oes
287 * Adapted finish_http_response to new list_to_text
289 * Revision 1.16 2001/08/01 21:33:18 jongfoster
290 * Changes to fill_template() that reduce memory usage without having
291 * an impact on performance. I also renamed some variables so as not
292 * to clash with the C++ keywords "new" and "template".
294 * Revision 1.15 2001/08/01 21:19:22 jongfoster
295 * Moving file version information to a separate CGI page.
297 * Revision 1.14 2001/08/01 00:19:03 jongfoster
298 * New function: map_conditional() for an if-then-else syntax.
299 * Changing to use new version of show_defines()
301 * Revision 1.13 2001/07/30 22:08:36 jongfoster
302 * Tidying up #defines:
303 * - All feature #defines are now of the form FEATURE_xxx
304 * - Permanently turned off WIN_GUI_EDIT
305 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
307 * Revision 1.12 2001/07/29 18:47:05 jongfoster
308 * Adding missing #include "loadcfg.h"
310 * Revision 1.11 2001/07/18 17:24:37 oes
311 * Changed to conform to new pcrs interface
313 * Revision 1.10 2001/07/13 13:53:13 oes
314 * Removed all #ifdef PCRS and related code
316 * Revision 1.9 2001/06/29 21:45:41 oes
317 * Indentation, CRLF->LF, Tab-> Space
319 * Revision 1.8 2001/06/29 13:21:46 oes
320 * - Cosmetics: renamed and reordered functions, variables,
321 * texts, improved comments etc
323 * - Removed ij_untrusted_url() The relevant
324 * info is now part of the "untrusted" page,
325 * which is generated by filters.c:trust_url()
327 * - Generators of content now call finish_http_response()
328 * themselves, making jcc.c:chat() a little less
331 * - Removed obsolete "Pragma: no-cache" from our headers
333 * - http_responses now know their head length
335 * - fill_template now uses the new interface to pcrs, so that
336 * - long jobs (like whole files) no longer have to be assembled
337 * in a fixed size buffer
338 * - the new T (trivial) option is used, and the replacement may
339 * contain Perl syntax backrefs without confusing pcrs
341 * - Introduced default_exports() which generates a set of exports
342 * common to all CGIs and other content generators
344 * - Introduced convenience function map_block_killer()
346 * - Introduced convenience function make_menu()
348 * - Introduced CGI-like function error_response() which generates
349 * the "No such domain" and "Connect failed" messages using the
352 * - cgi_show_url_info:
353 * - adapted to new CGI features
354 * - form and answers now generated from same template
355 * - http:// prefix in URL now OK
358 * - adapted to new CGI features
359 * - no longer uses csp->init_proxy_args
362 * - moved menu generation to make_menu()
364 * - add_stats now writes single export map entries instead
367 * - Moved redirect_url() to filters.c
369 * - Fixed mem leak in free_http_response(), map_block_killer(),
371 * - Removed logentry from cancelled commit
373 * Revision 1.7 2001/06/09 10:51:58 jongfoster
374 * Changing "show URL info" handler to new style.
375 * Changing BUFSIZ ==> BUFFER_SIZE
377 * Revision 1.6 2001/06/07 23:05:19 jongfoster
378 * Removing code related to old forward and ACL files.
380 * Revision 1.5 2001/06/05 19:59:16 jongfoster
381 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
383 * Revision 1.4 2001/06/04 10:41:52 swa
384 * show version string of cgi.h and cgi.c
386 * Revision 1.3 2001/06/03 19:12:16 oes
387 * introduced new cgi handling
389 * No revisions before 1.3
391 **********************************************************************/
397 #include <sys/types.h>
405 #define snprintf _snprintf
406 #endif /* def _WIN32 */
414 #include "miscutil.h"
415 #include "cgisimple.h"
416 #ifdef FEATURE_CGI_EDIT_ACTIONS
418 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
420 /* loadcfg.h is for g_bToggleIJB only */
422 const char cgi_h_rcs[] = CGI_H_VERSION;
425 * List of CGI functions: name, handler, description.
426 * Note: Do NOT use single quotes in the description;
427 * this will break the dynamic "blocked" template!
429 static const struct cgi_dispatcher cgi_dispatchers[] = {
432 "Privoxy main page" },
433 #ifdef FEATURE_GRACEFUL_TERMINATION
436 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
437 "this is a one click Denial Of Service attack!!!</em>" },
441 "View & change the current configuration" },
444 "View the source code version numbers" },
447 "View the request headers." },
450 "Look up which actions apply to a URL and why" },
451 #ifdef FEATURE_CGI_EDIT_ACTIONS
454 "Toggle Privoxy on or off" },
456 { "edit-actions", /* Edit the actions list */
459 { "eaa", /* Shortcut for edit-actions-add-url-form */
460 cgi_edit_actions_add_url_form,
462 { "eau", /* Shortcut for edit-actions-url-form */
463 cgi_edit_actions_url_form,
465 { "ear", /* Shortcut for edit-actions-remove-url-form */
466 cgi_edit_actions_remove_url_form,
468 { "eafu", /* Shortcut for edit-actions-for-url */
469 cgi_edit_actions_for_url,
471 { "eas", /* Shortcut for edit-actions-submit */
472 cgi_edit_actions_submit,
474 { "easa", /* Shortcut for edit-actions-section-add */
475 cgi_edit_actions_section_add,
477 { "easr", /* Shortcut for edit-actions-section-remove */
478 cgi_edit_actions_section_remove,
480 { "eass", /* Shortcut for edit-actions-section-swap */
481 cgi_edit_actions_section_swap,
483 { "edit-actions-for-url",
484 cgi_edit_actions_for_url,
485 NULL /* Edit the actions for (a) specified URL(s) */ },
486 { "edit-actions-list",
487 cgi_edit_actions_list,
488 NULL /* Edit the actions list */ },
489 { "edit-actions-submit",
490 cgi_edit_actions_submit,
491 NULL /* Change the actions for (a) specified URL(s) */ },
492 { "edit-actions-url",
493 cgi_edit_actions_url,
494 NULL /* Change a URL pattern in the actionsfile */ },
495 { "edit-actions-url-form",
496 cgi_edit_actions_url_form,
497 NULL /* Form to change a URL pattern in the actionsfile */ },
498 { "edit-actions-add-url",
499 cgi_edit_actions_add_url,
500 NULL /* Add a URL pattern to the actionsfile */ },
501 { "edit-actions-add-url-form",
502 cgi_edit_actions_add_url_form,
503 NULL /* Form to add a URL pattern to the actionsfile */ },
504 { "edit-actions-remove-url",
505 cgi_edit_actions_remove_url,
506 NULL /* Remove a URL pattern from the actionsfile */ },
507 { "edit-actions-remove-url-form",
508 cgi_edit_actions_remove_url_form,
509 NULL /* Form to remove a URL pattern from the actionsfile */ },
510 { "edit-actions-section-add",
511 cgi_edit_actions_section_add,
512 NULL /* Remove a section from the actionsfile */ },
513 { "edit-actions-section-remove",
514 cgi_edit_actions_section_remove,
515 NULL /* Remove a section from the actionsfile */ },
516 { "edit-actions-section-swap",
517 cgi_edit_actions_section_swap,
518 NULL /* Swap two sections in the actionsfile */ },
519 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
522 NULL /* Sends a robots.txt file to tell robots to go away. */ },
525 NULL /* Send a built-in image */ },
528 NULL /* Send templates/cgi-style.css */ },
530 cgi_transparent_image,
531 NULL /* Send a transparent image (short name) */ },
532 { NULL, /* NULL Indicates end of list and default page */
534 NULL /* Unknown CGI page */ }
539 * Built-in images for ad replacement
541 * Hint: You can encode your own images like this:
542 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
545 #ifdef FEATURE_NO_GIFS
548 * Checkerboard pattern, as a PNG.
550 const char image_pattern_data[] =
551 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
552 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
553 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
554 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
555 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
556 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
557 "\000\000\000\111\105\116\104\256\102\140\202";
560 * 1x1 transparant PNG.
562 const char image_blank_data[] =
563 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
564 "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236"
565 "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070"
566 "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022"
567 "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115"
568 "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101"
569 "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006"
570 "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110"
571 "\000\000\000\000\111\105\116\104\256\102\140\202";
575 * Checkerboard pattern, as a GIF.
577 const char image_pattern_data[] =
578 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
579 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
580 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
581 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
585 * 1x1 transparant GIF.
587 const char image_blank_data[] =
588 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
589 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
590 "\000\001\000\000\002\002D\001\000;";
594 * The size of the image_pattern, in bytes.
596 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
599 * The size of the image_blank, in bytes.
601 const size_t image_blank_length = sizeof(image_blank_data) - 1;
605 * The "Out of memory" CGI response. This is statically allocated
606 * and is initialized at startup, for obvious reasons. It's
607 * read-only. finish_http_response() and free_http_response()
608 * have been special-cased to do nothing if they are passed
611 static struct http_response cgi_error_memory_response[1];
614 static struct http_response *dispatch_known_cgi(struct client_state * csp,
616 static struct map *parse_cgi_parameters(char *argstring);
619 /*********************************************************************
621 * Function : dispatch_cgi
623 * Description : Checks if a request URL has either the magical
624 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
625 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
626 * http://config.privoxy.org/). If so, it passes
627 * the (rest of the) path onto dispatch_known_cgi, which
628 * calls the relevant CGI handler function.
631 * 1 : csp = Current client state (buffers, headers, etc...)
633 * Returns : http_response if match, NULL if nonmatch or handler fail
635 *********************************************************************/
636 struct http_response *dispatch_cgi(struct client_state *csp)
638 const char *host = csp->http->host;
639 const char *path = csp->http->path;
642 * Should we intercept ?
645 /* Note: "example.com" and "example.com." are equivalent hostnames. */
647 /* Either the host matches CGI_SITE_1_HOST ..*/
648 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
649 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
650 && (path[0] == '/') )
652 /* ..then the path will all be for us. Remove leading '/' */
655 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
656 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
657 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
658 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
660 /* take everything following CGI_SITE_2_PATH */
661 path += strlen(CGI_SITE_2_PATH);
664 /* skip the forward slash after CGI_SITE_2_PATH */
667 else if (*path != '\0')
670 * wierdness: URL is /configXXX, where XXX is some string
671 * Do *NOT* intercept.
683 * This is a CGI call.
686 return dispatch_known_cgi(csp, path);
690 /*********************************************************************
692 * Function : dispatch_known_cgi
694 * Description : Processes a CGI once dispatch_cgi has determined that
695 * it matches one of the magic prefixes. Parses the path
696 * as a cgi name plus query string, prepares a map that
697 * maps CGI parameter names to their values, initializes
698 * the http_response struct, and calls the relevant CGI
702 * 1 : csp = Current client state (buffers, headers, etc...)
703 * 2 : path = Path of CGI, with the CGI prefix removed.
704 * Should not have a leading "/".
706 * Returns : http_response, or NULL on handler failure or out of
709 *********************************************************************/
710 static struct http_response *dispatch_known_cgi(struct client_state * csp,
713 const struct cgi_dispatcher *d;
714 struct map *param_list;
715 struct http_response *rsp;
716 char *query_args_start;
720 if (NULL == (path_copy = strdup(path)))
722 return cgi_error_memory();
725 query_args_start = path_copy;
726 while (*query_args_start && *query_args_start != '?')
730 if (*query_args_start == '?')
732 *query_args_start++ = '\0';
735 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
738 return cgi_error_memory();
744 * path_copy = CGI call name
745 * param_list = CGI params, as map
748 /* Get mem for response or fail*/
749 if (NULL == (rsp = alloc_http_response()))
752 free_map(param_list);
753 return cgi_error_memory();
756 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
757 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
758 csp->ip_addr_str, csp->http->cmd);
760 /* Find and start the right CGI function*/
764 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
766 err = (d->handler)(csp, rsp, param_list);
768 free_map(param_list);
769 if (err == JB_ERR_CGI_PARAMS)
771 err = cgi_error_bad_param(csp, rsp);
773 if (err && (err != JB_ERR_MEMORY))
775 /* Unexpected error! Shouldn't get here */
776 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
777 err = cgi_error_unknown(csp, rsp, err);
782 return finish_http_response(rsp);
786 /* Error in handler, probably out-of-memory */
787 free_http_response(rsp);
788 return cgi_error_memory();
796 /*********************************************************************
798 * Function : parse_cgi_parameters
800 * Description : Parse a URL-encoded argument string into name/value
801 * pairs and store them in a struct map list.
804 * 1 : argstring = string to be parsed. Will be trashed.
806 * Returns : pointer to param list, or NULL if out of memory.
808 *********************************************************************/
809 static struct map *parse_cgi_parameters(char *argstring)
812 char *vector[BUFFER_SIZE];
814 struct map *cgi_params;
816 if (NULL == (cgi_params = new_map()))
821 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
823 for (i = 0; i < pairs; i++)
825 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
828 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
830 free_map(cgi_params);
841 /*********************************************************************
843 * Function : get_char_param
845 * Description : Get a single-character parameter passed to a CGI
849 * 1 : parameters = map of cgi parameters
850 * 2 : param_name = The name of the parameter to read
852 * Returns : Uppercase character on success, '\0' on error.
854 *********************************************************************/
855 char get_char_param(const struct map *parameters,
856 const char *param_name)
863 ch = *(lookup(parameters, param_name));
864 if ((ch >= 'a') && (ch <= 'z'))
873 /*********************************************************************
875 * Function : get_string_param
877 * Description : Get a string paramater, to be used as an
878 * ACTION_STRING or ACTION_MULTI paramater.
879 * Validates the input to prevent stupid/malicious
880 * users from corrupting their action file.
883 * 1 : parameters = map of cgi parameters
884 * 2 : param_name = The name of the parameter to read
885 * 3 : pparam = destination for paramater. Allocated as
886 * part of the map "parameters", so don't free it.
887 * Set to NULL if not specified.
889 * Returns : JB_ERR_OK on success, or if the paramater
891 * JB_ERR_MEMORY on out-of-memory.
892 * JB_ERR_CGI_PARAMS if the paramater is not valid.
894 *********************************************************************/
895 jb_err get_string_param(const struct map *parameters,
896 const char *param_name,
909 param = lookup(parameters, param_name);
915 if (strlen(param) >= CGI_PARAM_LEN_MAX)
920 * Note that the length limit is arbitrary, it just seems
921 * sensible to limit it to *something*. There's no
922 * technical reason for any limit at all.
924 return JB_ERR_CGI_PARAMS;
927 /* Check every character to see if it's legal */
929 while ((ch = *s++) != '\0')
931 if ( ((unsigned char)ch < (unsigned char)' ')
934 /* Probable hack attempt, or user accidentally used '}'. */
935 return JB_ERR_CGI_PARAMS;
946 /*********************************************************************
948 * Function : get_number_param
950 * Description : Get a non-negative integer from the parameters
951 * passed to a CGI function.
954 * 1 : csp = Current client state (buffers, headers, etc...)
955 * 2 : parameters = map of cgi parameters
956 * 3 : name = Name of CGI parameter to read
957 * 4 : pvalue = destination for value.
958 * Set to -1 on error.
960 * Returns : JB_ERR_OK on success
961 * JB_ERR_MEMORY on out-of-memory
962 * JB_ERR_CGI_PARAMS if the parameter was not specified
965 *********************************************************************/
966 jb_err get_number_param(struct client_state *csp,
967 const struct map *parameters,
982 param = lookup(parameters, name);
985 return JB_ERR_CGI_PARAMS;
988 /* We don't use atoi because I want to check this carefully... */
991 while ((ch = *param++) != '\0')
993 if ((ch < '0') || (ch > '9'))
995 return JB_ERR_CGI_PARAMS;
1002 * <limits.h> defines UINT_MAX
1004 * (UINT_MAX - ch) / 10 is the largest number that
1005 * can be safely multiplied by 10 then have ch added.
1007 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1009 return JB_ERR_CGI_PARAMS;
1012 value = value * 10 + ch;
1023 /*********************************************************************
1025 * Function : error_response
1027 * Description : returns an http_response that explains the reason
1028 * why a request failed.
1031 * 1 : csp = Current client state (buffers, headers, etc...)
1032 * 2 : templatename = Which template should be used for the answer
1033 * 3 : sys_err = system error number
1035 * Returns : A http_response. If we run out of memory, this
1036 * will be cgi_error_memory().
1038 *********************************************************************/
1039 struct http_response *error_response(struct client_state *csp,
1040 const char *templatename,
1044 struct http_response *rsp;
1045 struct map * exports = default_exports(csp, NULL);
1046 if (exports == NULL)
1048 return cgi_error_memory();
1051 if (NULL == (rsp = alloc_http_response()))
1054 return cgi_error_memory();
1057 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1058 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1059 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1060 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1061 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1064 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1067 /* Some failures, like "404 no such domain", don't have an IP address. */
1068 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1076 free_http_response(rsp);
1077 return cgi_error_memory();
1080 if (!strcmp(templatename, "no-such-domain"))
1082 rsp->status = strdup("404 No such domain");
1083 if (rsp->status == NULL)
1086 free_http_response(rsp);
1087 return cgi_error_memory();
1090 else if (!strcmp(templatename, "connect-failed"))
1092 rsp->status = strdup("503 Connect failed");
1093 if (rsp->status == NULL)
1096 free_http_response(rsp);
1097 return cgi_error_memory();
1101 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1104 free_http_response(rsp);
1105 return cgi_error_memory();
1108 return finish_http_response(rsp);
1112 /*********************************************************************
1114 * Function : cgi_init_error_messages
1116 * Description : Call at the start of the program to initialize
1117 * the error message used by cgi_error_memory().
1123 *********************************************************************/
1124 void cgi_init_error_messages(void)
1126 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1127 cgi_error_memory_response->head =
1128 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1129 "Content-Type: text/html\r\n"
1131 cgi_error_memory_response->body =
1133 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1135 "<h1>500 Internal Privoxy Error</h1>\r\n"
1136 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1137 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1141 cgi_error_memory_response->head_length =
1142 strlen(cgi_error_memory_response->head);
1143 cgi_error_memory_response->content_length =
1144 strlen(cgi_error_memory_response->body);
1148 /*********************************************************************
1150 * Function : cgi_error_memory
1152 * Description : Called if a CGI function runs out of memory.
1153 * Returns a statically-allocated error response.
1157 * Returns : http_response data structure for output. This is
1158 * statically allocated, for obvious reasons.
1160 *********************************************************************/
1161 struct http_response *cgi_error_memory(void)
1163 /* assert that it's been initialized. */
1164 assert(cgi_error_memory_response->head);
1166 return cgi_error_memory_response;
1170 /*********************************************************************
1172 * Function : cgi_error_no_template
1174 * Description : Almost-CGI function that is called if a template
1175 * cannot be loaded. Note this is not a true CGI,
1176 * it takes a template name rather than a map of
1180 * 1 : csp = Current client state (buffers, headers, etc...)
1181 * 2 : rsp = http_response data structure for output
1182 * 3 : template_name = Name of template that could not
1185 * Returns : JB_ERR_OK on success
1186 * JB_ERR_MEMORY on out-of-memory error.
1188 *********************************************************************/
1189 jb_err cgi_error_no_template(struct client_state *csp,
1190 struct http_response *rsp,
1191 const char *template_name)
1193 static const char status[] =
1194 "500 Internal Privoxy Error";
1195 static const char body_prefix[] =
1197 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1199 "<h1>500 Internal Privoxy Error</h1>\r\n"
1200 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1201 "<p><b>Could not load template file <code>";
1202 static const char body_suffix[] =
1203 "</code> or one of it's included components.</b></p>\r\n"
1204 "<p>Please contact your proxy administrator.</p>\r\n"
1205 "<p>If you are the proxy administrator, please put the required file(s)"
1206 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1207 "location of the <code><i>(confdir)</i></code> directory "
1208 "is specified in the main Privoxy <code>config</code> "
1209 "file. (It's typically the Privoxy install directory"
1211 ", or <code>/etc/privoxy/</code>"
1212 #endif /* ndef _WIN32 */
1219 assert(template_name);
1221 /* Reset rsp, if needed */
1225 rsp->content_length = 0;
1226 rsp->head_length = 0;
1229 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1230 if (rsp->body == NULL)
1232 return JB_ERR_MEMORY;
1234 strcpy(rsp->body, body_prefix);
1235 strcat(rsp->body, template_name);
1236 strcat(rsp->body, body_suffix);
1238 rsp->status = strdup(status);
1239 if (rsp->body == NULL)
1241 return JB_ERR_MEMORY;
1248 /*********************************************************************
1250 * Function : cgi_error_unknown
1252 * Description : Almost-CGI function that is called if an unexpected
1253 * error occurs in the top-level CGI dispatcher.
1254 * In this context, "unexpected" means "anything other
1255 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1256 * expected to handle all other errors internally,
1257 * since they can give more relavent error messages
1260 * Note this is not a true CGI, it takes an error
1261 * code rather than a map of parameters.
1264 * 1 : csp = Current client state (buffers, headers, etc...)
1265 * 2 : rsp = http_response data structure for output
1266 * 3 : error_to_report = Error code to report.
1268 * Returns : JB_ERR_OK on success
1269 * JB_ERR_MEMORY on out-of-memory error.
1271 *********************************************************************/
1272 jb_err cgi_error_unknown(struct client_state *csp,
1273 struct http_response *rsp,
1274 jb_err error_to_report)
1276 static const char status[] =
1277 "500 Internal Privoxy Error";
1278 static const char body_prefix[] =
1280 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1282 "<h1>500 Internal Privoxy Error</h1>\r\n"
1283 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1284 "<p><b>Unexpected internal error: ";
1285 static const char body_suffix[] =
1288 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1289 "file a bug report</a>.</p>\r\n"
1296 /* Reset rsp, if needed */
1300 rsp->content_length = 0;
1301 rsp->head_length = 0;
1304 sprintf(errnumbuf, "%d", error_to_report);
1306 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1307 if (rsp->body == NULL)
1309 return JB_ERR_MEMORY;
1311 strcpy(rsp->body, body_prefix);
1312 strcat(rsp->body, errnumbuf);
1313 strcat(rsp->body, body_suffix);
1315 rsp->status = strdup(status);
1316 if (rsp->body == NULL)
1318 return JB_ERR_MEMORY;
1325 /*********************************************************************
1327 * Function : cgi_error_bad_param
1329 * Description : CGI function that is called if the parameters
1330 * (query string) for a CGI were wrong.
1333 * 1 : csp = Current client state (buffers, headers, etc...)
1334 * 2 : rsp = http_response data structure for output
1336 * CGI Parameters : none
1338 * Returns : JB_ERR_OK on success
1339 * JB_ERR_MEMORY on out-of-memory error.
1341 *********************************************************************/
1342 jb_err cgi_error_bad_param(struct client_state *csp,
1343 struct http_response *rsp)
1345 struct map *exports;
1350 if (NULL == (exports = default_exports(csp, NULL)))
1352 return JB_ERR_MEMORY;
1355 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1359 /*********************************************************************
1361 * Function : add_help_link
1363 * Description : Produce a copy of the string given as item,
1364 * embedded in an HTML link to its corresponding
1365 * section (item name in uppercase) in the actions
1366 * chapter of the user manual, (whose URL is given in
1367 * the config and defaults to our web site).
1369 * FIXME: I currently only work for actions, and would
1370 * like to be generalized for other topics.
1373 * 1 : item = item (will NOT be free()d.)
1374 * It is assumed to be HTML-safe.
1375 * 2 : config = The current configuration.
1377 * Returns : String with item embedded in link, or NULL on
1380 *********************************************************************/
1381 char *add_help_link(const char *item,
1382 struct configuration_spec *config)
1386 if (!item) return NULL;
1388 result = strdup("<a href=\"");
1389 string_append(&result, config->usermanual);
1390 string_append(&result, ACTIONS_HELP_PREFIX);
1391 string_join (&result, string_toupper(item));
1392 string_append(&result, "\">");
1393 string_append(&result, item);
1394 string_append(&result, "</a> ");
1400 /*********************************************************************
1402 * Function : get_http_time
1404 * Description : Get the time in a format suitable for use in a
1405 * HTTP header - e.g.:
1406 * "Sun, 06 Nov 1994 08:49:37 GMT"
1409 * 1 : time_offset = Time returned will be current time
1410 * plus this number of seconds.
1411 * 2 : buf = Destination for result. Must be long enough
1412 * to hold 29 characters plus a trailing zero.
1416 *********************************************************************/
1417 void get_http_time(int time_offset, char *buf)
1419 static const char day_names[7][4] =
1420 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1421 static const char month_names[12][4] =
1422 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1423 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1426 time_t current_time;
1430 time(¤t_time); /* get current time */
1432 current_time += time_offset;
1434 /* get and save the gmt */
1436 #ifdef HAVE_GMTIME_R
1438 t = gmtime_r(¤t_time, &dummy);
1440 t = gmtime(¤t_time);
1444 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1446 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1447 day_names[t->tm_wday],
1449 month_names[t->tm_mon],
1459 /*********************************************************************
1461 * Function : finish_http_response
1463 * Description : Fill in the missing headers in an http response,
1464 * and flatten the headers to an http head.
1467 * 1 : rsp = pointer to http_response to be processed
1469 * Returns : A http_response, usually the rsp parameter.
1470 * On error, free()s rsp and returns cgi_error_memory()
1472 *********************************************************************/
1473 struct http_response *finish_http_response(struct http_response *rsp)
1475 char buf[BUFFER_SIZE];
1478 /* Special case - do NOT change this statically allocated response,
1479 * which is ready for output anyway.
1481 if (rsp == cgi_error_memory_response)
1487 * Fill in the HTTP Status
1489 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1490 err = enlist_first(rsp->headers, buf);
1493 * Set the Content-Length
1495 if (rsp->content_length == 0)
1497 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1501 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1502 err = enlist(rsp->headers, buf);
1506 * Fill in the default headers:
1508 * Content-Type: default to text/html if not already specified.
1509 * Date: set to current date/time.
1510 * Last-Modified: set to date/time the page was last changed.
1511 * Expires: set to date/time page next needs reloading.
1512 * Cache-Control: set to "no-cache" if applicable.
1514 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1516 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1521 * Set Expires to about 10 min into the future so it'll get reloaded
1522 * occasionally, e.g. if Privoxy gets upgraded.
1527 get_http_time(0, buf);
1528 err = enlist_unique_header(rsp->headers, "Date", buf);
1531 /* Some date in the past. */
1532 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1536 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1537 err = enlist_unique_header(rsp->headers, "Expires", buf);
1543 * Compliant browsers should not cache this due to the "Cache-Control"
1544 * setting. However, to be certain, we also set both "Last-Modified"
1545 * and "Expires" to the current time.
1547 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1549 get_http_time(0, buf);
1550 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1551 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1552 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1559 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1561 free_http_response(rsp);
1562 return cgi_error_memory();
1564 rsp->head_length = strlen(rsp->head);
1571 /*********************************************************************
1573 * Function : alloc_http_response
1575 * Description : Allocates a new http_response structure.
1579 * Returns : pointer to a new http_response, or NULL.
1581 *********************************************************************/
1582 struct http_response *alloc_http_response(void)
1584 return (struct http_response *) zalloc(sizeof(struct http_response));
1589 /*********************************************************************
1591 * Function : free_http_response
1593 * Description : Free the memory occupied by an http_response
1594 * and its depandant structures.
1597 * 1 : rsp = pointer to http_response to be freed
1601 *********************************************************************/
1602 void free_http_response(struct http_response *rsp)
1605 * Must special case cgi_error_memory_response, which is never freed.
1607 if (rsp && (rsp != cgi_error_memory_response))
1612 destroy_list(rsp->headers);
1619 /*********************************************************************
1621 * Function : template_load
1623 * Description : CGI support function that loads a given HTML
1624 * template from the confdir, ignoring comment
1625 * lines and following #include statements up to
1629 * 1 : csp = Current client state (buffers, headers, etc...)
1630 * 2 : template_ptr = Destination for pointer to loaded
1632 * 3 : templatename = name of the HTML template to be used
1633 * 4 : recursive = Flag set if this function calls itself
1634 * following an #include statament
1636 * Returns : JB_ERR_OK on success
1637 * JB_ERR_MEMORY on out-of-memory error.
1638 * JB_ERR_FILE if the template file cannot be read
1640 *********************************************************************/
1641 jb_err template_load(struct client_state *csp, char **template_ptr,
1642 const char *templatename, int recursive)
1645 char *templates_dir_path;
1648 char *included_module;
1651 char buf[BUFFER_SIZE];
1654 assert(template_ptr);
1655 assert(templatename);
1657 *template_ptr = NULL;
1659 /* Validate template name. Paranoia. */
1660 for (p = templatename; *p != 0; p++)
1662 if ( ((*p < 'a') || (*p > 'z'))
1663 && ((*p < 'A') || (*p > 'Z'))
1664 && ((*p < '0') || (*p > '9'))
1668 /* Illegal character */
1673 /* Generate full path */
1675 templates_dir_path = make_path(csp->config->confdir, "templates");
1676 if (templates_dir_path == NULL)
1678 return JB_ERR_MEMORY;
1681 full_path = make_path(templates_dir_path, templatename);
1682 free(templates_dir_path);
1683 if (full_path == NULL)
1685 return JB_ERR_MEMORY;
1688 /* Allocate buffer */
1690 file_buffer = strdup("");
1691 if (file_buffer == NULL)
1694 return JB_ERR_MEMORY;
1697 /* Open template file */
1699 if (NULL == (fp = fopen(full_path, "r")))
1701 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1709 * Read the file, ignoring comments, and honoring #include
1710 * statements, unless we're already called recursively.
1712 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1713 * This is unlikely in practise.
1715 while (fgets(buf, BUFFER_SIZE, fp))
1717 if (!recursive && !strncmp(buf, "#include ", 9))
1719 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1726 if (string_join(&file_buffer, included_module))
1729 return JB_ERR_MEMORY;
1735 /* skip lines starting with '#' */
1741 if (string_append(&file_buffer, buf))
1744 return JB_ERR_MEMORY;
1749 *template_ptr = file_buffer;
1755 /*********************************************************************
1757 * Function : template_fill
1759 * Description : CGI support function that fills in a pre-loaded
1760 * HTML template by replacing @name@ with value using
1761 * pcrs, for each item in the output map.
1763 * Note that a leading '$' charachter in the export map's
1764 * values will be stripped and toggle on backreference
1768 * 1 : template_ptr = IN: Template to be filled out.
1770 * OUT: Filled out template.
1771 * Caller must free().
1772 * 2 : exports = map with fill in symbol -> name pairs
1774 * Returns : JB_ERR_OK on success
1775 * JB_ERR_MEMORY on out-of-memory error
1777 *********************************************************************/
1778 jb_err template_fill(char **template_ptr, const struct map *exports)
1780 struct map_entry *m;
1782 char buf[BUFFER_SIZE];
1783 char *tmp_out_buffer;
1789 assert(template_ptr);
1790 assert(*template_ptr);
1793 file_buffer = *template_ptr;
1794 size = strlen(file_buffer) + 1;
1797 * Assemble pcrs joblist from exports map
1799 for (m = exports->first; m != NULL; m = m->next)
1801 if (*m->name == '$')
1804 * First character of name is '$', so remove this flag
1805 * character and allow backreferences ($1 etc) in the
1806 * "replace with" text.
1808 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1814 * Treat the "replace with" text as a literal string -
1815 * no quoting needed, no backreferences allowed.
1816 * ("Trivial" ['T'] flag).
1820 /* Enclose name in @@ */
1821 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1825 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
1827 /* Make and run job. */
1828 job = pcrs_compile(buf, m->value, flags, &error);
1831 if (error == PCRS_ERR_NOMEM)
1834 *template_ptr = NULL;
1835 return JB_ERR_MEMORY;
1839 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
1840 /* Hope it wasn't important and silently ignore the invalid job */
1845 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
1848 if (NULL == tmp_out_buffer)
1850 *template_ptr = NULL;
1851 return JB_ERR_MEMORY;
1853 file_buffer = tmp_out_buffer;
1860 *template_ptr = file_buffer;
1865 /*********************************************************************
1867 * Function : template_fill_for_cgi
1869 * Description : CGI support function that loads a HTML template
1870 * and fills it in. Handles file-not-found errors
1871 * by sending a HTML error message. For convenience,
1872 * this function also frees the passed "exports" map.
1875 * 1 : csp = Client state
1876 * 2 : templatename = name of the HTML template to be used
1877 * 3 : exports = map with fill in symbol -> name pairs.
1878 * Will be freed by this function.
1879 * 4 : rsp = Response structure to fill in.
1881 * Returns : JB_ERR_OK on success
1882 * JB_ERR_MEMORY on out-of-memory error
1884 *********************************************************************/
1885 jb_err template_fill_for_cgi(struct client_state *csp,
1886 const char *templatename,
1887 struct map *exports,
1888 struct http_response *rsp)
1893 assert(templatename);
1897 err = template_load(csp, &rsp->body, templatename, 0);
1898 if (err == JB_ERR_FILE)
1901 return cgi_error_no_template(csp, rsp, templatename);
1906 return err; /* JB_ERR_MEMORY */
1908 err = template_fill(&rsp->body, exports);
1914 /*********************************************************************
1916 * Function : default_exports
1918 * Description : returns a struct map list that contains exports
1919 * which are common to all CGI functions.
1922 * 1 : csp = Current client state (buffers, headers, etc...)
1923 * 2 : caller = name of CGI who calls us and which should
1924 * be excluded from the generated menu. May be
1926 * Returns : NULL if no memory, else a new map. Caller frees.
1928 *********************************************************************/
1929 struct map *default_exports(const struct client_state *csp, const char *caller)
1933 struct map * exports;
1934 int local_help_exists = 0;
1938 exports = new_map();
1939 if (exports == NULL)
1944 err = map(exports, "version", 1, html_encode(VERSION), 0);
1945 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
1946 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
1947 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
1948 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
1949 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
1950 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
1951 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
1952 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
1953 if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB);
1955 snprintf(buf, 20, "%d", csp->config->hport);
1956 if (!err) err = map(exports, "my-port", 1, buf, 1);
1958 if(!strcmp(CODE_STATUS, "stable"))
1960 if (!err) err = map_block_killer(exports, "unstable");
1963 if (csp->config->admin_address != NULL)
1965 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
1966 local_help_exists = 1;
1970 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
1973 if (csp->config->proxy_info_url != NULL)
1975 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
1976 local_help_exists = 1;
1980 if (!err) err = map_block_killer(exports, "have-proxy-info");
1983 if (local_help_exists == 0)
1985 if (!err) err = map_block_killer(exports, "have-help-info");
1998 /*********************************************************************
2000 * Function : map_block_killer
2002 * Description : Convenience function.
2003 * Adds a "killer" for the conditional HTML-template
2004 * block <name>, i.e. a substitution of the regex
2005 * "if-<name>-start.*if-<name>-end" to the given
2009 * 1 : exports = map to extend
2010 * 2 : name = name of conditional block
2012 * Returns : JB_ERR_OK on success
2013 * JB_ERR_MEMORY on out-of-memory error.
2015 *********************************************************************/
2016 jb_err map_block_killer(struct map *exports, const char *name)
2018 char buf[1000]; /* Will do, since the names are hardwired */
2022 assert(strlen(name) < 490);
2024 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2025 return map(exports, buf, 1, "", 1);
2029 /*********************************************************************
2031 * Function : map_block_keep
2033 * Description : Convenience function. Removes the markers used
2034 * by map-block-killer, to save a few bytes.
2035 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2038 * 1 : exports = map to extend
2039 * 2 : name = name of conditional block
2041 * Returns : JB_ERR_OK on success
2042 * JB_ERR_MEMORY on out-of-memory error.
2044 *********************************************************************/
2045 jb_err map_block_keep(struct map *exports, const char *name)
2048 char buf[500]; /* Will do, since the names are hardwired */
2052 assert(strlen(name) < 490);
2054 snprintf(buf, 500, "if-%s-start", name);
2055 err = map(exports, buf, 1, "", 1);
2062 snprintf(buf, 500, "if-%s-end", name);
2063 return map(exports, buf, 1, "", 1);
2067 /*********************************************************************
2069 * Function : map_conditional
2071 * Description : Convenience function.
2072 * Adds an "if-then-else" for the conditional HTML-template
2073 * block <name>, i.e. a substitution of the form:
2080 * The control structure and one of the alternatives
2084 * 1 : exports = map to extend
2085 * 2 : name = name of conditional block
2086 * 3 : choose_first = nonzero for first, zero for second.
2088 * Returns : JB_ERR_OK on success
2089 * JB_ERR_MEMORY on out-of-memory error.
2091 *********************************************************************/
2092 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2094 char buf[1000]; /* Will do, since the names are hardwired */
2099 assert(strlen(name) < 480);
2101 snprintf(buf, 1000, (choose_first
2102 ? "else-not-%s@.*@endif-%s"
2103 : "if-%s-then@.*@else-not-%s"),
2106 err = map(exports, buf, 1, "", 1);
2112 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2113 return map(exports, buf, 1, "", 1);
2117 /*********************************************************************
2119 * Function : make_menu
2121 * Description : Returns an HTML-formatted menu of the available
2122 * unhidden CGIs, excluding the one given in <self>
2124 * Parameters : self = name of CGI to leave out, can be NULL for
2127 * Returns : menu string, or NULL on out-of-memory error.
2129 *********************************************************************/
2130 char *make_menu(const char *self)
2132 const struct cgi_dispatcher *d;
2133 char *result = strdup("");
2137 self = "NO-SUCH-CGI!";
2140 /* List available unhidden CGI's and export as "other-cgis" */
2141 for (d = cgi_dispatchers; d->name; d++)
2143 if (d->description && strcmp(d->name, self))
2145 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2146 string_append(&result, d->name);
2147 string_append(&result, "\">");
2148 string_append(&result, d->description);
2149 string_append(&result, "</a></li>");
2157 /*********************************************************************
2159 * Function : dump_map
2161 * Description : HTML-dump a map for debugging (as table)
2164 * 1 : the_map = map to dump
2166 * Returns : string with HTML
2168 *********************************************************************/
2169 char *dump_map(const struct map *the_map)
2171 struct map_entry *cur_entry;
2172 char *ret = strdup("");
2174 string_append(&ret, "<table>\n");
2176 for (cur_entry = the_map->first;
2177 (cur_entry != NULL) && (ret != NULL);
2178 cur_entry = cur_entry->next)
2180 string_append(&ret, "<tr><td><b>");
2181 string_join (&ret, html_encode(cur_entry->name));
2182 string_append(&ret, "</b></td><td>");
2183 string_join (&ret, html_encode(cur_entry->value));
2184 string_append(&ret, "</td></tr>\n");
2187 string_append(&ret, "</table>\n");