1 const char cgi_rcs[] = "$Id: cgi.c,v 1.70.2.11 2003/10/23 12:29:26 oes Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/Attic/cgi.c,v $
6 * Purpose : Declares functions to intercept request, generate
7 * html or gif answers, and to compose HTTP resonses.
8 * This only contains the framework functions, the
9 * actual handler functions are declared elsewhere.
11 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001 the SourceForge
15 * Privoxy team. http://www.privoxy.org/
17 * Based on the Internet Junkbuster originally written
18 * by and Copyright (C) 1997 Anonymous Coders and
19 * Junkbusters Corporation. http://www.junkbusters.com
21 * This program is free software; you can redistribute it
22 * and/or modify it under the terms of the GNU General
23 * Public License as published by the Free Software
24 * Foundation; either version 2 of the License, or (at
25 * your option) any later version.
27 * This program is distributed in the hope that it will
28 * be useful, but WITHOUT ANY WARRANTY; without even the
29 * implied warranty of MERCHANTABILITY or FITNESS FOR A
30 * PARTICULAR PURPOSE. See the GNU General Public
31 * License for more details.
33 * The GNU General Public License should be included with
34 * this file. If not, you can view it at
35 * http://www.gnu.org/copyleft/gpl.html
36 * or write to the Free Software Foundation, Inc., 59
37 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
41 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
42 * Bugfix: Transparent PNG was not transparent. Thanks to
43 * Dan Razzell of Starfish Systems for notice and new PNG.
45 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
46 * Security fix: dspatch_known_cgi no longer considers an empty
47 * referrer safe for critical CGIs, since malicious links could
48 * reside on https:// locations which browsers don't advertize as
49 * referrers. Closes bug #749916, thanks to Jeff Epler for the
50 * hint. Goodbye One-Click[tm] toggling :-(
52 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
55 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
56 * Killed a compiler warning on OSX
58 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
59 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
61 * - Show toggle info only if we have it
63 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
64 * Move declaration of struct tm dummy outside of a control block so it is
65 * accessible later on during snprintf in get_http_time.
67 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
68 * Cosmetic: Renamed cryptic variable
70 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
71 * Wrapping all *_r functions (the non-_r versions of them) with mutex semaphores for OSX. Hopefully this will take care of all of those pesky crash reports.
73 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
74 * Disable access to critical CGIs via untrusted referrers.
75 * This prevents users from being tricked by malicious websites
76 * into making unintentional configuration changes:
78 * - Added flag to each cgi_dispatcher that allows or denies
80 * - Introduced proviorical function that greps for the
81 * referrer header before regular header parsing happens
82 * - Added safety check to dispatch_known_cgi. CGI is called
83 * if (cgi harmless || no referrer || we are referrer).
84 * Else a) toggle calls are modified not to change status and
85 * b) all other calls are denied.
87 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
88 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
90 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
91 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
93 * Revision 1.70 2002/05/19 11:33:20 jongfoster
94 * If a CGI error was not handled, and propogated back to
95 * dispatch_known_cgi(), then it was assumed to be "out of memory".
96 * This gave a very misleading error message.
98 * Now other errors will cause a simple message giving the error
99 * number and asking the user to report a bug.
102 * http://sourceforge.net/tracker/index.php?func=detail
103 * &aid=557905&group_id=11118&atid=111118
105 * Revision 1.69 2002/05/14 21:28:40 oes
106 * - Fixed add_help_link to link to the (now split) actions
107 * part of the config chapter
108 * - Renamed helplink export to actions-help-prefix
110 * Revision 1.68 2002/05/12 21:36:29 jongfoster
111 * Correcting function comments
113 * Revision 1.67 2002/04/30 12:02:07 oes
114 * Nit: updated a comment
116 * Revision 1.66 2002/04/26 18:32:57 jongfoster
117 * Fixing a memory leak on error
119 * Revision 1.65 2002/04/26 12:53:51 oes
120 * - New function add_help_link
121 * - default_exports now exports links to the user manual
122 * and a prefix for links into the config chapter
124 * Revision 1.64 2002/04/24 02:17:21 oes
125 * - Better descriptions for CGIs
126 * - Hide edit-actions, more shortcuts
127 * - Moved get_char_param, get_string_param and get_number_param here
130 * Revision 1.63 2002/04/15 19:06:43 jongfoster
133 * Revision 1.62 2002/04/10 19:59:46 jongfoster
134 * Fixes to #include in templates:
135 * - Didn't close main file if loading an included template fails.
136 * - I'm paranoid and want to disallow "#include /etc/passwd".
138 * Revision 1.61 2002/04/10 13:37:48 oes
139 * Made templates modular: template_load now recursive with max depth 1
141 * Revision 1.60 2002/04/08 20:50:25 swa
144 * Revision 1.59 2002/04/05 15:51:51 oes
145 * - added send-stylesheet CGI
146 * - bugfix: error-pages now get correct request protocol
148 * - kludged CGI descriptions and menu not to break JS syntax
150 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
151 * Fix Mac OSX compiler warnings
153 * Revision 1.57 2002/03/26 22:29:54 swa
154 * we have a new homepage!
156 * Revision 1.56 2002/03/24 17:50:46 jongfoster
157 * Fixing compile error if actions file editor disabled
159 * Revision 1.55 2002/03/24 16:55:06 oes
160 * Making GIF checkerboard transparent
162 * Revision 1.54 2002/03/24 16:18:15 jongfoster
165 * Revision 1.53 2002/03/24 16:06:00 oes
166 * Correct transparency for checkerboard PNG. Thanks, Magnus!
168 * Revision 1.52 2002/03/24 15:23:33 jongfoster
171 * Revision 1.51 2002/03/24 13:25:43 swa
172 * name change related issues
174 * Revision 1.50 2002/03/16 23:54:06 jongfoster
175 * Adding graceful termination feature, to help look for memory leaks.
176 * If you enable this (which, by design, has to be done by hand
177 * editing config.h) and then go to http://i.j.b/die, then the program
178 * will exit cleanly after the *next* request. It should free all the
179 * memory that was used.
181 * Revision 1.49 2002/03/13 00:27:04 jongfoster
184 * Revision 1.48 2002/03/08 17:47:07 jongfoster
187 * Revision 1.47 2002/03/08 16:41:33 oes
188 * Added GIF images again
190 * Revision 1.46 2002/03/07 03:48:38 oes
191 * - Changed built-in images from GIF to PNG
192 * (with regard to Unisys patent issue)
193 * - Added a 4x4 pattern PNG which is less intrusive
194 * than the logo but also clearly marks the deleted banners
196 * Revision 1.45 2002/03/06 22:54:35 jongfoster
197 * Automated function-comment nitpicking.
199 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
200 * - Better error reporting on OS/2
201 * - Fix double-slash comment (oops)
203 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
204 * - Re-enable OS/2 building after new parms were added
205 * - Fix false out of memory report when resolving CGI templates when no IP
206 * address is available of failed attempt (a la no such domain)
208 * Revision 1.42 2002/01/21 00:33:20 jongfoster
209 * Replacing strsav() with the safer string_append() or string_join().
210 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
211 * Adding missing html_encode() to error message generators.
212 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
214 * Revision 1.41 2002/01/17 20:56:22 jongfoster
215 * Replacing hard references to the URL of the config interface
216 * with #defines from project.h
218 * Revision 1.40 2002/01/09 14:26:46 oes
219 * Added support for thread-safe gmtime_r call.
221 * Revision 1.39 2001/11/16 00:48:13 jongfoster
222 * Fixing a compiler warning
224 * Revision 1.38 2001/11/13 00:31:21 jongfoster
225 * - Adding new CGIs for use by non-JavaScript browsers:
226 * edit-actions-url-form
227 * edit-actions-add-url-form
228 * edit-actions-remove-url-form
229 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
232 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
233 * Show enablement/disablement status in almost all templates.
234 * There is a little trickiness here: apparent recursive resolution of
235 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
236 * the actual enablement status. So a similar construct,
237 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
240 * Revision 1.36 2001/10/26 17:33:27 oes
243 * Revision 1.35 2001/10/23 21:48:19 jongfoster
244 * Cleaning up error handling in CGI functions - they now send back
245 * a HTML error page and should never cause a FATAL error. (Fixes one
246 * potential source of "denial of service" attacks).
248 * CGI actions file editor that works and is actually useful.
250 * Ability to toggle Junkbuster remotely using a CGI call.
252 * You can turn off both the above features in the main configuration
253 * file, e.g. if you are running a multi-user proxy.
255 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
256 * Only show "Local support" on templates conditionally:
257 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
258 * - if not, no Local support section appears
260 * Revision 1.33 2001/10/14 22:28:41 jongfoster
261 * Fixing stupid typo.
263 * Revision 1.32 2001/10/14 22:20:18 jongfoster
264 * - Changes to CGI dispatching method to match CGI names exactly,
265 * rather than doing a prefix match.
266 * - No longer need to count the length of the CGI handler names by hand.
267 * - Adding new handler for 404 error when disptching a CGI, if none of
268 * the handlers match.
269 * - Adding new handlers for CGI actionsfile editor.
271 * Revision 1.31 2001/10/10 10:56:39 oes
272 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
274 * Revision 1.30 2001/10/02 15:30:57 oes
275 * Introduced show-request cgi
277 * Revision 1.29 2001/09/20 15:47:44 steudten
279 * Fix BUG: Modify int size to size_t size in fill_template()
280 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
282 * Revision 1.28 2001/09/19 18:00:37 oes
283 * - Deletef time() FIXME (Can't fail under Linux either, if
284 * the argument is guaranteed to be in out address space,
287 * - Pointer notation cosmetics
288 * - Fixed a minor bug in template_fill(): Failiure of
289 * pcrs_execute() now secure.
291 * Revision 1.27 2001/09/16 17:08:54 jongfoster
292 * Moving simple CGI functions from cgi.c to new file cgisimple.c
294 * Revision 1.26 2001/09/16 15:47:37 jongfoster
295 * First version of CGI-based edit interface. This is very much a
296 * work-in-progress, and you can't actually use it to edit anything
297 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
298 * to have any effect.
300 * Revision 1.25 2001/09/16 15:02:35 jongfoster
301 * Adding i.j.b/robots.txt.
302 * Inlining add_stats() since it's only ever called from one place.
304 * Revision 1.24 2001/09/16 11:38:01 jongfoster
305 * Splitting fill_template() into 2 functions:
306 * template_load() loads the file
307 * template_fill() performs the PCRS regexps.
308 * This is because the CGI edit interface has a "table row"
309 * template which is used many times in the page - this
310 * change means it's only loaded from disk once.
312 * Revision 1.23 2001/09/16 11:16:05 jongfoster
313 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
315 * Revision 1.22 2001/09/16 11:00:10 jongfoster
316 * New function alloc_http_response, for symmetry with free_http_response
318 * Revision 1.21 2001/09/13 23:53:03 jongfoster
319 * Support for both static and dynamically generated CGI pages.
320 * Correctly setting Last-Modified: and Expires: HTTP headers.
322 * Revision 1.20 2001/09/13 23:40:36 jongfoster
323 * (Cosmetic only) Indentation correction
325 * Revision 1.19 2001/09/13 23:31:25 jongfoster
326 * Moving image data to cgi.c rather than cgi.h.
328 * Revision 1.18 2001/08/05 16:06:20 jongfoster
329 * Modifiying "struct map" so that there are now separate header and
330 * "map_entry" structures. This means that functions which modify a
331 * map no longer need to return a pointer to the modified map.
332 * Also, it no longer reverses the order of the entries (which may be
333 * important with some advanced template substitutions).
335 * Revision 1.17 2001/08/05 15:57:38 oes
336 * Adapted finish_http_response to new list_to_text
338 * Revision 1.16 2001/08/01 21:33:18 jongfoster
339 * Changes to fill_template() that reduce memory usage without having
340 * an impact on performance. I also renamed some variables so as not
341 * to clash with the C++ keywords "new" and "template".
343 * Revision 1.15 2001/08/01 21:19:22 jongfoster
344 * Moving file version information to a separate CGI page.
346 * Revision 1.14 2001/08/01 00:19:03 jongfoster
347 * New function: map_conditional() for an if-then-else syntax.
348 * Changing to use new version of show_defines()
350 * Revision 1.13 2001/07/30 22:08:36 jongfoster
351 * Tidying up #defines:
352 * - All feature #defines are now of the form FEATURE_xxx
353 * - Permanently turned off WIN_GUI_EDIT
354 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
356 * Revision 1.12 2001/07/29 18:47:05 jongfoster
357 * Adding missing #include "loadcfg.h"
359 * Revision 1.11 2001/07/18 17:24:37 oes
360 * Changed to conform to new pcrs interface
362 * Revision 1.10 2001/07/13 13:53:13 oes
363 * Removed all #ifdef PCRS and related code
365 * Revision 1.9 2001/06/29 21:45:41 oes
366 * Indentation, CRLF->LF, Tab-> Space
368 * Revision 1.8 2001/06/29 13:21:46 oes
369 * - Cosmetics: renamed and reordered functions, variables,
370 * texts, improved comments etc
372 * - Removed ij_untrusted_url() The relevant
373 * info is now part of the "untrusted" page,
374 * which is generated by filters.c:trust_url()
376 * - Generators of content now call finish_http_response()
377 * themselves, making jcc.c:chat() a little less
380 * - Removed obsolete "Pragma: no-cache" from our headers
382 * - http_responses now know their head length
384 * - fill_template now uses the new interface to pcrs, so that
385 * - long jobs (like whole files) no longer have to be assembled
386 * in a fixed size buffer
387 * - the new T (trivial) option is used, and the replacement may
388 * contain Perl syntax backrefs without confusing pcrs
390 * - Introduced default_exports() which generates a set of exports
391 * common to all CGIs and other content generators
393 * - Introduced convenience function map_block_killer()
395 * - Introduced convenience function make_menu()
397 * - Introduced CGI-like function error_response() which generates
398 * the "No such domain" and "Connect failed" messages using the
401 * - cgi_show_url_info:
402 * - adapted to new CGI features
403 * - form and answers now generated from same template
404 * - http:// prefix in URL now OK
407 * - adapted to new CGI features
408 * - no longer uses csp->init_proxy_args
411 * - moved menu generation to make_menu()
413 * - add_stats now writes single export map entries instead
416 * - Moved redirect_url() to filters.c
418 * - Fixed mem leak in free_http_response(), map_block_killer(),
420 * - Removed logentry from cancelled commit
422 * Revision 1.7 2001/06/09 10:51:58 jongfoster
423 * Changing "show URL info" handler to new style.
424 * Changing BUFSIZ ==> BUFFER_SIZE
426 * Revision 1.6 2001/06/07 23:05:19 jongfoster
427 * Removing code related to old forward and ACL files.
429 * Revision 1.5 2001/06/05 19:59:16 jongfoster
430 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
432 * Revision 1.4 2001/06/04 10:41:52 swa
433 * show version string of cgi.h and cgi.c
435 * Revision 1.3 2001/06/03 19:12:16 oes
436 * introduced new cgi handling
438 * No revisions before 1.3
440 **********************************************************************/
446 #include <sys/types.h>
454 #define snprintf _snprintf
455 #endif /* def _WIN32 */
463 #include "miscutil.h"
464 #include "cgisimple.h"
465 #ifdef FEATURE_CGI_EDIT_ACTIONS
467 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
469 /* loadcfg.h is for global_toggle_state only */
470 #ifdef FEATURE_PTHREAD
473 /* jcc.h is for mutex semaphore globals only */
474 #endif /* def FEATURE_PTHREAD */
475 const char cgi_h_rcs[] = CGI_H_VERSION;
478 * List of CGI functions: name, handler, description
479 * Note: Do NOT use single quotes in the description;
480 * this will break the dynamic "blocked" template!
482 static const struct cgi_dispatcher cgi_dispatchers[] = {
487 #ifdef FEATURE_GRACEFUL_TERMINATION
490 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
491 "this is a one click Denial Of Service attack!!!</em>",
496 #ifdef FEATURE_CGI_EDIT_ACTIONS
497 "View & change the current configuration",
499 "View the current configuration",
504 "View the source code version numbers",
508 "View the request headers.",
512 "Look up which actions apply to a URL and why",
514 #ifdef FEATURE_CGI_EDIT_ACTIONS
517 "Toggle Privoxy on or off",
519 { "edit-actions", /* Edit the actions list */
522 { "eaa", /* Shortcut for edit-actions-add-url-form */
523 cgi_edit_actions_add_url_form,
525 { "eau", /* Shortcut for edit-actions-url-form */
526 cgi_edit_actions_url_form,
528 { "ear", /* Shortcut for edit-actions-remove-url-form */
529 cgi_edit_actions_remove_url_form,
531 { "eal", /* Shortcut for edit-actions-list */
532 cgi_edit_actions_list,
534 { "eafu", /* Shortcut for edit-actions-for-url */
535 cgi_edit_actions_for_url,
537 { "eas", /* Shortcut for edit-actions-submit */
538 cgi_edit_actions_submit,
540 { "easa", /* Shortcut for edit-actions-section-add */
541 cgi_edit_actions_section_add,
543 { "easr", /* Shortcut for edit-actions-section-remove */
544 cgi_edit_actions_section_remove,
546 { "eass", /* Shortcut for edit-actions-section-swap */
547 cgi_edit_actions_section_swap,
549 { "edit-actions-for-url",
550 cgi_edit_actions_for_url,
551 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
552 { "edit-actions-list",
553 cgi_edit_actions_list,
554 NULL, TRUE /* Edit the actions list */ },
555 { "edit-actions-submit",
556 cgi_edit_actions_submit,
557 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
558 { "edit-actions-url",
559 cgi_edit_actions_url,
560 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
561 { "edit-actions-url-form",
562 cgi_edit_actions_url_form,
563 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
564 { "edit-actions-add-url",
565 cgi_edit_actions_add_url,
566 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
567 { "edit-actions-add-url-form",
568 cgi_edit_actions_add_url_form,
569 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
570 { "edit-actions-remove-url",
571 cgi_edit_actions_remove_url,
572 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
573 { "edit-actions-remove-url-form",
574 cgi_edit_actions_remove_url_form,
575 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
576 { "edit-actions-section-add",
577 cgi_edit_actions_section_add,
578 NULL, FALSE /* Remove a section from the actionsfile */ },
579 { "edit-actions-section-remove",
580 cgi_edit_actions_section_remove,
581 NULL, FALSE /* Remove a section from the actionsfile */ },
582 { "edit-actions-section-swap",
583 cgi_edit_actions_section_swap,
584 NULL, FALSE /* Swap two sections in the actionsfile */ },
585 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
588 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
591 NULL, TRUE /* Send a built-in image */ },
594 NULL, TRUE /* Send templates/cgi-style.css */ },
596 cgi_transparent_image,
597 NULL, TRUE /* Send a transparent image (short name) */ },
598 { NULL, /* NULL Indicates end of list and default page */
600 NULL, TRUE /* Unknown CGI page */ }
605 * Built-in images for ad replacement
607 * Hint: You can encode your own images like this:
608 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
611 #ifdef FEATURE_NO_GIFS
614 * Checkerboard pattern, as a PNG.
616 const char image_pattern_data[] =
617 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
618 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
619 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
620 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
621 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
622 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
623 "\000\000\000\111\105\116\104\256\102\140\202";
626 * 1x1 transparant PNG.
628 const char image_blank_data[] =
629 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
630 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
631 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
632 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
633 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
634 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
635 "\000\000\000\000\111\105\116\104\256\102\140\202";
639 * Checkerboard pattern, as a GIF.
641 const char image_pattern_data[] =
642 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
643 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
644 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
645 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
649 * 1x1 transparant GIF.
651 const char image_blank_data[] =
652 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
653 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
654 "\000\001\000\000\002\002D\001\000;";
657 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
658 const size_t image_blank_length = sizeof(image_blank_data) - 1;
661 static struct http_response cgi_error_memory_response[1];
663 static struct http_response *dispatch_known_cgi(struct client_state * csp,
665 static struct map *parse_cgi_parameters(char *argstring);
668 /*********************************************************************
670 * Function : dispatch_cgi
672 * Description : Checks if a request URL has either the magical
673 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
674 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
675 * http://config.privoxy.org/). If so, it passes
676 * the (rest of the) path onto dispatch_known_cgi, which
677 * calls the relevant CGI handler function.
680 * 1 : csp = Current client state (buffers, headers, etc...)
682 * Returns : http_response if match, NULL if nonmatch or handler fail
684 *********************************************************************/
685 struct http_response *dispatch_cgi(struct client_state *csp)
687 const char *host = csp->http->host;
688 const char *path = csp->http->path;
691 * Should we intercept ?
694 /* Note: "example.com" and "example.com." are equivalent hostnames. */
696 /* Either the host matches CGI_SITE_1_HOST ..*/
697 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
698 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
699 && (path[0] == '/') )
701 /* ..then the path will all be for us. Remove leading '/' */
704 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
705 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
706 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
707 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
709 /* take everything following CGI_SITE_2_PATH */
710 path += strlen(CGI_SITE_2_PATH);
713 /* skip the forward slash after CGI_SITE_2_PATH */
716 else if (*path != '\0')
719 * weirdness: URL is /configXXX, where XXX is some string
720 * Do *NOT* intercept.
732 * This is a CGI call.
735 return dispatch_known_cgi(csp, path);
739 /*********************************************************************
741 * Function : grep_cgi_referrer
743 * Description : Ugly provisorical fix that greps the value of the
744 * referer HTTP header field out of a linked list of
745 * strings like found at csp->headers. Will disappear
748 * FIXME: csp->headers ought to be csp->http->headers
749 * FIXME: Parsing all client header lines should
750 * happen right after the request is received!
753 * 1 : csp = Current client state (buffers, headers, etc...)
755 * Returns : pointer to value (no copy!), or NULL if none found.
757 *********************************************************************/
758 char *grep_cgi_referrer(struct client_state *csp)
760 struct list_entry *p;
762 for (p = csp->headers->first; p != NULL; p = p->next)
764 if (p->str == NULL) continue;
765 if (strncmpic(p->str, "Referer: ", 9) == 0)
767 return ((p->str) + 9);
775 /*********************************************************************
777 * Function : dispatch_known_cgi
779 * Description : Processes a CGI once dispatch_cgi has determined that
780 * it matches one of the magic prefixes. Parses the path
781 * as a cgi name plus query string, prepares a map that
782 * maps CGI parameter names to their values, initializes
783 * the http_response struct, and calls the relevant CGI
787 * 1 : csp = Current client state (buffers, headers, etc...)
788 * 2 : path = Path of CGI, with the CGI prefix removed.
789 * Should not have a leading "/".
791 * Returns : http_response, or NULL on handler failure or out of
794 *********************************************************************/
795 static struct http_response *dispatch_known_cgi(struct client_state * csp,
798 const struct cgi_dispatcher *d;
799 struct map *param_list;
800 struct http_response *rsp;
801 char *query_args_start;
806 if (NULL == (path_copy = strdup(path)))
808 return cgi_error_memory();
811 query_args_start = path_copy;
812 while (*query_args_start && *query_args_start != '?')
816 if (*query_args_start == '?')
818 *query_args_start++ = '\0';
821 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
824 return cgi_error_memory();
829 * path_copy = CGI call name
830 * param_list = CGI params, as map
833 /* Get mem for response or fail*/
834 if (NULL == (rsp = alloc_http_response()))
837 free_map(param_list);
838 return cgi_error_memory();
841 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
842 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
843 csp->ip_addr_str, csp->http->cmd);
846 * Find and start the right CGI function
851 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
854 * If the called CGI is either harmless, or referred
855 * from a trusted source, start it.
858 || ((NULL != (referrer = grep_cgi_referrer(csp)))
859 && (0 == strncmp(referrer, "http://config.privoxy.org/", 26)))
862 err = (d->handler)(csp, rsp, param_list);
867 * Else, modify toggle calls so that they only display
868 * the status, and deny all other calls.
870 if (0 == strcmp(path_copy, "toggle"))
872 unmap(param_list, "set");
873 err = (d->handler)(csp, rsp, param_list);
877 err = cgi_error_disabled(csp, rsp);
882 free_map(param_list);
884 if (err == JB_ERR_CGI_PARAMS)
886 err = cgi_error_bad_param(csp, rsp);
888 if (err && (err != JB_ERR_MEMORY))
890 /* Unexpected error! Shouldn't get here */
891 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
892 err = cgi_error_unknown(csp, rsp, err);
897 return finish_http_response(rsp);
901 /* Error in handler, probably out-of-memory */
902 free_http_response(rsp);
903 return cgi_error_memory();
911 /*********************************************************************
913 * Function : parse_cgi_parameters
915 * Description : Parse a URL-encoded argument string into name/value
916 * pairs and store them in a struct map list.
919 * 1 : argstring = string to be parsed. Will be trashed.
921 * Returns : pointer to param list, or NULL if out of memory.
923 *********************************************************************/
924 static struct map *parse_cgi_parameters(char *argstring)
927 char *vector[BUFFER_SIZE];
929 struct map *cgi_params;
931 if (NULL == (cgi_params = new_map()))
937 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
938 * the fragment identifier along with the request, so we must
939 * cut it off here, so it won't pollute the CGI params:
941 if (NULL != (p = strchr(argstring, '#')))
946 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
948 for (i = 0; i < pairs; i++)
950 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
953 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
955 free_map(cgi_params);
966 /*********************************************************************
968 * Function : get_char_param
970 * Description : Get a single-character parameter passed to a CGI
974 * 1 : parameters = map of cgi parameters
975 * 2 : param_name = The name of the parameter to read
977 * Returns : Uppercase character on success, '\0' on error.
979 *********************************************************************/
980 char get_char_param(const struct map *parameters,
981 const char *param_name)
988 ch = *(lookup(parameters, param_name));
989 if ((ch >= 'a') && (ch <= 'z'))
998 /*********************************************************************
1000 * Function : get_string_param
1002 * Description : Get a string paramater, to be used as an
1003 * ACTION_STRING or ACTION_MULTI paramater.
1004 * Validates the input to prevent stupid/malicious
1005 * users from corrupting their action file.
1008 * 1 : parameters = map of cgi parameters
1009 * 2 : param_name = The name of the parameter to read
1010 * 3 : pparam = destination for paramater. Allocated as
1011 * part of the map "parameters", so don't free it.
1012 * Set to NULL if not specified.
1014 * Returns : JB_ERR_OK on success, or if the paramater
1015 * was not specified.
1016 * JB_ERR_MEMORY on out-of-memory.
1017 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1019 *********************************************************************/
1020 jb_err get_string_param(const struct map *parameters,
1021 const char *param_name,
1022 const char **pparam)
1034 param = lookup(parameters, param_name);
1040 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1045 * Note that the length limit is arbitrary, it just seems
1046 * sensible to limit it to *something*. There's no
1047 * technical reason for any limit at all.
1049 return JB_ERR_CGI_PARAMS;
1052 /* Check every character to see if it's legal */
1054 while ((ch = *s++) != '\0')
1056 if ( ((unsigned char)ch < (unsigned char)' ')
1059 /* Probable hack attempt, or user accidentally used '}'. */
1060 return JB_ERR_CGI_PARAMS;
1071 /*********************************************************************
1073 * Function : get_number_param
1075 * Description : Get a non-negative integer from the parameters
1076 * passed to a CGI function.
1079 * 1 : csp = Current client state (buffers, headers, etc...)
1080 * 2 : parameters = map of cgi parameters
1081 * 3 : name = Name of CGI parameter to read
1082 * 4 : pvalue = destination for value.
1083 * Set to -1 on error.
1085 * Returns : JB_ERR_OK on success
1086 * JB_ERR_MEMORY on out-of-memory
1087 * JB_ERR_CGI_PARAMS if the parameter was not specified
1090 *********************************************************************/
1091 jb_err get_number_param(struct client_state *csp,
1092 const struct map *parameters,
1107 param = lookup(parameters, name);
1110 return JB_ERR_CGI_PARAMS;
1113 /* We don't use atoi because I want to check this carefully... */
1116 while ((ch = *param++) != '\0')
1118 if ((ch < '0') || (ch > '9'))
1120 return JB_ERR_CGI_PARAMS;
1127 * <limits.h> defines UINT_MAX
1129 * (UINT_MAX - ch) / 10 is the largest number that
1130 * can be safely multiplied by 10 then have ch added.
1132 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1134 return JB_ERR_CGI_PARAMS;
1137 value = value * 10 + ch;
1148 /*********************************************************************
1150 * Function : error_response
1152 * Description : returns an http_response that explains the reason
1153 * why a request failed.
1156 * 1 : csp = Current client state (buffers, headers, etc...)
1157 * 2 : templatename = Which template should be used for the answer
1158 * 3 : sys_err = system error number
1160 * Returns : A http_response. If we run out of memory, this
1161 * will be cgi_error_memory().
1163 *********************************************************************/
1164 struct http_response *error_response(struct client_state *csp,
1165 const char *templatename,
1169 struct http_response *rsp;
1170 struct map * exports = default_exports(csp, NULL);
1171 if (exports == NULL)
1173 return cgi_error_memory();
1176 if (NULL == (rsp = alloc_http_response()))
1179 return cgi_error_memory();
1182 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1183 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1184 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1185 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1186 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1189 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1192 /* Some failures, like "404 no such domain", don't have an IP address. */
1193 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1201 free_http_response(rsp);
1202 return cgi_error_memory();
1205 if (!strcmp(templatename, "no-such-domain"))
1207 rsp->status = strdup("404 No such domain");
1208 if (rsp->status == NULL)
1211 free_http_response(rsp);
1212 return cgi_error_memory();
1215 else if (!strcmp(templatename, "connect-failed"))
1217 rsp->status = strdup("503 Connect failed");
1218 if (rsp->status == NULL)
1221 free_http_response(rsp);
1222 return cgi_error_memory();
1226 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1229 free_http_response(rsp);
1230 return cgi_error_memory();
1233 return finish_http_response(rsp);
1237 /*********************************************************************
1239 * Function : cgi_init_error_messages
1241 * Description : Call at the start of the program to initialize
1242 * the error message used by cgi_error_memory().
1248 *********************************************************************/
1249 void cgi_init_error_messages(void)
1251 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1252 cgi_error_memory_response->head =
1253 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1254 "Content-Type: text/html\r\n"
1256 cgi_error_memory_response->body =
1258 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1260 "<h1>500 Internal Privoxy Error</h1>\r\n"
1261 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1262 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1266 cgi_error_memory_response->head_length =
1267 strlen(cgi_error_memory_response->head);
1268 cgi_error_memory_response->content_length =
1269 strlen(cgi_error_memory_response->body);
1273 /*********************************************************************
1275 * Function : cgi_error_memory
1277 * Description : Called if a CGI function runs out of memory.
1278 * Returns a statically-allocated error response.
1282 * Returns : http_response data structure for output. This is
1283 * statically allocated, for obvious reasons.
1285 *********************************************************************/
1286 struct http_response *cgi_error_memory(void)
1288 /* assert that it's been initialized. */
1289 assert(cgi_error_memory_response->head);
1291 return cgi_error_memory_response;
1295 /*********************************************************************
1297 * Function : cgi_error_no_template
1299 * Description : Almost-CGI function that is called if a template
1300 * cannot be loaded. Note this is not a true CGI,
1301 * it takes a template name rather than a map of
1305 * 1 : csp = Current client state (buffers, headers, etc...)
1306 * 2 : rsp = http_response data structure for output
1307 * 3 : template_name = Name of template that could not
1310 * Returns : JB_ERR_OK on success
1311 * JB_ERR_MEMORY on out-of-memory error.
1313 *********************************************************************/
1314 jb_err cgi_error_no_template(struct client_state *csp,
1315 struct http_response *rsp,
1316 const char *template_name)
1318 static const char status[] =
1319 "500 Internal Privoxy Error";
1320 static const char body_prefix[] =
1322 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1324 "<h1>500 Internal Privoxy Error</h1>\r\n"
1325 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1326 "<p><b>Could not load template file <code>";
1327 static const char body_suffix[] =
1328 "</code> or one of it's included components.</b></p>\r\n"
1329 "<p>Please contact your proxy administrator.</p>\r\n"
1330 "<p>If you are the proxy administrator, please put the required file(s)"
1331 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1332 "location of the <code><i>(confdir)</i></code> directory "
1333 "is specified in the main Privoxy <code>config</code> "
1334 "file. (It's typically the Privoxy install directory"
1336 ", or <code>/etc/privoxy/</code>"
1337 #endif /* ndef _WIN32 */
1344 assert(template_name);
1346 /* Reset rsp, if needed */
1350 rsp->content_length = 0;
1351 rsp->head_length = 0;
1354 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1355 if (rsp->body == NULL)
1357 return JB_ERR_MEMORY;
1359 strcpy(rsp->body, body_prefix);
1360 strcat(rsp->body, template_name);
1361 strcat(rsp->body, body_suffix);
1363 rsp->status = strdup(status);
1364 if (rsp->body == NULL)
1366 return JB_ERR_MEMORY;
1373 /*********************************************************************
1375 * Function : cgi_error_unknown
1377 * Description : Almost-CGI function that is called if an unexpected
1378 * error occurs in the top-level CGI dispatcher.
1379 * In this context, "unexpected" means "anything other
1380 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1381 * expected to handle all other errors internally,
1382 * since they can give more relavent error messages
1385 * Note this is not a true CGI, it takes an error
1386 * code rather than a map of parameters.
1389 * 1 : csp = Current client state (buffers, headers, etc...)
1390 * 2 : rsp = http_response data structure for output
1391 * 3 : error_to_report = Error code to report.
1393 * Returns : JB_ERR_OK on success
1394 * JB_ERR_MEMORY on out-of-memory error.
1396 *********************************************************************/
1397 jb_err cgi_error_unknown(struct client_state *csp,
1398 struct http_response *rsp,
1399 jb_err error_to_report)
1401 static const char status[] =
1402 "500 Internal Privoxy Error";
1403 static const char body_prefix[] =
1405 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1407 "<h1>500 Internal Privoxy Error</h1>\r\n"
1408 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1409 "<p><b>Unexpected internal error: ";
1410 static const char body_suffix[] =
1413 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1414 "file a bug report</a>.</p>\r\n"
1421 /* Reset rsp, if needed */
1425 rsp->content_length = 0;
1426 rsp->head_length = 0;
1429 sprintf(errnumbuf, "%d", error_to_report);
1431 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1432 if (rsp->body == NULL)
1434 return JB_ERR_MEMORY;
1436 strcpy(rsp->body, body_prefix);
1437 strcat(rsp->body, errnumbuf);
1438 strcat(rsp->body, body_suffix);
1440 rsp->status = strdup(status);
1441 if (rsp->body == NULL)
1443 return JB_ERR_MEMORY;
1450 /*********************************************************************
1452 * Function : cgi_error_bad_param
1454 * Description : CGI function that is called if the parameters
1455 * (query string) for a CGI were wrong.
1458 * 1 : csp = Current client state (buffers, headers, etc...)
1459 * 2 : rsp = http_response data structure for output
1461 * CGI Parameters : none
1463 * Returns : JB_ERR_OK on success
1464 * JB_ERR_MEMORY on out-of-memory error.
1466 *********************************************************************/
1467 jb_err cgi_error_bad_param(struct client_state *csp,
1468 struct http_response *rsp)
1470 struct map *exports;
1475 if (NULL == (exports = default_exports(csp, NULL)))
1477 return JB_ERR_MEMORY;
1480 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1484 /*********************************************************************
1486 * Function : cgi_redirect
1488 * Description : CGI support function to generate a HTTP redirect
1492 * 1 : rsp = http_response data structure for output
1493 * 2 : target = string with the target URL
1495 * CGI Parameters : None
1497 * Returns : JB_ERR_OK on success
1498 * JB_ERR_MEMORY on out-of-memory error.
1500 *********************************************************************/
1501 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1508 err = enlist_unique_header(rsp->headers, "Location", target);
1510 rsp->status = strdup("302 Local Redirect from Privoxy");
1511 if (rsp->status == NULL)
1513 return JB_ERR_MEMORY;
1520 /*********************************************************************
1522 * Function : add_help_link
1524 * Description : Produce a copy of the string given as item,
1525 * embedded in an HTML link to its corresponding
1526 * section (item name in uppercase) in the actions
1527 * chapter of the user manual, (whose URL is given in
1528 * the config and defaults to our web site).
1530 * FIXME: I currently only work for actions, and would
1531 * like to be generalized for other topics.
1534 * 1 : item = item (will NOT be free()d.)
1535 * It is assumed to be HTML-safe.
1536 * 2 : config = The current configuration.
1538 * Returns : String with item embedded in link, or NULL on
1541 *********************************************************************/
1542 char *add_help_link(const char *item,
1543 struct configuration_spec *config)
1547 if (!item) return NULL;
1549 result = strdup("<a href=\"");
1550 string_append(&result, config->usermanual);
1551 string_append(&result, ACTIONS_HELP_PREFIX);
1552 string_join (&result, string_toupper(item));
1553 string_append(&result, "\">");
1554 string_append(&result, item);
1555 string_append(&result, "</a> ");
1561 /*********************************************************************
1563 * Function : get_http_time
1565 * Description : Get the time in a format suitable for use in a
1566 * HTTP header - e.g.:
1567 * "Sun, 06 Nov 1994 08:49:37 GMT"
1570 * 1 : time_offset = Time returned will be current time
1571 * plus this number of seconds.
1572 * 2 : buf = Destination for result. Must be long enough
1573 * to hold 29 characters plus a trailing zero.
1577 *********************************************************************/
1578 void get_http_time(int time_offset, char *buf)
1580 static const char day_names[7][4] =
1581 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1582 static const char month_names[12][4] =
1583 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1584 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1587 time_t current_time;
1588 #if defined(HAVE_GMTIME_R) && !defined(OSX_DARWIN)
1590 * Declare dummy up here (instead of inside get/set gmt block) so it
1591 * doesn't go out of scope before it's potentially used in snprintf later.
1592 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1593 * !defined HAVE_GMTIME_R.
1600 time(¤t_time); /* get current time */
1602 current_time += time_offset;
1604 /* get and save the gmt */
1607 pthread_mutex_lock(&gmtime_mutex);
1608 t = gmtime(¤t_time);
1609 pthread_mutex_unlock(&gmtime_mutex);
1611 t = gmtime_r(¤t_time, &dummy);
1613 t = gmtime(¤t_time);
1617 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1619 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1620 day_names[t->tm_wday],
1622 month_names[t->tm_mon],
1632 /*********************************************************************
1634 * Function : finish_http_response
1636 * Description : Fill in the missing headers in an http response,
1637 * and flatten the headers to an http head.
1640 * 1 : rsp = pointer to http_response to be processed
1642 * Returns : A http_response, usually the rsp parameter.
1643 * On error, free()s rsp and returns cgi_error_memory()
1645 *********************************************************************/
1646 struct http_response *finish_http_response(struct http_response *rsp)
1648 char buf[BUFFER_SIZE];
1651 /* Special case - do NOT change this statically allocated response,
1652 * which is ready for output anyway.
1654 if (rsp == cgi_error_memory_response)
1660 * Fill in the HTTP Status
1662 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1663 err = enlist_first(rsp->headers, buf);
1666 * Set the Content-Length
1668 if (rsp->content_length == 0)
1670 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1674 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1675 err = enlist(rsp->headers, buf);
1679 * Fill in the default headers:
1681 * Content-Type: default to text/html if not already specified.
1682 * Date: set to current date/time.
1683 * Last-Modified: set to date/time the page was last changed.
1684 * Expires: set to date/time page next needs reloading.
1685 * Cache-Control: set to "no-cache" if applicable.
1687 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1689 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1694 * Set Expires to about 10 min into the future so it'll get reloaded
1695 * occasionally, e.g. if Privoxy gets upgraded.
1700 get_http_time(0, buf);
1701 err = enlist_unique_header(rsp->headers, "Date", buf);
1704 /* Some date in the past. */
1705 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1709 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1710 err = enlist_unique_header(rsp->headers, "Expires", buf);
1716 * Compliant browsers should not cache this due to the "Cache-Control"
1717 * setting. However, to be certain, we also set both "Last-Modified"
1718 * and "Expires" to the current time.
1720 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1722 get_http_time(0, buf);
1723 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1724 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1725 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1732 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1734 free_http_response(rsp);
1735 return cgi_error_memory();
1737 rsp->head_length = strlen(rsp->head);
1744 /*********************************************************************
1746 * Function : alloc_http_response
1748 * Description : Allocates a new http_response structure.
1752 * Returns : pointer to a new http_response, or NULL.
1754 *********************************************************************/
1755 struct http_response *alloc_http_response(void)
1757 return (struct http_response *) zalloc(sizeof(struct http_response));
1762 /*********************************************************************
1764 * Function : free_http_response
1766 * Description : Free the memory occupied by an http_response
1767 * and its depandant structures.
1770 * 1 : rsp = pointer to http_response to be freed
1774 *********************************************************************/
1775 void free_http_response(struct http_response *rsp)
1778 * Must special case cgi_error_memory_response, which is never freed.
1780 if (rsp && (rsp != cgi_error_memory_response))
1785 destroy_list(rsp->headers);
1792 /*********************************************************************
1794 * Function : template_load
1796 * Description : CGI support function that loads a given HTML
1797 * template from the confdir, ignoring comment
1798 * lines and following #include statements up to
1802 * 1 : csp = Current client state (buffers, headers, etc...)
1803 * 2 : template_ptr = Destination for pointer to loaded
1805 * 3 : templatename = name of the HTML template to be used
1806 * 4 : recursive = Flag set if this function calls itself
1807 * following an #include statament
1809 * Returns : JB_ERR_OK on success
1810 * JB_ERR_MEMORY on out-of-memory error.
1811 * JB_ERR_FILE if the template file cannot be read
1813 *********************************************************************/
1814 jb_err template_load(struct client_state *csp, char **template_ptr,
1815 const char *templatename, int recursive)
1818 char *templates_dir_path;
1821 char *included_module;
1824 char buf[BUFFER_SIZE];
1827 assert(template_ptr);
1828 assert(templatename);
1830 *template_ptr = NULL;
1832 /* Validate template name. Paranoia. */
1833 for (p = templatename; *p != 0; p++)
1835 if ( ((*p < 'a') || (*p > 'z'))
1836 && ((*p < 'A') || (*p > 'Z'))
1837 && ((*p < '0') || (*p > '9'))
1841 /* Illegal character */
1846 /* Generate full path */
1848 templates_dir_path = make_path(csp->config->confdir, "templates");
1849 if (templates_dir_path == NULL)
1851 return JB_ERR_MEMORY;
1854 full_path = make_path(templates_dir_path, templatename);
1855 free(templates_dir_path);
1856 if (full_path == NULL)
1858 return JB_ERR_MEMORY;
1861 /* Allocate buffer */
1863 file_buffer = strdup("");
1864 if (file_buffer == NULL)
1867 return JB_ERR_MEMORY;
1870 /* Open template file */
1872 if (NULL == (fp = fopen(full_path, "r")))
1874 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1882 * Read the file, ignoring comments, and honoring #include
1883 * statements, unless we're already called recursively.
1885 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1886 * This is unlikely in practise.
1888 while (fgets(buf, BUFFER_SIZE, fp))
1890 if (!recursive && !strncmp(buf, "#include ", 9))
1892 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1899 if (string_join(&file_buffer, included_module))
1902 return JB_ERR_MEMORY;
1908 /* skip lines starting with '#' */
1914 if (string_append(&file_buffer, buf))
1917 return JB_ERR_MEMORY;
1922 *template_ptr = file_buffer;
1928 /*********************************************************************
1930 * Function : template_fill
1932 * Description : CGI support function that fills in a pre-loaded
1933 * HTML template by replacing @name@ with value using
1934 * pcrs, for each item in the output map.
1936 * Note that a leading '$' charachter in the export map's
1937 * values will be stripped and toggle on backreference
1941 * 1 : template_ptr = IN: Template to be filled out.
1943 * OUT: Filled out template.
1944 * Caller must free().
1945 * 2 : exports = map with fill in symbol -> name pairs
1947 * Returns : JB_ERR_OK on success
1948 * JB_ERR_MEMORY on out-of-memory error
1950 *********************************************************************/
1951 jb_err template_fill(char **template_ptr, const struct map *exports)
1953 struct map_entry *m;
1955 char buf[BUFFER_SIZE];
1956 char *tmp_out_buffer;
1962 assert(template_ptr);
1963 assert(*template_ptr);
1966 file_buffer = *template_ptr;
1967 size = strlen(file_buffer) + 1;
1970 * Assemble pcrs joblist from exports map
1972 for (m = exports->first; m != NULL; m = m->next)
1974 if (*m->name == '$')
1977 * First character of name is '$', so remove this flag
1978 * character and allow backreferences ($1 etc) in the
1979 * "replace with" text.
1981 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1987 * Treat the "replace with" text as a literal string -
1988 * no quoting needed, no backreferences allowed.
1989 * ("Trivial" ['T'] flag).
1993 /* Enclose name in @@ */
1994 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1998 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2000 /* Make and run job. */
2001 job = pcrs_compile(buf, m->value, flags, &error);
2004 if (error == PCRS_ERR_NOMEM)
2007 *template_ptr = NULL;
2008 return JB_ERR_MEMORY;
2012 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2013 /* Hope it wasn't important and silently ignore the invalid job */
2018 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2021 if (NULL == tmp_out_buffer)
2023 *template_ptr = NULL;
2024 return JB_ERR_MEMORY;
2026 file_buffer = tmp_out_buffer;
2033 *template_ptr = file_buffer;
2038 /*********************************************************************
2040 * Function : template_fill_for_cgi
2042 * Description : CGI support function that loads a HTML template
2043 * and fills it in. Handles file-not-found errors
2044 * by sending a HTML error message. For convenience,
2045 * this function also frees the passed "exports" map.
2048 * 1 : csp = Client state
2049 * 2 : templatename = name of the HTML template to be used
2050 * 3 : exports = map with fill in symbol -> name pairs.
2051 * Will be freed by this function.
2052 * 4 : rsp = Response structure to fill in.
2054 * Returns : JB_ERR_OK on success
2055 * JB_ERR_MEMORY on out-of-memory error
2057 *********************************************************************/
2058 jb_err template_fill_for_cgi(struct client_state *csp,
2059 const char *templatename,
2060 struct map *exports,
2061 struct http_response *rsp)
2066 assert(templatename);
2070 err = template_load(csp, &rsp->body, templatename, 0);
2071 if (err == JB_ERR_FILE)
2074 return cgi_error_no_template(csp, rsp, templatename);
2079 return err; /* JB_ERR_MEMORY */
2081 err = template_fill(&rsp->body, exports);
2087 /*********************************************************************
2089 * Function : default_exports
2091 * Description : returns a struct map list that contains exports
2092 * which are common to all CGI functions.
2095 * 1 : csp = Current client state (buffers, headers, etc...)
2096 * 2 : caller = name of CGI who calls us and which should
2097 * be excluded from the generated menu. May be
2099 * Returns : NULL if no memory, else a new map. Caller frees.
2101 *********************************************************************/
2102 struct map *default_exports(const struct client_state *csp, const char *caller)
2106 struct map * exports;
2107 int local_help_exists = 0;
2111 exports = new_map();
2112 if (exports == NULL)
2117 err = map(exports, "version", 1, html_encode(VERSION), 0);
2118 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2119 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2120 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2121 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2122 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
2123 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2124 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2125 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2126 #ifdef FEATURE_TOGGLE
2127 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2129 if (!err) err = map_block_killer(exports, "can-toggle");
2132 snprintf(buf, 20, "%d", csp->config->hport);
2133 if (!err) err = map(exports, "my-port", 1, buf, 1);
2135 if(!strcmp(CODE_STATUS, "stable"))
2137 if (!err) err = map_block_killer(exports, "unstable");
2140 if (csp->config->admin_address != NULL)
2142 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2143 local_help_exists = 1;
2147 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2150 if (csp->config->proxy_info_url != NULL)
2152 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2153 local_help_exists = 1;
2157 if (!err) err = map_block_killer(exports, "have-proxy-info");
2160 if (local_help_exists == 0)
2162 if (!err) err = map_block_killer(exports, "have-help-info");
2175 /*********************************************************************
2177 * Function : map_block_killer
2179 * Description : Convenience function.
2180 * Adds a "killer" for the conditional HTML-template
2181 * block <name>, i.e. a substitution of the regex
2182 * "if-<name>-start.*if-<name>-end" to the given
2186 * 1 : exports = map to extend
2187 * 2 : name = name of conditional block
2189 * Returns : JB_ERR_OK on success
2190 * JB_ERR_MEMORY on out-of-memory error.
2192 *********************************************************************/
2193 jb_err map_block_killer(struct map *exports, const char *name)
2195 char buf[1000]; /* Will do, since the names are hardwired */
2199 assert(strlen(name) < 490);
2201 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2202 return map(exports, buf, 1, "", 1);
2206 /*********************************************************************
2208 * Function : map_block_keep
2210 * Description : Convenience function. Removes the markers used
2211 * by map-block-killer, to save a few bytes.
2212 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2215 * 1 : exports = map to extend
2216 * 2 : name = name of conditional block
2218 * Returns : JB_ERR_OK on success
2219 * JB_ERR_MEMORY on out-of-memory error.
2221 *********************************************************************/
2222 jb_err map_block_keep(struct map *exports, const char *name)
2225 char buf[500]; /* Will do, since the names are hardwired */
2229 assert(strlen(name) < 490);
2231 snprintf(buf, 500, "if-%s-start", name);
2232 err = map(exports, buf, 1, "", 1);
2239 snprintf(buf, 500, "if-%s-end", name);
2240 return map(exports, buf, 1, "", 1);
2244 /*********************************************************************
2246 * Function : map_conditional
2248 * Description : Convenience function.
2249 * Adds an "if-then-else" for the conditional HTML-template
2250 * block <name>, i.e. a substitution of the form:
2257 * The control structure and one of the alternatives
2261 * 1 : exports = map to extend
2262 * 2 : name = name of conditional block
2263 * 3 : choose_first = nonzero for first, zero for second.
2265 * Returns : JB_ERR_OK on success
2266 * JB_ERR_MEMORY on out-of-memory error.
2268 *********************************************************************/
2269 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2271 char buf[1000]; /* Will do, since the names are hardwired */
2276 assert(strlen(name) < 480);
2278 snprintf(buf, 1000, (choose_first
2279 ? "else-not-%s@.*@endif-%s"
2280 : "if-%s-then@.*@else-not-%s"),
2283 err = map(exports, buf, 1, "", 1);
2289 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2290 return map(exports, buf, 1, "", 1);
2294 /*********************************************************************
2296 * Function : make_menu
2298 * Description : Returns an HTML-formatted menu of the available
2299 * unhidden CGIs, excluding the one given in <self>
2301 * Parameters : self = name of CGI to leave out, can be NULL for
2304 * Returns : menu string, or NULL on out-of-memory error.
2306 *********************************************************************/
2307 char *make_menu(const char *self)
2309 const struct cgi_dispatcher *d;
2310 char *result = strdup("");
2314 self = "NO-SUCH-CGI!";
2317 /* List available unhidden CGI's and export as "other-cgis" */
2318 for (d = cgi_dispatchers; d->name; d++)
2320 if (d->description && strcmp(d->name, self))
2322 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2323 string_append(&result, d->name);
2324 string_append(&result, "\">");
2325 string_append(&result, d->description);
2326 string_append(&result, "</a></li>");
2334 /*********************************************************************
2336 * Function : dump_map
2338 * Description : HTML-dump a map for debugging (as table)
2341 * 1 : the_map = map to dump
2343 * Returns : string with HTML
2345 *********************************************************************/
2346 char *dump_map(const struct map *the_map)
2348 struct map_entry *cur_entry;
2349 char *ret = strdup("");
2351 string_append(&ret, "<table>\n");
2353 for (cur_entry = the_map->first;
2354 (cur_entry != NULL) && (ret != NULL);
2355 cur_entry = cur_entry->next)
2357 string_append(&ret, "<tr><td><b>");
2358 string_join (&ret, html_encode(cur_entry->name));
2359 string_append(&ret, "</b></td><td>");
2360 string_join (&ret, html_encode(cur_entry->value));
2361 string_append(&ret, "</td></tr>\n");
2364 string_append(&ret, "</table>\n");