1 const char cgi_rcs[] = "$Id: cgi.c,v 1.49 2002/03/13 00:27:04 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 * IJBSWA team. http://ijbswa.sourceforge.net
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.49 2002/03/13 00:27:04 jongfoster
44 * Revision 1.48 2002/03/08 17:47:07 jongfoster
47 * Revision 1.47 2002/03/08 16:41:33 oes
48 * Added GIF images again
50 * Revision 1.46 2002/03/07 03:48:38 oes
51 * - Changed built-in images from GIF to PNG
52 * (with regard to Unisys patent issue)
53 * - Added a 4x4 pattern PNG which is less intrusive
54 * than the logo but also clearly marks the deleted banners
56 * Revision 1.45 2002/03/06 22:54:35 jongfoster
57 * Automated function-comment nitpicking.
59 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
60 * - Better error reporting on OS/2
61 * - Fix double-slash comment (oops)
63 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
64 * - Re-enable OS/2 building after new parms were added
65 * - Fix false out of memory report when resolving CGI templates when no IP
66 * address is available of failed attempt (a la no such domain)
68 * Revision 1.42 2002/01/21 00:33:20 jongfoster
69 * Replacing strsav() with the safer string_append() or string_join().
70 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
71 * Adding missing html_encode() to error message generators.
72 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
74 * Revision 1.41 2002/01/17 20:56:22 jongfoster
75 * Replacing hard references to the URL of the config interface
76 * with #defines from project.h
78 * Revision 1.40 2002/01/09 14:26:46 oes
79 * Added support for thread-safe gmtime_r call.
81 * Revision 1.39 2001/11/16 00:48:13 jongfoster
82 * Fixing a compiler warning
84 * Revision 1.38 2001/11/13 00:31:21 jongfoster
85 * - Adding new CGIs for use by non-JavaScript browsers:
86 * edit-actions-url-form
87 * edit-actions-add-url-form
88 * edit-actions-remove-url-form
89 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
92 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
93 * Show enablement/disablement status in almost all templates.
94 * There is a little trickiness here: apparent recursive resolution of
95 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
96 * the actual enablement status. So a similar construct,
97 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
100 * Revision 1.36 2001/10/26 17:33:27 oes
103 * Revision 1.35 2001/10/23 21:48:19 jongfoster
104 * Cleaning up error handling in CGI functions - they now send back
105 * a HTML error page and should never cause a FATAL error. (Fixes one
106 * potential source of "denial of service" attacks).
108 * CGI actions file editor that works and is actually useful.
110 * Ability to toggle JunkBuster remotely using a CGI call.
112 * You can turn off both the above features in the main configuration
113 * file, e.g. if you are running a multi-user proxy.
115 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
116 * Only show "Local support" on templates conditionally:
117 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
118 * - if not, no Local support section appears
120 * Revision 1.33 2001/10/14 22:28:41 jongfoster
121 * Fixing stupid typo.
123 * Revision 1.32 2001/10/14 22:20:18 jongfoster
124 * - Changes to CGI dispatching method to match CGI names exactly,
125 * rather than doing a prefix match.
126 * - No longer need to count the length of the CGI handler names by hand.
127 * - Adding new handler for 404 error when disptching a CGI, if none of
128 * the handlers match.
129 * - Adding new handlers for CGI actionsfile editor.
131 * Revision 1.31 2001/10/10 10:56:39 oes
132 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
134 * Revision 1.30 2001/10/02 15:30:57 oes
135 * Introduced show-request cgi
137 * Revision 1.29 2001/09/20 15:47:44 steudten
139 * Fix BUG: Modify int size to size_t size in fill_template()
140 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
142 * Revision 1.28 2001/09/19 18:00:37 oes
143 * - Deletef time() FIXME (Can't fail under Linux either, if
144 * the argument is guaranteed to be in out address space,
147 * - Pointer notation cosmetics
148 * - Fixed a minor bug in template_fill(): Failiure of
149 * pcrs_execute() now secure.
151 * Revision 1.27 2001/09/16 17:08:54 jongfoster
152 * Moving simple CGI functions from cgi.c to new file cgisimple.c
154 * Revision 1.26 2001/09/16 15:47:37 jongfoster
155 * First version of CGI-based edit interface. This is very much a
156 * work-in-progress, and you can't actually use it to edit anything
157 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
158 * to have any effect.
160 * Revision 1.25 2001/09/16 15:02:35 jongfoster
161 * Adding i.j.b/robots.txt.
162 * Inlining add_stats() since it's only ever called from one place.
164 * Revision 1.24 2001/09/16 11:38:01 jongfoster
165 * Splitting fill_template() into 2 functions:
166 * template_load() loads the file
167 * template_fill() performs the PCRS regexps.
168 * This is because the CGI edit interface has a "table row"
169 * template which is used many times in the page - this
170 * change means it's only loaded from disk once.
172 * Revision 1.23 2001/09/16 11:16:05 jongfoster
173 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
175 * Revision 1.22 2001/09/16 11:00:10 jongfoster
176 * New function alloc_http_response, for symmetry with free_http_response
178 * Revision 1.21 2001/09/13 23:53:03 jongfoster
179 * Support for both static and dynamically generated CGI pages.
180 * Correctly setting Last-Modified: and Expires: HTTP headers.
182 * Revision 1.20 2001/09/13 23:40:36 jongfoster
183 * (Cosmetic only) Indentation correction
185 * Revision 1.19 2001/09/13 23:31:25 jongfoster
186 * Moving image data to cgi.c rather than cgi.h.
188 * Revision 1.18 2001/08/05 16:06:20 jongfoster
189 * Modifiying "struct map" so that there are now separate header and
190 * "map_entry" structures. This means that functions which modify a
191 * map no longer need to return a pointer to the modified map.
192 * Also, it no longer reverses the order of the entries (which may be
193 * important with some advanced template substitutions).
195 * Revision 1.17 2001/08/05 15:57:38 oes
196 * Adapted finish_http_response to new list_to_text
198 * Revision 1.16 2001/08/01 21:33:18 jongfoster
199 * Changes to fill_template() that reduce memory usage without having
200 * an impact on performance. I also renamed some variables so as not
201 * to clash with the C++ keywords "new" and "template".
203 * Revision 1.15 2001/08/01 21:19:22 jongfoster
204 * Moving file version information to a separate CGI page.
206 * Revision 1.14 2001/08/01 00:19:03 jongfoster
207 * New function: map_conditional() for an if-then-else syntax.
208 * Changing to use new version of show_defines()
210 * Revision 1.13 2001/07/30 22:08:36 jongfoster
211 * Tidying up #defines:
212 * - All feature #defines are now of the form FEATURE_xxx
213 * - Permanently turned off WIN_GUI_EDIT
214 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
216 * Revision 1.12 2001/07/29 18:47:05 jongfoster
217 * Adding missing #include "loadcfg.h"
219 * Revision 1.11 2001/07/18 17:24:37 oes
220 * Changed to conform to new pcrs interface
222 * Revision 1.10 2001/07/13 13:53:13 oes
223 * Removed all #ifdef PCRS and related code
225 * Revision 1.9 2001/06/29 21:45:41 oes
226 * Indentation, CRLF->LF, Tab-> Space
228 * Revision 1.8 2001/06/29 13:21:46 oes
229 * - Cosmetics: renamed and reordered functions, variables,
230 * texts, improved comments etc
232 * - Removed ij_untrusted_url() The relevant
233 * info is now part of the "untrusted" page,
234 * which is generated by filters.c:trust_url()
236 * - Generators of content now call finish_http_response()
237 * themselves, making jcc.c:chat() a little less
240 * - Removed obsolete "Pragma: no-cache" from our headers
242 * - http_responses now know their head length
244 * - fill_template now uses the new interface to pcrs, so that
245 * - long jobs (like whole files) no longer have to be assembled
246 * in a fixed size buffer
247 * - the new T (trivial) option is used, and the replacement may
248 * contain Perl syntax backrefs without confusing pcrs
250 * - Introduced default_exports() which generates a set of exports
251 * common to all CGIs and other content generators
253 * - Introduced convenience function map_block_killer()
255 * - Introduced convenience function make_menu()
257 * - Introduced CGI-like function error_response() which generates
258 * the "No such domain" and "Connect failed" messages using the
261 * - cgi_show_url_info:
262 * - adapted to new CGI features
263 * - form and answers now generated from same template
264 * - http:// prefix in URL now OK
267 * - adapted to new CGI features
268 * - no longer uses csp->init_proxy_args
271 * - moved menu generation to make_menu()
273 * - add_stats now writes single export map entries instead
276 * - Moved redirect_url() to filters.c
278 * - Fixed mem leak in free_http_response(), map_block_killer(),
280 * - Removed logentry from cancelled commit
282 * Revision 1.7 2001/06/09 10:51:58 jongfoster
283 * Changing "show URL info" handler to new style.
284 * Changing BUFSIZ ==> BUFFER_SIZE
286 * Revision 1.6 2001/06/07 23:05:19 jongfoster
287 * Removing code related to old forward and ACL files.
289 * Revision 1.5 2001/06/05 19:59:16 jongfoster
290 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
292 * Revision 1.4 2001/06/04 10:41:52 swa
293 * show version string of cgi.h and cgi.c
295 * Revision 1.3 2001/06/03 19:12:16 oes
296 * introduced new cgi handling
298 * No revisions before 1.3
300 **********************************************************************/
306 #include <sys/types.h>
313 #define snprintf _snprintf
314 #endif /* def _WIN32 */
322 #include "miscutil.h"
323 #include "cgisimple.h"
324 #ifdef FEATURE_CGI_EDIT_ACTIONS
326 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
328 /* loadcfg.h is for g_bToggleIJB only */
330 const char cgi_h_rcs[] = CGI_H_VERSION;
332 static const struct cgi_dispatcher cgi_dispatchers[] = {
335 "Junkbuster main page" },
336 #ifdef FEATURE_GRACEFUL_TERMINATION
339 "<b>Shut down</b> - <font color=red size='+1'>Do not deploy this build in a production environment, this is a one click Denial Of Service attack!!!</font>" },
343 "Show information about the current configuration" },
346 "Show the source code version numbers" },
349 "Show the client's request headers." },
352 "Show which actions apply to a URL and why" },
355 "Toggle JunkBuster on or off" },
356 #ifdef FEATURE_CGI_EDIT_ACTIONS
359 "Edit the actions list" },
362 { "eaa", /* Shortcut for edit-actions-add-url-form */
363 cgi_edit_actions_add_url_form,
365 { "eau", /* Shortcut for edit-actions-url-form */
366 cgi_edit_actions_url_form,
368 { "ear", /* Shortcut for edit-actions-remove-url-form */
369 cgi_edit_actions_remove_url_form,
371 { "eas", /* Shortcut for edit-actions-for-url */
372 cgi_edit_actions_for_url,
374 { "easa", /* Shortcut for edit-actions-section-add */
375 cgi_edit_actions_section_add,
377 { "easr", /* Shortcut for edit-actions-section-remove */
378 cgi_edit_actions_section_remove,
380 { "eass", /* Shortcut for edit-actions-section-swap */
381 cgi_edit_actions_section_swap,
383 { "edit-actions-for-url",
384 cgi_edit_actions_for_url,
385 NULL /* Edit the actions for (a) specified URL(s) */ },
386 { "edit-actions-list",
387 cgi_edit_actions_list,
388 NULL /* Edit the actions list */ },
389 { "edit-actions-submit",
390 cgi_edit_actions_submit,
391 NULL /* Change the actions for (a) specified URL(s) */ },
392 { "edit-actions-url",
393 cgi_edit_actions_url,
394 NULL /* Change a URL pattern in the actionsfile */ },
395 { "edit-actions-url-form",
396 cgi_edit_actions_url_form,
397 NULL /* Form to change a URL pattern in the actionsfile */ },
398 { "edit-actions-add-url",
399 cgi_edit_actions_add_url,
400 NULL /* Add a URL pattern to the actionsfile */ },
401 { "edit-actions-add-url-form",
402 cgi_edit_actions_add_url_form,
403 NULL /* Form to add a URL pattern to the actionsfile */ },
404 { "edit-actions-remove-url",
405 cgi_edit_actions_remove_url,
406 NULL /* Remove a URL pattern from the actionsfile */ },
407 { "edit-actions-remove-url-form",
408 cgi_edit_actions_remove_url_form,
409 NULL /* Form to remove a URL pattern from the actionsfile */ },
410 { "edit-actions-section-add",
411 cgi_edit_actions_section_add,
412 NULL /* Remove a section from the actionsfile */ },
413 { "edit-actions-section-remove",
414 cgi_edit_actions_section_remove,
415 NULL /* Remove a section from the actionsfile */ },
416 { "edit-actions-section-swap",
417 cgi_edit_actions_section_swap,
418 NULL /* Swap two sections in the actionsfile */ },
419 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
422 NULL /* Sends a robots.txt file to tell robots to go away. */ },
425 NULL /* Send a built-in image */ },
427 cgi_transparent_image,
428 NULL /* Send a transparent image (short name) */ },
429 { NULL, /* NULL Indicates end of list and default page */
431 NULL /* Unknown CGI page */ }
436 * Bulit-in images for ad replacement
438 * Hint: You can encode your own images like this:
439 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
442 #ifdef FEATURE_NO_GIFS
445 * "Junkbuster" logo, as a PNG.
447 const char image_logo_data[] =
448 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
449 "\122\000\000\000\104\000\000\000\013\001\003\000\000\000\374"
450 "\323\271\110\000\000\000\004\147\101\115\101\000\000\261\217"
451 "\013\374\141\005\000\000\000\006\120\114\124\105\310\310\310"
452 "\000\000\000\062\100\100\345\000\000\000\001\164\122\116\123"
453 "\000\100\346\330\146\000\000\000\001\142\113\107\104\000\210"
454 "\005\035\110\000\000\000\126\111\104\101\124\170\332\143\140"
455 "\200\003\066\006\146\066\006\006\011\124\326\331\315\146\147"
456 "\316\333\174\116\000\262\156\247\347\334\234\071\373\001\220"
457 "\065\373\130\316\035\311\331\015\020\326\161\311\337\014\014"
458 "\151\147\147\247\345\034\236\331\014\144\335\235\155\236\173"
459 "\163\366\154\006\006\233\334\331\162\307\316\363\174\106\330"
460 "\300\000\000\002\127\040\324\250\204\044\102\000\000\000\000"
461 "\111\105\116\104\256\102\140\202";
464 * Checkerboard pattern, as a PNG.
466 const char image_pattern_data[] =
467 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
468 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
469 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
470 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
471 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
472 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
473 "\000\000\000\111\105\116\104\256\102\140\202";
476 * 1x1 transparant PNG.
478 const char image_blank_data[] =
479 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
480 "\122\000\000\000\002\000\000\000\002\010\002\000\000\000\375"
481 "\324\232\163\000\000\000\006\142\113\107\104\000\310\000\310"
482 "\000\310\052\045\225\037\000\000\000\027\111\104\101\124\170"
483 "\332\143\374\377\377\377\311\223\047\031\116\234\070\361\377"
484 "\377\177\000\112\335\012\257\162\103\306\335\000\000\000\000"
485 "\111\105\116\104\256\102\140\202o";
489 * "Junkbuster" logo, as a GIF.
491 const char image_logo_data[] =
492 "GIF89aD\000\013\000\360\000\000\000\000\000\377\377\377!"
493 "\371\004\001\000\000\001\000,\000\000\000\000D\000\013\000"
494 "\000\002a\214\217\251\313\355\277\000\200G&K\025\316hC\037"
495 "\200\234\230Y\2309\235S\230\266\206\372J\253<\3131\253\271"
496 "\270\215\342\254\013\203\371\202\264\334P\207\332\020o\266"
497 "N\215I\332=\211\312\3513\266:\026AK)\364\370\365aobr\305"
498 "\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276"
502 * Checkerboard pattern, as a GIF.
504 const char image_pattern_data[] =
505 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
506 "\310\377\377\377\041\376\025\111\040\165\163\145\144\040\164"
507 "\157\040\142\145\040\141\040\142\141\156\156\145\162\000\054"
508 "\000\000\000\000\004\000\004\000\000\002\005\104\174\147\270"
512 * 1x1 transparant GIF.
514 const char image_blank_data[] =
515 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
516 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
517 "\000\001\000\000\002\002D\001\000;";
520 const size_t image_logo_length = sizeof(image_logo_data) - 1;
521 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
522 const size_t image_blank_length = sizeof(image_blank_data) - 1;
525 static struct http_response cgi_error_memory_response[1];
527 static struct http_response *dispatch_known_cgi(struct client_state * csp,
529 static struct map *parse_cgi_parameters(char *argstring);
532 /*********************************************************************
534 * Function : dispatch_cgi
536 * Description : Checks if a request URL has either the magical
537 * hostname CGI_SITE_1_HOST (usully http://i.j.b/) or
538 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
539 * http://ijbswa.sourceforge.net/config). If so, it passes
540 * the (rest of the) path onto dispatch_known_cgi, which
541 * calls the relevant CGI handler function.
544 * 1 : csp = Current client state (buffers, headers, etc...)
546 * Returns : http_response if match, NULL if nonmatch or handler fail
548 *********************************************************************/
549 struct http_response *dispatch_cgi(struct client_state *csp)
551 const char *host = csp->http->host;
552 const char *path = csp->http->path;
555 * Should we intercept ?
558 /* Note: "example.com" and "example.com." are equivalent hostnames. */
560 /* Either the host matches CGI_SITE_1_HOST ..*/
561 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
562 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
563 && (path[0] == '/') )
565 /* ..then the path will all be for us. Remove leading '/' */
568 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
569 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
570 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
571 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
573 /* take everything following CGI_SITE_2_PATH */
574 path += strlen(CGI_SITE_2_PATH);
577 /* skip the forward slash after CGI_SITE_2_PATH */
580 else if (*path != '\0')
583 * wierdness: URL is /configXXX, where XXX is some string
584 * Do *NOT* intercept.
596 * This is a CGI call.
599 return dispatch_known_cgi(csp, path);
603 /*********************************************************************
605 * Function : dispatch_known_cgi
607 * Description : Processes a CGI once dispatch_cgi has determined that
608 * it matches one of the magic prefixes. Parses the path
609 * as a cgi name plus query string, prepares a map that
610 * maps CGI parameter names to their values, initializes
611 * the http_response struct, and calls the relevant CGI
615 * 1 : csp = Current client state (buffers, headers, etc...)
616 * 2 : path = Path of CGI, with the CGI prefix removed.
617 * Should not have a leading "/".
619 * Returns : http_response, or NULL on handler failure or out of
622 *********************************************************************/
623 static struct http_response *dispatch_known_cgi(struct client_state * csp,
626 const struct cgi_dispatcher *d;
627 struct map *param_list;
628 struct http_response *rsp;
629 char *query_args_start;
633 if (NULL == (path_copy = strdup(path)))
635 return cgi_error_memory();
638 query_args_start = path_copy;
639 while (*query_args_start && *query_args_start != '?')
643 if (*query_args_start == '?')
645 *query_args_start++ = '\0';
648 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
651 return cgi_error_memory();
657 * path_copy = CGI call name
658 * param_list = CGI params, as map
661 /* Get mem for response or fail*/
662 if (NULL == (rsp = alloc_http_response()))
665 free_map(param_list);
666 return cgi_error_memory();
669 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
670 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
671 csp->ip_addr_str, csp->http->cmd);
673 /* Find and start the right CGI function*/
677 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
679 err = (d->handler)(csp, rsp, param_list);
681 free_map(param_list);
682 if (err == JB_ERR_CGI_PARAMS)
684 err = cgi_error_bad_param(csp, rsp);
689 return finish_http_response(rsp);
693 /* Error in handler, probably out-of-memory */
694 free_http_response(rsp);
695 return cgi_error_memory();
703 /*********************************************************************
705 * Function : parse_cgi_parameters
707 * Description : Parse a URL-encoded argument string into name/value
708 * pairs and store them in a struct map list.
711 * 1 : string = string to be parsed. Will be trashed.
713 * Returns : pointer to param list, or NULL if out of memory.
715 *********************************************************************/
716 static struct map *parse_cgi_parameters(char *argstring)
719 char *vector[BUFFER_SIZE];
721 struct map *cgi_params;
723 if (NULL == (cgi_params = new_map()))
728 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
730 for (i = 0; i < pairs; i++)
732 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
735 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
737 free_map(cgi_params);
748 /*********************************************************************
750 * Function : error_response
752 * Description : returns an http_response that explains the reason
753 * why a request failed.
756 * 1 : csp = Current client state (buffers, headers, etc...)
757 * 2 : templatename = Which template should be used for the answer
758 * 3 : sys_err = system error number
760 * Returns : A http_response. If we run out of memory, this
761 * will be cgi_error_memory().
763 *********************************************************************/
764 struct http_response *error_response(struct client_state *csp,
765 const char *templatename,
769 struct http_response *rsp;
770 struct map * exports = default_exports(csp, NULL);
773 return cgi_error_memory();
776 if (NULL == (rsp = alloc_http_response()))
779 return cgi_error_memory();
782 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
783 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
784 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
785 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
788 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
791 /* Some failures, like "404 no such domain", don't have an IP address. */
792 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
800 free_http_response(rsp);
801 return cgi_error_memory();
804 if (!strcmp(templatename, "no-such-domain"))
806 rsp->status = strdup("404 No such domain");
807 if (rsp->status == NULL)
810 free_http_response(rsp);
811 return cgi_error_memory();
814 else if (!strcmp(templatename, "connect-failed"))
816 rsp->status = strdup("503 Connect failed");
817 if (rsp->status == NULL)
820 free_http_response(rsp);
821 return cgi_error_memory();
825 err = template_fill_for_cgi(csp, templatename, exports, rsp);
828 free_http_response(rsp);
829 return cgi_error_memory();
832 return finish_http_response(rsp);
836 /*********************************************************************
838 * Function : cgi_init_error_messages
840 * Description : Call at the start of the program to initialize
841 * the error message used by cgi_error_memory().
847 *********************************************************************/
848 void cgi_init_error_messages(void)
850 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
851 cgi_error_memory_response->head =
852 "HTTP/1.0 500 Internal JunkBuster Proxy Error\r\n"
853 "Content-Type: text/html\r\n"
855 cgi_error_memory_response->body =
857 "<head><title>500 Internal JunkBuster Proxy Error</title></head>\r\n"
859 "<h1>500 Internal JunkBuster Proxy Error</h1>\r\n"
860 "<p>JunkBuster <b>ran out of memory</b> while processing your request.</p>\r\n"
861 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
865 cgi_error_memory_response->head_length =
866 strlen(cgi_error_memory_response->head);
867 cgi_error_memory_response->content_length =
868 strlen(cgi_error_memory_response->body);
872 /*********************************************************************
874 * Function : cgi_error_memory
876 * Description : Called if a CGI function runs out of memory.
877 * Returns a statically-allocated error response.
880 * 1 : csp = Current client state (buffers, headers, etc...)
881 * 2 : rsp = http_response data structure for output
882 * 3 : template_name = Name of template that could not
885 * Returns : JB_ERR_OK on success
886 * JB_ERR_MEMORY on out-of-memory error.
888 *********************************************************************/
889 struct http_response *cgi_error_memory(void)
891 /* assert that it's been initialized. */
892 assert(cgi_error_memory_response->head);
894 return cgi_error_memory_response;
898 /*********************************************************************
900 * Function : cgi_error_no_template
902 * Description : Almost-CGI function that is called if a templae
903 * cannot be loaded. Note this is not a true CGI,
904 * it takes a template name rather than a map of
908 * 1 : csp = Current client state (buffers, headers, etc...)
909 * 2 : rsp = http_response data structure for output
910 * 3 : template_name = Name of template that could not
913 * Returns : JB_ERR_OK on success
914 * JB_ERR_MEMORY on out-of-memory error.
916 *********************************************************************/
917 jb_err cgi_error_no_template(struct client_state *csp,
918 struct http_response *rsp,
919 const char *template_name)
921 static const char status[] =
922 "500 Internal JunkBuster Proxy Error";
923 static const char body_prefix[] =
925 "<head><title>500 Internal JunkBuster Proxy Error</title></head>\r\n"
927 "<h1>500 Internal JunkBuster Proxy Error</h1>\r\n"
928 "<p>JunkBuster encountered an error while processing your request:</p>\r\n"
929 "<p><b>Could not load template file <code>";
930 static const char body_suffix[] =
931 "</code></b></p>\r\n"
932 "<p>Please contact your proxy administrator.</p>\r\n"
933 "<p>If you are the proxy administrator, please put the required file "
934 "in the <code><i>(confdir)</i>/templates</code> directory. The "
935 "location of the <code><i>(confdir)</i></code> directory "
936 "is specified in the main JunkBuster <code>config</code> "
937 "file. (It's typically the JunkBuster install directory"
939 ", or <code>/etc/junkbuster/</code>"
940 #endif /* ndef _WIN32 */
947 assert(template_name);
949 /* Reset rsp, if needed */
953 rsp->content_length = 0;
954 rsp->head_length = 0;
957 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
958 if (rsp->body == NULL)
960 return JB_ERR_MEMORY;
962 strcpy(rsp->body, body_prefix);
963 strcat(rsp->body, template_name);
964 strcat(rsp->body, body_suffix);
966 rsp->status = strdup(status);
967 if (rsp->body == NULL)
969 return JB_ERR_MEMORY;
976 /*********************************************************************
978 * Function : cgi_error_bad_param
980 * Description : CGI function that is called if the parameters
981 * (query string) for a CGI were wrong.
984 * 1 : csp = Current client state (buffers, headers, etc...)
985 * 2 : rsp = http_response data structure for output
987 * CGI Parameters : none
989 * Returns : JB_ERR_OK on success
990 * JB_ERR_MEMORY on out-of-memory error.
992 *********************************************************************/
993 jb_err cgi_error_bad_param(struct client_state *csp,
994 struct http_response *rsp)
1001 if (NULL == (exports = default_exports(csp, NULL)))
1003 return JB_ERR_MEMORY;
1006 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1010 /*********************************************************************
1012 * Function : get_http_time
1014 * Description : Get the time in a format suitable for use in a
1015 * HTTP header - e.g.:
1016 * "Sun, 06 Nov 1994 08:49:37 GMT"
1019 * 1 : time_offset = Time returned will be current time
1020 * plus this number of seconds.
1021 * 2 : buf = Destination for result. Must be long enough
1022 * to hold 29 characters plus a trailing zero.
1026 *********************************************************************/
1027 void get_http_time(int time_offset, char *buf)
1029 static const char day_names[7][4] =
1030 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1031 static const char month_names[12][4] =
1032 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1033 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1036 time_t current_time;
1040 time(¤t_time); /* get current time */
1042 current_time += time_offset;
1044 /* get and save the gmt */
1046 #ifdef HAVE_GMTIME_R
1048 t = gmtime_r(¤t_time, &dummy);
1050 t = gmtime(¤t_time);
1054 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1056 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1057 day_names[t->tm_wday],
1059 month_names[t->tm_mon],
1069 /*********************************************************************
1071 * Function : finish_http_response
1073 * Description : Fill in the missing headers in an http response,
1074 * and flatten the headers to an http head.
1077 * 1 : rsp = pointer to http_response to be processed
1079 * Returns : A http_response, usually the rsp parameter.
1080 * On error, free()s rsp and returns cgi_error_memory()
1082 *********************************************************************/
1083 struct http_response *finish_http_response(struct http_response *rsp)
1085 char buf[BUFFER_SIZE];
1088 /* Special case - do NOT change this statically allocated response,
1089 * which is ready for output anyway.
1091 if (rsp == cgi_error_memory_response)
1097 * Fill in the HTTP Status
1099 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1100 err = enlist_first(rsp->headers, buf);
1103 * Set the Content-Length
1105 if (rsp->content_length == 0)
1107 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1111 sprintf(buf, "Content-Length: %d", rsp->content_length);
1112 err = enlist(rsp->headers, buf);
1116 * Fill in the default headers:
1118 * Content-Type: default to text/html if not already specified.
1119 * Date: set to current date/time.
1120 * Last-Modified: set to date/time the page was last changed.
1121 * Expires: set to date/time page next needs reloading.
1122 * Cache-Control: set to "no-cache" if applicable.
1124 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1126 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1131 * Set Expires to about 10 min into the future so it'll get reloaded
1132 * occasionally, e.g. if IJB gets upgraded.
1137 get_http_time(0, buf);
1138 err = enlist_unique_header(rsp->headers, "Date", buf);
1141 /* Some date in the past. */
1142 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1146 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1147 err = enlist_unique_header(rsp->headers, "Expires", buf);
1153 * Compliant browsers should not cache this due to the "Cache-Control"
1154 * setting. However, to be certain, we also set both "Last-Modified"
1155 * and "Expires" to the current time.
1157 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1159 get_http_time(0, buf);
1160 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1161 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1162 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1169 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1171 free_http_response(rsp);
1172 return cgi_error_memory();
1174 rsp->head_length = strlen(rsp->head);
1181 /*********************************************************************
1183 * Function : alloc_http_response
1185 * Description : Allocates a new http_response structure.
1189 * Returns : pointer to a new http_response, or NULL.
1191 *********************************************************************/
1192 struct http_response *alloc_http_response(void)
1194 return (struct http_response *) zalloc(sizeof(struct http_response));
1199 /*********************************************************************
1201 * Function : free_http_response
1203 * Description : Free the memory occupied by an http_response
1204 * and its depandant structures.
1207 * 1 : rsp = pointer to http_response to be freed
1211 *********************************************************************/
1212 void free_http_response(struct http_response *rsp)
1215 * Must special case cgi_error_memory_response, which is never freed.
1217 if (rsp && (rsp != cgi_error_memory_response))
1222 destroy_list(rsp->headers);
1229 /*********************************************************************
1231 * Function : template_load
1233 * Description : CGI support function that loads a given HTML
1234 * template from the confdir, ignoring comment
1238 * 1 : csp = Current client state (buffers, headers, etc...)
1239 * 2 : template_ptr = Destination for pointer to loaded
1241 * 3 : template = name of the HTML template to be used
1243 * Returns : JB_ERR_OK on success
1244 * JB_ERR_MEMORY on out-of-memory error.
1245 * JB_ERR_FILE if the template file cannot be read
1247 *********************************************************************/
1248 jb_err template_load(struct client_state *csp, char ** template_ptr,
1249 const char *templatename)
1251 char *templates_dir_path;
1255 char buf[BUFFER_SIZE];
1258 assert(template_ptr);
1259 assert(templatename);
1261 *template_ptr = NULL;
1264 * Open template file or fail
1267 templates_dir_path = make_path(csp->config->confdir, "templates");
1268 if (templates_dir_path == NULL)
1270 return JB_ERR_MEMORY;
1273 full_path = make_path(templates_dir_path, templatename);
1274 free(templates_dir_path);
1275 if (full_path == NULL)
1277 return JB_ERR_MEMORY;
1280 file_buffer = strdup("");
1281 if (file_buffer == NULL)
1284 return JB_ERR_MEMORY;
1287 if (NULL == (fp = fopen(full_path, "r")))
1289 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1297 * Read the file, ignoring comments.
1299 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1300 * This is unlikely in practise.
1302 while (fgets(buf, BUFFER_SIZE, fp))
1304 /* skip lines starting with '#' */
1310 if (string_append(&file_buffer, buf))
1313 return JB_ERR_MEMORY;
1318 *template_ptr = file_buffer;
1324 /*********************************************************************
1326 * Function : template_fill
1328 * Description : CGI support function that fills in a pre-loaded
1329 * HTML template by replacing @name@ with value using
1330 * pcrs, for each item in the output map.
1332 * Note that a leading '$' charachter in the export map's
1333 * values will be stripped and toggle on backreference
1337 * 1 : template_ptr = IN: Template to be filled out.
1339 * OUT: Filled out template.
1340 * Caller must free().
1341 * 2 : exports = map with fill in symbol -> name pairs
1343 * Returns : JB_ERR_OK on success
1344 * JB_ERR_MEMORY on out-of-memory error
1346 *********************************************************************/
1347 jb_err template_fill(char **template_ptr, const struct map *exports)
1349 struct map_entry *m;
1351 char buf[BUFFER_SIZE];
1352 char *tmp_out_buffer;
1358 assert(template_ptr);
1359 assert(*template_ptr);
1362 file_buffer = *template_ptr;
1363 size = strlen(file_buffer) + 1;
1366 * Assemble pcrs joblist from exports map
1368 for (m = exports->first; m != NULL; m = m->next)
1370 if (*m->name == '$')
1373 * First character of name is '$', so remove this flag
1374 * character and allow backreferences ($1 etc) in the
1375 * "replace with" text.
1377 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1383 * Treat the "replace with" text as a literal string -
1384 * no quoting needed, no backreferences allowed.
1385 * ("Trivial" ['T'] flag).
1389 /* Enclose name in @@ */
1390 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1394 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
1396 /* Make and run job. */
1397 job = pcrs_compile(buf, m->value, flags, &error);
1400 if (error == PCRS_ERR_NOMEM)
1403 *template_ptr = NULL;
1404 return JB_ERR_MEMORY;
1408 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
1409 /* Hope it wasn't important and silently ignore the invalid job */
1414 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
1417 if (NULL == tmp_out_buffer)
1419 *template_ptr = NULL;
1420 return JB_ERR_MEMORY;
1422 file_buffer = tmp_out_buffer;
1429 *template_ptr = file_buffer;
1434 /*********************************************************************
1436 * Function : template_fill_for_cgi
1438 * Description : CGI support function that loads a HTML template
1439 * and fills it in. Handles file-not-found errors
1440 * by sending a HTML error message. For convenience,
1441 * this function also frees the passed "exports" map.
1444 * 1 : csp = Client state
1445 * 2 : templatename = name of the HTML template to be used
1446 * 3 : exports = map with fill in symbol -> name pairs.
1447 * Will be freed by this function.
1449 * Returns : JB_ERR_OK on success
1450 * JB_ERR_MEMORY on out-of-memory error
1452 *********************************************************************/
1453 jb_err template_fill_for_cgi(struct client_state *csp,
1454 const char *templatename,
1455 struct map *exports,
1456 struct http_response *rsp)
1461 assert(templatename);
1465 err = template_load(csp, &rsp->body, templatename);
1466 if (err == JB_ERR_FILE)
1469 return cgi_error_no_template(csp, rsp, templatename);
1474 return err; /* JB_ERR_MEMORY */
1476 err = template_fill(&rsp->body, exports);
1482 /*********************************************************************
1484 * Function : default_exports
1486 * Description : returns a struct map list that contains exports
1487 * which are common to all CGI functions.
1490 * 1 : csp = Current client state (buffers, headers, etc...)
1491 * 2 : caller = name of CGI who calls us and which should
1492 * be excluded from the generated menu. May be
1494 * Returns : NULL if no memory, else a new map. Caller frees.
1496 *********************************************************************/
1497 struct map *default_exports(const struct client_state *csp, const char *caller)
1501 struct map * exports;
1502 int local_help_exists = 0;
1506 exports = new_map();
1507 if (exports == NULL)
1512 err = map(exports, "version", 1, html_encode(VERSION), 0);
1513 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
1514 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
1515 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
1516 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
1517 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
1518 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
1519 if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB);
1521 snprintf(buf, 20, "%d", csp->config->hport);
1522 if (!err) err = map(exports, "my-port", 1, buf, 1);
1524 if(!strcmp(CODE_STATUS, "stable"))
1526 if (!err) err = map_block_killer(exports, "unstable");
1529 if (csp->config->admin_address != NULL)
1531 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
1532 local_help_exists = 1;
1536 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
1539 if (csp->config->proxy_info_url != NULL)
1541 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
1542 local_help_exists = 1;
1546 if (!err) err = map_block_killer(exports, "have-proxy-info");
1549 if (local_help_exists == 0)
1551 if (!err) err = map_block_killer(exports, "have-help-info");
1564 /*********************************************************************
1566 * Function : map_block_killer
1568 * Description : Convenience function.
1569 * Adds a "killer" for the conditional HTML-template
1570 * block <name>, i.e. a substitution of the regex
1571 * "if-<name>-start.*if-<name>-end" to the given
1575 * 1 : exports = map to extend
1576 * 2 : name = name of conditional block
1578 * Returns : JB_ERR_OK on success
1579 * JB_ERR_MEMORY on out-of-memory error.
1581 *********************************************************************/
1582 jb_err map_block_killer(struct map *exports, const char *name)
1584 char buf[1000]; /* Will do, since the names are hardwired */
1588 assert(strlen(name) < 490);
1590 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
1591 return map(exports, buf, 1, "", 1);
1595 /*********************************************************************
1597 * Function : map_block_keep
1599 * Description : Convenience function. Removes the markers used
1600 * by map-block-killer, to save a few bytes.
1601 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
1604 * 1 : exports = map to extend
1605 * 2 : name = name of conditional block
1607 * Returns : JB_ERR_OK on success
1608 * JB_ERR_MEMORY on out-of-memory error.
1610 *********************************************************************/
1611 jb_err map_block_keep(struct map *exports, const char *name)
1614 char buf[500]; /* Will do, since the names are hardwired */
1618 assert(strlen(name) < 490);
1620 snprintf(buf, 500, "if-%s-start", name);
1621 err = map(exports, buf, 1, "", 1);
1628 snprintf(buf, 500, "if-%s-end", name);
1629 return map(exports, buf, 1, "", 1);
1633 /*********************************************************************
1635 * Function : map_conditional
1637 * Description : Convenience function.
1638 * Adds an "if-then-else" for the conditional HTML-template
1639 * block <name>, i.e. a substitution of the form:
1646 * The control structure and one of the alternatives
1650 * 1 : exports = map to extend
1651 * 2 : name = name of conditional block
1652 * 3 : choose_first = nonzero for first, zero for second.
1654 * Returns : JB_ERR_OK on success
1655 * JB_ERR_MEMORY on out-of-memory error.
1657 *********************************************************************/
1658 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
1660 char buf[1000]; /* Will do, since the names are hardwired */
1665 assert(strlen(name) < 480);
1667 snprintf(buf, 1000, (choose_first
1668 ? "else-not-%s@.*@endif-%s"
1669 : "if-%s-then@.*@else-not-%s"),
1672 err = map(exports, buf, 1, "", 1);
1678 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
1679 return map(exports, buf, 1, "", 1);
1683 /*********************************************************************
1685 * Function : make_menu
1687 * Description : Returns an HTML-formatted menu of the available
1688 * unhidden CGIs, excluding the one given in <self>.
1690 * Parameters : self = name of CGI to leave out, can be NULL
1692 * Returns : menu string, or NULL on out-of-memory error.
1694 *********************************************************************/
1695 char *make_menu(const char *self)
1697 const struct cgi_dispatcher *d;
1698 char *result = strdup("");
1702 self = "NO-SUCH-CGI!";
1705 /* List available unhidden CGI's and export as "other-cgis" */
1706 for (d = cgi_dispatchers; d->name; d++)
1708 if (d->description && strcmp(d->name, self))
1710 string_append(&result, "<li><a href=\"" CGI_PREFIX);
1711 string_append(&result, d->name);
1712 string_append(&result, "\">");
1713 string_append(&result, d->description);
1714 string_append(&result, "</a></li>\n");
1722 /*********************************************************************
1724 * Function : dump_map
1726 * Description : HTML-dump a map for debugging
1729 * 1 : the_map = map to dump
1731 * Returns : string with HTML
1733 *********************************************************************/
1734 char *dump_map(const struct map *the_map)
1736 struct map_entry *cur_entry;
1737 char *ret = strdup("");
1739 string_append(&ret, "<table>\n");
1741 for (cur_entry = the_map->first;
1742 (cur_entry != NULL) && (ret != NULL);
1743 cur_entry = cur_entry->next)
1745 string_append(&ret, "<tr><td><b>");
1746 string_join (&ret, html_encode(cur_entry->name));
1747 string_append(&ret, "</b></td><td>");
1748 string_join (&ret, html_encode(cur_entry->value));
1749 string_append(&ret, "</td></tr>\n");
1752 string_append(&ret, "</table>\n");