1 const char cgi_rcs[] = "$Id: cgi.c,v 1.103 2008/03/21 11:13:57 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.103 2008/03/21 11:13:57 fabiankeil
42 * Only gather host information if it's actually needed.
43 * Also move the code out of accept_connection() so it's less likely
44 * to delay other incoming connections if the host is misconfigured.
46 * Revision 1.102 2008/02/23 16:33:43 fabiankeil
47 * Let forward_url() use the standard parameter ordering
48 * and mark its second parameter immutable.
50 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
51 * Add SOCKS5 support for "Forwarding failure" CGI page.
53 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
54 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
57 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
58 * #1763173 from Stefan Huehner: declare some more functions static.
60 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
61 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
63 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
64 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
66 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
67 * Use sizeof() more often.
69 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
70 * Don't overlook map result for the forwarding-type.
72 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
73 * Use a transparent background for the PNG replacement pattern.
75 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
76 * - Save the reason for generating http_responses.
77 * - Fix --disable-toggle (again).
78 * - Use TBL birthday hack for 403 responses as well.
79 * - Uglify the @menu@ again to fix JavaScript
80 * errors on the "blocked" template.
81 * - Escape an ampersand in cgi_error_unknown().
83 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
84 * - Add HEAD support to finish_http_response.
85 * - Add error favicon to internal HTML error messages.
87 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
88 * Add new config option "templdir" to
89 * change the templates directory.
91 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
92 * Added "forwarding-failed" template support for error_response().
94 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
95 * Add favicon delivery functions.
97 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
98 * - Map variables that aren't guaranteed to be
99 * pure ASCII html_encoded.
100 * - Use CGI_PREFIX to generate URL for user manual
101 * CGI page to make sure CGI_SITE_2_PATH is included.
103 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
104 * - "Protect" against a rather lame JavaScript-based
105 * Privoxy detection "attack" and check the referrer
106 * before delivering the CGI style sheet.
107 * - Move referrer check for unsafe CGI pages into
108 * referrer_is_safe() and log the result.
109 * - Map @url@ in cgi-error-disabled page.
110 * It's required for the "go there anyway" link.
111 * - Mark *csp as immutable for grep_cgi_referrer().
113 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
114 * Fix strdup() error handling in cgi_error_unknown()
115 * and cgi_error_no_template(). Reported by Markus Elfring.
117 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
118 * Handle pcrs_execute() errors in template_fill() properly.
120 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
121 * Fixed gcc43 conversion warnings and replaced sprintf
122 * calls with snprintf to give OpenBSD's gcc one less reason
125 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
126 * Escape ampersand in Privoxy menu.
128 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
129 * Suppress the toggle link if remote toggling is disabled.
131 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
132 * Fix configure option --disable-toggle.
133 * Thanks to Peter Thoenen for reporting this.
135 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
136 * Don't lose the FORCE_PREFIX in case of
137 * connection problems. Fixes #612235.
139 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
140 * Make pthread mutex locking more generic. Instead of
141 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
142 * and use mutex locking unless there is an _r function
143 * available. Better safe than sorry.
145 * Fixes "./configure --disable-pthread" and should result
146 * in less threading-related problems on pthread-using platforms,
147 * but it still doesn't fix BR#1122404.
149 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
150 * Use CGI_PREFIX to check the referrer.
151 * The check for "http://config.privoxy.org/" fails
152 * if the user modified CGI_SITE_2_HOST.
154 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
155 * Adjusted headers for Privoxy's cgi responses:
156 * Don't set Last-Modified, Expires and Cache-Control
157 * headers for redirects; always set "Connection: close".
159 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
160 * Only predate the Last-Modified header for cgi responses
161 * that are delivered with status code 404 or 503.
163 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
164 * Mark cgi_send_user_manual as harmless,
165 * to fix the access denied problem Hal spotted.
166 * The manual has no secret content, therefore we
167 * don't have to care about "secure" referrers.
169 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
170 * Incorporate modified version of Roland Rosenfeld's patch to
171 * optionally access the user-manual via Privoxy. Closes patch 679075.
173 * Formatting changed to Privoxy style, added call to
174 * cgi_error_no_template if the requested file doesn't
175 * exist and modified check whether or not Privoxy itself
176 * should serve the manual. Should work cross-platform now.
178 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
179 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
181 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
182 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
183 * with what was really the latest development (the v_3_0_branch branch)
185 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
186 * Moved cgi_error_disabled() from cgiedit.c to
187 * cgi.c to re-enable build with --disable-editor.
188 * Fixes Bug #892744. Thanks to Matthew Fischer
191 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
192 * - Added new function cgi_redirect to handle creation of
193 * HTTP redirect messages formerly repeated in the code.
194 * - Send cgi_error_disabled instead of cgi_error_404 when
195 * referrer check fails
196 * - Dynamic content now gets Expires header field with date
199 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
200 * Bugfix: Transparent PNG was not transparent. Thanks to
201 * Dan Razzell of Starfish Systems for notice and new PNG.
203 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
204 * Security fix: dspatch_known_cgi no longer considers an empty
205 * referrer safe for critical CGIs, since malicious links could
206 * reside on https:// locations which browsers don't advertize as
207 * referrers. Closes bug #749916, thanks to Jeff Epler for the
208 * hint. Goodbye One-Click[tm] toggling :-(
210 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
213 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
214 * Killed a compiler warning on OSX
216 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
217 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
218 * (fixes bug #710056)
219 * - Show toggle info only if we have it
221 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
222 * Move declaration of struct tm dummy outside of a control block so it is
223 * accessible later on during snprintf in get_http_time.
225 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
226 * Cosmetic: Renamed cryptic variable
228 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
229 * 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.
231 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
232 * Disable access to critical CGIs via untrusted referrers.
233 * This prevents users from being tricked by malicious websites
234 * into making unintentional configuration changes:
236 * - Added flag to each cgi_dispatcher that allows or denies
238 * - Introduced proviorical function that greps for the
239 * referrer header before regular header parsing happens
240 * - Added safety check to dispatch_known_cgi. CGI is called
241 * if (cgi harmless || no referrer || we are referrer).
242 * Else a) toggle calls are modified not to change status and
243 * b) all other calls are denied.
245 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
246 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
248 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
249 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
251 * Revision 1.70 2002/05/19 11:33:20 jongfoster
252 * If a CGI error was not handled, and propogated back to
253 * dispatch_known_cgi(), then it was assumed to be "out of memory".
254 * This gave a very misleading error message.
256 * Now other errors will cause a simple message giving the error
257 * number and asking the user to report a bug.
260 * http://sourceforge.net/tracker/index.php?func=detail
261 * &aid=557905&group_id=11118&atid=111118
263 * Revision 1.69 2002/05/14 21:28:40 oes
264 * - Fixed add_help_link to link to the (now split) actions
265 * part of the config chapter
266 * - Renamed helplink export to actions-help-prefix
268 * Revision 1.68 2002/05/12 21:36:29 jongfoster
269 * Correcting function comments
271 * Revision 1.67 2002/04/30 12:02:07 oes
272 * Nit: updated a comment
274 * Revision 1.66 2002/04/26 18:32:57 jongfoster
275 * Fixing a memory leak on error
277 * Revision 1.65 2002/04/26 12:53:51 oes
278 * - New function add_help_link
279 * - default_exports now exports links to the user manual
280 * and a prefix for links into the config chapter
282 * Revision 1.64 2002/04/24 02:17:21 oes
283 * - Better descriptions for CGIs
284 * - Hide edit-actions, more shortcuts
285 * - Moved get_char_param, get_string_param and get_number_param here
288 * Revision 1.63 2002/04/15 19:06:43 jongfoster
291 * Revision 1.62 2002/04/10 19:59:46 jongfoster
292 * Fixes to #include in templates:
293 * - Didn't close main file if loading an included template fails.
294 * - I'm paranoid and want to disallow "#include /etc/passwd".
296 * Revision 1.61 2002/04/10 13:37:48 oes
297 * Made templates modular: template_load now recursive with max depth 1
299 * Revision 1.60 2002/04/08 20:50:25 swa
302 * Revision 1.59 2002/04/05 15:51:51 oes
303 * - added send-stylesheet CGI
304 * - bugfix: error-pages now get correct request protocol
306 * - kludged CGI descriptions and menu not to break JS syntax
308 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
309 * Fix Mac OSX compiler warnings
311 * Revision 1.57 2002/03/26 22:29:54 swa
312 * we have a new homepage!
314 * Revision 1.56 2002/03/24 17:50:46 jongfoster
315 * Fixing compile error if actions file editor disabled
317 * Revision 1.55 2002/03/24 16:55:06 oes
318 * Making GIF checkerboard transparent
320 * Revision 1.54 2002/03/24 16:18:15 jongfoster
323 * Revision 1.53 2002/03/24 16:06:00 oes
324 * Correct transparency for checkerboard PNG. Thanks, Magnus!
326 * Revision 1.52 2002/03/24 15:23:33 jongfoster
329 * Revision 1.51 2002/03/24 13:25:43 swa
330 * name change related issues
332 * Revision 1.50 2002/03/16 23:54:06 jongfoster
333 * Adding graceful termination feature, to help look for memory leaks.
334 * If you enable this (which, by design, has to be done by hand
335 * editing config.h) and then go to http://i.j.b/die, then the program
336 * will exit cleanly after the *next* request. It should free all the
337 * memory that was used.
339 * Revision 1.49 2002/03/13 00:27:04 jongfoster
342 * Revision 1.48 2002/03/08 17:47:07 jongfoster
345 * Revision 1.47 2002/03/08 16:41:33 oes
346 * Added GIF images again
348 * Revision 1.46 2002/03/07 03:48:38 oes
349 * - Changed built-in images from GIF to PNG
350 * (with regard to Unisys patent issue)
351 * - Added a 4x4 pattern PNG which is less intrusive
352 * than the logo but also clearly marks the deleted banners
354 * Revision 1.45 2002/03/06 22:54:35 jongfoster
355 * Automated function-comment nitpicking.
357 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
358 * - Better error reporting on OS/2
359 * - Fix double-slash comment (oops)
361 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
362 * - Re-enable OS/2 building after new parms were added
363 * - Fix false out of memory report when resolving CGI templates when no IP
364 * address is available of failed attempt (a la no such domain)
366 * Revision 1.42 2002/01/21 00:33:20 jongfoster
367 * Replacing strsav() with the safer string_append() or string_join().
368 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
369 * Adding missing html_encode() to error message generators.
370 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
372 * Revision 1.41 2002/01/17 20:56:22 jongfoster
373 * Replacing hard references to the URL of the config interface
374 * with #defines from project.h
376 * Revision 1.40 2002/01/09 14:26:46 oes
377 * Added support for thread-safe gmtime_r call.
379 * Revision 1.39 2001/11/16 00:48:13 jongfoster
380 * Fixing a compiler warning
382 * Revision 1.38 2001/11/13 00:31:21 jongfoster
383 * - Adding new CGIs for use by non-JavaScript browsers:
384 * edit-actions-url-form
385 * edit-actions-add-url-form
386 * edit-actions-remove-url-form
387 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
390 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
391 * Show enablement/disablement status in almost all templates.
392 * There is a little trickiness here: apparent recursive resolution of
393 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
394 * the actual enablement status. So a similar construct,
395 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
398 * Revision 1.36 2001/10/26 17:33:27 oes
401 * Revision 1.35 2001/10/23 21:48:19 jongfoster
402 * Cleaning up error handling in CGI functions - they now send back
403 * a HTML error page and should never cause a FATAL error. (Fixes one
404 * potential source of "denial of service" attacks).
406 * CGI actions file editor that works and is actually useful.
408 * Ability to toggle Junkbuster remotely using a CGI call.
410 * You can turn off both the above features in the main configuration
411 * file, e.g. if you are running a multi-user proxy.
413 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
414 * Only show "Local support" on templates conditionally:
415 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
416 * - if not, no Local support section appears
418 * Revision 1.33 2001/10/14 22:28:41 jongfoster
419 * Fixing stupid typo.
421 * Revision 1.32 2001/10/14 22:20:18 jongfoster
422 * - Changes to CGI dispatching method to match CGI names exactly,
423 * rather than doing a prefix match.
424 * - No longer need to count the length of the CGI handler names by hand.
425 * - Adding new handler for 404 error when disptching a CGI, if none of
426 * the handlers match.
427 * - Adding new handlers for CGI actionsfile editor.
429 * Revision 1.31 2001/10/10 10:56:39 oes
430 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
432 * Revision 1.30 2001/10/02 15:30:57 oes
433 * Introduced show-request cgi
435 * Revision 1.29 2001/09/20 15:47:44 steudten
437 * Fix BUG: Modify int size to size_t size in fill_template()
438 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
440 * Revision 1.28 2001/09/19 18:00:37 oes
441 * - Deletef time() FIXME (Can't fail under Linux either, if
442 * the argument is guaranteed to be in out address space,
445 * - Pointer notation cosmetics
446 * - Fixed a minor bug in template_fill(): Failiure of
447 * pcrs_execute() now secure.
449 * Revision 1.27 2001/09/16 17:08:54 jongfoster
450 * Moving simple CGI functions from cgi.c to new file cgisimple.c
452 * Revision 1.26 2001/09/16 15:47:37 jongfoster
453 * First version of CGI-based edit interface. This is very much a
454 * work-in-progress, and you can't actually use it to edit anything
455 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
456 * to have any effect.
458 * Revision 1.25 2001/09/16 15:02:35 jongfoster
459 * Adding i.j.b/robots.txt.
460 * Inlining add_stats() since it's only ever called from one place.
462 * Revision 1.24 2001/09/16 11:38:01 jongfoster
463 * Splitting fill_template() into 2 functions:
464 * template_load() loads the file
465 * template_fill() performs the PCRS regexps.
466 * This is because the CGI edit interface has a "table row"
467 * template which is used many times in the page - this
468 * change means it's only loaded from disk once.
470 * Revision 1.23 2001/09/16 11:16:05 jongfoster
471 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
473 * Revision 1.22 2001/09/16 11:00:10 jongfoster
474 * New function alloc_http_response, for symmetry with free_http_response
476 * Revision 1.21 2001/09/13 23:53:03 jongfoster
477 * Support for both static and dynamically generated CGI pages.
478 * Correctly setting Last-Modified: and Expires: HTTP headers.
480 * Revision 1.20 2001/09/13 23:40:36 jongfoster
481 * (Cosmetic only) Indentation correction
483 * Revision 1.19 2001/09/13 23:31:25 jongfoster
484 * Moving image data to cgi.c rather than cgi.h.
486 * Revision 1.18 2001/08/05 16:06:20 jongfoster
487 * Modifiying "struct map" so that there are now separate header and
488 * "map_entry" structures. This means that functions which modify a
489 * map no longer need to return a pointer to the modified map.
490 * Also, it no longer reverses the order of the entries (which may be
491 * important with some advanced template substitutions).
493 * Revision 1.17 2001/08/05 15:57:38 oes
494 * Adapted finish_http_response to new list_to_text
496 * Revision 1.16 2001/08/01 21:33:18 jongfoster
497 * Changes to fill_template() that reduce memory usage without having
498 * an impact on performance. I also renamed some variables so as not
499 * to clash with the C++ keywords "new" and "template".
501 * Revision 1.15 2001/08/01 21:19:22 jongfoster
502 * Moving file version information to a separate CGI page.
504 * Revision 1.14 2001/08/01 00:19:03 jongfoster
505 * New function: map_conditional() for an if-then-else syntax.
506 * Changing to use new version of show_defines()
508 * Revision 1.13 2001/07/30 22:08:36 jongfoster
509 * Tidying up #defines:
510 * - All feature #defines are now of the form FEATURE_xxx
511 * - Permanently turned off WIN_GUI_EDIT
512 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
514 * Revision 1.12 2001/07/29 18:47:05 jongfoster
515 * Adding missing #include "loadcfg.h"
517 * Revision 1.11 2001/07/18 17:24:37 oes
518 * Changed to conform to new pcrs interface
520 * Revision 1.10 2001/07/13 13:53:13 oes
521 * Removed all #ifdef PCRS and related code
523 * Revision 1.9 2001/06/29 21:45:41 oes
524 * Indentation, CRLF->LF, Tab-> Space
526 * Revision 1.8 2001/06/29 13:21:46 oes
527 * - Cosmetics: renamed and reordered functions, variables,
528 * texts, improved comments etc
530 * - Removed ij_untrusted_url() The relevant
531 * info is now part of the "untrusted" page,
532 * which is generated by filters.c:trust_url()
534 * - Generators of content now call finish_http_response()
535 * themselves, making jcc.c:chat() a little less
538 * - Removed obsolete "Pragma: no-cache" from our headers
540 * - http_responses now know their head length
542 * - fill_template now uses the new interface to pcrs, so that
543 * - long jobs (like whole files) no longer have to be assembled
544 * in a fixed size buffer
545 * - the new T (trivial) option is used, and the replacement may
546 * contain Perl syntax backrefs without confusing pcrs
548 * - Introduced default_exports() which generates a set of exports
549 * common to all CGIs and other content generators
551 * - Introduced convenience function map_block_killer()
553 * - Introduced convenience function make_menu()
555 * - Introduced CGI-like function error_response() which generates
556 * the "No such domain" and "Connect failed" messages using the
559 * - cgi_show_url_info:
560 * - adapted to new CGI features
561 * - form and answers now generated from same template
562 * - http:// prefix in URL now OK
565 * - adapted to new CGI features
566 * - no longer uses csp->init_proxy_args
569 * - moved menu generation to make_menu()
571 * - add_stats now writes single export map entries instead
574 * - Moved redirect_url() to filters.c
576 * - Fixed mem leak in free_http_response(), map_block_killer(),
578 * - Removed logentry from cancelled commit
580 * Revision 1.7 2001/06/09 10:51:58 jongfoster
581 * Changing "show URL info" handler to new style.
582 * Changing BUFSIZ ==> BUFFER_SIZE
584 * Revision 1.6 2001/06/07 23:05:19 jongfoster
585 * Removing code related to old forward and ACL files.
587 * Revision 1.5 2001/06/05 19:59:16 jongfoster
588 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
590 * Revision 1.4 2001/06/04 10:41:52 swa
591 * show version string of cgi.h and cgi.c
593 * Revision 1.3 2001/06/03 19:12:16 oes
594 * introduced new cgi handling
596 * No revisions before 1.3
598 **********************************************************************/
604 #include <sys/types.h>
618 #include "miscutil.h"
619 #include "cgisimple.h"
620 #include "jbsockets.h"
621 #ifdef FEATURE_CGI_EDIT_ACTIONS
623 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
625 /* loadcfg.h is for global_toggle_state only */
626 #ifdef FEATURE_PTHREAD
628 /* jcc.h is for mutex semaphore globals only */
629 #endif /* def FEATURE_PTHREAD */
630 const char cgi_h_rcs[] = CGI_H_VERSION;
633 * List of CGI functions: name, handler, description
634 * Note: Do NOT use single quotes in the description;
635 * this will break the dynamic "blocked" template!
637 static const struct cgi_dispatcher cgi_dispatchers[] = {
642 #ifdef FEATURE_GRACEFUL_TERMINATION
645 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
646 "this is a one click Denial Of Service attack!!!</em>",
651 #ifdef FEATURE_CGI_EDIT_ACTIONS
652 "View & change the current configuration",
654 "View the current configuration",
659 "View the source code version numbers",
663 "View the request headers.",
667 "Look up which actions apply to a URL and why",
669 #ifdef FEATURE_CGI_EDIT_ACTIONS
670 #ifdef FEATURE_TOGGLE
673 "Toggle Privoxy on or off",
675 #endif /* def FEATURE_TOGGLE */
676 { "edit-actions", /* Edit the actions list */
679 { "eaa", /* Shortcut for edit-actions-add-url-form */
680 cgi_edit_actions_add_url_form,
682 { "eau", /* Shortcut for edit-actions-url-form */
683 cgi_edit_actions_url_form,
685 { "ear", /* Shortcut for edit-actions-remove-url-form */
686 cgi_edit_actions_remove_url_form,
688 { "eal", /* Shortcut for edit-actions-list */
689 cgi_edit_actions_list,
691 { "eafu", /* Shortcut for edit-actions-for-url */
692 cgi_edit_actions_for_url,
694 { "eas", /* Shortcut for edit-actions-submit */
695 cgi_edit_actions_submit,
697 { "easa", /* Shortcut for edit-actions-section-add */
698 cgi_edit_actions_section_add,
700 { "easr", /* Shortcut for edit-actions-section-remove */
701 cgi_edit_actions_section_remove,
703 { "eass", /* Shortcut for edit-actions-section-swap */
704 cgi_edit_actions_section_swap,
706 { "edit-actions-for-url",
707 cgi_edit_actions_for_url,
708 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
709 { "edit-actions-list",
710 cgi_edit_actions_list,
711 NULL, TRUE /* Edit the actions list */ },
712 { "edit-actions-submit",
713 cgi_edit_actions_submit,
714 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
715 { "edit-actions-url",
716 cgi_edit_actions_url,
717 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
718 { "edit-actions-url-form",
719 cgi_edit_actions_url_form,
720 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
721 { "edit-actions-add-url",
722 cgi_edit_actions_add_url,
723 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
724 { "edit-actions-add-url-form",
725 cgi_edit_actions_add_url_form,
726 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
727 { "edit-actions-remove-url",
728 cgi_edit_actions_remove_url,
729 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
730 { "edit-actions-remove-url-form",
731 cgi_edit_actions_remove_url_form,
732 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
733 { "edit-actions-section-add",
734 cgi_edit_actions_section_add,
735 NULL, FALSE /* Remove a section from the actionsfile */ },
736 { "edit-actions-section-remove",
737 cgi_edit_actions_section_remove,
738 NULL, FALSE /* Remove a section from the actionsfile */ },
739 { "edit-actions-section-swap",
740 cgi_edit_actions_section_swap,
741 NULL, FALSE /* Swap two sections in the actionsfile */ },
742 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
743 { "error-favicon.ico",
744 cgi_send_error_favicon,
745 NULL, TRUE /* Sends the favicon image for error pages. */ },
747 cgi_send_default_favicon,
748 NULL, TRUE /* Sends the default favicon image. */ },
751 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
754 NULL, TRUE /* Send a built-in image */ },
757 NULL, FALSE /* Send templates/cgi-style.css */ },
759 cgi_transparent_image,
760 NULL, TRUE /* Send a transparent image (short name) */ },
762 cgi_send_user_manual,
763 NULL, TRUE /* Send user-manual */ },
764 { NULL, /* NULL Indicates end of list and default page */
766 NULL, TRUE /* Unknown CGI page */ }
771 * Built-in images for ad replacement
773 * Hint: You can encode your own images like this:
774 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
777 #ifdef FEATURE_NO_GIFS
780 * Checkerboard pattern, as a PNG.
782 const char image_pattern_data[] =
783 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
784 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
785 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
786 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
787 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
788 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
789 "\000\000\000\000\111\105\116\104\256\102\140\202";
792 * 1x1 transparant PNG.
794 const char image_blank_data[] =
795 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
796 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
797 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
798 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
799 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
800 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
801 "\000\000\000\000\111\105\116\104\256\102\140\202";
805 * Checkerboard pattern, as a GIF.
807 const char image_pattern_data[] =
808 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
809 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
810 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
811 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
815 * 1x1 transparant GIF.
817 const char image_blank_data[] =
818 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
819 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
820 "\000\001\000\000\002\002D\001\000;";
823 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
824 const size_t image_blank_length = sizeof(image_blank_data) - 1;
827 static struct http_response cgi_error_memory_response[1];
829 static struct http_response *dispatch_known_cgi(struct client_state * csp,
831 static struct map *parse_cgi_parameters(char *argstring);
834 /*********************************************************************
836 * Function : dispatch_cgi
838 * Description : Checks if a request URL has either the magical
839 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
840 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
841 * http://config.privoxy.org/). If so, it passes
842 * the (rest of the) path onto dispatch_known_cgi, which
843 * calls the relevant CGI handler function.
846 * 1 : csp = Current client state (buffers, headers, etc...)
848 * Returns : http_response if match, NULL if nonmatch or handler fail
850 *********************************************************************/
851 struct http_response *dispatch_cgi(struct client_state *csp)
853 const char *host = csp->http->host;
854 const char *path = csp->http->path;
857 * Should we intercept ?
860 /* Note: "example.com" and "example.com." are equivalent hostnames. */
862 /* Either the host matches CGI_SITE_1_HOST ..*/
863 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
864 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
865 && (path[0] == '/') )
867 /* ..then the path will all be for us. Remove leading '/' */
870 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
871 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
872 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
873 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
875 /* take everything following CGI_SITE_2_PATH */
876 path += strlen(CGI_SITE_2_PATH);
879 /* skip the forward slash after CGI_SITE_2_PATH */
882 else if (*path != '\0')
885 * weirdness: URL is /configXXX, where XXX is some string
886 * Do *NOT* intercept.
898 * This is a CGI call.
901 return dispatch_known_cgi(csp, path);
905 /*********************************************************************
907 * Function : grep_cgi_referrer
909 * Description : Ugly provisorical fix that greps the value of the
910 * referer HTTP header field out of a linked list of
911 * strings like found at csp->headers. Will disappear
914 * FIXME: csp->headers ought to be csp->http->headers
915 * FIXME: Parsing all client header lines should
916 * happen right after the request is received!
919 * 1 : csp = Current client state (buffers, headers, etc...)
921 * Returns : pointer to value (no copy!), or NULL if none found.
923 *********************************************************************/
924 static char *grep_cgi_referrer(const struct client_state *csp)
926 struct list_entry *p;
928 for (p = csp->headers->first; p != NULL; p = p->next)
930 if (p->str == NULL) continue;
931 if (strncmpic(p->str, "Referer: ", 9) == 0)
933 return ((p->str) + 9);
941 /*********************************************************************
943 * Function : referrer_is_safe
945 * Description : Decides whether we trust the Referer for
946 * CGI pages which are only meant to be reachable
947 * through Privoxy's web interface directly.
950 * 1 : csp = Current client state (buffers, headers, etc...)
952 * Returns : TRUE if the referrer is safe, or
953 * FALSE if the referrer is unsafe or not set.
955 *********************************************************************/
956 static int referrer_is_safe(const struct client_state *csp)
959 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
961 referrer = grep_cgi_referrer(csp);
963 if (NULL == referrer)
965 /* No referrer, no access */
966 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
969 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
970 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
972 /* Trustworthy referrer */
973 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
974 csp->http->url, referrer);
980 /* Untrustworthy referrer */
981 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
982 csp->http->url, referrer);
989 /*********************************************************************
991 * Function : dispatch_known_cgi
993 * Description : Processes a CGI once dispatch_cgi has determined that
994 * it matches one of the magic prefixes. Parses the path
995 * as a cgi name plus query string, prepares a map that
996 * maps CGI parameter names to their values, initializes
997 * the http_response struct, and calls the relevant CGI
1001 * 1 : csp = Current client state (buffers, headers, etc...)
1002 * 2 : path = Path of CGI, with the CGI prefix removed.
1003 * Should not have a leading "/".
1005 * Returns : http_response, or NULL on handler failure or out of
1008 *********************************************************************/
1009 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1012 const struct cgi_dispatcher *d;
1013 struct map *param_list;
1014 struct http_response *rsp;
1015 char *query_args_start;
1019 if (NULL == (path_copy = strdup(path)))
1021 return cgi_error_memory();
1023 query_args_start = path_copy;
1024 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1028 if (*query_args_start == '/')
1030 *query_args_start++ = '\0';
1031 if ((param_list = new_map()))
1033 map(param_list, "file", 1, url_decode(query_args_start), 0);
1038 if (*query_args_start == '?')
1040 *query_args_start++ = '\0';
1042 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1045 return cgi_error_memory();
1051 * path_copy = CGI call name
1052 * param_list = CGI params, as map
1055 /* Get mem for response or fail*/
1056 if (NULL == (rsp = alloc_http_response()))
1059 free_map(param_list);
1060 return cgi_error_memory();
1064 * Find and start the right CGI function
1066 d = cgi_dispatchers;
1069 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1072 * If the called CGI is either harmless, or referred
1073 * from a trusted source, start it.
1075 if (d->harmless || referrer_is_safe(csp))
1077 err = (d->handler)(csp, rsp, param_list);
1082 * Else, modify toggle calls so that they only display
1083 * the status, and deny all other calls.
1085 if (0 == strcmp(path_copy, "toggle"))
1087 unmap(param_list, "set");
1088 err = (d->handler)(csp, rsp, param_list);
1092 err = cgi_error_disabled(csp, rsp);
1097 free_map(param_list);
1099 if (err == JB_ERR_CGI_PARAMS)
1101 err = cgi_error_bad_param(csp, rsp);
1103 if (err && (err != JB_ERR_MEMORY))
1105 /* Unexpected error! Shouldn't get here */
1106 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1107 err = cgi_error_unknown(csp, rsp, err);
1112 rsp->reason = RSP_REASON_CGI_CALL;
1113 return finish_http_response(csp, rsp);
1117 /* Error in handler, probably out-of-memory */
1118 free_http_response(rsp);
1119 return cgi_error_memory();
1127 /*********************************************************************
1129 * Function : parse_cgi_parameters
1131 * Description : Parse a URL-encoded argument string into name/value
1132 * pairs and store them in a struct map list.
1135 * 1 : argstring = string to be parsed. Will be trashed.
1137 * Returns : pointer to param list, or NULL if out of memory.
1139 *********************************************************************/
1140 static struct map *parse_cgi_parameters(char *argstring)
1143 char *vector[BUFFER_SIZE];
1145 struct map *cgi_params;
1147 if (NULL == (cgi_params = new_map()))
1153 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1154 * the fragment identifier along with the request, so we must
1155 * cut it off here, so it won't pollute the CGI params:
1157 if (NULL != (p = strchr(argstring, '#')))
1162 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1164 for (i = 0; i < pairs; i++)
1166 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1169 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1171 free_map(cgi_params);
1182 /*********************************************************************
1184 * Function : get_char_param
1186 * Description : Get a single-character parameter passed to a CGI
1190 * 1 : parameters = map of cgi parameters
1191 * 2 : param_name = The name of the parameter to read
1193 * Returns : Uppercase character on success, '\0' on error.
1195 *********************************************************************/
1196 char get_char_param(const struct map *parameters,
1197 const char *param_name)
1204 ch = *(lookup(parameters, param_name));
1205 if ((ch >= 'a') && (ch <= 'z'))
1207 ch = (char)(ch - 'a' + 'A');
1214 /*********************************************************************
1216 * Function : get_string_param
1218 * Description : Get a string paramater, to be used as an
1219 * ACTION_STRING or ACTION_MULTI paramater.
1220 * Validates the input to prevent stupid/malicious
1221 * users from corrupting their action file.
1224 * 1 : parameters = map of cgi parameters
1225 * 2 : param_name = The name of the parameter to read
1226 * 3 : pparam = destination for paramater. Allocated as
1227 * part of the map "parameters", so don't free it.
1228 * Set to NULL if not specified.
1230 * Returns : JB_ERR_OK on success, or if the paramater
1231 * was not specified.
1232 * JB_ERR_MEMORY on out-of-memory.
1233 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1235 *********************************************************************/
1236 jb_err get_string_param(const struct map *parameters,
1237 const char *param_name,
1238 const char **pparam)
1250 param = lookup(parameters, param_name);
1256 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1261 * Note that the length limit is arbitrary, it just seems
1262 * sensible to limit it to *something*. There's no
1263 * technical reason for any limit at all.
1265 return JB_ERR_CGI_PARAMS;
1268 /* Check every character to see if it's legal */
1270 while ((ch = *s++) != '\0')
1272 if ( ((unsigned char)ch < (unsigned char)' ')
1275 /* Probable hack attempt, or user accidentally used '}'. */
1276 return JB_ERR_CGI_PARAMS;
1287 /*********************************************************************
1289 * Function : get_number_param
1291 * Description : Get a non-negative integer from the parameters
1292 * passed to a CGI function.
1295 * 1 : csp = Current client state (buffers, headers, etc...)
1296 * 2 : parameters = map of cgi parameters
1297 * 3 : name = Name of CGI parameter to read
1298 * 4 : pvalue = destination for value.
1299 * Set to -1 on error.
1301 * Returns : JB_ERR_OK on success
1302 * JB_ERR_MEMORY on out-of-memory
1303 * JB_ERR_CGI_PARAMS if the parameter was not specified
1306 *********************************************************************/
1307 jb_err get_number_param(struct client_state *csp,
1308 const struct map *parameters,
1323 param = lookup(parameters, name);
1326 return JB_ERR_CGI_PARAMS;
1329 /* We don't use atoi because I want to check this carefully... */
1332 while ((ch = *param++) != '\0')
1334 if ((ch < '0') || (ch > '9'))
1336 return JB_ERR_CGI_PARAMS;
1339 ch = (char)(ch - '0');
1343 * <limits.h> defines UINT_MAX
1345 * (UINT_MAX - ch) / 10 is the largest number that
1346 * can be safely multiplied by 10 then have ch added.
1348 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1350 return JB_ERR_CGI_PARAMS;
1353 value = value * 10 + (unsigned)ch;
1364 /*********************************************************************
1366 * Function : error_response
1368 * Description : returns an http_response that explains the reason
1369 * why a request failed.
1372 * 1 : csp = Current client state (buffers, headers, etc...)
1373 * 2 : templatename = Which template should be used for the answer
1374 * 3 : sys_err = system error number
1376 * Returns : A http_response. If we run out of memory, this
1377 * will be cgi_error_memory().
1379 *********************************************************************/
1380 struct http_response *error_response(struct client_state *csp,
1381 const char *templatename,
1385 struct http_response *rsp;
1386 struct map *exports = default_exports(csp, NULL);
1389 if (exports == NULL)
1391 return cgi_error_memory();
1394 if (NULL == (rsp = alloc_http_response()))
1397 return cgi_error_memory();
1400 #ifdef FEATURE_FORCE_LOAD
1401 if (csp->flags & CSP_FLAG_FORCED)
1403 path = strdup(FORCE_PREFIX);
1406 #endif /* def FEATURE_FORCE_LOAD */
1410 err = string_append(&path, csp->http->path);
1412 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1413 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1414 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1415 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1416 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1419 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1422 /* Some failures, like "404 no such domain", don't have an IP address. */
1423 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1431 free_http_response(rsp);
1432 return cgi_error_memory();
1435 if (!strcmp(templatename, "no-such-domain"))
1437 rsp->status = strdup("404 No such domain");
1438 if (rsp->status == NULL)
1441 free_http_response(rsp);
1442 return cgi_error_memory();
1444 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1446 else if (!strcmp(templatename, "forwarding-failed"))
1448 const struct forward_spec *fwd = forward_url(csp, csp->http);
1449 char *socks_type = NULL;
1452 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1453 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1457 * XXX: While the template is called forwarding-failed,
1458 * it currently only handles socks forwarding failures.
1460 assert(fwd->type != SOCKS_NONE);
1463 * Map failure reason, forwarding type and forwarder.
1465 if (NULL == csp->error_message)
1468 * Either we forgot to record the failure reason,
1469 * or the memory allocation failed.
1471 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1472 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1474 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1477 * XXX: this is almost the same code as in cgi_show_url_info()
1478 * and thus should be factored out and shared.
1483 socks_type = "socks4-";
1486 socks_type = "socks4a-";
1489 socks_type = "socks5-";
1492 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1495 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1496 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1498 if (!err) rsp->status = strdup("503 Forwarding failure");
1499 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1502 free_http_response(rsp);
1503 return cgi_error_memory();
1505 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1507 else if (!strcmp(templatename, "connect-failed"))
1509 rsp->status = strdup("503 Connect failed");
1510 if (rsp->status == NULL)
1513 free_http_response(rsp);
1514 return cgi_error_memory();
1516 rsp->reason = RSP_REASON_CONNECT_FAILED;
1519 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1522 free_http_response(rsp);
1523 return cgi_error_memory();
1526 return finish_http_response(csp, rsp);
1530 /*********************************************************************
1532 * Function : cgi_error_disabled
1534 * Description : CGI function that is called to generate an error
1535 * response if the actions editor or toggle CGI are
1536 * accessed despite having being disabled at compile-
1537 * or run-time, or if the user followed an untrusted link
1538 * to access a unsafe CGI feature that is only reachable
1539 * through Privoxy directly.
1542 * 1 : csp = Current client state (buffers, headers, etc...)
1543 * 2 : rsp = http_response data structure for output
1545 * CGI Parameters : none
1547 * Returns : JB_ERR_OK on success
1548 * JB_ERR_MEMORY on out-of-memory error.
1550 *********************************************************************/
1551 jb_err cgi_error_disabled(struct client_state *csp,
1552 struct http_response *rsp)
1554 struct map *exports;
1559 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1561 return JB_ERR_MEMORY;
1563 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1565 /* Not important enough to do anything */
1566 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1569 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1573 /*********************************************************************
1575 * Function : cgi_init_error_messages
1577 * Description : Call at the start of the program to initialize
1578 * the error message used by cgi_error_memory().
1584 *********************************************************************/
1585 void cgi_init_error_messages(void)
1587 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1588 cgi_error_memory_response->head =
1589 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1590 "Content-Type: text/html\r\n"
1592 cgi_error_memory_response->body =
1595 " <title>500 Internal Privoxy Error</title>\r\n"
1596 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1599 "<h1>500 Internal Privoxy Error</h1>\r\n"
1600 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1601 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1605 cgi_error_memory_response->head_length =
1606 strlen(cgi_error_memory_response->head);
1607 cgi_error_memory_response->content_length =
1608 strlen(cgi_error_memory_response->body);
1609 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1613 /*********************************************************************
1615 * Function : cgi_error_memory
1617 * Description : Called if a CGI function runs out of memory.
1618 * Returns a statically-allocated error response.
1622 * Returns : http_response data structure for output. This is
1623 * statically allocated, for obvious reasons.
1625 *********************************************************************/
1626 struct http_response *cgi_error_memory(void)
1628 /* assert that it's been initialized. */
1629 assert(cgi_error_memory_response->head);
1631 return cgi_error_memory_response;
1635 /*********************************************************************
1637 * Function : cgi_error_no_template
1639 * Description : Almost-CGI function that is called if a template
1640 * cannot be loaded. Note this is not a true CGI,
1641 * it takes a template name rather than a map of
1645 * 1 : csp = Current client state (buffers, headers, etc...)
1646 * 2 : rsp = http_response data structure for output
1647 * 3 : template_name = Name of template that could not
1650 * Returns : JB_ERR_OK on success
1651 * JB_ERR_MEMORY on out-of-memory error.
1653 *********************************************************************/
1654 jb_err cgi_error_no_template(struct client_state *csp,
1655 struct http_response *rsp,
1656 const char *template_name)
1658 static const char status[] =
1659 "500 Internal Privoxy Error";
1660 static const char body_prefix[] =
1663 " <title>500 Internal Privoxy Error</title>\r\n"
1664 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1667 "<h1>500 Internal Privoxy Error</h1>\r\n"
1668 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1669 "<p><b>Could not load template file <code>";
1670 static const char body_suffix[] =
1671 "</code> or one of it's included components.</b></p>\r\n"
1672 "<p>Please contact your proxy administrator.</p>\r\n"
1673 "<p>If you are the proxy administrator, please put the required file(s)"
1674 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1675 "location of the <code><i>(confdir)</i></code> directory "
1676 "is specified in the main Privoxy <code>config</code> "
1677 "file. (It's typically the Privoxy install directory"
1679 ", or <code>/etc/privoxy/</code>"
1680 #endif /* ndef _WIN32 */
1684 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1688 assert(template_name);
1690 /* Reset rsp, if needed */
1694 rsp->content_length = 0;
1695 rsp->head_length = 0;
1698 rsp->body = malloc(body_size);
1699 if (rsp->body == NULL)
1701 return JB_ERR_MEMORY;
1703 strlcpy(rsp->body, body_prefix, body_size);
1704 strlcat(rsp->body, template_name, body_size);
1705 strlcat(rsp->body, body_suffix, body_size);
1707 rsp->status = strdup(status);
1708 if (rsp->status == NULL)
1710 return JB_ERR_MEMORY;
1717 /*********************************************************************
1719 * Function : cgi_error_unknown
1721 * Description : Almost-CGI function that is called if an unexpected
1722 * error occurs in the top-level CGI dispatcher.
1723 * In this context, "unexpected" means "anything other
1724 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1725 * expected to handle all other errors internally,
1726 * since they can give more relavent error messages
1729 * Note this is not a true CGI, it takes an error
1730 * code rather than a map of parameters.
1733 * 1 : csp = Current client state (buffers, headers, etc...)
1734 * 2 : rsp = http_response data structure for output
1735 * 3 : error_to_report = Error code to report.
1737 * Returns : JB_ERR_OK on success
1738 * JB_ERR_MEMORY on out-of-memory error.
1740 *********************************************************************/
1741 jb_err cgi_error_unknown(struct client_state *csp,
1742 struct http_response *rsp,
1743 jb_err error_to_report)
1745 static const char status[] =
1746 "500 Internal Privoxy Error";
1747 static const char body_prefix[] =
1750 " <title>500 Internal Privoxy Error</title>\r\n"
1751 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1754 "<h1>500 Internal Privoxy Error</h1>\r\n"
1755 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1756 "<p><b>Unexpected internal error: ";
1757 static const char body_suffix[] =
1760 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1761 "file a bug report</a>.</p>\r\n"
1766 * Due to sizeof(errnumbuf), body_size will be slightly
1767 * bigger than necessary but it doesn't really matter.
1769 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1773 /* Reset rsp, if needed */
1777 rsp->content_length = 0;
1778 rsp->head_length = 0;
1780 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1782 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1784 rsp->body = malloc(body_size);
1785 if (rsp->body == NULL)
1787 return JB_ERR_MEMORY;
1789 strlcpy(rsp->body, body_prefix, body_size);
1790 strlcat(rsp->body, errnumbuf, body_size);
1791 strlcat(rsp->body, body_suffix, body_size);
1793 rsp->status = strdup(status);
1794 if (rsp->status == NULL)
1796 return JB_ERR_MEMORY;
1803 /*********************************************************************
1805 * Function : cgi_error_bad_param
1807 * Description : CGI function that is called if the parameters
1808 * (query string) for a CGI were wrong.
1811 * 1 : csp = Current client state (buffers, headers, etc...)
1812 * 2 : rsp = http_response data structure for output
1814 * CGI Parameters : none
1816 * Returns : JB_ERR_OK on success
1817 * JB_ERR_MEMORY on out-of-memory error.
1819 *********************************************************************/
1820 jb_err cgi_error_bad_param(struct client_state *csp,
1821 struct http_response *rsp)
1823 struct map *exports;
1828 if (NULL == (exports = default_exports(csp, NULL)))
1830 return JB_ERR_MEMORY;
1833 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1837 /*********************************************************************
1839 * Function : cgi_redirect
1841 * Description : CGI support function to generate a HTTP redirect
1845 * 1 : rsp = http_response data structure for output
1846 * 2 : target = string with the target URL
1848 * CGI Parameters : None
1850 * Returns : JB_ERR_OK on success
1851 * JB_ERR_MEMORY on out-of-memory error.
1853 *********************************************************************/
1854 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1861 err = enlist_unique_header(rsp->headers, "Location", target);
1863 rsp->status = strdup("302 Local Redirect from Privoxy");
1864 if (rsp->status == NULL)
1866 return JB_ERR_MEMORY;
1873 /*********************************************************************
1875 * Function : add_help_link
1877 * Description : Produce a copy of the string given as item,
1878 * embedded in an HTML link to its corresponding
1879 * section (item name in uppercase) in the actions
1880 * chapter of the user manual, (whose URL is given in
1881 * the config and defaults to our web site).
1883 * FIXME: I currently only work for actions, and would
1884 * like to be generalized for other topics.
1887 * 1 : item = item (will NOT be free()d.)
1888 * It is assumed to be HTML-safe.
1889 * 2 : config = The current configuration.
1891 * Returns : String with item embedded in link, or NULL on
1894 *********************************************************************/
1895 char *add_help_link(const char *item,
1896 struct configuration_spec *config)
1900 if (!item) return NULL;
1902 result = strdup("<a href=\"");
1903 if (!strncmpic(config->usermanual, "file://", 7) ||
1904 !strncmpic(config->usermanual, "http", 4))
1906 string_append(&result, config->usermanual);
1910 string_append(&result, "http://");
1911 string_append(&result, CGI_SITE_2_HOST);
1912 string_append(&result, "/user-manual/");
1914 string_append(&result, ACTIONS_HELP_PREFIX);
1915 string_join (&result, string_toupper(item));
1916 string_append(&result, "\">");
1917 string_append(&result, item);
1918 string_append(&result, "</a> ");
1924 /*********************************************************************
1926 * Function : get_http_time
1928 * Description : Get the time in a format suitable for use in a
1929 * HTTP header - e.g.:
1930 * "Sun, 06 Nov 1994 08:49:37 GMT"
1932 * XXX: Should probably get a third parameter for
1936 * 1 : time_offset = Time returned will be current time
1937 * plus this number of seconds.
1938 * 2 : buf = Destination for result. Must be long enough
1939 * to hold 29 characters plus a trailing zero.
1943 *********************************************************************/
1944 void get_http_time(int time_offset, char *buf)
1946 static const char day_names[7][4] =
1947 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1948 static const char month_names[12][4] =
1949 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1950 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1953 time_t current_time;
1954 #if defined(HAVE_GMTIME_R)
1956 * Declare dummy up here (instead of inside get/set gmt block) so it
1957 * doesn't go out of scope before it's potentially used in snprintf later.
1958 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1959 * !defined HAVE_GMTIME_R.
1966 time(¤t_time); /* get current time */
1968 current_time += time_offset;
1970 /* get and save the gmt */
1973 t = gmtime_r(¤t_time, &dummy);
1974 #elif FEATURE_PTHREAD
1975 pthread_mutex_lock(&gmtime_mutex);
1976 t = gmtime(¤t_time);
1977 pthread_mutex_unlock(&gmtime_mutex);
1979 t = gmtime(¤t_time);
1983 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1985 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1986 day_names[t->tm_wday],
1988 month_names[t->tm_mon],
1998 /*********************************************************************
2000 * Function : finish_http_response
2002 * Description : Fill in the missing headers in an http response,
2003 * and flatten the headers to an http head.
2004 * For HEAD requests the body is freed once
2005 * the Content-Length header is set.
2008 * 1 : rsp = pointer to http_response to be processed
2010 * Returns : A http_response, usually the rsp parameter.
2011 * On error, free()s rsp and returns cgi_error_memory()
2013 *********************************************************************/
2014 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2016 char buf[BUFFER_SIZE];
2019 /* Special case - do NOT change this statically allocated response,
2020 * which is ready for output anyway.
2022 if (rsp == cgi_error_memory_response)
2028 * Fill in the HTTP Status, using HTTP/1.1
2029 * unless the client asked for HTTP/1.0.
2031 snprintf(buf, sizeof(buf), "%s %s",
2032 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2033 rsp->status ? rsp->status : "200 OK");
2034 err = enlist_first(rsp->headers, buf);
2037 * Set the Content-Length
2039 if (rsp->content_length == 0)
2041 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2045 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2046 err = enlist(rsp->headers, buf);
2049 if (0 == strcmpic(csp->http->gpc, "head"))
2052 * The client only asked for the head. Dispose
2053 * the body and log an offensive message.
2055 * While it may seem to be a bit inefficient to
2056 * prepare the body if it isn't needed, it's the
2057 * only way to get the Content-Length right for
2058 * dynamic pages. We could have disposed the body
2059 * earlier, but not without duplicating the
2060 * Content-Length setting code above.
2062 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2064 rsp->content_length = 0;
2067 if (strncmpic(rsp->status, "302", 3))
2070 * If it's not a redirect without any content,
2071 * set the Content-Type to text/html if it's
2072 * not already specified.
2074 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2078 * Fill in the rest of the default headers:
2080 * Date: set to current date/time.
2081 * Last-Modified: set to date/time the page was last changed.
2082 * Expires: set to date/time page next needs reloading.
2083 * Cache-Control: set to "no-cache" if applicable.
2085 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2090 * Set Expires to about 10 min into the future so it'll get reloaded
2091 * occasionally, e.g. if Privoxy gets upgraded.
2096 get_http_time(0, buf);
2097 err = enlist_unique_header(rsp->headers, "Date", buf);
2100 /* Some date in the past. */
2101 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2105 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2106 err = enlist_unique_header(rsp->headers, "Expires", buf);
2109 else if (!strncmpic(rsp->status, "302", 3))
2111 get_http_time(0, buf);
2112 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2117 * Setting "Cache-Control" to "no-cache" and "Expires" to
2118 * the current time doesn't exactly forbid caching, it just
2119 * requires the client to revalidate the cached copy.
2121 * If a temporary problem occurs and the user tries again after
2122 * getting Privoxy's error message, a compliant browser may set the
2123 * If-Modified-Since header with the content of the error page's
2124 * Last-Modified header. More often than not, the document on the server
2125 * is older than Privoxy's error message, the server would send status code
2126 * 304 and the browser would display the outdated error message again and again.
2128 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2129 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2130 * and can be safely used to "revalidate" without getting a status code 304.
2132 * There is no need to let the useless If-Modified-Since header reach the
2133 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2135 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2137 get_http_time(0, buf);
2138 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2139 if (!strncmpic(rsp->status, "403", 3)
2140 || !strncmpic(rsp->status, "404", 3)
2141 || !strncmpic(rsp->status, "503", 3))
2143 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2147 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2149 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2150 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2156 * HTTP/1.1 applications that do not support persistent connections MUST
2157 * include the "close" connection option in every message.
2159 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2164 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2166 free_http_response(rsp);
2167 return cgi_error_memory();
2169 rsp->head_length = strlen(rsp->head);
2176 /*********************************************************************
2178 * Function : alloc_http_response
2180 * Description : Allocates a new http_response structure.
2184 * Returns : pointer to a new http_response, or NULL.
2186 *********************************************************************/
2187 struct http_response *alloc_http_response(void)
2189 return (struct http_response *) zalloc(sizeof(struct http_response));
2194 /*********************************************************************
2196 * Function : free_http_response
2198 * Description : Free the memory occupied by an http_response
2199 * and its depandant structures.
2202 * 1 : rsp = pointer to http_response to be freed
2206 *********************************************************************/
2207 void free_http_response(struct http_response *rsp)
2210 * Must special case cgi_error_memory_response, which is never freed.
2212 if (rsp && (rsp != cgi_error_memory_response))
2217 destroy_list(rsp->headers);
2224 /*********************************************************************
2226 * Function : template_load
2228 * Description : CGI support function that loads a given HTML
2229 * template, ignoring comment lines and following
2230 * #include statements up to a depth of 1.
2233 * 1 : csp = Current client state (buffers, headers, etc...)
2234 * 2 : template_ptr = Destination for pointer to loaded
2236 * 3 : templatename = name of the HTML template to be used
2237 * 4 : recursive = Flag set if this function calls itself
2238 * following an #include statament
2240 * Returns : JB_ERR_OK on success
2241 * JB_ERR_MEMORY on out-of-memory error.
2242 * JB_ERR_FILE if the template file cannot be read
2244 *********************************************************************/
2245 jb_err template_load(struct client_state *csp, char **template_ptr,
2246 const char *templatename, int recursive)
2249 char *templates_dir_path;
2252 char *included_module;
2255 char buf[BUFFER_SIZE];
2258 assert(template_ptr);
2259 assert(templatename);
2261 *template_ptr = NULL;
2263 /* Validate template name. Paranoia. */
2264 for (p = templatename; *p != 0; p++)
2266 if ( ((*p < 'a') || (*p > 'z'))
2267 && ((*p < 'A') || (*p > 'Z'))
2268 && ((*p < '0') || (*p > '9'))
2272 /* Illegal character */
2278 * Generate full path using either templdir
2279 * or confdir/templates as base directory.
2281 if (NULL != csp->config->templdir)
2283 templates_dir_path = strdup(csp->config->templdir);
2287 templates_dir_path = make_path(csp->config->confdir, "templates");
2290 if (templates_dir_path == NULL)
2292 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2294 return JB_ERR_MEMORY;
2297 full_path = make_path(templates_dir_path, templatename);
2298 free(templates_dir_path);
2299 if (full_path == NULL)
2301 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2303 return JB_ERR_MEMORY;
2306 /* Allocate buffer */
2308 file_buffer = strdup("");
2309 if (file_buffer == NULL)
2311 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2313 return JB_ERR_MEMORY;
2316 /* Open template file */
2318 if (NULL == (fp = fopen(full_path, "r")))
2320 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2328 * Read the file, ignoring comments, and honoring #include
2329 * statements, unless we're already called recursively.
2331 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2332 * This is unlikely in practise.
2334 while (fgets(buf, BUFFER_SIZE, fp))
2336 if (!recursive && !strncmp(buf, "#include ", 9))
2338 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2345 if (string_join(&file_buffer, included_module))
2348 return JB_ERR_MEMORY;
2354 /* skip lines starting with '#' */
2360 if (string_append(&file_buffer, buf))
2363 return JB_ERR_MEMORY;
2368 *template_ptr = file_buffer;
2374 /*********************************************************************
2376 * Function : template_fill
2378 * Description : CGI support function that fills in a pre-loaded
2379 * HTML template by replacing @name@ with value using
2380 * pcrs, for each item in the output map.
2382 * Note that a leading '$' charachter in the export map's
2383 * values will be stripped and toggle on backreference
2387 * 1 : template_ptr = IN: Template to be filled out.
2389 * OUT: Filled out template.
2390 * Caller must free().
2391 * 2 : exports = map with fill in symbol -> name pairs
2393 * Returns : JB_ERR_OK on success (and for uncritical errors)
2394 * JB_ERR_MEMORY on out-of-memory error
2396 *********************************************************************/
2397 jb_err template_fill(char **template_ptr, const struct map *exports)
2399 struct map_entry *m;
2401 char buf[BUFFER_SIZE];
2402 char *tmp_out_buffer;
2408 assert(template_ptr);
2409 assert(*template_ptr);
2412 file_buffer = *template_ptr;
2413 size = strlen(file_buffer) + 1;
2416 * Assemble pcrs joblist from exports map
2418 for (m = exports->first; m != NULL; m = m->next)
2420 if (*m->name == '$')
2423 * First character of name is '$', so remove this flag
2424 * character and allow backreferences ($1 etc) in the
2425 * "replace with" text.
2427 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2433 * Treat the "replace with" text as a literal string -
2434 * no quoting needed, no backreferences allowed.
2435 * ("Trivial" ['T'] flag).
2439 /* Enclose name in @@ */
2440 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2444 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2446 /* Make and run job. */
2447 job = pcrs_compile(buf, m->value, flags, &error);
2450 if (error == PCRS_ERR_NOMEM)
2453 *template_ptr = NULL;
2454 return JB_ERR_MEMORY;
2458 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2459 /* Hope it wasn't important and silently ignore the invalid job */
2464 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2467 if (NULL == tmp_out_buffer)
2469 *template_ptr = NULL;
2470 return JB_ERR_MEMORY;
2476 * Substitution failed, keep the original buffer,
2477 * log the problem and ignore it.
2479 * The user might see some unresolved @CGI_VARIABLES@,
2480 * but returning a special CGI error page seems unreasonable
2481 * and could mask more important error messages.
2483 free(tmp_out_buffer);
2484 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2485 buf, m->value, flags, pcrs_strerror(error));
2489 /* Substitution succeeded, use modified buffer. */
2491 file_buffer = tmp_out_buffer;
2499 *template_ptr = file_buffer;
2504 /*********************************************************************
2506 * Function : template_fill_for_cgi
2508 * Description : CGI support function that loads a HTML template
2509 * and fills it in. Handles file-not-found errors
2510 * by sending a HTML error message. For convenience,
2511 * this function also frees the passed "exports" map.
2514 * 1 : csp = Client state
2515 * 2 : templatename = name of the HTML template to be used
2516 * 3 : exports = map with fill in symbol -> name pairs.
2517 * Will be freed by this function.
2518 * 4 : rsp = Response structure to fill in.
2520 * Returns : JB_ERR_OK on success
2521 * JB_ERR_MEMORY on out-of-memory error
2523 *********************************************************************/
2524 jb_err template_fill_for_cgi(struct client_state *csp,
2525 const char *templatename,
2526 struct map *exports,
2527 struct http_response *rsp)
2532 assert(templatename);
2536 err = template_load(csp, &rsp->body, templatename, 0);
2537 if (err == JB_ERR_FILE)
2540 return cgi_error_no_template(csp, rsp, templatename);
2545 return err; /* JB_ERR_MEMORY */
2547 err = template_fill(&rsp->body, exports);
2553 /*********************************************************************
2555 * Function : default_exports
2557 * Description : returns a struct map list that contains exports
2558 * which are common to all CGI functions.
2561 * 1 : csp = Current client state (buffers, headers, etc...)
2562 * 2 : caller = name of CGI who calls us and which should
2563 * be excluded from the generated menu. May be
2565 * Returns : NULL if no memory, else a new map. Caller frees.
2567 *********************************************************************/
2568 struct map *default_exports(const struct client_state *csp, const char *caller)
2572 struct map * exports;
2573 int local_help_exists = 0;
2574 char *ip_address = NULL;
2575 char *hostname = NULL;
2579 exports = new_map();
2580 if (exports == NULL)
2585 if (csp->config->hostname)
2587 get_host_information(csp->cfd, &ip_address, NULL);
2588 hostname = strdup(csp->config->hostname);
2592 get_host_information(csp->cfd, &ip_address, &hostname);
2595 err = map(exports, "version", 1, html_encode(VERSION), 0);
2596 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2598 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2600 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2601 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2602 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2603 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2604 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2605 !strncmpic(csp->config->usermanual, "http", 4))
2607 /* Manual is located somewhere else, just link to it. */
2608 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2612 /* Manual is delivered by Privoxy. */
2613 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2615 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2616 #ifdef FEATURE_TOGGLE
2617 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2619 if (!err) err = map_block_killer(exports, "can-toggle");
2622 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2623 if (!err) err = map(exports, "my-port", 1, buf, 1);
2625 if(!strcmp(CODE_STATUS, "stable"))
2627 if (!err) err = map_block_killer(exports, "unstable");
2630 if (csp->config->admin_address != NULL)
2632 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2633 local_help_exists = 1;
2637 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2640 if (csp->config->proxy_info_url != NULL)
2642 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2643 local_help_exists = 1;
2647 if (!err) err = map_block_killer(exports, "have-proxy-info");
2650 if (local_help_exists == 0)
2652 if (!err) err = map_block_killer(exports, "have-help-info");
2665 /*********************************************************************
2667 * Function : map_block_killer
2669 * Description : Convenience function.
2670 * Adds a "killer" for the conditional HTML-template
2671 * block <name>, i.e. a substitution of the regex
2672 * "if-<name>-start.*if-<name>-end" to the given
2676 * 1 : exports = map to extend
2677 * 2 : name = name of conditional block
2679 * Returns : JB_ERR_OK on success
2680 * JB_ERR_MEMORY on out-of-memory error.
2682 *********************************************************************/
2683 jb_err map_block_killer(struct map *exports, const char *name)
2685 char buf[1000]; /* Will do, since the names are hardwired */
2689 assert(strlen(name) < 490);
2691 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2692 return map(exports, buf, 1, "", 1);
2696 /*********************************************************************
2698 * Function : map_block_keep
2700 * Description : Convenience function. Removes the markers used
2701 * by map-block-killer, to save a few bytes.
2702 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2705 * 1 : exports = map to extend
2706 * 2 : name = name of conditional block
2708 * Returns : JB_ERR_OK on success
2709 * JB_ERR_MEMORY on out-of-memory error.
2711 *********************************************************************/
2712 jb_err map_block_keep(struct map *exports, const char *name)
2715 char buf[500]; /* Will do, since the names are hardwired */
2719 assert(strlen(name) < 490);
2721 snprintf(buf, sizeof(buf), "if-%s-start", name);
2722 err = map(exports, buf, 1, "", 1);
2729 snprintf(buf, sizeof(buf), "if-%s-end", name);
2730 return map(exports, buf, 1, "", 1);
2734 /*********************************************************************
2736 * Function : map_conditional
2738 * Description : Convenience function.
2739 * Adds an "if-then-else" for the conditional HTML-template
2740 * block <name>, i.e. a substitution of the form:
2747 * The control structure and one of the alternatives
2751 * 1 : exports = map to extend
2752 * 2 : name = name of conditional block
2753 * 3 : choose_first = nonzero for first, zero for second.
2755 * Returns : JB_ERR_OK on success
2756 * JB_ERR_MEMORY on out-of-memory error.
2758 *********************************************************************/
2759 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2761 char buf[1000]; /* Will do, since the names are hardwired */
2766 assert(strlen(name) < 480);
2768 snprintf(buf, sizeof(buf), (choose_first
2769 ? "else-not-%s@.*@endif-%s"
2770 : "if-%s-then@.*@else-not-%s"),
2773 err = map(exports, buf, 1, "", 1);
2779 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2780 return map(exports, buf, 1, "", 1);
2784 /*********************************************************************
2786 * Function : make_menu
2788 * Description : Returns an HTML-formatted menu of the available
2789 * unhidden CGIs, excluding the one given in <self>
2790 * and the toggle CGI if toggling is disabled.
2793 * 1 : self = name of CGI to leave out, can be NULL for
2795 * 2 : feature_flags = feature bitmap from csp->config
2798 * Returns : menu string, or NULL on out-of-memory error.
2800 *********************************************************************/
2801 char *make_menu(const char *self, const unsigned feature_flags)
2803 const struct cgi_dispatcher *d;
2804 char *result = strdup("");
2808 self = "NO-SUCH-CGI!";
2811 /* List available unhidden CGI's and export as "other-cgis" */
2812 for (d = cgi_dispatchers; d->name; d++)
2815 #ifdef FEATURE_TOGGLE
2816 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2819 * Suppress the toggle link if remote toggling is disabled.
2823 #endif /* def FEATURE_TOGGLE */
2825 if (d->description && strcmp(d->name, self))
2827 char *html_encoded_prefix;
2830 * Line breaks would be great, but break
2831 * the "blocked" template's JavaScript.
2833 string_append(&result, "<li><a href=\"");
2834 html_encoded_prefix = html_encode(CGI_PREFIX);
2835 if (html_encoded_prefix == NULL)
2841 string_append(&result, html_encoded_prefix);
2842 free(html_encoded_prefix);
2844 string_append(&result, d->name);
2845 string_append(&result, "\">");
2846 string_append(&result, d->description);
2847 string_append(&result, "</a></li>");
2855 /*********************************************************************
2857 * Function : dump_map
2859 * Description : HTML-dump a map for debugging (as table)
2862 * 1 : the_map = map to dump
2864 * Returns : string with HTML
2866 *********************************************************************/
2867 char *dump_map(const struct map *the_map)
2869 struct map_entry *cur_entry;
2870 char *ret = strdup("");
2872 string_append(&ret, "<table>\n");
2874 for (cur_entry = the_map->first;
2875 (cur_entry != NULL) && (ret != NULL);
2876 cur_entry = cur_entry->next)
2878 string_append(&ret, "<tr><td><b>");
2879 string_join (&ret, html_encode(cur_entry->name));
2880 string_append(&ret, "</b></td><td>");
2881 string_join (&ret, html_encode(cur_entry->value));
2882 string_append(&ret, "</td></tr>\n");
2885 string_append(&ret, "</table>\n");