1 const char cgi_rcs[] = "$Id: cgi.c,v 1.70.2.6 2003/03/12 01:26:25 david__schmidt 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.6 2003/03/12 01:26:25 david__schmidt
42 * Move declaration of struct tm dummy outside of a control block so it is
43 * accessible later on during snprintf in get_http_time.
45 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
46 * Cosmetic: Renamed cryptic variable
48 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
49 * 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.
51 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
52 * Disable access to critical CGIs via untrusted referrers.
53 * This prevents users from being tricked by malicious websites
54 * into making unintentional configuration changes:
56 * - Added flag to each cgi_dispatcher that allows or denies
58 * - Introduced proviorical function that greps for the
59 * referrer header before regular header parsing happens
60 * - Added safety check to dispatch_known_cgi. CGI is called
61 * if (cgi harmless || no referrer || we are referrer).
62 * Else a) toggle calls are modified not to change status and
63 * b) all other calls are denied.
65 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
66 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
68 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
69 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
71 * Revision 1.70 2002/05/19 11:33:20 jongfoster
72 * If a CGI error was not handled, and propogated back to
73 * dispatch_known_cgi(), then it was assumed to be "out of memory".
74 * This gave a very misleading error message.
76 * Now other errors will cause a simple message giving the error
77 * number and asking the user to report a bug.
80 * http://sourceforge.net/tracker/index.php?func=detail
81 * &aid=557905&group_id=11118&atid=111118
83 * Revision 1.69 2002/05/14 21:28:40 oes
84 * - Fixed add_help_link to link to the (now split) actions
85 * part of the config chapter
86 * - Renamed helplink export to actions-help-prefix
88 * Revision 1.68 2002/05/12 21:36:29 jongfoster
89 * Correcting function comments
91 * Revision 1.67 2002/04/30 12:02:07 oes
92 * Nit: updated a comment
94 * Revision 1.66 2002/04/26 18:32:57 jongfoster
95 * Fixing a memory leak on error
97 * Revision 1.65 2002/04/26 12:53:51 oes
98 * - New function add_help_link
99 * - default_exports now exports links to the user manual
100 * and a prefix for links into the config chapter
102 * Revision 1.64 2002/04/24 02:17:21 oes
103 * - Better descriptions for CGIs
104 * - Hide edit-actions, more shortcuts
105 * - Moved get_char_param, get_string_param and get_number_param here
108 * Revision 1.63 2002/04/15 19:06:43 jongfoster
111 * Revision 1.62 2002/04/10 19:59:46 jongfoster
112 * Fixes to #include in templates:
113 * - Didn't close main file if loading an included template fails.
114 * - I'm paranoid and want to disallow "#include /etc/passwd".
116 * Revision 1.61 2002/04/10 13:37:48 oes
117 * Made templates modular: template_load now recursive with max depth 1
119 * Revision 1.60 2002/04/08 20:50:25 swa
122 * Revision 1.59 2002/04/05 15:51:51 oes
123 * - added send-stylesheet CGI
124 * - bugfix: error-pages now get correct request protocol
126 * - kludged CGI descriptions and menu not to break JS syntax
128 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
129 * Fix Mac OSX compiler warnings
131 * Revision 1.57 2002/03/26 22:29:54 swa
132 * we have a new homepage!
134 * Revision 1.56 2002/03/24 17:50:46 jongfoster
135 * Fixing compile error if actions file editor disabled
137 * Revision 1.55 2002/03/24 16:55:06 oes
138 * Making GIF checkerboard transparent
140 * Revision 1.54 2002/03/24 16:18:15 jongfoster
143 * Revision 1.53 2002/03/24 16:06:00 oes
144 * Correct transparency for checkerboard PNG. Thanks, Magnus!
146 * Revision 1.52 2002/03/24 15:23:33 jongfoster
149 * Revision 1.51 2002/03/24 13:25:43 swa
150 * name change related issues
152 * Revision 1.50 2002/03/16 23:54:06 jongfoster
153 * Adding graceful termination feature, to help look for memory leaks.
154 * If you enable this (which, by design, has to be done by hand
155 * editing config.h) and then go to http://i.j.b/die, then the program
156 * will exit cleanly after the *next* request. It should free all the
157 * memory that was used.
159 * Revision 1.49 2002/03/13 00:27:04 jongfoster
162 * Revision 1.48 2002/03/08 17:47:07 jongfoster
165 * Revision 1.47 2002/03/08 16:41:33 oes
166 * Added GIF images again
168 * Revision 1.46 2002/03/07 03:48:38 oes
169 * - Changed built-in images from GIF to PNG
170 * (with regard to Unisys patent issue)
171 * - Added a 4x4 pattern PNG which is less intrusive
172 * than the logo but also clearly marks the deleted banners
174 * Revision 1.45 2002/03/06 22:54:35 jongfoster
175 * Automated function-comment nitpicking.
177 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
178 * - Better error reporting on OS/2
179 * - Fix double-slash comment (oops)
181 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
182 * - Re-enable OS/2 building after new parms were added
183 * - Fix false out of memory report when resolving CGI templates when no IP
184 * address is available of failed attempt (a la no such domain)
186 * Revision 1.42 2002/01/21 00:33:20 jongfoster
187 * Replacing strsav() with the safer string_append() or string_join().
188 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
189 * Adding missing html_encode() to error message generators.
190 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
192 * Revision 1.41 2002/01/17 20:56:22 jongfoster
193 * Replacing hard references to the URL of the config interface
194 * with #defines from project.h
196 * Revision 1.40 2002/01/09 14:26:46 oes
197 * Added support for thread-safe gmtime_r call.
199 * Revision 1.39 2001/11/16 00:48:13 jongfoster
200 * Fixing a compiler warning
202 * Revision 1.38 2001/11/13 00:31:21 jongfoster
203 * - Adding new CGIs for use by non-JavaScript browsers:
204 * edit-actions-url-form
205 * edit-actions-add-url-form
206 * edit-actions-remove-url-form
207 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
210 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
211 * Show enablement/disablement status in almost all templates.
212 * There is a little trickiness here: apparent recursive resolution of
213 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
214 * the actual enablement status. So a similar construct,
215 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
218 * Revision 1.36 2001/10/26 17:33:27 oes
221 * Revision 1.35 2001/10/23 21:48:19 jongfoster
222 * Cleaning up error handling in CGI functions - they now send back
223 * a HTML error page and should never cause a FATAL error. (Fixes one
224 * potential source of "denial of service" attacks).
226 * CGI actions file editor that works and is actually useful.
228 * Ability to toggle Junkbuster remotely using a CGI call.
230 * You can turn off both the above features in the main configuration
231 * file, e.g. if you are running a multi-user proxy.
233 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
234 * Only show "Local support" on templates conditionally:
235 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
236 * - if not, no Local support section appears
238 * Revision 1.33 2001/10/14 22:28:41 jongfoster
239 * Fixing stupid typo.
241 * Revision 1.32 2001/10/14 22:20:18 jongfoster
242 * - Changes to CGI dispatching method to match CGI names exactly,
243 * rather than doing a prefix match.
244 * - No longer need to count the length of the CGI handler names by hand.
245 * - Adding new handler for 404 error when disptching a CGI, if none of
246 * the handlers match.
247 * - Adding new handlers for CGI actionsfile editor.
249 * Revision 1.31 2001/10/10 10:56:39 oes
250 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
252 * Revision 1.30 2001/10/02 15:30:57 oes
253 * Introduced show-request cgi
255 * Revision 1.29 2001/09/20 15:47:44 steudten
257 * Fix BUG: Modify int size to size_t size in fill_template()
258 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
260 * Revision 1.28 2001/09/19 18:00:37 oes
261 * - Deletef time() FIXME (Can't fail under Linux either, if
262 * the argument is guaranteed to be in out address space,
265 * - Pointer notation cosmetics
266 * - Fixed a minor bug in template_fill(): Failiure of
267 * pcrs_execute() now secure.
269 * Revision 1.27 2001/09/16 17:08:54 jongfoster
270 * Moving simple CGI functions from cgi.c to new file cgisimple.c
272 * Revision 1.26 2001/09/16 15:47:37 jongfoster
273 * First version of CGI-based edit interface. This is very much a
274 * work-in-progress, and you can't actually use it to edit anything
275 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
276 * to have any effect.
278 * Revision 1.25 2001/09/16 15:02:35 jongfoster
279 * Adding i.j.b/robots.txt.
280 * Inlining add_stats() since it's only ever called from one place.
282 * Revision 1.24 2001/09/16 11:38:01 jongfoster
283 * Splitting fill_template() into 2 functions:
284 * template_load() loads the file
285 * template_fill() performs the PCRS regexps.
286 * This is because the CGI edit interface has a "table row"
287 * template which is used many times in the page - this
288 * change means it's only loaded from disk once.
290 * Revision 1.23 2001/09/16 11:16:05 jongfoster
291 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
293 * Revision 1.22 2001/09/16 11:00:10 jongfoster
294 * New function alloc_http_response, for symmetry with free_http_response
296 * Revision 1.21 2001/09/13 23:53:03 jongfoster
297 * Support for both static and dynamically generated CGI pages.
298 * Correctly setting Last-Modified: and Expires: HTTP headers.
300 * Revision 1.20 2001/09/13 23:40:36 jongfoster
301 * (Cosmetic only) Indentation correction
303 * Revision 1.19 2001/09/13 23:31:25 jongfoster
304 * Moving image data to cgi.c rather than cgi.h.
306 * Revision 1.18 2001/08/05 16:06:20 jongfoster
307 * Modifiying "struct map" so that there are now separate header and
308 * "map_entry" structures. This means that functions which modify a
309 * map no longer need to return a pointer to the modified map.
310 * Also, it no longer reverses the order of the entries (which may be
311 * important with some advanced template substitutions).
313 * Revision 1.17 2001/08/05 15:57:38 oes
314 * Adapted finish_http_response to new list_to_text
316 * Revision 1.16 2001/08/01 21:33:18 jongfoster
317 * Changes to fill_template() that reduce memory usage without having
318 * an impact on performance. I also renamed some variables so as not
319 * to clash with the C++ keywords "new" and "template".
321 * Revision 1.15 2001/08/01 21:19:22 jongfoster
322 * Moving file version information to a separate CGI page.
324 * Revision 1.14 2001/08/01 00:19:03 jongfoster
325 * New function: map_conditional() for an if-then-else syntax.
326 * Changing to use new version of show_defines()
328 * Revision 1.13 2001/07/30 22:08:36 jongfoster
329 * Tidying up #defines:
330 * - All feature #defines are now of the form FEATURE_xxx
331 * - Permanently turned off WIN_GUI_EDIT
332 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
334 * Revision 1.12 2001/07/29 18:47:05 jongfoster
335 * Adding missing #include "loadcfg.h"
337 * Revision 1.11 2001/07/18 17:24:37 oes
338 * Changed to conform to new pcrs interface
340 * Revision 1.10 2001/07/13 13:53:13 oes
341 * Removed all #ifdef PCRS and related code
343 * Revision 1.9 2001/06/29 21:45:41 oes
344 * Indentation, CRLF->LF, Tab-> Space
346 * Revision 1.8 2001/06/29 13:21:46 oes
347 * - Cosmetics: renamed and reordered functions, variables,
348 * texts, improved comments etc
350 * - Removed ij_untrusted_url() The relevant
351 * info is now part of the "untrusted" page,
352 * which is generated by filters.c:trust_url()
354 * - Generators of content now call finish_http_response()
355 * themselves, making jcc.c:chat() a little less
358 * - Removed obsolete "Pragma: no-cache" from our headers
360 * - http_responses now know their head length
362 * - fill_template now uses the new interface to pcrs, so that
363 * - long jobs (like whole files) no longer have to be assembled
364 * in a fixed size buffer
365 * - the new T (trivial) option is used, and the replacement may
366 * contain Perl syntax backrefs without confusing pcrs
368 * - Introduced default_exports() which generates a set of exports
369 * common to all CGIs and other content generators
371 * - Introduced convenience function map_block_killer()
373 * - Introduced convenience function make_menu()
375 * - Introduced CGI-like function error_response() which generates
376 * the "No such domain" and "Connect failed" messages using the
379 * - cgi_show_url_info:
380 * - adapted to new CGI features
381 * - form and answers now generated from same template
382 * - http:// prefix in URL now OK
385 * - adapted to new CGI features
386 * - no longer uses csp->init_proxy_args
389 * - moved menu generation to make_menu()
391 * - add_stats now writes single export map entries instead
394 * - Moved redirect_url() to filters.c
396 * - Fixed mem leak in free_http_response(), map_block_killer(),
398 * - Removed logentry from cancelled commit
400 * Revision 1.7 2001/06/09 10:51:58 jongfoster
401 * Changing "show URL info" handler to new style.
402 * Changing BUFSIZ ==> BUFFER_SIZE
404 * Revision 1.6 2001/06/07 23:05:19 jongfoster
405 * Removing code related to old forward and ACL files.
407 * Revision 1.5 2001/06/05 19:59:16 jongfoster
408 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
410 * Revision 1.4 2001/06/04 10:41:52 swa
411 * show version string of cgi.h and cgi.c
413 * Revision 1.3 2001/06/03 19:12:16 oes
414 * introduced new cgi handling
416 * No revisions before 1.3
418 **********************************************************************/
424 #include <sys/types.h>
432 #define snprintf _snprintf
433 #endif /* def _WIN32 */
441 #include "miscutil.h"
442 #include "cgisimple.h"
443 #ifdef FEATURE_CGI_EDIT_ACTIONS
445 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
447 /* loadcfg.h is for global_toggle_state only */
448 #ifdef FEATURE_PTHREAD
451 /* jcc.h is for mutex semaphore globals only */
452 #endif /* def FEATURE_PTHREAD */
453 const char cgi_h_rcs[] = CGI_H_VERSION;
456 * List of CGI functions: name, handler, description
457 * Note: Do NOT use single quotes in the description;
458 * this will break the dynamic "blocked" template!
460 static const struct cgi_dispatcher cgi_dispatchers[] = {
465 #ifdef FEATURE_GRACEFUL_TERMINATION
468 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
469 "this is a one click Denial Of Service attack!!!</em>",
474 #ifdef FEATURE_CGI_EDIT_ACTIONS
475 "View & change the current configuration",
477 "View the current configuration",
482 "View the source code version numbers",
486 "View the request headers.",
490 "Look up which actions apply to a URL and why",
492 #ifdef FEATURE_CGI_EDIT_ACTIONS
495 "Toggle Privoxy on or off",
497 { "edit-actions", /* Edit the actions list */
500 { "eaa", /* Shortcut for edit-actions-add-url-form */
501 cgi_edit_actions_add_url_form,
503 { "eau", /* Shortcut for edit-actions-url-form */
504 cgi_edit_actions_url_form,
506 { "ear", /* Shortcut for edit-actions-remove-url-form */
507 cgi_edit_actions_remove_url_form,
509 { "eafu", /* Shortcut for edit-actions-for-url */
510 cgi_edit_actions_for_url,
512 { "eas", /* Shortcut for edit-actions-submit */
513 cgi_edit_actions_submit,
515 { "easa", /* Shortcut for edit-actions-section-add */
516 cgi_edit_actions_section_add,
518 { "easr", /* Shortcut for edit-actions-section-remove */
519 cgi_edit_actions_section_remove,
521 { "eass", /* Shortcut for edit-actions-section-swap */
522 cgi_edit_actions_section_swap,
524 { "edit-actions-for-url",
525 cgi_edit_actions_for_url,
526 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
527 { "edit-actions-list",
528 cgi_edit_actions_list,
529 NULL, TRUE /* Edit the actions list */ },
530 { "edit-actions-submit",
531 cgi_edit_actions_submit,
532 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
533 { "edit-actions-url",
534 cgi_edit_actions_url,
535 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
536 { "edit-actions-url-form",
537 cgi_edit_actions_url_form,
538 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
539 { "edit-actions-add-url",
540 cgi_edit_actions_add_url,
541 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
542 { "edit-actions-add-url-form",
543 cgi_edit_actions_add_url_form,
544 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
545 { "edit-actions-remove-url",
546 cgi_edit_actions_remove_url,
547 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
548 { "edit-actions-remove-url-form",
549 cgi_edit_actions_remove_url_form,
550 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
551 { "edit-actions-section-add",
552 cgi_edit_actions_section_add,
553 NULL, FALSE /* Remove a section from the actionsfile */ },
554 { "edit-actions-section-remove",
555 cgi_edit_actions_section_remove,
556 NULL, FALSE /* Remove a section from the actionsfile */ },
557 { "edit-actions-section-swap",
558 cgi_edit_actions_section_swap,
559 NULL, FALSE /* Swap two sections in the actionsfile */ },
560 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
563 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
566 NULL, TRUE /* Send a built-in image */ },
569 NULL, TRUE /* Send templates/cgi-style.css */ },
571 cgi_transparent_image,
572 NULL, TRUE /* Send a transparent image (short name) */ },
573 { NULL, /* NULL Indicates end of list and default page */
575 NULL, TRUE /* Unknown CGI page */ }
580 * Bulit-in images for ad replacement
582 * Hint: You can encode your own images like this:
583 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
586 #ifdef FEATURE_NO_GIFS
589 * Checkerboard pattern, as a PNG.
591 const char image_pattern_data[] =
592 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
593 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
594 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
595 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
596 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
597 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
598 "\000\000\000\111\105\116\104\256\102\140\202";
601 * 1x1 transparant PNG.
603 const char image_blank_data[] =
604 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
605 "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236"
606 "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070"
607 "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022"
608 "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115"
609 "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101"
610 "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006"
611 "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110"
612 "\000\000\000\000\111\105\116\104\256\102\140\202";
616 * Checkerboard pattern, as a GIF.
618 const char image_pattern_data[] =
619 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
620 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
621 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
622 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
626 * 1x1 transparant GIF.
628 const char image_blank_data[] =
629 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
630 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
631 "\000\001\000\000\002\002D\001\000;";
634 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
635 const size_t image_blank_length = sizeof(image_blank_data) - 1;
638 static struct http_response cgi_error_memory_response[1];
640 static struct http_response *dispatch_known_cgi(struct client_state * csp,
642 static struct map *parse_cgi_parameters(char *argstring);
645 /*********************************************************************
647 * Function : dispatch_cgi
649 * Description : Checks if a request URL has either the magical
650 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
651 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
652 * http://config.privoxy.org/). If so, it passes
653 * the (rest of the) path onto dispatch_known_cgi, which
654 * calls the relevant CGI handler function.
657 * 1 : csp = Current client state (buffers, headers, etc...)
659 * Returns : http_response if match, NULL if nonmatch or handler fail
661 *********************************************************************/
662 struct http_response *dispatch_cgi(struct client_state *csp)
664 const char *host = csp->http->host;
665 const char *path = csp->http->path;
668 * Should we intercept ?
671 /* Note: "example.com" and "example.com." are equivalent hostnames. */
673 /* Either the host matches CGI_SITE_1_HOST ..*/
674 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
675 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
676 && (path[0] == '/') )
678 /* ..then the path will all be for us. Remove leading '/' */
681 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
682 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
683 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
684 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
686 /* take everything following CGI_SITE_2_PATH */
687 path += strlen(CGI_SITE_2_PATH);
690 /* skip the forward slash after CGI_SITE_2_PATH */
693 else if (*path != '\0')
696 * wierdness: URL is /configXXX, where XXX is some string
697 * Do *NOT* intercept.
709 * This is a CGI call.
712 return dispatch_known_cgi(csp, path);
716 /*********************************************************************
718 * Function : grep_cgi_referrer
720 * Description : Ugly provisorical fix that greps the value of the
721 * referer HTTP header field out of a linked list of
722 * strings like found at csp->headers. Will disappear
725 * FIXME: csp->headers ought to be csp->http->headers
726 * FIXME: Parsing all client header lines should
727 * happen right after the request is received!
730 * 1 : csp = Current client state (buffers, headers, etc...)
732 * Returns : pointer to value (no copy!), or NULL if none found.
734 *********************************************************************/
735 char *grep_cgi_referrer(struct client_state *csp)
737 struct list_entry *p;
739 for (p = csp->headers->first; p != NULL; p = p->next)
741 if (p->str == NULL) continue;
742 if (strncmpic(p->str, "Referer: ", 9) == 0)
744 return ((p->str) + 9);
752 /*********************************************************************
754 * Function : dispatch_known_cgi
756 * Description : Processes a CGI once dispatch_cgi has determined that
757 * it matches one of the magic prefixes. Parses the path
758 * as a cgi name plus query string, prepares a map that
759 * maps CGI parameter names to their values, initializes
760 * the http_response struct, and calls the relevant CGI
764 * 1 : csp = Current client state (buffers, headers, etc...)
765 * 2 : path = Path of CGI, with the CGI prefix removed.
766 * Should not have a leading "/".
768 * Returns : http_response, or NULL on handler failure or out of
771 *********************************************************************/
772 static struct http_response *dispatch_known_cgi(struct client_state * csp,
775 const struct cgi_dispatcher *d;
776 struct map *param_list;
777 struct http_response *rsp;
778 char *query_args_start;
783 if (NULL == (path_copy = strdup(path)))
785 return cgi_error_memory();
788 query_args_start = path_copy;
789 while (*query_args_start && *query_args_start != '?')
793 if (*query_args_start == '?')
795 *query_args_start++ = '\0';
798 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
801 return cgi_error_memory();
806 * path_copy = CGI call name
807 * param_list = CGI params, as map
810 /* Get mem for response or fail*/
811 if (NULL == (rsp = alloc_http_response()))
814 free_map(param_list);
815 return cgi_error_memory();
818 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
819 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
820 csp->ip_addr_str, csp->http->cmd);
823 * Find and start the right CGI function
828 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
831 * If the called CGI is either harmless, or not referred
832 * from an untrusted source, start it.
835 || (NULL == (referrer = grep_cgi_referrer(csp)))
836 || (0 == strncmp(referrer, "http://config.privoxy.org/", 26))
839 err = (d->handler)(csp, rsp, param_list);
844 * Else, modify toggle calls so that they only display
845 * the status, and deny all other calls.
847 if (0 == strcmp(path_copy, "toggle"))
849 unmap(param_list, "set");
850 err = (d->handler)(csp, rsp, param_list);
854 err = cgi_error_404(csp, rsp, param_list);
859 free_map(param_list);
861 if (err == JB_ERR_CGI_PARAMS)
863 err = cgi_error_bad_param(csp, rsp);
865 if (err && (err != JB_ERR_MEMORY))
867 /* Unexpected error! Shouldn't get here */
868 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
869 err = cgi_error_unknown(csp, rsp, err);
874 return finish_http_response(rsp);
878 /* Error in handler, probably out-of-memory */
879 free_http_response(rsp);
880 return cgi_error_memory();
888 /*********************************************************************
890 * Function : parse_cgi_parameters
892 * Description : Parse a URL-encoded argument string into name/value
893 * pairs and store them in a struct map list.
896 * 1 : argstring = string to be parsed. Will be trashed.
898 * Returns : pointer to param list, or NULL if out of memory.
900 *********************************************************************/
901 static struct map *parse_cgi_parameters(char *argstring)
904 char *vector[BUFFER_SIZE];
906 struct map *cgi_params;
908 if (NULL == (cgi_params = new_map()))
914 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
915 * the fragment identifier along with the request, so we must
916 * cut it off here, so it won't pollute the CGI params:
918 if (NULL != (p = strchr(argstring, '#')))
923 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
925 for (i = 0; i < pairs; i++)
927 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
930 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
932 free_map(cgi_params);
943 /*********************************************************************
945 * Function : get_char_param
947 * Description : Get a single-character parameter passed to a CGI
951 * 1 : parameters = map of cgi parameters
952 * 2 : param_name = The name of the parameter to read
954 * Returns : Uppercase character on success, '\0' on error.
956 *********************************************************************/
957 char get_char_param(const struct map *parameters,
958 const char *param_name)
965 ch = *(lookup(parameters, param_name));
966 if ((ch >= 'a') && (ch <= 'z'))
975 /*********************************************************************
977 * Function : get_string_param
979 * Description : Get a string paramater, to be used as an
980 * ACTION_STRING or ACTION_MULTI paramater.
981 * Validates the input to prevent stupid/malicious
982 * users from corrupting their action file.
985 * 1 : parameters = map of cgi parameters
986 * 2 : param_name = The name of the parameter to read
987 * 3 : pparam = destination for paramater. Allocated as
988 * part of the map "parameters", so don't free it.
989 * Set to NULL if not specified.
991 * Returns : JB_ERR_OK on success, or if the paramater
993 * JB_ERR_MEMORY on out-of-memory.
994 * JB_ERR_CGI_PARAMS if the paramater is not valid.
996 *********************************************************************/
997 jb_err get_string_param(const struct map *parameters,
998 const char *param_name,
1011 param = lookup(parameters, param_name);
1017 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1022 * Note that the length limit is arbitrary, it just seems
1023 * sensible to limit it to *something*. There's no
1024 * technical reason for any limit at all.
1026 return JB_ERR_CGI_PARAMS;
1029 /* Check every character to see if it's legal */
1031 while ((ch = *s++) != '\0')
1033 if ( ((unsigned char)ch < (unsigned char)' ')
1036 /* Probable hack attempt, or user accidentally used '}'. */
1037 return JB_ERR_CGI_PARAMS;
1048 /*********************************************************************
1050 * Function : get_number_param
1052 * Description : Get a non-negative integer from the parameters
1053 * passed to a CGI function.
1056 * 1 : csp = Current client state (buffers, headers, etc...)
1057 * 2 : parameters = map of cgi parameters
1058 * 3 : name = Name of CGI parameter to read
1059 * 4 : pvalue = destination for value.
1060 * Set to -1 on error.
1062 * Returns : JB_ERR_OK on success
1063 * JB_ERR_MEMORY on out-of-memory
1064 * JB_ERR_CGI_PARAMS if the parameter was not specified
1067 *********************************************************************/
1068 jb_err get_number_param(struct client_state *csp,
1069 const struct map *parameters,
1084 param = lookup(parameters, name);
1087 return JB_ERR_CGI_PARAMS;
1090 /* We don't use atoi because I want to check this carefully... */
1093 while ((ch = *param++) != '\0')
1095 if ((ch < '0') || (ch > '9'))
1097 return JB_ERR_CGI_PARAMS;
1104 * <limits.h> defines UINT_MAX
1106 * (UINT_MAX - ch) / 10 is the largest number that
1107 * can be safely multiplied by 10 then have ch added.
1109 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1111 return JB_ERR_CGI_PARAMS;
1114 value = value * 10 + ch;
1125 /*********************************************************************
1127 * Function : error_response
1129 * Description : returns an http_response that explains the reason
1130 * why a request failed.
1133 * 1 : csp = Current client state (buffers, headers, etc...)
1134 * 2 : templatename = Which template should be used for the answer
1135 * 3 : sys_err = system error number
1137 * Returns : A http_response. If we run out of memory, this
1138 * will be cgi_error_memory().
1140 *********************************************************************/
1141 struct http_response *error_response(struct client_state *csp,
1142 const char *templatename,
1146 struct http_response *rsp;
1147 struct map * exports = default_exports(csp, NULL);
1148 if (exports == NULL)
1150 return cgi_error_memory();
1153 if (NULL == (rsp = alloc_http_response()))
1156 return cgi_error_memory();
1159 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1160 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1161 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1162 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1163 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1166 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1169 /* Some failures, like "404 no such domain", don't have an IP address. */
1170 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1178 free_http_response(rsp);
1179 return cgi_error_memory();
1182 if (!strcmp(templatename, "no-such-domain"))
1184 rsp->status = strdup("404 No such domain");
1185 if (rsp->status == NULL)
1188 free_http_response(rsp);
1189 return cgi_error_memory();
1192 else if (!strcmp(templatename, "connect-failed"))
1194 rsp->status = strdup("503 Connect failed");
1195 if (rsp->status == NULL)
1198 free_http_response(rsp);
1199 return cgi_error_memory();
1203 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1206 free_http_response(rsp);
1207 return cgi_error_memory();
1210 return finish_http_response(rsp);
1214 /*********************************************************************
1216 * Function : cgi_init_error_messages
1218 * Description : Call at the start of the program to initialize
1219 * the error message used by cgi_error_memory().
1225 *********************************************************************/
1226 void cgi_init_error_messages(void)
1228 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1229 cgi_error_memory_response->head =
1230 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1231 "Content-Type: text/html\r\n"
1233 cgi_error_memory_response->body =
1235 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1237 "<h1>500 Internal Privoxy Error</h1>\r\n"
1238 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1239 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1243 cgi_error_memory_response->head_length =
1244 strlen(cgi_error_memory_response->head);
1245 cgi_error_memory_response->content_length =
1246 strlen(cgi_error_memory_response->body);
1250 /*********************************************************************
1252 * Function : cgi_error_memory
1254 * Description : Called if a CGI function runs out of memory.
1255 * Returns a statically-allocated error response.
1259 * Returns : http_response data structure for output. This is
1260 * statically allocated, for obvious reasons.
1262 *********************************************************************/
1263 struct http_response *cgi_error_memory(void)
1265 /* assert that it's been initialized. */
1266 assert(cgi_error_memory_response->head);
1268 return cgi_error_memory_response;
1272 /*********************************************************************
1274 * Function : cgi_error_no_template
1276 * Description : Almost-CGI function that is called if a template
1277 * cannot be loaded. Note this is not a true CGI,
1278 * it takes a template name rather than a map of
1282 * 1 : csp = Current client state (buffers, headers, etc...)
1283 * 2 : rsp = http_response data structure for output
1284 * 3 : template_name = Name of template that could not
1287 * Returns : JB_ERR_OK on success
1288 * JB_ERR_MEMORY on out-of-memory error.
1290 *********************************************************************/
1291 jb_err cgi_error_no_template(struct client_state *csp,
1292 struct http_response *rsp,
1293 const char *template_name)
1295 static const char status[] =
1296 "500 Internal Privoxy Error";
1297 static const char body_prefix[] =
1299 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1301 "<h1>500 Internal Privoxy Error</h1>\r\n"
1302 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1303 "<p><b>Could not load template file <code>";
1304 static const char body_suffix[] =
1305 "</code> or one of it's included components.</b></p>\r\n"
1306 "<p>Please contact your proxy administrator.</p>\r\n"
1307 "<p>If you are the proxy administrator, please put the required file(s)"
1308 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1309 "location of the <code><i>(confdir)</i></code> directory "
1310 "is specified in the main Privoxy <code>config</code> "
1311 "file. (It's typically the Privoxy install directory"
1313 ", or <code>/etc/privoxy/</code>"
1314 #endif /* ndef _WIN32 */
1321 assert(template_name);
1323 /* Reset rsp, if needed */
1327 rsp->content_length = 0;
1328 rsp->head_length = 0;
1331 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1332 if (rsp->body == NULL)
1334 return JB_ERR_MEMORY;
1336 strcpy(rsp->body, body_prefix);
1337 strcat(rsp->body, template_name);
1338 strcat(rsp->body, body_suffix);
1340 rsp->status = strdup(status);
1341 if (rsp->body == NULL)
1343 return JB_ERR_MEMORY;
1350 /*********************************************************************
1352 * Function : cgi_error_unknown
1354 * Description : Almost-CGI function that is called if an unexpected
1355 * error occurs in the top-level CGI dispatcher.
1356 * In this context, "unexpected" means "anything other
1357 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1358 * expected to handle all other errors internally,
1359 * since they can give more relavent error messages
1362 * Note this is not a true CGI, it takes an error
1363 * code rather than a map of parameters.
1366 * 1 : csp = Current client state (buffers, headers, etc...)
1367 * 2 : rsp = http_response data structure for output
1368 * 3 : error_to_report = Error code to report.
1370 * Returns : JB_ERR_OK on success
1371 * JB_ERR_MEMORY on out-of-memory error.
1373 *********************************************************************/
1374 jb_err cgi_error_unknown(struct client_state *csp,
1375 struct http_response *rsp,
1376 jb_err error_to_report)
1378 static const char status[] =
1379 "500 Internal Privoxy Error";
1380 static const char body_prefix[] =
1382 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1384 "<h1>500 Internal Privoxy Error</h1>\r\n"
1385 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1386 "<p><b>Unexpected internal error: ";
1387 static const char body_suffix[] =
1390 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1391 "file a bug report</a>.</p>\r\n"
1398 /* Reset rsp, if needed */
1402 rsp->content_length = 0;
1403 rsp->head_length = 0;
1406 sprintf(errnumbuf, "%d", error_to_report);
1408 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1409 if (rsp->body == NULL)
1411 return JB_ERR_MEMORY;
1413 strcpy(rsp->body, body_prefix);
1414 strcat(rsp->body, errnumbuf);
1415 strcat(rsp->body, body_suffix);
1417 rsp->status = strdup(status);
1418 if (rsp->body == NULL)
1420 return JB_ERR_MEMORY;
1427 /*********************************************************************
1429 * Function : cgi_error_bad_param
1431 * Description : CGI function that is called if the parameters
1432 * (query string) for a CGI were wrong.
1435 * 1 : csp = Current client state (buffers, headers, etc...)
1436 * 2 : rsp = http_response data structure for output
1438 * CGI Parameters : none
1440 * Returns : JB_ERR_OK on success
1441 * JB_ERR_MEMORY on out-of-memory error.
1443 *********************************************************************/
1444 jb_err cgi_error_bad_param(struct client_state *csp,
1445 struct http_response *rsp)
1447 struct map *exports;
1452 if (NULL == (exports = default_exports(csp, NULL)))
1454 return JB_ERR_MEMORY;
1457 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1461 /*********************************************************************
1463 * Function : add_help_link
1465 * Description : Produce a copy of the string given as item,
1466 * embedded in an HTML link to its corresponding
1467 * section (item name in uppercase) in the actions
1468 * chapter of the user manual, (whose URL is given in
1469 * the config and defaults to our web site).
1471 * FIXME: I currently only work for actions, and would
1472 * like to be generalized for other topics.
1475 * 1 : item = item (will NOT be free()d.)
1476 * It is assumed to be HTML-safe.
1477 * 2 : config = The current configuration.
1479 * Returns : String with item embedded in link, or NULL on
1482 *********************************************************************/
1483 char *add_help_link(const char *item,
1484 struct configuration_spec *config)
1488 if (!item) return NULL;
1490 result = strdup("<a href=\"");
1491 string_append(&result, config->usermanual);
1492 string_append(&result, ACTIONS_HELP_PREFIX);
1493 string_join (&result, string_toupper(item));
1494 string_append(&result, "\">");
1495 string_append(&result, item);
1496 string_append(&result, "</a> ");
1502 /*********************************************************************
1504 * Function : get_http_time
1506 * Description : Get the time in a format suitable for use in a
1507 * HTTP header - e.g.:
1508 * "Sun, 06 Nov 1994 08:49:37 GMT"
1511 * 1 : time_offset = Time returned will be current time
1512 * plus this number of seconds.
1513 * 2 : buf = Destination for result. Must be long enough
1514 * to hold 29 characters plus a trailing zero.
1518 *********************************************************************/
1519 void get_http_time(int time_offset, char *buf)
1521 static const char day_names[7][4] =
1522 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1523 static const char month_names[12][4] =
1524 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1525 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1528 time_t current_time;
1529 #ifdef HAVE_GMTIME_R
1531 * Declare dummy up here (instead of inside get/set gmt block) so it
1532 * doesn't go out of scope before it's potentially used in snprintf later.
1533 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1534 * !defined HAVE_GMTIME_R.
1541 time(¤t_time); /* get current time */
1543 current_time += time_offset;
1545 /* get and save the gmt */
1548 pthread_mutex_lock(&gmtime_mutex);
1549 t = gmtime(¤t_time);
1550 pthread_mutex_unlock(&gmtime_mutex);
1552 t = gmtime_r(¤t_time, &dummy);
1554 t = gmtime(¤t_time);
1558 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1560 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1561 day_names[t->tm_wday],
1563 month_names[t->tm_mon],
1573 /*********************************************************************
1575 * Function : finish_http_response
1577 * Description : Fill in the missing headers in an http response,
1578 * and flatten the headers to an http head.
1581 * 1 : rsp = pointer to http_response to be processed
1583 * Returns : A http_response, usually the rsp parameter.
1584 * On error, free()s rsp and returns cgi_error_memory()
1586 *********************************************************************/
1587 struct http_response *finish_http_response(struct http_response *rsp)
1589 char buf[BUFFER_SIZE];
1592 /* Special case - do NOT change this statically allocated response,
1593 * which is ready for output anyway.
1595 if (rsp == cgi_error_memory_response)
1601 * Fill in the HTTP Status
1603 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1604 err = enlist_first(rsp->headers, buf);
1607 * Set the Content-Length
1609 if (rsp->content_length == 0)
1611 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1615 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1616 err = enlist(rsp->headers, buf);
1620 * Fill in the default headers:
1622 * Content-Type: default to text/html if not already specified.
1623 * Date: set to current date/time.
1624 * Last-Modified: set to date/time the page was last changed.
1625 * Expires: set to date/time page next needs reloading.
1626 * Cache-Control: set to "no-cache" if applicable.
1628 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1630 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1635 * Set Expires to about 10 min into the future so it'll get reloaded
1636 * occasionally, e.g. if Privoxy gets upgraded.
1641 get_http_time(0, buf);
1642 err = enlist_unique_header(rsp->headers, "Date", buf);
1645 /* Some date in the past. */
1646 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1650 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1651 err = enlist_unique_header(rsp->headers, "Expires", buf);
1657 * Compliant browsers should not cache this due to the "Cache-Control"
1658 * setting. However, to be certain, we also set both "Last-Modified"
1659 * and "Expires" to the current time.
1661 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1663 get_http_time(0, buf);
1664 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1665 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1666 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1673 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1675 free_http_response(rsp);
1676 return cgi_error_memory();
1678 rsp->head_length = strlen(rsp->head);
1685 /*********************************************************************
1687 * Function : alloc_http_response
1689 * Description : Allocates a new http_response structure.
1693 * Returns : pointer to a new http_response, or NULL.
1695 *********************************************************************/
1696 struct http_response *alloc_http_response(void)
1698 return (struct http_response *) zalloc(sizeof(struct http_response));
1703 /*********************************************************************
1705 * Function : free_http_response
1707 * Description : Free the memory occupied by an http_response
1708 * and its depandant structures.
1711 * 1 : rsp = pointer to http_response to be freed
1715 *********************************************************************/
1716 void free_http_response(struct http_response *rsp)
1719 * Must special case cgi_error_memory_response, which is never freed.
1721 if (rsp && (rsp != cgi_error_memory_response))
1726 destroy_list(rsp->headers);
1733 /*********************************************************************
1735 * Function : template_load
1737 * Description : CGI support function that loads a given HTML
1738 * template from the confdir, ignoring comment
1739 * lines and following #include statements up to
1743 * 1 : csp = Current client state (buffers, headers, etc...)
1744 * 2 : template_ptr = Destination for pointer to loaded
1746 * 3 : templatename = name of the HTML template to be used
1747 * 4 : recursive = Flag set if this function calls itself
1748 * following an #include statament
1750 * Returns : JB_ERR_OK on success
1751 * JB_ERR_MEMORY on out-of-memory error.
1752 * JB_ERR_FILE if the template file cannot be read
1754 *********************************************************************/
1755 jb_err template_load(struct client_state *csp, char **template_ptr,
1756 const char *templatename, int recursive)
1759 char *templates_dir_path;
1762 char *included_module;
1765 char buf[BUFFER_SIZE];
1768 assert(template_ptr);
1769 assert(templatename);
1771 *template_ptr = NULL;
1773 /* Validate template name. Paranoia. */
1774 for (p = templatename; *p != 0; p++)
1776 if ( ((*p < 'a') || (*p > 'z'))
1777 && ((*p < 'A') || (*p > 'Z'))
1778 && ((*p < '0') || (*p > '9'))
1782 /* Illegal character */
1787 /* Generate full path */
1789 templates_dir_path = make_path(csp->config->confdir, "templates");
1790 if (templates_dir_path == NULL)
1792 return JB_ERR_MEMORY;
1795 full_path = make_path(templates_dir_path, templatename);
1796 free(templates_dir_path);
1797 if (full_path == NULL)
1799 return JB_ERR_MEMORY;
1802 /* Allocate buffer */
1804 file_buffer = strdup("");
1805 if (file_buffer == NULL)
1808 return JB_ERR_MEMORY;
1811 /* Open template file */
1813 if (NULL == (fp = fopen(full_path, "r")))
1815 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1823 * Read the file, ignoring comments, and honoring #include
1824 * statements, unless we're already called recursively.
1826 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1827 * This is unlikely in practise.
1829 while (fgets(buf, BUFFER_SIZE, fp))
1831 if (!recursive && !strncmp(buf, "#include ", 9))
1833 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1840 if (string_join(&file_buffer, included_module))
1843 return JB_ERR_MEMORY;
1849 /* skip lines starting with '#' */
1855 if (string_append(&file_buffer, buf))
1858 return JB_ERR_MEMORY;
1863 *template_ptr = file_buffer;
1869 /*********************************************************************
1871 * Function : template_fill
1873 * Description : CGI support function that fills in a pre-loaded
1874 * HTML template by replacing @name@ with value using
1875 * pcrs, for each item in the output map.
1877 * Note that a leading '$' charachter in the export map's
1878 * values will be stripped and toggle on backreference
1882 * 1 : template_ptr = IN: Template to be filled out.
1884 * OUT: Filled out template.
1885 * Caller must free().
1886 * 2 : exports = map with fill in symbol -> name pairs
1888 * Returns : JB_ERR_OK on success
1889 * JB_ERR_MEMORY on out-of-memory error
1891 *********************************************************************/
1892 jb_err template_fill(char **template_ptr, const struct map *exports)
1894 struct map_entry *m;
1896 char buf[BUFFER_SIZE];
1897 char *tmp_out_buffer;
1903 assert(template_ptr);
1904 assert(*template_ptr);
1907 file_buffer = *template_ptr;
1908 size = strlen(file_buffer) + 1;
1911 * Assemble pcrs joblist from exports map
1913 for (m = exports->first; m != NULL; m = m->next)
1915 if (*m->name == '$')
1918 * First character of name is '$', so remove this flag
1919 * character and allow backreferences ($1 etc) in the
1920 * "replace with" text.
1922 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1928 * Treat the "replace with" text as a literal string -
1929 * no quoting needed, no backreferences allowed.
1930 * ("Trivial" ['T'] flag).
1934 /* Enclose name in @@ */
1935 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1939 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
1941 /* Make and run job. */
1942 job = pcrs_compile(buf, m->value, flags, &error);
1945 if (error == PCRS_ERR_NOMEM)
1948 *template_ptr = NULL;
1949 return JB_ERR_MEMORY;
1953 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
1954 /* Hope it wasn't important and silently ignore the invalid job */
1959 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
1962 if (NULL == tmp_out_buffer)
1964 *template_ptr = NULL;
1965 return JB_ERR_MEMORY;
1967 file_buffer = tmp_out_buffer;
1974 *template_ptr = file_buffer;
1979 /*********************************************************************
1981 * Function : template_fill_for_cgi
1983 * Description : CGI support function that loads a HTML template
1984 * and fills it in. Handles file-not-found errors
1985 * by sending a HTML error message. For convenience,
1986 * this function also frees the passed "exports" map.
1989 * 1 : csp = Client state
1990 * 2 : templatename = name of the HTML template to be used
1991 * 3 : exports = map with fill in symbol -> name pairs.
1992 * Will be freed by this function.
1993 * 4 : rsp = Response structure to fill in.
1995 * Returns : JB_ERR_OK on success
1996 * JB_ERR_MEMORY on out-of-memory error
1998 *********************************************************************/
1999 jb_err template_fill_for_cgi(struct client_state *csp,
2000 const char *templatename,
2001 struct map *exports,
2002 struct http_response *rsp)
2007 assert(templatename);
2011 err = template_load(csp, &rsp->body, templatename, 0);
2012 if (err == JB_ERR_FILE)
2015 return cgi_error_no_template(csp, rsp, templatename);
2020 return err; /* JB_ERR_MEMORY */
2022 err = template_fill(&rsp->body, exports);
2028 /*********************************************************************
2030 * Function : default_exports
2032 * Description : returns a struct map list that contains exports
2033 * which are common to all CGI functions.
2036 * 1 : csp = Current client state (buffers, headers, etc...)
2037 * 2 : caller = name of CGI who calls us and which should
2038 * be excluded from the generated menu. May be
2040 * Returns : NULL if no memory, else a new map. Caller frees.
2042 *********************************************************************/
2043 struct map *default_exports(const struct client_state *csp, const char *caller)
2047 struct map * exports;
2048 int local_help_exists = 0;
2052 exports = new_map();
2053 if (exports == NULL)
2058 err = map(exports, "version", 1, html_encode(VERSION), 0);
2059 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2060 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2061 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2062 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2063 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
2064 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2065 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2066 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2067 #ifdef FEATURE_TOGGLE
2068 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2070 if (!err) err = map_block_killer(exports, "can-toggle");
2073 snprintf(buf, 20, "%d", csp->config->hport);
2074 if (!err) err = map(exports, "my-port", 1, buf, 1);
2076 if(!strcmp(CODE_STATUS, "stable"))
2078 if (!err) err = map_block_killer(exports, "unstable");
2081 if (csp->config->admin_address != NULL)
2083 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2084 local_help_exists = 1;
2088 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2091 if (csp->config->proxy_info_url != NULL)
2093 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2094 local_help_exists = 1;
2098 if (!err) err = map_block_killer(exports, "have-proxy-info");
2101 if (local_help_exists == 0)
2103 if (!err) err = map_block_killer(exports, "have-help-info");
2116 /*********************************************************************
2118 * Function : map_block_killer
2120 * Description : Convenience function.
2121 * Adds a "killer" for the conditional HTML-template
2122 * block <name>, i.e. a substitution of the regex
2123 * "if-<name>-start.*if-<name>-end" to the given
2127 * 1 : exports = map to extend
2128 * 2 : name = name of conditional block
2130 * Returns : JB_ERR_OK on success
2131 * JB_ERR_MEMORY on out-of-memory error.
2133 *********************************************************************/
2134 jb_err map_block_killer(struct map *exports, const char *name)
2136 char buf[1000]; /* Will do, since the names are hardwired */
2140 assert(strlen(name) < 490);
2142 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2143 return map(exports, buf, 1, "", 1);
2147 /*********************************************************************
2149 * Function : map_block_keep
2151 * Description : Convenience function. Removes the markers used
2152 * by map-block-killer, to save a few bytes.
2153 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2156 * 1 : exports = map to extend
2157 * 2 : name = name of conditional block
2159 * Returns : JB_ERR_OK on success
2160 * JB_ERR_MEMORY on out-of-memory error.
2162 *********************************************************************/
2163 jb_err map_block_keep(struct map *exports, const char *name)
2166 char buf[500]; /* Will do, since the names are hardwired */
2170 assert(strlen(name) < 490);
2172 snprintf(buf, 500, "if-%s-start", name);
2173 err = map(exports, buf, 1, "", 1);
2180 snprintf(buf, 500, "if-%s-end", name);
2181 return map(exports, buf, 1, "", 1);
2185 /*********************************************************************
2187 * Function : map_conditional
2189 * Description : Convenience function.
2190 * Adds an "if-then-else" for the conditional HTML-template
2191 * block <name>, i.e. a substitution of the form:
2198 * The control structure and one of the alternatives
2202 * 1 : exports = map to extend
2203 * 2 : name = name of conditional block
2204 * 3 : choose_first = nonzero for first, zero for second.
2206 * Returns : JB_ERR_OK on success
2207 * JB_ERR_MEMORY on out-of-memory error.
2209 *********************************************************************/
2210 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2212 char buf[1000]; /* Will do, since the names are hardwired */
2217 assert(strlen(name) < 480);
2219 snprintf(buf, 1000, (choose_first
2220 ? "else-not-%s@.*@endif-%s"
2221 : "if-%s-then@.*@else-not-%s"),
2224 err = map(exports, buf, 1, "", 1);
2230 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2231 return map(exports, buf, 1, "", 1);
2235 /*********************************************************************
2237 * Function : make_menu
2239 * Description : Returns an HTML-formatted menu of the available
2240 * unhidden CGIs, excluding the one given in <self>
2242 * Parameters : self = name of CGI to leave out, can be NULL for
2245 * Returns : menu string, or NULL on out-of-memory error.
2247 *********************************************************************/
2248 char *make_menu(const char *self)
2250 const struct cgi_dispatcher *d;
2251 char *result = strdup("");
2255 self = "NO-SUCH-CGI!";
2258 /* List available unhidden CGI's and export as "other-cgis" */
2259 for (d = cgi_dispatchers; d->name; d++)
2261 if (d->description && strcmp(d->name, self))
2263 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2264 string_append(&result, d->name);
2265 string_append(&result, "\">");
2266 string_append(&result, d->description);
2267 string_append(&result, "</a></li>");
2275 /*********************************************************************
2277 * Function : dump_map
2279 * Description : HTML-dump a map for debugging (as table)
2282 * 1 : the_map = map to dump
2284 * Returns : string with HTML
2286 *********************************************************************/
2287 char *dump_map(const struct map *the_map)
2289 struct map_entry *cur_entry;
2290 char *ret = strdup("");
2292 string_append(&ret, "<table>\n");
2294 for (cur_entry = the_map->first;
2295 (cur_entry != NULL) && (ret != NULL);
2296 cur_entry = cur_entry->next)
2298 string_append(&ret, "<tr><td><b>");
2299 string_join (&ret, html_encode(cur_entry->name));
2300 string_append(&ret, "</b></td><td>");
2301 string_join (&ret, html_encode(cur_entry->value));
2302 string_append(&ret, "</td></tr>\n");
2305 string_append(&ret, "</table>\n");