1 const char cgi_rcs[] = "$Id: cgi.c,v 1.104 2008/03/26 18:07:06 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
6 * Purpose : Declares functions to intercept request, generate
7 * html or gif answers, and to compose HTTP resonses.
8 * This only contains the framework functions, the
9 * actual handler functions are declared elsewhere.
11 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001-2004, 2006-2007
15 * the SourceForge 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.104 2008/03/26 18:07:06 fabiankeil
42 * Add hostname directive. Closes PR#1918189.
44 * Revision 1.103 2008/03/21 11:13:57 fabiankeil
45 * Only gather host information if it's actually needed.
46 * Also move the code out of accept_connection() so it's less likely
47 * to delay other incoming connections if the host is misconfigured.
49 * Revision 1.102 2008/02/23 16:33:43 fabiankeil
50 * Let forward_url() use the standard parameter ordering
51 * and mark its second parameter immutable.
53 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
54 * Add SOCKS5 support for "Forwarding failure" CGI page.
56 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
57 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
60 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
61 * #1763173 from Stefan Huehner: declare some more functions static.
63 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
64 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
66 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
67 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
69 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
70 * Use sizeof() more often.
72 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
73 * Don't overlook map result for the forwarding-type.
75 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
76 * Use a transparent background for the PNG replacement pattern.
78 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
79 * - Save the reason for generating http_responses.
80 * - Fix --disable-toggle (again).
81 * - Use TBL birthday hack for 403 responses as well.
82 * - Uglify the @menu@ again to fix JavaScript
83 * errors on the "blocked" template.
84 * - Escape an ampersand in cgi_error_unknown().
86 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
87 * - Add HEAD support to finish_http_response.
88 * - Add error favicon to internal HTML error messages.
90 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
91 * Add new config option "templdir" to
92 * change the templates directory.
94 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
95 * Added "forwarding-failed" template support for error_response().
97 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
98 * Add favicon delivery functions.
100 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
101 * - Map variables that aren't guaranteed to be
102 * pure ASCII html_encoded.
103 * - Use CGI_PREFIX to generate URL for user manual
104 * CGI page to make sure CGI_SITE_2_PATH is included.
106 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
107 * - "Protect" against a rather lame JavaScript-based
108 * Privoxy detection "attack" and check the referrer
109 * before delivering the CGI style sheet.
110 * - Move referrer check for unsafe CGI pages into
111 * referrer_is_safe() and log the result.
112 * - Map @url@ in cgi-error-disabled page.
113 * It's required for the "go there anyway" link.
114 * - Mark *csp as immutable for grep_cgi_referrer().
116 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
117 * Fix strdup() error handling in cgi_error_unknown()
118 * and cgi_error_no_template(). Reported by Markus Elfring.
120 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
121 * Handle pcrs_execute() errors in template_fill() properly.
123 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
124 * Fixed gcc43 conversion warnings and replaced sprintf
125 * calls with snprintf to give OpenBSD's gcc one less reason
128 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
129 * Escape ampersand in Privoxy menu.
131 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
132 * Suppress the toggle link if remote toggling is disabled.
134 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
135 * Fix configure option --disable-toggle.
136 * Thanks to Peter Thoenen for reporting this.
138 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
139 * Don't lose the FORCE_PREFIX in case of
140 * connection problems. Fixes #612235.
142 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
143 * Make pthread mutex locking more generic. Instead of
144 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
145 * and use mutex locking unless there is an _r function
146 * available. Better safe than sorry.
148 * Fixes "./configure --disable-pthread" and should result
149 * in less threading-related problems on pthread-using platforms,
150 * but it still doesn't fix BR#1122404.
152 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
153 * Use CGI_PREFIX to check the referrer.
154 * The check for "http://config.privoxy.org/" fails
155 * if the user modified CGI_SITE_2_HOST.
157 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
158 * Adjusted headers for Privoxy's cgi responses:
159 * Don't set Last-Modified, Expires and Cache-Control
160 * headers for redirects; always set "Connection: close".
162 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
163 * Only predate the Last-Modified header for cgi responses
164 * that are delivered with status code 404 or 503.
166 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
167 * Mark cgi_send_user_manual as harmless,
168 * to fix the access denied problem Hal spotted.
169 * The manual has no secret content, therefore we
170 * don't have to care about "secure" referrers.
172 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
173 * Incorporate modified version of Roland Rosenfeld's patch to
174 * optionally access the user-manual via Privoxy. Closes patch 679075.
176 * Formatting changed to Privoxy style, added call to
177 * cgi_error_no_template if the requested file doesn't
178 * exist and modified check whether or not Privoxy itself
179 * should serve the manual. Should work cross-platform now.
181 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
182 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
184 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
185 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
186 * with what was really the latest development (the v_3_0_branch branch)
188 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
189 * Moved cgi_error_disabled() from cgiedit.c to
190 * cgi.c to re-enable build with --disable-editor.
191 * Fixes Bug #892744. Thanks to Matthew Fischer
194 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
195 * - Added new function cgi_redirect to handle creation of
196 * HTTP redirect messages formerly repeated in the code.
197 * - Send cgi_error_disabled instead of cgi_error_404 when
198 * referrer check fails
199 * - Dynamic content now gets Expires header field with date
202 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
203 * Bugfix: Transparent PNG was not transparent. Thanks to
204 * Dan Razzell of Starfish Systems for notice and new PNG.
206 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
207 * Security fix: dspatch_known_cgi no longer considers an empty
208 * referrer safe for critical CGIs, since malicious links could
209 * reside on https:// locations which browsers don't advertize as
210 * referrers. Closes bug #749916, thanks to Jeff Epler for the
211 * hint. Goodbye One-Click[tm] toggling :-(
213 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
216 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
217 * Killed a compiler warning on OSX
219 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
220 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
221 * (fixes bug #710056)
222 * - Show toggle info only if we have it
224 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
225 * Move declaration of struct tm dummy outside of a control block so it is
226 * accessible later on during snprintf in get_http_time.
228 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
229 * Cosmetic: Renamed cryptic variable
231 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
232 * 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.
234 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
235 * Disable access to critical CGIs via untrusted referrers.
236 * This prevents users from being tricked by malicious websites
237 * into making unintentional configuration changes:
239 * - Added flag to each cgi_dispatcher that allows or denies
241 * - Introduced proviorical function that greps for the
242 * referrer header before regular header parsing happens
243 * - Added safety check to dispatch_known_cgi. CGI is called
244 * if (cgi harmless || no referrer || we are referrer).
245 * Else a) toggle calls are modified not to change status and
246 * b) all other calls are denied.
248 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
249 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
251 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
252 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
254 * Revision 1.70 2002/05/19 11:33:20 jongfoster
255 * If a CGI error was not handled, and propogated back to
256 * dispatch_known_cgi(), then it was assumed to be "out of memory".
257 * This gave a very misleading error message.
259 * Now other errors will cause a simple message giving the error
260 * number and asking the user to report a bug.
263 * http://sourceforge.net/tracker/index.php?func=detail
264 * &aid=557905&group_id=11118&atid=111118
266 * Revision 1.69 2002/05/14 21:28:40 oes
267 * - Fixed add_help_link to link to the (now split) actions
268 * part of the config chapter
269 * - Renamed helplink export to actions-help-prefix
271 * Revision 1.68 2002/05/12 21:36:29 jongfoster
272 * Correcting function comments
274 * Revision 1.67 2002/04/30 12:02:07 oes
275 * Nit: updated a comment
277 * Revision 1.66 2002/04/26 18:32:57 jongfoster
278 * Fixing a memory leak on error
280 * Revision 1.65 2002/04/26 12:53:51 oes
281 * - New function add_help_link
282 * - default_exports now exports links to the user manual
283 * and a prefix for links into the config chapter
285 * Revision 1.64 2002/04/24 02:17:21 oes
286 * - Better descriptions for CGIs
287 * - Hide edit-actions, more shortcuts
288 * - Moved get_char_param, get_string_param and get_number_param here
291 * Revision 1.63 2002/04/15 19:06:43 jongfoster
294 * Revision 1.62 2002/04/10 19:59:46 jongfoster
295 * Fixes to #include in templates:
296 * - Didn't close main file if loading an included template fails.
297 * - I'm paranoid and want to disallow "#include /etc/passwd".
299 * Revision 1.61 2002/04/10 13:37:48 oes
300 * Made templates modular: template_load now recursive with max depth 1
302 * Revision 1.60 2002/04/08 20:50:25 swa
305 * Revision 1.59 2002/04/05 15:51:51 oes
306 * - added send-stylesheet CGI
307 * - bugfix: error-pages now get correct request protocol
309 * - kludged CGI descriptions and menu not to break JS syntax
311 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
312 * Fix Mac OSX compiler warnings
314 * Revision 1.57 2002/03/26 22:29:54 swa
315 * we have a new homepage!
317 * Revision 1.56 2002/03/24 17:50:46 jongfoster
318 * Fixing compile error if actions file editor disabled
320 * Revision 1.55 2002/03/24 16:55:06 oes
321 * Making GIF checkerboard transparent
323 * Revision 1.54 2002/03/24 16:18:15 jongfoster
326 * Revision 1.53 2002/03/24 16:06:00 oes
327 * Correct transparency for checkerboard PNG. Thanks, Magnus!
329 * Revision 1.52 2002/03/24 15:23:33 jongfoster
332 * Revision 1.51 2002/03/24 13:25:43 swa
333 * name change related issues
335 * Revision 1.50 2002/03/16 23:54:06 jongfoster
336 * Adding graceful termination feature, to help look for memory leaks.
337 * If you enable this (which, by design, has to be done by hand
338 * editing config.h) and then go to http://i.j.b/die, then the program
339 * will exit cleanly after the *next* request. It should free all the
340 * memory that was used.
342 * Revision 1.49 2002/03/13 00:27:04 jongfoster
345 * Revision 1.48 2002/03/08 17:47:07 jongfoster
348 * Revision 1.47 2002/03/08 16:41:33 oes
349 * Added GIF images again
351 * Revision 1.46 2002/03/07 03:48:38 oes
352 * - Changed built-in images from GIF to PNG
353 * (with regard to Unisys patent issue)
354 * - Added a 4x4 pattern PNG which is less intrusive
355 * than the logo but also clearly marks the deleted banners
357 * Revision 1.45 2002/03/06 22:54:35 jongfoster
358 * Automated function-comment nitpicking.
360 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
361 * - Better error reporting on OS/2
362 * - Fix double-slash comment (oops)
364 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
365 * - Re-enable OS/2 building after new parms were added
366 * - Fix false out of memory report when resolving CGI templates when no IP
367 * address is available of failed attempt (a la no such domain)
369 * Revision 1.42 2002/01/21 00:33:20 jongfoster
370 * Replacing strsav() with the safer string_append() or string_join().
371 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
372 * Adding missing html_encode() to error message generators.
373 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
375 * Revision 1.41 2002/01/17 20:56:22 jongfoster
376 * Replacing hard references to the URL of the config interface
377 * with #defines from project.h
379 * Revision 1.40 2002/01/09 14:26:46 oes
380 * Added support for thread-safe gmtime_r call.
382 * Revision 1.39 2001/11/16 00:48:13 jongfoster
383 * Fixing a compiler warning
385 * Revision 1.38 2001/11/13 00:31:21 jongfoster
386 * - Adding new CGIs for use by non-JavaScript browsers:
387 * edit-actions-url-form
388 * edit-actions-add-url-form
389 * edit-actions-remove-url-form
390 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
393 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
394 * Show enablement/disablement status in almost all templates.
395 * There is a little trickiness here: apparent recursive resolution of
396 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
397 * the actual enablement status. So a similar construct,
398 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
401 * Revision 1.36 2001/10/26 17:33:27 oes
404 * Revision 1.35 2001/10/23 21:48:19 jongfoster
405 * Cleaning up error handling in CGI functions - they now send back
406 * a HTML error page and should never cause a FATAL error. (Fixes one
407 * potential source of "denial of service" attacks).
409 * CGI actions file editor that works and is actually useful.
411 * Ability to toggle Junkbuster remotely using a CGI call.
413 * You can turn off both the above features in the main configuration
414 * file, e.g. if you are running a multi-user proxy.
416 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
417 * Only show "Local support" on templates conditionally:
418 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
419 * - if not, no Local support section appears
421 * Revision 1.33 2001/10/14 22:28:41 jongfoster
422 * Fixing stupid typo.
424 * Revision 1.32 2001/10/14 22:20:18 jongfoster
425 * - Changes to CGI dispatching method to match CGI names exactly,
426 * rather than doing a prefix match.
427 * - No longer need to count the length of the CGI handler names by hand.
428 * - Adding new handler for 404 error when disptching a CGI, if none of
429 * the handlers match.
430 * - Adding new handlers for CGI actionsfile editor.
432 * Revision 1.31 2001/10/10 10:56:39 oes
433 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
435 * Revision 1.30 2001/10/02 15:30:57 oes
436 * Introduced show-request cgi
438 * Revision 1.29 2001/09/20 15:47:44 steudten
440 * Fix BUG: Modify int size to size_t size in fill_template()
441 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
443 * Revision 1.28 2001/09/19 18:00:37 oes
444 * - Deletef time() FIXME (Can't fail under Linux either, if
445 * the argument is guaranteed to be in out address space,
448 * - Pointer notation cosmetics
449 * - Fixed a minor bug in template_fill(): Failiure of
450 * pcrs_execute() now secure.
452 * Revision 1.27 2001/09/16 17:08:54 jongfoster
453 * Moving simple CGI functions from cgi.c to new file cgisimple.c
455 * Revision 1.26 2001/09/16 15:47:37 jongfoster
456 * First version of CGI-based edit interface. This is very much a
457 * work-in-progress, and you can't actually use it to edit anything
458 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
459 * to have any effect.
461 * Revision 1.25 2001/09/16 15:02:35 jongfoster
462 * Adding i.j.b/robots.txt.
463 * Inlining add_stats() since it's only ever called from one place.
465 * Revision 1.24 2001/09/16 11:38:01 jongfoster
466 * Splitting fill_template() into 2 functions:
467 * template_load() loads the file
468 * template_fill() performs the PCRS regexps.
469 * This is because the CGI edit interface has a "table row"
470 * template which is used many times in the page - this
471 * change means it's only loaded from disk once.
473 * Revision 1.23 2001/09/16 11:16:05 jongfoster
474 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
476 * Revision 1.22 2001/09/16 11:00:10 jongfoster
477 * New function alloc_http_response, for symmetry with free_http_response
479 * Revision 1.21 2001/09/13 23:53:03 jongfoster
480 * Support for both static and dynamically generated CGI pages.
481 * Correctly setting Last-Modified: and Expires: HTTP headers.
483 * Revision 1.20 2001/09/13 23:40:36 jongfoster
484 * (Cosmetic only) Indentation correction
486 * Revision 1.19 2001/09/13 23:31:25 jongfoster
487 * Moving image data to cgi.c rather than cgi.h.
489 * Revision 1.18 2001/08/05 16:06:20 jongfoster
490 * Modifiying "struct map" so that there are now separate header and
491 * "map_entry" structures. This means that functions which modify a
492 * map no longer need to return a pointer to the modified map.
493 * Also, it no longer reverses the order of the entries (which may be
494 * important with some advanced template substitutions).
496 * Revision 1.17 2001/08/05 15:57:38 oes
497 * Adapted finish_http_response to new list_to_text
499 * Revision 1.16 2001/08/01 21:33:18 jongfoster
500 * Changes to fill_template() that reduce memory usage without having
501 * an impact on performance. I also renamed some variables so as not
502 * to clash with the C++ keywords "new" and "template".
504 * Revision 1.15 2001/08/01 21:19:22 jongfoster
505 * Moving file version information to a separate CGI page.
507 * Revision 1.14 2001/08/01 00:19:03 jongfoster
508 * New function: map_conditional() for an if-then-else syntax.
509 * Changing to use new version of show_defines()
511 * Revision 1.13 2001/07/30 22:08:36 jongfoster
512 * Tidying up #defines:
513 * - All feature #defines are now of the form FEATURE_xxx
514 * - Permanently turned off WIN_GUI_EDIT
515 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
517 * Revision 1.12 2001/07/29 18:47:05 jongfoster
518 * Adding missing #include "loadcfg.h"
520 * Revision 1.11 2001/07/18 17:24:37 oes
521 * Changed to conform to new pcrs interface
523 * Revision 1.10 2001/07/13 13:53:13 oes
524 * Removed all #ifdef PCRS and related code
526 * Revision 1.9 2001/06/29 21:45:41 oes
527 * Indentation, CRLF->LF, Tab-> Space
529 * Revision 1.8 2001/06/29 13:21:46 oes
530 * - Cosmetics: renamed and reordered functions, variables,
531 * texts, improved comments etc
533 * - Removed ij_untrusted_url() The relevant
534 * info is now part of the "untrusted" page,
535 * which is generated by filters.c:trust_url()
537 * - Generators of content now call finish_http_response()
538 * themselves, making jcc.c:chat() a little less
541 * - Removed obsolete "Pragma: no-cache" from our headers
543 * - http_responses now know their head length
545 * - fill_template now uses the new interface to pcrs, so that
546 * - long jobs (like whole files) no longer have to be assembled
547 * in a fixed size buffer
548 * - the new T (trivial) option is used, and the replacement may
549 * contain Perl syntax backrefs without confusing pcrs
551 * - Introduced default_exports() which generates a set of exports
552 * common to all CGIs and other content generators
554 * - Introduced convenience function map_block_killer()
556 * - Introduced convenience function make_menu()
558 * - Introduced CGI-like function error_response() which generates
559 * the "No such domain" and "Connect failed" messages using the
562 * - cgi_show_url_info:
563 * - adapted to new CGI features
564 * - form and answers now generated from same template
565 * - http:// prefix in URL now OK
568 * - adapted to new CGI features
569 * - no longer uses csp->init_proxy_args
572 * - moved menu generation to make_menu()
574 * - add_stats now writes single export map entries instead
577 * - Moved redirect_url() to filters.c
579 * - Fixed mem leak in free_http_response(), map_block_killer(),
581 * - Removed logentry from cancelled commit
583 * Revision 1.7 2001/06/09 10:51:58 jongfoster
584 * Changing "show URL info" handler to new style.
585 * Changing BUFSIZ ==> BUFFER_SIZE
587 * Revision 1.6 2001/06/07 23:05:19 jongfoster
588 * Removing code related to old forward and ACL files.
590 * Revision 1.5 2001/06/05 19:59:16 jongfoster
591 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
593 * Revision 1.4 2001/06/04 10:41:52 swa
594 * show version string of cgi.h and cgi.c
596 * Revision 1.3 2001/06/03 19:12:16 oes
597 * introduced new cgi handling
599 * No revisions before 1.3
601 **********************************************************************/
607 #include <sys/types.h>
621 #include "miscutil.h"
622 #include "cgisimple.h"
623 #include "jbsockets.h"
624 #ifdef FEATURE_CGI_EDIT_ACTIONS
626 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
628 /* loadcfg.h is for global_toggle_state only */
629 #ifdef FEATURE_PTHREAD
631 /* jcc.h is for mutex semaphore globals only */
632 #endif /* def FEATURE_PTHREAD */
633 const char cgi_h_rcs[] = CGI_H_VERSION;
636 * List of CGI functions: name, handler, description
637 * Note: Do NOT use single quotes in the description;
638 * this will break the dynamic "blocked" template!
640 static const struct cgi_dispatcher cgi_dispatchers[] = {
645 #ifdef FEATURE_GRACEFUL_TERMINATION
648 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
649 "this is a one click Denial Of Service attack!!!</em>",
654 #ifdef FEATURE_CGI_EDIT_ACTIONS
655 "View & change the current configuration",
657 "View the current configuration",
662 "View the source code version numbers",
666 "View the request headers.",
670 "Look up which actions apply to a URL and why",
672 #ifdef FEATURE_CGI_EDIT_ACTIONS
673 #ifdef FEATURE_TOGGLE
676 "Toggle Privoxy on or off",
678 #endif /* def FEATURE_TOGGLE */
679 { "edit-actions", /* Edit the actions list */
682 { "eaa", /* Shortcut for edit-actions-add-url-form */
683 cgi_edit_actions_add_url_form,
685 { "eau", /* Shortcut for edit-actions-url-form */
686 cgi_edit_actions_url_form,
688 { "ear", /* Shortcut for edit-actions-remove-url-form */
689 cgi_edit_actions_remove_url_form,
691 { "eal", /* Shortcut for edit-actions-list */
692 cgi_edit_actions_list,
694 { "eafu", /* Shortcut for edit-actions-for-url */
695 cgi_edit_actions_for_url,
697 { "eas", /* Shortcut for edit-actions-submit */
698 cgi_edit_actions_submit,
700 { "easa", /* Shortcut for edit-actions-section-add */
701 cgi_edit_actions_section_add,
703 { "easr", /* Shortcut for edit-actions-section-remove */
704 cgi_edit_actions_section_remove,
706 { "eass", /* Shortcut for edit-actions-section-swap */
707 cgi_edit_actions_section_swap,
709 { "edit-actions-for-url",
710 cgi_edit_actions_for_url,
711 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
712 { "edit-actions-list",
713 cgi_edit_actions_list,
714 NULL, TRUE /* Edit the actions list */ },
715 { "edit-actions-submit",
716 cgi_edit_actions_submit,
717 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
718 { "edit-actions-url",
719 cgi_edit_actions_url,
720 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
721 { "edit-actions-url-form",
722 cgi_edit_actions_url_form,
723 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
724 { "edit-actions-add-url",
725 cgi_edit_actions_add_url,
726 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
727 { "edit-actions-add-url-form",
728 cgi_edit_actions_add_url_form,
729 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
730 { "edit-actions-remove-url",
731 cgi_edit_actions_remove_url,
732 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
733 { "edit-actions-remove-url-form",
734 cgi_edit_actions_remove_url_form,
735 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
736 { "edit-actions-section-add",
737 cgi_edit_actions_section_add,
738 NULL, FALSE /* Remove a section from the actionsfile */ },
739 { "edit-actions-section-remove",
740 cgi_edit_actions_section_remove,
741 NULL, FALSE /* Remove a section from the actionsfile */ },
742 { "edit-actions-section-swap",
743 cgi_edit_actions_section_swap,
744 NULL, FALSE /* Swap two sections in the actionsfile */ },
745 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
746 { "error-favicon.ico",
747 cgi_send_error_favicon,
748 NULL, TRUE /* Sends the favicon image for error pages. */ },
750 cgi_send_default_favicon,
751 NULL, TRUE /* Sends the default favicon image. */ },
754 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
757 NULL, TRUE /* Send a built-in image */ },
760 NULL, FALSE /* Send templates/cgi-style.css */ },
762 cgi_transparent_image,
763 NULL, TRUE /* Send a transparent image (short name) */ },
765 cgi_send_user_manual,
766 NULL, TRUE /* Send user-manual */ },
767 { NULL, /* NULL Indicates end of list and default page */
769 NULL, TRUE /* Unknown CGI page */ }
774 * Built-in images for ad replacement
776 * Hint: You can encode your own images like this:
777 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
780 #ifdef FEATURE_NO_GIFS
783 * Checkerboard pattern, as a PNG.
785 const char image_pattern_data[] =
786 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
787 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
788 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
789 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
790 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
791 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
792 "\000\000\000\000\111\105\116\104\256\102\140\202";
795 * 1x1 transparant PNG.
797 const char image_blank_data[] =
798 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
799 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
800 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
801 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
802 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
803 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
804 "\000\000\000\000\111\105\116\104\256\102\140\202";
808 * Checkerboard pattern, as a GIF.
810 const char image_pattern_data[] =
811 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
812 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
813 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
814 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
818 * 1x1 transparant GIF.
820 const char image_blank_data[] =
821 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
822 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
823 "\000\001\000\000\002\002D\001\000;";
826 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
827 const size_t image_blank_length = sizeof(image_blank_data) - 1;
830 static struct http_response cgi_error_memory_response[1];
832 static struct http_response *dispatch_known_cgi(struct client_state * csp,
834 static struct map *parse_cgi_parameters(char *argstring);
837 /*********************************************************************
839 * Function : dispatch_cgi
841 * Description : Checks if a request URL has either the magical
842 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
843 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
844 * http://config.privoxy.org/). If so, it passes
845 * the (rest of the) path onto dispatch_known_cgi, which
846 * calls the relevant CGI handler function.
849 * 1 : csp = Current client state (buffers, headers, etc...)
851 * Returns : http_response if match, NULL if nonmatch or handler fail
853 *********************************************************************/
854 struct http_response *dispatch_cgi(struct client_state *csp)
856 const char *host = csp->http->host;
857 const char *path = csp->http->path;
860 * Should we intercept ?
863 /* Note: "example.com" and "example.com." are equivalent hostnames. */
865 /* Either the host matches CGI_SITE_1_HOST ..*/
866 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
867 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
868 && (path[0] == '/') )
870 /* ..then the path will all be for us. Remove leading '/' */
873 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
874 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
875 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
876 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
878 /* take everything following CGI_SITE_2_PATH */
879 path += strlen(CGI_SITE_2_PATH);
882 /* skip the forward slash after CGI_SITE_2_PATH */
885 else if (*path != '\0')
888 * weirdness: URL is /configXXX, where XXX is some string
889 * Do *NOT* intercept.
901 * This is a CGI call.
904 return dispatch_known_cgi(csp, path);
908 /*********************************************************************
910 * Function : grep_cgi_referrer
912 * Description : Ugly provisorical fix that greps the value of the
913 * referer HTTP header field out of a linked list of
914 * strings like found at csp->headers. Will disappear
917 * FIXME: csp->headers ought to be csp->http->headers
918 * FIXME: Parsing all client header lines should
919 * happen right after the request is received!
922 * 1 : csp = Current client state (buffers, headers, etc...)
924 * Returns : pointer to value (no copy!), or NULL if none found.
926 *********************************************************************/
927 static char *grep_cgi_referrer(const struct client_state *csp)
929 struct list_entry *p;
931 for (p = csp->headers->first; p != NULL; p = p->next)
933 if (p->str == NULL) continue;
934 if (strncmpic(p->str, "Referer: ", 9) == 0)
936 return ((p->str) + 9);
944 /*********************************************************************
946 * Function : referrer_is_safe
948 * Description : Decides whether we trust the Referer for
949 * CGI pages which are only meant to be reachable
950 * through Privoxy's web interface directly.
953 * 1 : csp = Current client state (buffers, headers, etc...)
955 * Returns : TRUE if the referrer is safe, or
956 * FALSE if the referrer is unsafe or not set.
958 *********************************************************************/
959 static int referrer_is_safe(const struct client_state *csp)
962 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
964 referrer = grep_cgi_referrer(csp);
966 if (NULL == referrer)
968 /* No referrer, no access */
969 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
972 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
973 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
975 /* Trustworthy referrer */
976 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
977 csp->http->url, referrer);
983 /* Untrustworthy referrer */
984 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
985 csp->http->url, referrer);
992 /*********************************************************************
994 * Function : dispatch_known_cgi
996 * Description : Processes a CGI once dispatch_cgi has determined that
997 * it matches one of the magic prefixes. Parses the path
998 * as a cgi name plus query string, prepares a map that
999 * maps CGI parameter names to their values, initializes
1000 * the http_response struct, and calls the relevant CGI
1004 * 1 : csp = Current client state (buffers, headers, etc...)
1005 * 2 : path = Path of CGI, with the CGI prefix removed.
1006 * Should not have a leading "/".
1008 * Returns : http_response, or NULL on handler failure or out of
1011 *********************************************************************/
1012 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1015 const struct cgi_dispatcher *d;
1016 struct map *param_list;
1017 struct http_response *rsp;
1018 char *query_args_start;
1022 if (NULL == (path_copy = strdup(path)))
1024 return cgi_error_memory();
1026 query_args_start = path_copy;
1027 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1031 if (*query_args_start == '/')
1033 *query_args_start++ = '\0';
1034 if ((param_list = new_map()))
1036 map(param_list, "file", 1, url_decode(query_args_start), 0);
1041 if (*query_args_start == '?')
1043 *query_args_start++ = '\0';
1045 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1048 return cgi_error_memory();
1054 * path_copy = CGI call name
1055 * param_list = CGI params, as map
1058 /* Get mem for response or fail*/
1059 if (NULL == (rsp = alloc_http_response()))
1062 free_map(param_list);
1063 return cgi_error_memory();
1067 * Find and start the right CGI function
1069 d = cgi_dispatchers;
1072 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1075 * If the called CGI is either harmless, or referred
1076 * from a trusted source, start it.
1078 if (d->harmless || referrer_is_safe(csp))
1080 err = (d->handler)(csp, rsp, param_list);
1085 * Else, modify toggle calls so that they only display
1086 * the status, and deny all other calls.
1088 if (0 == strcmp(path_copy, "toggle"))
1090 unmap(param_list, "set");
1091 err = (d->handler)(csp, rsp, param_list);
1095 err = cgi_error_disabled(csp, rsp);
1100 free_map(param_list);
1102 if (err == JB_ERR_CGI_PARAMS)
1104 err = cgi_error_bad_param(csp, rsp);
1106 if (err && (err != JB_ERR_MEMORY))
1108 /* Unexpected error! Shouldn't get here */
1109 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1110 err = cgi_error_unknown(csp, rsp, err);
1115 rsp->reason = RSP_REASON_CGI_CALL;
1116 return finish_http_response(csp, rsp);
1120 /* Error in handler, probably out-of-memory */
1121 free_http_response(rsp);
1122 return cgi_error_memory();
1130 /*********************************************************************
1132 * Function : parse_cgi_parameters
1134 * Description : Parse a URL-encoded argument string into name/value
1135 * pairs and store them in a struct map list.
1138 * 1 : argstring = string to be parsed. Will be trashed.
1140 * Returns : pointer to param list, or NULL if out of memory.
1142 *********************************************************************/
1143 static struct map *parse_cgi_parameters(char *argstring)
1146 char *vector[BUFFER_SIZE];
1148 struct map *cgi_params;
1150 if (NULL == (cgi_params = new_map()))
1156 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1157 * the fragment identifier along with the request, so we must
1158 * cut it off here, so it won't pollute the CGI params:
1160 if (NULL != (p = strchr(argstring, '#')))
1165 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1167 for (i = 0; i < pairs; i++)
1169 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1172 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1174 free_map(cgi_params);
1185 /*********************************************************************
1187 * Function : get_char_param
1189 * Description : Get a single-character parameter passed to a CGI
1193 * 1 : parameters = map of cgi parameters
1194 * 2 : param_name = The name of the parameter to read
1196 * Returns : Uppercase character on success, '\0' on error.
1198 *********************************************************************/
1199 char get_char_param(const struct map *parameters,
1200 const char *param_name)
1207 ch = *(lookup(parameters, param_name));
1208 if ((ch >= 'a') && (ch <= 'z'))
1210 ch = (char)(ch - 'a' + 'A');
1217 /*********************************************************************
1219 * Function : get_string_param
1221 * Description : Get a string paramater, to be used as an
1222 * ACTION_STRING or ACTION_MULTI paramater.
1223 * Validates the input to prevent stupid/malicious
1224 * users from corrupting their action file.
1227 * 1 : parameters = map of cgi parameters
1228 * 2 : param_name = The name of the parameter to read
1229 * 3 : pparam = destination for paramater. Allocated as
1230 * part of the map "parameters", so don't free it.
1231 * Set to NULL if not specified.
1233 * Returns : JB_ERR_OK on success, or if the paramater
1234 * was not specified.
1235 * JB_ERR_MEMORY on out-of-memory.
1236 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1238 *********************************************************************/
1239 jb_err get_string_param(const struct map *parameters,
1240 const char *param_name,
1241 const char **pparam)
1253 param = lookup(parameters, param_name);
1259 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1264 * Note that the length limit is arbitrary, it just seems
1265 * sensible to limit it to *something*. There's no
1266 * technical reason for any limit at all.
1268 return JB_ERR_CGI_PARAMS;
1271 /* Check every character to see if it's legal */
1273 while ((ch = *s++) != '\0')
1275 if ( ((unsigned char)ch < (unsigned char)' ')
1278 /* Probable hack attempt, or user accidentally used '}'. */
1279 return JB_ERR_CGI_PARAMS;
1290 /*********************************************************************
1292 * Function : get_number_param
1294 * Description : Get a non-negative integer from the parameters
1295 * passed to a CGI function.
1298 * 1 : csp = Current client state (buffers, headers, etc...)
1299 * 2 : parameters = map of cgi parameters
1300 * 3 : name = Name of CGI parameter to read
1301 * 4 : pvalue = destination for value.
1302 * Set to -1 on error.
1304 * Returns : JB_ERR_OK on success
1305 * JB_ERR_MEMORY on out-of-memory
1306 * JB_ERR_CGI_PARAMS if the parameter was not specified
1309 *********************************************************************/
1310 jb_err get_number_param(struct client_state *csp,
1311 const struct map *parameters,
1326 param = lookup(parameters, name);
1329 return JB_ERR_CGI_PARAMS;
1332 /* We don't use atoi because I want to check this carefully... */
1335 while ((ch = *param++) != '\0')
1337 if ((ch < '0') || (ch > '9'))
1339 return JB_ERR_CGI_PARAMS;
1342 ch = (char)(ch - '0');
1346 * <limits.h> defines UINT_MAX
1348 * (UINT_MAX - ch) / 10 is the largest number that
1349 * can be safely multiplied by 10 then have ch added.
1351 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1353 return JB_ERR_CGI_PARAMS;
1356 value = value * 10 + (unsigned)ch;
1367 /*********************************************************************
1369 * Function : error_response
1371 * Description : returns an http_response that explains the reason
1372 * why a request failed.
1375 * 1 : csp = Current client state (buffers, headers, etc...)
1376 * 2 : templatename = Which template should be used for the answer
1377 * 3 : sys_err = system error number
1379 * Returns : A http_response. If we run out of memory, this
1380 * will be cgi_error_memory().
1382 *********************************************************************/
1383 struct http_response *error_response(struct client_state *csp,
1384 const char *templatename,
1388 struct http_response *rsp;
1389 struct map *exports = default_exports(csp, NULL);
1392 if (exports == NULL)
1394 return cgi_error_memory();
1397 if (NULL == (rsp = alloc_http_response()))
1400 return cgi_error_memory();
1403 #ifdef FEATURE_FORCE_LOAD
1404 if (csp->flags & CSP_FLAG_FORCED)
1406 path = strdup(FORCE_PREFIX);
1409 #endif /* def FEATURE_FORCE_LOAD */
1413 err = string_append(&path, csp->http->path);
1415 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1416 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1417 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1418 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1419 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1422 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1425 /* Some failures, like "404 no such domain", don't have an IP address. */
1426 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1434 free_http_response(rsp);
1435 return cgi_error_memory();
1438 if (!strcmp(templatename, "no-such-domain"))
1440 rsp->status = strdup("404 No such domain");
1441 if (rsp->status == NULL)
1444 free_http_response(rsp);
1445 return cgi_error_memory();
1447 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1449 else if (!strcmp(templatename, "forwarding-failed"))
1451 const struct forward_spec *fwd = forward_url(csp, csp->http);
1452 char *socks_type = NULL;
1455 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1456 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1460 * XXX: While the template is called forwarding-failed,
1461 * it currently only handles socks forwarding failures.
1463 assert(fwd->type != SOCKS_NONE);
1466 * Map failure reason, forwarding type and forwarder.
1468 if (NULL == csp->error_message)
1471 * Either we forgot to record the failure reason,
1472 * or the memory allocation failed.
1474 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1475 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1477 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1480 * XXX: this is almost the same code as in cgi_show_url_info()
1481 * and thus should be factored out and shared.
1486 socks_type = "socks4-";
1489 socks_type = "socks4a-";
1492 socks_type = "socks5-";
1495 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1498 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1499 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1501 if (!err) rsp->status = strdup("503 Forwarding failure");
1502 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1505 free_http_response(rsp);
1506 return cgi_error_memory();
1508 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1510 else if (!strcmp(templatename, "connect-failed"))
1512 rsp->status = strdup("503 Connect failed");
1513 if (rsp->status == NULL)
1516 free_http_response(rsp);
1517 return cgi_error_memory();
1519 rsp->reason = RSP_REASON_CONNECT_FAILED;
1522 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1525 free_http_response(rsp);
1526 return cgi_error_memory();
1529 return finish_http_response(csp, rsp);
1533 /*********************************************************************
1535 * Function : cgi_error_disabled
1537 * Description : CGI function that is called to generate an error
1538 * response if the actions editor or toggle CGI are
1539 * accessed despite having being disabled at compile-
1540 * or run-time, or if the user followed an untrusted link
1541 * to access a unsafe CGI feature that is only reachable
1542 * through Privoxy directly.
1545 * 1 : csp = Current client state (buffers, headers, etc...)
1546 * 2 : rsp = http_response data structure for output
1548 * CGI Parameters : none
1550 * Returns : JB_ERR_OK on success
1551 * JB_ERR_MEMORY on out-of-memory error.
1553 *********************************************************************/
1554 jb_err cgi_error_disabled(struct client_state *csp,
1555 struct http_response *rsp)
1557 struct map *exports;
1562 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1564 return JB_ERR_MEMORY;
1566 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1568 /* Not important enough to do anything */
1569 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1572 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1576 /*********************************************************************
1578 * Function : cgi_init_error_messages
1580 * Description : Call at the start of the program to initialize
1581 * the error message used by cgi_error_memory().
1587 *********************************************************************/
1588 void cgi_init_error_messages(void)
1590 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1591 cgi_error_memory_response->head =
1592 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1593 "Content-Type: text/html\r\n"
1595 cgi_error_memory_response->body =
1598 " <title>500 Internal Privoxy Error</title>\r\n"
1599 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1602 "<h1>500 Internal Privoxy Error</h1>\r\n"
1603 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1604 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1608 cgi_error_memory_response->head_length =
1609 strlen(cgi_error_memory_response->head);
1610 cgi_error_memory_response->content_length =
1611 strlen(cgi_error_memory_response->body);
1612 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1616 /*********************************************************************
1618 * Function : cgi_error_memory
1620 * Description : Called if a CGI function runs out of memory.
1621 * Returns a statically-allocated error response.
1625 * Returns : http_response data structure for output. This is
1626 * statically allocated, for obvious reasons.
1628 *********************************************************************/
1629 struct http_response *cgi_error_memory(void)
1631 /* assert that it's been initialized. */
1632 assert(cgi_error_memory_response->head);
1634 return cgi_error_memory_response;
1638 /*********************************************************************
1640 * Function : cgi_error_no_template
1642 * Description : Almost-CGI function that is called if a template
1643 * cannot be loaded. Note this is not a true CGI,
1644 * it takes a template name rather than a map of
1648 * 1 : csp = Current client state (buffers, headers, etc...)
1649 * 2 : rsp = http_response data structure for output
1650 * 3 : template_name = Name of template that could not
1653 * Returns : JB_ERR_OK on success
1654 * JB_ERR_MEMORY on out-of-memory error.
1656 *********************************************************************/
1657 jb_err cgi_error_no_template(struct client_state *csp,
1658 struct http_response *rsp,
1659 const char *template_name)
1661 static const char status[] =
1662 "500 Internal Privoxy Error";
1663 static const char body_prefix[] =
1666 " <title>500 Internal Privoxy Error</title>\r\n"
1667 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1670 "<h1>500 Internal Privoxy Error</h1>\r\n"
1671 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1672 "<p><b>Could not load template file <code>";
1673 static const char body_suffix[] =
1674 "</code> or one of it's included components.</b></p>\r\n"
1675 "<p>Please contact your proxy administrator.</p>\r\n"
1676 "<p>If you are the proxy administrator, please put the required file(s)"
1677 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1678 "location of the <code><i>(confdir)</i></code> directory "
1679 "is specified in the main Privoxy <code>config</code> "
1680 "file. (It's typically the Privoxy install directory"
1682 ", or <code>/etc/privoxy/</code>"
1683 #endif /* ndef _WIN32 */
1687 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1691 assert(template_name);
1693 /* Reset rsp, if needed */
1697 rsp->content_length = 0;
1698 rsp->head_length = 0;
1701 rsp->body = malloc(body_size);
1702 if (rsp->body == NULL)
1704 return JB_ERR_MEMORY;
1706 strlcpy(rsp->body, body_prefix, body_size);
1707 strlcat(rsp->body, template_name, body_size);
1708 strlcat(rsp->body, body_suffix, body_size);
1710 rsp->status = strdup(status);
1711 if (rsp->status == NULL)
1713 return JB_ERR_MEMORY;
1720 /*********************************************************************
1722 * Function : cgi_error_unknown
1724 * Description : Almost-CGI function that is called if an unexpected
1725 * error occurs in the top-level CGI dispatcher.
1726 * In this context, "unexpected" means "anything other
1727 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1728 * expected to handle all other errors internally,
1729 * since they can give more relavent error messages
1732 * Note this is not a true CGI, it takes an error
1733 * code rather than a map of parameters.
1736 * 1 : csp = Current client state (buffers, headers, etc...)
1737 * 2 : rsp = http_response data structure for output
1738 * 3 : error_to_report = Error code to report.
1740 * Returns : JB_ERR_OK on success
1741 * JB_ERR_MEMORY on out-of-memory error.
1743 *********************************************************************/
1744 jb_err cgi_error_unknown(struct client_state *csp,
1745 struct http_response *rsp,
1746 jb_err error_to_report)
1748 static const char status[] =
1749 "500 Internal Privoxy Error";
1750 static const char body_prefix[] =
1753 " <title>500 Internal Privoxy Error</title>\r\n"
1754 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1757 "<h1>500 Internal Privoxy Error</h1>\r\n"
1758 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1759 "<p><b>Unexpected internal error: ";
1760 static const char body_suffix[] =
1763 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1764 "file a bug report</a>.</p>\r\n"
1769 * Due to sizeof(errnumbuf), body_size will be slightly
1770 * bigger than necessary but it doesn't really matter.
1772 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1776 /* Reset rsp, if needed */
1780 rsp->content_length = 0;
1781 rsp->head_length = 0;
1783 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1785 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1787 rsp->body = malloc(body_size);
1788 if (rsp->body == NULL)
1790 return JB_ERR_MEMORY;
1792 strlcpy(rsp->body, body_prefix, body_size);
1793 strlcat(rsp->body, errnumbuf, body_size);
1794 strlcat(rsp->body, body_suffix, body_size);
1796 rsp->status = strdup(status);
1797 if (rsp->status == NULL)
1799 return JB_ERR_MEMORY;
1806 /*********************************************************************
1808 * Function : cgi_error_bad_param
1810 * Description : CGI function that is called if the parameters
1811 * (query string) for a CGI were wrong.
1814 * 1 : csp = Current client state (buffers, headers, etc...)
1815 * 2 : rsp = http_response data structure for output
1817 * CGI Parameters : none
1819 * Returns : JB_ERR_OK on success
1820 * JB_ERR_MEMORY on out-of-memory error.
1822 *********************************************************************/
1823 jb_err cgi_error_bad_param(struct client_state *csp,
1824 struct http_response *rsp)
1826 struct map *exports;
1831 if (NULL == (exports = default_exports(csp, NULL)))
1833 return JB_ERR_MEMORY;
1836 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1840 /*********************************************************************
1842 * Function : cgi_redirect
1844 * Description : CGI support function to generate a HTTP redirect
1848 * 1 : rsp = http_response data structure for output
1849 * 2 : target = string with the target URL
1851 * CGI Parameters : None
1853 * Returns : JB_ERR_OK on success
1854 * JB_ERR_MEMORY on out-of-memory error.
1856 *********************************************************************/
1857 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1864 err = enlist_unique_header(rsp->headers, "Location", target);
1866 rsp->status = strdup("302 Local Redirect from Privoxy");
1867 if (rsp->status == NULL)
1869 return JB_ERR_MEMORY;
1876 /*********************************************************************
1878 * Function : add_help_link
1880 * Description : Produce a copy of the string given as item,
1881 * embedded in an HTML link to its corresponding
1882 * section (item name in uppercase) in the actions
1883 * chapter of the user manual, (whose URL is given in
1884 * the config and defaults to our web site).
1886 * FIXME: I currently only work for actions, and would
1887 * like to be generalized for other topics.
1890 * 1 : item = item (will NOT be free()d.)
1891 * It is assumed to be HTML-safe.
1892 * 2 : config = The current configuration.
1894 * Returns : String with item embedded in link, or NULL on
1897 *********************************************************************/
1898 char *add_help_link(const char *item,
1899 struct configuration_spec *config)
1903 if (!item) return NULL;
1905 result = strdup("<a href=\"");
1906 if (!strncmpic(config->usermanual, "file://", 7) ||
1907 !strncmpic(config->usermanual, "http", 4))
1909 string_append(&result, config->usermanual);
1913 string_append(&result, "http://");
1914 string_append(&result, CGI_SITE_2_HOST);
1915 string_append(&result, "/user-manual/");
1917 string_append(&result, ACTIONS_HELP_PREFIX);
1918 string_join (&result, string_toupper(item));
1919 string_append(&result, "\">");
1920 string_append(&result, item);
1921 string_append(&result, "</a> ");
1927 /*********************************************************************
1929 * Function : get_http_time
1931 * Description : Get the time in a format suitable for use in a
1932 * HTTP header - e.g.:
1933 * "Sun, 06 Nov 1994 08:49:37 GMT"
1936 * 1 : time_offset = Time returned will be current time
1937 * plus this number of seconds.
1938 * 2 : buf = Destination for result.
1939 * 3 : buffer_size = Size of the buffer above. Must be big
1940 * enough to hold 29 characters plus a
1945 *********************************************************************/
1946 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1948 static const char day_names[7][4] =
1949 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1950 static const char month_names[12][4] =
1951 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1952 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1955 time_t current_time;
1956 #if defined(HAVE_GMTIME_R)
1958 * Declare dummy up here (instead of inside get/set gmt block) so it
1959 * doesn't go out of scope before it's potentially used in snprintf later.
1960 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1961 * !defined HAVE_GMTIME_R.
1967 assert(buffer_size > 29);
1969 time(¤t_time); /* get current time */
1971 current_time += time_offset;
1973 /* get and save the gmt */
1976 t = gmtime_r(¤t_time, &dummy);
1977 #elif FEATURE_PTHREAD
1978 pthread_mutex_lock(&gmtime_mutex);
1979 t = gmtime(¤t_time);
1980 pthread_mutex_unlock(&gmtime_mutex);
1982 t = gmtime(¤t_time);
1986 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1987 snprintf(buf, buffer_size,
1988 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1989 day_names[t->tm_wday],
1991 month_names[t->tm_mon],
2001 /*********************************************************************
2003 * Function : finish_http_response
2005 * Description : Fill in the missing headers in an http response,
2006 * and flatten the headers to an http head.
2007 * For HEAD requests the body is freed once
2008 * the Content-Length header is set.
2011 * 1 : rsp = pointer to http_response to be processed
2013 * Returns : A http_response, usually the rsp parameter.
2014 * On error, free()s rsp and returns cgi_error_memory()
2016 *********************************************************************/
2017 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2019 char buf[BUFFER_SIZE];
2022 /* Special case - do NOT change this statically allocated response,
2023 * which is ready for output anyway.
2025 if (rsp == cgi_error_memory_response)
2031 * Fill in the HTTP Status, using HTTP/1.1
2032 * unless the client asked for HTTP/1.0.
2034 snprintf(buf, sizeof(buf), "%s %s",
2035 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2036 rsp->status ? rsp->status : "200 OK");
2037 err = enlist_first(rsp->headers, buf);
2040 * Set the Content-Length
2042 if (rsp->content_length == 0)
2044 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2048 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2049 err = enlist(rsp->headers, buf);
2052 if (0 == strcmpic(csp->http->gpc, "head"))
2055 * The client only asked for the head. Dispose
2056 * the body and log an offensive message.
2058 * While it may seem to be a bit inefficient to
2059 * prepare the body if it isn't needed, it's the
2060 * only way to get the Content-Length right for
2061 * dynamic pages. We could have disposed the body
2062 * earlier, but not without duplicating the
2063 * Content-Length setting code above.
2065 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2067 rsp->content_length = 0;
2070 if (strncmpic(rsp->status, "302", 3))
2073 * If it's not a redirect without any content,
2074 * set the Content-Type to text/html if it's
2075 * not already specified.
2077 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2081 * Fill in the rest of the default headers:
2083 * Date: set to current date/time.
2084 * Last-Modified: set to date/time the page was last changed.
2085 * Expires: set to date/time page next needs reloading.
2086 * Cache-Control: set to "no-cache" if applicable.
2088 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2093 * Set Expires to about 10 min into the future so it'll get reloaded
2094 * occasionally, e.g. if Privoxy gets upgraded.
2099 get_http_time(0, buf, sizeof(buf));
2100 err = enlist_unique_header(rsp->headers, "Date", buf);
2103 /* Some date in the past. */
2104 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2108 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
2109 err = enlist_unique_header(rsp->headers, "Expires", buf);
2112 else if (!strncmpic(rsp->status, "302", 3))
2114 get_http_time(0, buf, sizeof(buf));
2115 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2120 * Setting "Cache-Control" to "no-cache" and "Expires" to
2121 * the current time doesn't exactly forbid caching, it just
2122 * requires the client to revalidate the cached copy.
2124 * If a temporary problem occurs and the user tries again after
2125 * getting Privoxy's error message, a compliant browser may set the
2126 * If-Modified-Since header with the content of the error page's
2127 * Last-Modified header. More often than not, the document on the server
2128 * is older than Privoxy's error message, the server would send status code
2129 * 304 and the browser would display the outdated error message again and again.
2131 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2132 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2133 * and can be safely used to "revalidate" without getting a status code 304.
2135 * There is no need to let the useless If-Modified-Since header reach the
2136 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2138 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2140 get_http_time(0, buf, sizeof(buf));
2141 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2142 if (!strncmpic(rsp->status, "403", 3)
2143 || !strncmpic(rsp->status, "404", 3)
2144 || !strncmpic(rsp->status, "503", 3))
2146 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2150 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2152 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2153 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2159 * HTTP/1.1 applications that do not support persistent connections MUST
2160 * include the "close" connection option in every message.
2162 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2167 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2169 free_http_response(rsp);
2170 return cgi_error_memory();
2172 rsp->head_length = strlen(rsp->head);
2179 /*********************************************************************
2181 * Function : alloc_http_response
2183 * Description : Allocates a new http_response structure.
2187 * Returns : pointer to a new http_response, or NULL.
2189 *********************************************************************/
2190 struct http_response *alloc_http_response(void)
2192 return (struct http_response *) zalloc(sizeof(struct http_response));
2197 /*********************************************************************
2199 * Function : free_http_response
2201 * Description : Free the memory occupied by an http_response
2202 * and its depandant structures.
2205 * 1 : rsp = pointer to http_response to be freed
2209 *********************************************************************/
2210 void free_http_response(struct http_response *rsp)
2213 * Must special case cgi_error_memory_response, which is never freed.
2215 if (rsp && (rsp != cgi_error_memory_response))
2220 destroy_list(rsp->headers);
2227 /*********************************************************************
2229 * Function : template_load
2231 * Description : CGI support function that loads a given HTML
2232 * template, ignoring comment lines and following
2233 * #include statements up to a depth of 1.
2236 * 1 : csp = Current client state (buffers, headers, etc...)
2237 * 2 : template_ptr = Destination for pointer to loaded
2239 * 3 : templatename = name of the HTML template to be used
2240 * 4 : recursive = Flag set if this function calls itself
2241 * following an #include statament
2243 * Returns : JB_ERR_OK on success
2244 * JB_ERR_MEMORY on out-of-memory error.
2245 * JB_ERR_FILE if the template file cannot be read
2247 *********************************************************************/
2248 jb_err template_load(struct client_state *csp, char **template_ptr,
2249 const char *templatename, int recursive)
2252 char *templates_dir_path;
2255 char *included_module;
2258 char buf[BUFFER_SIZE];
2261 assert(template_ptr);
2262 assert(templatename);
2264 *template_ptr = NULL;
2266 /* Validate template name. Paranoia. */
2267 for (p = templatename; *p != 0; p++)
2269 if ( ((*p < 'a') || (*p > 'z'))
2270 && ((*p < 'A') || (*p > 'Z'))
2271 && ((*p < '0') || (*p > '9'))
2275 /* Illegal character */
2281 * Generate full path using either templdir
2282 * or confdir/templates as base directory.
2284 if (NULL != csp->config->templdir)
2286 templates_dir_path = strdup(csp->config->templdir);
2290 templates_dir_path = make_path(csp->config->confdir, "templates");
2293 if (templates_dir_path == NULL)
2295 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2297 return JB_ERR_MEMORY;
2300 full_path = make_path(templates_dir_path, templatename);
2301 free(templates_dir_path);
2302 if (full_path == NULL)
2304 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2306 return JB_ERR_MEMORY;
2309 /* Allocate buffer */
2311 file_buffer = strdup("");
2312 if (file_buffer == NULL)
2314 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2316 return JB_ERR_MEMORY;
2319 /* Open template file */
2321 if (NULL == (fp = fopen(full_path, "r")))
2323 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2331 * Read the file, ignoring comments, and honoring #include
2332 * statements, unless we're already called recursively.
2334 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2335 * This is unlikely in practise.
2337 while (fgets(buf, BUFFER_SIZE, fp))
2339 if (!recursive && !strncmp(buf, "#include ", 9))
2341 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2348 if (string_join(&file_buffer, included_module))
2351 return JB_ERR_MEMORY;
2357 /* skip lines starting with '#' */
2363 if (string_append(&file_buffer, buf))
2366 return JB_ERR_MEMORY;
2371 *template_ptr = file_buffer;
2377 /*********************************************************************
2379 * Function : template_fill
2381 * Description : CGI support function that fills in a pre-loaded
2382 * HTML template by replacing @name@ with value using
2383 * pcrs, for each item in the output map.
2385 * Note that a leading '$' charachter in the export map's
2386 * values will be stripped and toggle on backreference
2390 * 1 : template_ptr = IN: Template to be filled out.
2392 * OUT: Filled out template.
2393 * Caller must free().
2394 * 2 : exports = map with fill in symbol -> name pairs
2396 * Returns : JB_ERR_OK on success (and for uncritical errors)
2397 * JB_ERR_MEMORY on out-of-memory error
2399 *********************************************************************/
2400 jb_err template_fill(char **template_ptr, const struct map *exports)
2402 struct map_entry *m;
2404 char buf[BUFFER_SIZE];
2405 char *tmp_out_buffer;
2411 assert(template_ptr);
2412 assert(*template_ptr);
2415 file_buffer = *template_ptr;
2416 size = strlen(file_buffer) + 1;
2419 * Assemble pcrs joblist from exports map
2421 for (m = exports->first; m != NULL; m = m->next)
2423 if (*m->name == '$')
2426 * First character of name is '$', so remove this flag
2427 * character and allow backreferences ($1 etc) in the
2428 * "replace with" text.
2430 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2436 * Treat the "replace with" text as a literal string -
2437 * no quoting needed, no backreferences allowed.
2438 * ("Trivial" ['T'] flag).
2442 /* Enclose name in @@ */
2443 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2447 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2449 /* Make and run job. */
2450 job = pcrs_compile(buf, m->value, flags, &error);
2453 if (error == PCRS_ERR_NOMEM)
2456 *template_ptr = NULL;
2457 return JB_ERR_MEMORY;
2461 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2462 /* Hope it wasn't important and silently ignore the invalid job */
2467 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2470 if (NULL == tmp_out_buffer)
2472 *template_ptr = NULL;
2473 return JB_ERR_MEMORY;
2479 * Substitution failed, keep the original buffer,
2480 * log the problem and ignore it.
2482 * The user might see some unresolved @CGI_VARIABLES@,
2483 * but returning a special CGI error page seems unreasonable
2484 * and could mask more important error messages.
2486 free(tmp_out_buffer);
2487 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2488 buf, m->value, flags, pcrs_strerror(error));
2492 /* Substitution succeeded, use modified buffer. */
2494 file_buffer = tmp_out_buffer;
2502 *template_ptr = file_buffer;
2507 /*********************************************************************
2509 * Function : template_fill_for_cgi
2511 * Description : CGI support function that loads a HTML template
2512 * and fills it in. Handles file-not-found errors
2513 * by sending a HTML error message. For convenience,
2514 * this function also frees the passed "exports" map.
2517 * 1 : csp = Client state
2518 * 2 : templatename = name of the HTML template to be used
2519 * 3 : exports = map with fill in symbol -> name pairs.
2520 * Will be freed by this function.
2521 * 4 : rsp = Response structure to fill in.
2523 * Returns : JB_ERR_OK on success
2524 * JB_ERR_MEMORY on out-of-memory error
2526 *********************************************************************/
2527 jb_err template_fill_for_cgi(struct client_state *csp,
2528 const char *templatename,
2529 struct map *exports,
2530 struct http_response *rsp)
2535 assert(templatename);
2539 err = template_load(csp, &rsp->body, templatename, 0);
2540 if (err == JB_ERR_FILE)
2543 return cgi_error_no_template(csp, rsp, templatename);
2548 return err; /* JB_ERR_MEMORY */
2550 err = template_fill(&rsp->body, exports);
2556 /*********************************************************************
2558 * Function : default_exports
2560 * Description : returns a struct map list that contains exports
2561 * which are common to all CGI functions.
2564 * 1 : csp = Current client state (buffers, headers, etc...)
2565 * 2 : caller = name of CGI who calls us and which should
2566 * be excluded from the generated menu. May be
2568 * Returns : NULL if no memory, else a new map. Caller frees.
2570 *********************************************************************/
2571 struct map *default_exports(const struct client_state *csp, const char *caller)
2575 struct map * exports;
2576 int local_help_exists = 0;
2577 char *ip_address = NULL;
2578 char *hostname = NULL;
2582 exports = new_map();
2583 if (exports == NULL)
2588 if (csp->config->hostname)
2590 get_host_information(csp->cfd, &ip_address, NULL);
2591 hostname = strdup(csp->config->hostname);
2595 get_host_information(csp->cfd, &ip_address, &hostname);
2598 err = map(exports, "version", 1, html_encode(VERSION), 0);
2599 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2601 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2603 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2604 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2605 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2606 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2607 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2608 !strncmpic(csp->config->usermanual, "http", 4))
2610 /* Manual is located somewhere else, just link to it. */
2611 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2615 /* Manual is delivered by Privoxy. */
2616 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2618 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2619 #ifdef FEATURE_TOGGLE
2620 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2622 if (!err) err = map_block_killer(exports, "can-toggle");
2625 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2626 if (!err) err = map(exports, "my-port", 1, buf, 1);
2628 if(!strcmp(CODE_STATUS, "stable"))
2630 if (!err) err = map_block_killer(exports, "unstable");
2633 if (csp->config->admin_address != NULL)
2635 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2636 local_help_exists = 1;
2640 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2643 if (csp->config->proxy_info_url != NULL)
2645 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2646 local_help_exists = 1;
2650 if (!err) err = map_block_killer(exports, "have-proxy-info");
2653 if (local_help_exists == 0)
2655 if (!err) err = map_block_killer(exports, "have-help-info");
2668 /*********************************************************************
2670 * Function : map_block_killer
2672 * Description : Convenience function.
2673 * Adds a "killer" for the conditional HTML-template
2674 * block <name>, i.e. a substitution of the regex
2675 * "if-<name>-start.*if-<name>-end" to the given
2679 * 1 : exports = map to extend
2680 * 2 : name = name of conditional block
2682 * Returns : JB_ERR_OK on success
2683 * JB_ERR_MEMORY on out-of-memory error.
2685 *********************************************************************/
2686 jb_err map_block_killer(struct map *exports, const char *name)
2688 char buf[1000]; /* Will do, since the names are hardwired */
2692 assert(strlen(name) < 490);
2694 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2695 return map(exports, buf, 1, "", 1);
2699 /*********************************************************************
2701 * Function : map_block_keep
2703 * Description : Convenience function. Removes the markers used
2704 * by map-block-killer, to save a few bytes.
2705 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2708 * 1 : exports = map to extend
2709 * 2 : name = name of conditional block
2711 * Returns : JB_ERR_OK on success
2712 * JB_ERR_MEMORY on out-of-memory error.
2714 *********************************************************************/
2715 jb_err map_block_keep(struct map *exports, const char *name)
2718 char buf[500]; /* Will do, since the names are hardwired */
2722 assert(strlen(name) < 490);
2724 snprintf(buf, sizeof(buf), "if-%s-start", name);
2725 err = map(exports, buf, 1, "", 1);
2732 snprintf(buf, sizeof(buf), "if-%s-end", name);
2733 return map(exports, buf, 1, "", 1);
2737 /*********************************************************************
2739 * Function : map_conditional
2741 * Description : Convenience function.
2742 * Adds an "if-then-else" for the conditional HTML-template
2743 * block <name>, i.e. a substitution of the form:
2750 * The control structure and one of the alternatives
2754 * 1 : exports = map to extend
2755 * 2 : name = name of conditional block
2756 * 3 : choose_first = nonzero for first, zero for second.
2758 * Returns : JB_ERR_OK on success
2759 * JB_ERR_MEMORY on out-of-memory error.
2761 *********************************************************************/
2762 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2764 char buf[1000]; /* Will do, since the names are hardwired */
2769 assert(strlen(name) < 480);
2771 snprintf(buf, sizeof(buf), (choose_first
2772 ? "else-not-%s@.*@endif-%s"
2773 : "if-%s-then@.*@else-not-%s"),
2776 err = map(exports, buf, 1, "", 1);
2782 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2783 return map(exports, buf, 1, "", 1);
2787 /*********************************************************************
2789 * Function : make_menu
2791 * Description : Returns an HTML-formatted menu of the available
2792 * unhidden CGIs, excluding the one given in <self>
2793 * and the toggle CGI if toggling is disabled.
2796 * 1 : self = name of CGI to leave out, can be NULL for
2798 * 2 : feature_flags = feature bitmap from csp->config
2801 * Returns : menu string, or NULL on out-of-memory error.
2803 *********************************************************************/
2804 char *make_menu(const char *self, const unsigned feature_flags)
2806 const struct cgi_dispatcher *d;
2807 char *result = strdup("");
2811 self = "NO-SUCH-CGI!";
2814 /* List available unhidden CGI's and export as "other-cgis" */
2815 for (d = cgi_dispatchers; d->name; d++)
2818 #ifdef FEATURE_TOGGLE
2819 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2822 * Suppress the toggle link if remote toggling is disabled.
2826 #endif /* def FEATURE_TOGGLE */
2828 if (d->description && strcmp(d->name, self))
2830 char *html_encoded_prefix;
2833 * Line breaks would be great, but break
2834 * the "blocked" template's JavaScript.
2836 string_append(&result, "<li><a href=\"");
2837 html_encoded_prefix = html_encode(CGI_PREFIX);
2838 if (html_encoded_prefix == NULL)
2844 string_append(&result, html_encoded_prefix);
2845 free(html_encoded_prefix);
2847 string_append(&result, d->name);
2848 string_append(&result, "\">");
2849 string_append(&result, d->description);
2850 string_append(&result, "</a></li>");
2858 /*********************************************************************
2860 * Function : dump_map
2862 * Description : HTML-dump a map for debugging (as table)
2865 * 1 : the_map = map to dump
2867 * Returns : string with HTML
2869 *********************************************************************/
2870 char *dump_map(const struct map *the_map)
2872 struct map_entry *cur_entry;
2873 char *ret = strdup("");
2875 string_append(&ret, "<table>\n");
2877 for (cur_entry = the_map->first;
2878 (cur_entry != NULL) && (ret != NULL);
2879 cur_entry = cur_entry->next)
2881 string_append(&ret, "<tr><td><b>");
2882 string_join (&ret, html_encode(cur_entry->name));
2883 string_append(&ret, "</b></td><td>");
2884 string_join (&ret, html_encode(cur_entry->value));
2885 string_append(&ret, "</td></tr>\n");
2888 string_append(&ret, "</table>\n");