2988 lines
95 KiB
C
2988 lines
95 KiB
C
const char cgi_rcs[] = "$Id: cgi.c,v 1.116 2009/03/15 14:59:34 fabiankeil Exp $";
|
||
/*********************************************************************
|
||
*
|
||
* File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
|
||
*
|
||
* Purpose : Declares functions to intercept request, generate
|
||
* html or gif answers, and to compose HTTP resonses.
|
||
* This only contains the framework functions, the
|
||
* actual handler functions are declared elsewhere.
|
||
*
|
||
* Functions declared include:
|
||
*
|
||
*
|
||
* Copyright : Written by and Copyright (C) 2001-2004, 2006-2008
|
||
* the SourceForge Privoxy team. http://www.privoxy.org/
|
||
*
|
||
* Based on the Internet Junkbuster originally written
|
||
* by and Copyright (C) 1997 Anonymous Coders and
|
||
* Junkbusters Corporation. http://www.junkbusters.com
|
||
*
|
||
* This program is free software; you can redistribute it
|
||
* and/or modify it under the terms of the GNU General
|
||
* Public License as published by the Free Software
|
||
* Foundation; either version 2 of the License, or (at
|
||
* your option) any later version.
|
||
*
|
||
* This program is distributed in the hope that it will
|
||
* be useful, but WITHOUT ANY WARRANTY; without even the
|
||
* implied warranty of MERCHANTABILITY or FITNESS FOR A
|
||
* PARTICULAR PURPOSE. See the GNU General Public
|
||
* License for more details.
|
||
*
|
||
* The GNU General Public License should be included with
|
||
* this file. If not, you can view it at
|
||
* http://www.gnu.org/copyleft/gpl.html
|
||
* or write to the Free Software Foundation, Inc., 59
|
||
* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||
*
|
||
* Revisions :
|
||
* $Log: cgi.c,v $
|
||
* Revision 1.116 2009/03/15 14:59:34 fabiankeil
|
||
* Cosmetics.
|
||
*
|
||
* Revision 1.115 2009/03/01 18:28:23 fabiankeil
|
||
* Help clang understand that we aren't dereferencing
|
||
* NULL pointers here.
|
||
*
|
||
* Revision 1.114 2008/12/04 18:15:04 fabiankeil
|
||
* Fix some cparser warnings.
|
||
*
|
||
* Revision 1.113 2008/09/04 08:13:58 fabiankeil
|
||
* Prepare for critical sections on Windows by adding a
|
||
* layer of indirection before the pthread mutex functions.
|
||
*
|
||
* Revision 1.112 2008/08/31 16:08:12 fabiankeil
|
||
* "View the request headers" isn't more equal than the other
|
||
* menu items and thus doesn't need a trailing dot either.
|
||
*
|
||
* Revision 1.111 2008/08/31 15:59:02 fabiankeil
|
||
* There's no reason to let remote toggling support depend
|
||
* on FEATURE_CGI_EDIT_ACTIONS, so make sure it doesn't.
|
||
*
|
||
* Revision 1.110 2008/08/31 14:55:43 fabiankeil
|
||
* Add a @date@ symbol to include a date(1)-like time string
|
||
* in templates. Modified version of the patch Endre Szabo
|
||
* submitted in #2026468.
|
||
*
|
||
* Revision 1.109 2008/07/26 09:40:27 fabiankeil
|
||
* Remove the unconditional block in get_http_time().
|
||
* It's pointless now that it's no longer used to limit
|
||
* dummy's scope. While at it, remove obvious comments
|
||
* and a trailing space.
|
||
*
|
||
* Revision 1.108 2008/05/26 17:30:53 fabiankeil
|
||
* Provide an OpenSearch Description to access the
|
||
* show-url-info page through "search engine plugins".
|
||
*
|
||
* Revision 1.107 2008/05/26 16:23:19 fabiankeil
|
||
* - Fix spelling in template-not-found message.
|
||
* - Declare referrer_is_safe()'s alternative_prefix[] static.
|
||
*
|
||
* Revision 1.106 2008/05/21 15:24:38 fabiankeil
|
||
* Mark csp as immutable for a bunch of functions.
|
||
*
|
||
* Revision 1.105 2008/04/17 14:40:47 fabiankeil
|
||
* Provide get_http_time() with the buffer size so it doesn't
|
||
* have to blindly assume that the buffer is big enough.
|
||
*
|
||
* Revision 1.104 2008/03/26 18:07:06 fabiankeil
|
||
* Add hostname directive. Closes PR#1918189.
|
||
*
|
||
* Revision 1.103 2008/03/21 11:13:57 fabiankeil
|
||
* Only gather host information if it's actually needed.
|
||
* Also move the code out of accept_connection() so it's less likely
|
||
* to delay other incoming connections if the host is misconfigured.
|
||
*
|
||
* Revision 1.102 2008/02/23 16:33:43 fabiankeil
|
||
* Let forward_url() use the standard parameter ordering
|
||
* and mark its second parameter immutable.
|
||
*
|
||
* Revision 1.101 2008/02/03 15:45:06 fabiankeil
|
||
* Add SOCKS5 support for "Forwarding failure" CGI page.
|
||
*
|
||
* Revision 1.100 2007/10/17 18:40:53 fabiankeil
|
||
* - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
|
||
* - White space fix.
|
||
*
|
||
* Revision 1.99 2007/08/05 13:42:22 fabiankeil
|
||
* #1763173 from Stefan Huehner: declare some more functions static.
|
||
*
|
||
* Revision 1.98 2007/05/14 10:33:51 fabiankeil
|
||
* - Use strlcpy() and strlcat() instead of strcpy() and strcat().
|
||
*
|
||
* Revision 1.97 2007/04/09 18:11:35 fabiankeil
|
||
* Don't mistake VC++'s _snprintf() for a snprintf() replacement.
|
||
*
|
||
* Revision 1.96 2007/03/08 17:41:05 fabiankeil
|
||
* Use sizeof() more often.
|
||
*
|
||
* Revision 1.95 2007/02/10 17:01:37 fabiankeil
|
||
* Don't overlook map result for the forwarding-type.
|
||
*
|
||
* Revision 1.94 2007/02/08 19:44:49 fabiankeil
|
||
* Use a transparent background for the PNG replacement pattern.
|
||
*
|
||
* Revision 1.93 2007/02/07 10:45:22 fabiankeil
|
||
* - Save the reason for generating http_responses.
|
||
* - Fix --disable-toggle (again).
|
||
* - Use TBL birthday hack for 403 responses as well.
|
||
* - Uglify the @menu@ again to fix JavaScript
|
||
* errors on the "blocked" template.
|
||
* - Escape an ampersand in cgi_error_unknown().
|
||
*
|
||
* Revision 1.92 2007/01/28 13:41:17 fabiankeil
|
||
* - Add HEAD support to finish_http_response.
|
||
* - Add error favicon to internal HTML error messages.
|
||
*
|
||
* Revision 1.91 2007/01/27 13:09:16 fabiankeil
|
||
* Add new config option "templdir" to
|
||
* change the templates directory.
|
||
*
|
||
* Revision 1.90 2007/01/25 13:47:26 fabiankeil
|
||
* Added "forwarding-failed" template support for error_response().
|
||
*
|
||
* Revision 1.89 2007/01/23 15:51:16 fabiankeil
|
||
* Add favicon delivery functions.
|
||
*
|
||
* Revision 1.88 2007/01/23 13:14:32 fabiankeil
|
||
* - Map variables that aren't guaranteed to be
|
||
* pure ASCII html_encoded.
|
||
* - Use CGI_PREFIX to generate URL for user manual
|
||
* CGI page to make sure CGI_SITE_2_PATH is included.
|
||
*
|
||
* Revision 1.87 2007/01/22 15:34:13 fabiankeil
|
||
* - "Protect" against a rather lame JavaScript-based
|
||
* Privoxy detection "attack" and check the referrer
|
||
* before delivering the CGI style sheet.
|
||
* - Move referrer check for unsafe CGI pages into
|
||
* referrer_is_safe() and log the result.
|
||
* - Map @url@ in cgi-error-disabled page.
|
||
* It's required for the "go there anyway" link.
|
||
* - Mark *csp as immutable for grep_cgi_referrer().
|
||
*
|
||
* Revision 1.86 2007/01/09 11:54:26 fabiankeil
|
||
* Fix strdup() error handling in cgi_error_unknown()
|
||
* and cgi_error_no_template(). Reported by Markus Elfring.
|
||
*
|
||
* Revision 1.85 2007/01/05 14:19:02 fabiankeil
|
||
* Handle pcrs_execute() errors in template_fill() properly.
|
||
*
|
||
* Revision 1.84 2006/12/28 17:54:22 fabiankeil
|
||
* Fixed gcc43 conversion warnings and replaced sprintf
|
||
* calls with snprintf to give OpenBSD's gcc one less reason
|
||
* to complain.
|
||
*
|
||
* Revision 1.83 2006/12/17 19:35:19 fabiankeil
|
||
* Escape ampersand in Privoxy menu.
|
||
*
|
||
* Revision 1.82 2006/12/17 17:53:39 fabiankeil
|
||
* Suppress the toggle link if remote toggling is disabled.
|
||
*
|
||
* Revision 1.81 2006/12/09 13:49:16 fabiankeil
|
||
* Fix configure option --disable-toggle.
|
||
* Thanks to Peter Thoenen for reporting this.
|
||
*
|
||
* Revision 1.80 2006/12/08 14:45:32 fabiankeil
|
||
* Don't lose the FORCE_PREFIX in case of
|
||
* connection problems. Fixes #612235.
|
||
*
|
||
* Revision 1.79 2006/11/13 19:05:50 fabiankeil
|
||
* Make pthread mutex locking more generic. Instead of
|
||
* checking for OSX and OpenBSD, check for FEATURE_PTHREAD
|
||
* and use mutex locking unless there is an _r function
|
||
* available. Better safe than sorry.
|
||
*
|
||
* Fixes "./configure --disable-pthread" and should result
|
||
* in less threading-related problems on pthread-using platforms,
|
||
* but it still doesn't fix BR#1122404.
|
||
*
|
||
* Revision 1.78 2006/09/21 19:22:07 fabiankeil
|
||
* Use CGI_PREFIX to check the referrer.
|
||
* The check for "http://config.privoxy.org/" fails
|
||
* if the user modified CGI_SITE_2_HOST.
|
||
*
|
||
* Revision 1.77 2006/09/21 15:17:23 fabiankeil
|
||
* Adjusted headers for Privoxy's cgi responses:
|
||
* Don't set Last-Modified, Expires and Cache-Control
|
||
* headers for redirects; always set "Connection: close".
|
||
*
|
||
* Revision 1.76 2006/09/07 14:06:38 fabiankeil
|
||
* Only predate the Last-Modified header for cgi responses
|
||
* that are delivered with status code 404 or 503.
|
||
*
|
||
* Revision 1.75 2006/09/07 11:56:39 fabiankeil
|
||
* Mark cgi_send_user_manual as harmless,
|
||
* to fix the access denied problem Hal spotted.
|
||
* The manual has no secret content, therefore we
|
||
* don't have to care about "secure" referrers.
|
||
*
|
||
* Revision 1.74 2006/09/06 18:45:03 fabiankeil
|
||
* Incorporate modified version of Roland Rosenfeld's patch to
|
||
* optionally access the user-manual via Privoxy. Closes patch 679075.
|
||
*
|
||
* Formatting changed to Privoxy style, added call to
|
||
* cgi_error_no_template if the requested file doesn't
|
||
* exist and modified check whether or not Privoxy itself
|
||
* should serve the manual. Should work cross-platform now.
|
||
*
|
||
* Revision 1.73 2006/08/03 02:46:41 david__schmidt
|
||
* Incorporate Fabian Keil's patch work:
|
||
http://www.fabiankeil.de/sourcecode/privoxy/
|
||
*
|
||
* Revision 1.72 2006/07/18 14:48:45 david__schmidt
|
||
* Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
|
||
* with what was really the latest development (the v_3_0_branch branch)
|
||
*
|
||
* Revision 1.70.2.13 2004/02/17 13:30:23 oes
|
||
* Moved cgi_error_disabled() from cgiedit.c to
|
||
* cgi.c to re-enable build with --disable-editor.
|
||
* Fixes Bug #892744. Thanks to Matthew Fischer
|
||
* for spotting.
|
||
*
|
||
* Revision 1.70.2.12 2003/12/17 16:33:16 oes
|
||
* - Added new function cgi_redirect to handle creation of
|
||
* HTTP redirect messages formerly repeated in the code.
|
||
* - Send cgi_error_disabled instead of cgi_error_404 when
|
||
* referrer check fails
|
||
* - Dynamic content now gets Expires header field with date
|
||
* in the past
|
||
*
|
||
* Revision 1.70.2.11 2003/10/23 12:29:26 oes
|
||
* Bugfix: Transparent PNG was not transparent. Thanks to
|
||
* Dan Razzell of Starfish Systems for notice and new PNG.
|
||
*
|
||
* Revision 1.70.2.10 2003/06/06 07:54:25 oes
|
||
* Security fix: dspatch_known_cgi no longer considers an empty
|
||
* referrer safe for critical CGIs, since malicious links could
|
||
* reside on https:// locations which browsers don't advertize as
|
||
* referrers. Closes bug #749916, thanks to Jeff Epler for the
|
||
* hint. Goodbye One-Click[tm] toggling :-(
|
||
*
|
||
* Revision 1.70.2.9 2003/05/08 15:11:31 oes
|
||
* Nit
|
||
*
|
||
* Revision 1.70.2.8 2003/04/29 13:33:51 oes
|
||
* Killed a compiler warning on OSX
|
||
*
|
||
* Revision 1.70.2.7 2003/04/03 13:50:58 oes
|
||
* - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
|
||
* (fixes bug #710056)
|
||
* - Show toggle info only if we have it
|
||
*
|
||
* Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
|
||
* Move declaration of struct tm dummy outside of a control block so it is
|
||
* accessible later on during snprintf in get_http_time.
|
||
*
|
||
* Revision 1.70.2.5 2003/03/11 11:53:58 oes
|
||
* Cosmetic: Renamed cryptic variable
|
||
*
|
||
* Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
|
||
* 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.
|
||
*
|
||
* Revision 1.70.2.3 2002/11/28 18:14:32 oes
|
||
* Disable access to critical CGIs via untrusted referrers.
|
||
* This prevents users from being tricked by malicious websites
|
||
* into making unintentional configuration changes:
|
||
*
|
||
* - Added flag to each cgi_dispatcher that allows or denies
|
||
* external linking
|
||
* - Introduced proviorical function that greps for the
|
||
* referrer header before regular header parsing happens
|
||
* - Added safety check to dispatch_known_cgi. CGI is called
|
||
* if (cgi harmless || no referrer || we are referrer).
|
||
* Else a) toggle calls are modified not to change status and
|
||
* b) all other calls are denied.
|
||
*
|
||
* Revision 1.70.2.2 2002/11/12 16:20:37 oes
|
||
* Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
|
||
*
|
||
* Revision 1.70.2.1 2002/08/05 11:17:46 oes
|
||
* Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
|
||
*
|
||
* Revision 1.70 2002/05/19 11:33:20 jongfoster
|
||
* If a CGI error was not handled, and propogated back to
|
||
* dispatch_known_cgi(), then it was assumed to be "out of memory".
|
||
* This gave a very misleading error message.
|
||
*
|
||
* Now other errors will cause a simple message giving the error
|
||
* number and asking the user to report a bug.
|
||
*
|
||
* Bug report:
|
||
* http://sourceforge.net/tracker/index.php?func=detail
|
||
* &aid=557905&group_id=11118&atid=111118
|
||
*
|
||
* Revision 1.69 2002/05/14 21:28:40 oes
|
||
* - Fixed add_help_link to link to the (now split) actions
|
||
* part of the config chapter
|
||
* - Renamed helplink export to actions-help-prefix
|
||
*
|
||
* Revision 1.68 2002/05/12 21:36:29 jongfoster
|
||
* Correcting function comments
|
||
*
|
||
* Revision 1.67 2002/04/30 12:02:07 oes
|
||
* Nit: updated a comment
|
||
*
|
||
* Revision 1.66 2002/04/26 18:32:57 jongfoster
|
||
* Fixing a memory leak on error
|
||
*
|
||
* Revision 1.65 2002/04/26 12:53:51 oes
|
||
* - New function add_help_link
|
||
* - default_exports now exports links to the user manual
|
||
* and a prefix for links into the config chapter
|
||
*
|
||
* Revision 1.64 2002/04/24 02:17:21 oes
|
||
* - Better descriptions for CGIs
|
||
* - Hide edit-actions, more shortcuts
|
||
* - Moved get_char_param, get_string_param and get_number_param here
|
||
* from cgiedit.c
|
||
*
|
||
* Revision 1.63 2002/04/15 19:06:43 jongfoster
|
||
* Typos
|
||
*
|
||
* Revision 1.62 2002/04/10 19:59:46 jongfoster
|
||
* Fixes to #include in templates:
|
||
* - Didn't close main file if loading an included template fails.
|
||
* - I'm paranoid and want to disallow "#include /etc/passwd".
|
||
*
|
||
* Revision 1.61 2002/04/10 13:37:48 oes
|
||
* Made templates modular: template_load now recursive with max depth 1
|
||
*
|
||
* Revision 1.60 2002/04/08 20:50:25 swa
|
||
* fixed JB spelling
|
||
*
|
||
* Revision 1.59 2002/04/05 15:51:51 oes
|
||
* - added send-stylesheet CGI
|
||
* - bugfix: error-pages now get correct request protocol
|
||
* - fixed
|
||
* - kludged CGI descriptions and menu not to break JS syntax
|
||
*
|
||
* Revision 1.58 2002/03/29 03:33:13 david__schmidt
|
||
* Fix Mac OSX compiler warnings
|
||
*
|
||
* Revision 1.57 2002/03/26 22:29:54 swa
|
||
* we have a new homepage!
|
||
*
|
||
* Revision 1.56 2002/03/24 17:50:46 jongfoster
|
||
* Fixing compile error if actions file editor disabled
|
||
*
|
||
* Revision 1.55 2002/03/24 16:55:06 oes
|
||
* Making GIF checkerboard transparent
|
||
*
|
||
* Revision 1.54 2002/03/24 16:18:15 jongfoster
|
||
* Removing old logo
|
||
*
|
||
* Revision 1.53 2002/03/24 16:06:00 oes
|
||
* Correct transparency for checkerboard PNG. Thanks, Magnus!
|
||
*
|
||
* Revision 1.52 2002/03/24 15:23:33 jongfoster
|
||
* Name changes
|
||
*
|
||
* Revision 1.51 2002/03/24 13:25:43 swa
|
||
* name change related issues
|
||
*
|
||
* Revision 1.50 2002/03/16 23:54:06 jongfoster
|
||
* Adding graceful termination feature, to help look for memory leaks.
|
||
* If you enable this (which, by design, has to be done by hand
|
||
* editing config.h) and then go to http://i.j.b/die, then the program
|
||
* will exit cleanly after the *next* request. It should free all the
|
||
* memory that was used.
|
||
*
|
||
* Revision 1.49 2002/03/13 00:27:04 jongfoster
|
||
* Killing warnings
|
||
*
|
||
* Revision 1.48 2002/03/08 17:47:07 jongfoster
|
||
* Adding comments
|
||
*
|
||
* Revision 1.47 2002/03/08 16:41:33 oes
|
||
* Added GIF images again
|
||
*
|
||
* Revision 1.46 2002/03/07 03:48:38 oes
|
||
* - Changed built-in images from GIF to PNG
|
||
* (with regard to Unisys patent issue)
|
||
* - Added a 4x4 pattern PNG which is less intrusive
|
||
* than the logo but also clearly marks the deleted banners
|
||
*
|
||
* Revision 1.45 2002/03/06 22:54:35 jongfoster
|
||
* Automated function-comment nitpicking.
|
||
*
|
||
* Revision 1.44 2002/03/05 22:43:45 david__schmidt
|
||
* - Better error reporting on OS/2
|
||
* - Fix double-slash comment (oops)
|
||
*
|
||
* Revision 1.43 2002/03/05 21:33:45 david__schmidt
|
||
* - Re-enable OS/2 building after new parms were added
|
||
* - Fix false out of memory report when resolving CGI templates when no IP
|
||
* address is available of failed attempt (a la no such domain)
|
||
*
|
||
* Revision 1.42 2002/01/21 00:33:20 jongfoster
|
||
* Replacing strsav() with the safer string_append() or string_join().
|
||
* Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
|
||
* Adding missing html_encode() to error message generators.
|
||
* Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
|
||
*
|
||
* Revision 1.41 2002/01/17 20:56:22 jongfoster
|
||
* Replacing hard references to the URL of the config interface
|
||
* with #defines from project.h
|
||
*
|
||
* Revision 1.40 2002/01/09 14:26:46 oes
|
||
* Added support for thread-safe gmtime_r call.
|
||
*
|
||
* Revision 1.39 2001/11/16 00:48:13 jongfoster
|
||
* Fixing a compiler warning
|
||
*
|
||
* Revision 1.38 2001/11/13 00:31:21 jongfoster
|
||
* - Adding new CGIs for use by non-JavaScript browsers:
|
||
* edit-actions-url-form
|
||
* edit-actions-add-url-form
|
||
* edit-actions-remove-url-form
|
||
* - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
|
||
* - Fixing || bug.
|
||
*
|
||
* Revision 1.37 2001/11/01 14:28:47 david__schmidt
|
||
* Show enablement/disablement status in almost all templates.
|
||
* There is a little trickiness here: apparent recursive resolution of
|
||
* @if-enabled-then@ caused the toggle template to show status out-of-phase with
|
||
* the actual enablement status. So a similar construct,
|
||
* @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
|
||
* templates.
|
||
*
|
||
* Revision 1.36 2001/10/26 17:33:27 oes
|
||
* marginal bugfix
|
||
*
|
||
* Revision 1.35 2001/10/23 21:48:19 jongfoster
|
||
* Cleaning up error handling in CGI functions - they now send back
|
||
* a HTML error page and should never cause a FATAL error. (Fixes one
|
||
* potential source of "denial of service" attacks).
|
||
*
|
||
* CGI actions file editor that works and is actually useful.
|
||
*
|
||
* Ability to toggle Junkbuster remotely using a CGI call.
|
||
*
|
||
* You can turn off both the above features in the main configuration
|
||
* file, e.g. if you are running a multi-user proxy.
|
||
*
|
||
* Revision 1.34 2001/10/18 22:22:09 david__schmidt
|
||
* Only show "Local support" on templates conditionally:
|
||
* - if either 'admin-address' or 'proxy-info-url' are uncommented in config
|
||
* - if not, no Local support section appears
|
||
*
|
||
* Revision 1.33 2001/10/14 22:28:41 jongfoster
|
||
* Fixing stupid typo.
|
||
*
|
||
* Revision 1.32 2001/10/14 22:20:18 jongfoster
|
||
* - Changes to CGI dispatching method to match CGI names exactly,
|
||
* rather than doing a prefix match.
|
||
* - No longer need to count the length of the CGI handler names by hand.
|
||
* - Adding new handler for 404 error when disptching a CGI, if none of
|
||
* the handlers match.
|
||
* - Adding new handlers for CGI actionsfile editor.
|
||
*
|
||
* Revision 1.31 2001/10/10 10:56:39 oes
|
||
* Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
|
||
*
|
||
* Revision 1.30 2001/10/02 15:30:57 oes
|
||
* Introduced show-request cgi
|
||
*
|
||
* Revision 1.29 2001/09/20 15:47:44 steudten
|
||
*
|
||
* Fix BUG: Modify int size to size_t size in fill_template()
|
||
* - removes big trouble on machines where sizeof(int) != sizeof(size_t).
|
||
*
|
||
* Revision 1.28 2001/09/19 18:00:37 oes
|
||
* - Deletef time() FIXME (Can't fail under Linux either, if
|
||
* the argument is guaranteed to be in out address space,
|
||
* which it is.)
|
||
* - Fixed comments
|
||
* - Pointer notation cosmetics
|
||
* - Fixed a minor bug in template_fill(): Failiure of
|
||
* pcrs_execute() now secure.
|
||
*
|
||
* Revision 1.27 2001/09/16 17:08:54 jongfoster
|
||
* Moving simple CGI functions from cgi.c to new file cgisimple.c
|
||
*
|
||
* Revision 1.26 2001/09/16 15:47:37 jongfoster
|
||
* First version of CGI-based edit interface. This is very much a
|
||
* work-in-progress, and you can't actually use it to edit anything
|
||
* yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
|
||
* to have any effect.
|
||
*
|
||
* Revision 1.25 2001/09/16 15:02:35 jongfoster
|
||
* Adding i.j.b/robots.txt.
|
||
* Inlining add_stats() since it's only ever called from one place.
|
||
*
|
||
* Revision 1.24 2001/09/16 11:38:01 jongfoster
|
||
* Splitting fill_template() into 2 functions:
|
||
* template_load() loads the file
|
||
* template_fill() performs the PCRS regexps.
|
||
* This is because the CGI edit interface has a "table row"
|
||
* template which is used many times in the page - this
|
||
* change means it's only loaded from disk once.
|
||
*
|
||
* Revision 1.23 2001/09/16 11:16:05 jongfoster
|
||
* Better error handling in dispatch_cgi() and parse_cgi_parameters()
|
||
*
|
||
* Revision 1.22 2001/09/16 11:00:10 jongfoster
|
||
* New function alloc_http_response, for symmetry with free_http_response
|
||
*
|
||
* Revision 1.21 2001/09/13 23:53:03 jongfoster
|
||
* Support for both static and dynamically generated CGI pages.
|
||
* Correctly setting Last-Modified: and Expires: HTTP headers.
|
||
*
|
||
* Revision 1.20 2001/09/13 23:40:36 jongfoster
|
||
* (Cosmetic only) Indentation correction
|
||
*
|
||
* Revision 1.19 2001/09/13 23:31:25 jongfoster
|
||
* Moving image data to cgi.c rather than cgi.h.
|
||
*
|
||
* Revision 1.18 2001/08/05 16:06:20 jongfoster
|
||
* Modifiying "struct map" so that there are now separate header and
|
||
* "map_entry" structures. This means that functions which modify a
|
||
* map no longer need to return a pointer to the modified map.
|
||
* Also, it no longer reverses the order of the entries (which may be
|
||
* important with some advanced template substitutions).
|
||
*
|
||
* Revision 1.17 2001/08/05 15:57:38 oes
|
||
* Adapted finish_http_response to new list_to_text
|
||
*
|
||
* Revision 1.16 2001/08/01 21:33:18 jongfoster
|
||
* Changes to fill_template() that reduce memory usage without having
|
||
* an impact on performance. I also renamed some variables so as not
|
||
* to clash with the C++ keywords "new" and "template".
|
||
*
|
||
* Revision 1.15 2001/08/01 21:19:22 jongfoster
|
||
* Moving file version information to a separate CGI page.
|
||
*
|
||
* Revision 1.14 2001/08/01 00:19:03 jongfoster
|
||
* New function: map_conditional() for an if-then-else syntax.
|
||
* Changing to use new version of show_defines()
|
||
*
|
||
* Revision 1.13 2001/07/30 22:08:36 jongfoster
|
||
* Tidying up #defines:
|
||
* - All feature #defines are now of the form FEATURE_xxx
|
||
* - Permanently turned off WIN_GUI_EDIT
|
||
* - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
|
||
*
|
||
* Revision 1.12 2001/07/29 18:47:05 jongfoster
|
||
* Adding missing #include "loadcfg.h"
|
||
*
|
||
* Revision 1.11 2001/07/18 17:24:37 oes
|
||
* Changed to conform to new pcrs interface
|
||
*
|
||
* Revision 1.10 2001/07/13 13:53:13 oes
|
||
* Removed all #ifdef PCRS and related code
|
||
*
|
||
* Revision 1.9 2001/06/29 21:45:41 oes
|
||
* Indentation, CRLF->LF, Tab-> Space
|
||
*
|
||
* Revision 1.8 2001/06/29 13:21:46 oes
|
||
* - Cosmetics: renamed and reordered functions, variables,
|
||
* texts, improved comments etc
|
||
*
|
||
* - Removed ij_untrusted_url() The relevant
|
||
* info is now part of the "untrusted" page,
|
||
* which is generated by filters.c:trust_url()
|
||
*
|
||
* - Generators of content now call finish_http_response()
|
||
* themselves, making jcc.c:chat() a little less
|
||
* cluttered
|
||
*
|
||
* - Removed obsolete "Pragma: no-cache" from our headers
|
||
*
|
||
* - http_responses now know their head length
|
||
*
|
||
* - fill_template now uses the new interface to pcrs, so that
|
||
* - long jobs (like whole files) no longer have to be assembled
|
||
* in a fixed size buffer
|
||
* - the new T (trivial) option is used, and the replacement may
|
||
* contain Perl syntax backrefs without confusing pcrs
|
||
*
|
||
* - Introduced default_exports() which generates a set of exports
|
||
* common to all CGIs and other content generators
|
||
*
|
||
* - Introduced convenience function map_block_killer()
|
||
*
|
||
* - Introduced convenience function make_menu()
|
||
*
|
||
* - Introduced CGI-like function error_response() which generates
|
||
* the "No such domain" and "Connect failed" messages using the
|
||
* CGI platform
|
||
*
|
||
* - cgi_show_url_info:
|
||
* - adapted to new CGI features
|
||
* - form and answers now generated from same template
|
||
* - http:// prefix in URL now OK
|
||
*
|
||
* - cgi_show_status:
|
||
* - adapted to new CGI features
|
||
* - no longer uses csp->init_proxy_args
|
||
*
|
||
* - cgi_default:
|
||
* - moved menu generation to make_menu()
|
||
*
|
||
* - add_stats now writes single export map entries instead
|
||
* of a fixed string
|
||
*
|
||
* - Moved redirect_url() to filters.c
|
||
*
|
||
* - Fixed mem leak in free_http_response(), map_block_killer(),
|
||
*
|
||
* - Removed logentry from cancelled commit
|
||
*
|
||
* Revision 1.7 2001/06/09 10:51:58 jongfoster
|
||
* Changing "show URL info" handler to new style.
|
||
* Changing BUFSIZ ==> BUFFER_SIZE
|
||
*
|
||
* Revision 1.6 2001/06/07 23:05:19 jongfoster
|
||
* Removing code related to old forward and ACL files.
|
||
*
|
||
* Revision 1.5 2001/06/05 19:59:16 jongfoster
|
||
* Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
|
||
*
|
||
* Revision 1.4 2001/06/04 10:41:52 swa
|
||
* show version string of cgi.h and cgi.c
|
||
*
|
||
* Revision 1.3 2001/06/03 19:12:16 oes
|
||
* introduced new cgi handling
|
||
*
|
||
* No revisions before 1.3
|
||
*
|
||
**********************************************************************/
|
||
|
||
|
||
#include "config.h"
|
||
|
||
#include <stdio.h>
|
||
#include <sys/types.h>
|
||
#include <stdlib.h>
|
||
#include <ctype.h>
|
||
#include <string.h>
|
||
#include <limits.h>
|
||
#include <assert.h>
|
||
|
||
#include "project.h"
|
||
#include "cgi.h"
|
||
#include "list.h"
|
||
#include "encode.h"
|
||
#include "ssplit.h"
|
||
#include "errlog.h"
|
||
#include "filters.h"
|
||
#include "miscutil.h"
|
||
#include "cgisimple.h"
|
||
#include "jbsockets.h"
|
||
#if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE)
|
||
#include "cgiedit.h"
|
||
#endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */
|
||
#include "loadcfg.h"
|
||
/* loadcfg.h is for global_toggle_state only */
|
||
#ifdef FEATURE_PTHREAD
|
||
#include "jcc.h"
|
||
/* jcc.h is for mutex semaphore globals only */
|
||
#endif /* def FEATURE_PTHREAD */
|
||
const char cgi_h_rcs[] = CGI_H_VERSION;
|
||
|
||
/*
|
||
* List of CGI functions: name, handler, description
|
||
* Note: Do NOT use single quotes in the description;
|
||
* this will break the dynamic "blocked" template!
|
||
*/
|
||
static const struct cgi_dispatcher cgi_dispatchers[] = {
|
||
{ "",
|
||
cgi_default,
|
||
"Privoxy main page",
|
||
TRUE },
|
||
#ifdef FEATURE_GRACEFUL_TERMINATION
|
||
{ "die",
|
||
cgi_die,
|
||
"<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
|
||
"this is a one click Denial Of Service attack!!!</em>",
|
||
FALSE },
|
||
#endif
|
||
{ "show-status",
|
||
cgi_show_status,
|
||
#ifdef FEATURE_CGI_EDIT_ACTIONS
|
||
"View & change the current configuration",
|
||
#else
|
||
"View the current configuration",
|
||
#endif
|
||
TRUE },
|
||
{ "show-version",
|
||
cgi_show_version,
|
||
"View the source code version numbers",
|
||
TRUE },
|
||
{ "show-request",
|
||
cgi_show_request,
|
||
"View the request headers",
|
||
TRUE },
|
||
{ "show-url-info",
|
||
cgi_show_url_info,
|
||
"Look up which actions apply to a URL and why",
|
||
TRUE },
|
||
#ifdef FEATURE_TOGGLE
|
||
{ "toggle",
|
||
cgi_toggle,
|
||
"Toggle Privoxy on or off",
|
||
FALSE },
|
||
#endif /* def FEATURE_TOGGLE */
|
||
#ifdef FEATURE_CGI_EDIT_ACTIONS
|
||
{ "edit-actions", /* Edit the actions list */
|
||
cgi_edit_actions,
|
||
NULL, FALSE },
|
||
{ "eaa", /* Shortcut for edit-actions-add-url-form */
|
||
cgi_edit_actions_add_url_form,
|
||
NULL, FALSE },
|
||
{ "eau", /* Shortcut for edit-actions-url-form */
|
||
cgi_edit_actions_url_form,
|
||
NULL, FALSE },
|
||
{ "ear", /* Shortcut for edit-actions-remove-url-form */
|
||
cgi_edit_actions_remove_url_form,
|
||
NULL, FALSE },
|
||
{ "eal", /* Shortcut for edit-actions-list */
|
||
cgi_edit_actions_list,
|
||
NULL, FALSE },
|
||
{ "eafu", /* Shortcut for edit-actions-for-url */
|
||
cgi_edit_actions_for_url,
|
||
NULL, FALSE },
|
||
{ "eas", /* Shortcut for edit-actions-submit */
|
||
cgi_edit_actions_submit,
|
||
NULL, FALSE },
|
||
{ "easa", /* Shortcut for edit-actions-section-add */
|
||
cgi_edit_actions_section_add,
|
||
NULL, FALSE },
|
||
{ "easr", /* Shortcut for edit-actions-section-remove */
|
||
cgi_edit_actions_section_remove,
|
||
NULL, FALSE },
|
||
{ "eass", /* Shortcut for edit-actions-section-swap */
|
||
cgi_edit_actions_section_swap,
|
||
NULL, FALSE },
|
||
{ "edit-actions-for-url",
|
||
cgi_edit_actions_for_url,
|
||
NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
|
||
{ "edit-actions-list",
|
||
cgi_edit_actions_list,
|
||
NULL, TRUE /* Edit the actions list */ },
|
||
{ "edit-actions-submit",
|
||
cgi_edit_actions_submit,
|
||
NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
|
||
{ "edit-actions-url",
|
||
cgi_edit_actions_url,
|
||
NULL, FALSE /* Change a URL pattern in the actionsfile */ },
|
||
{ "edit-actions-url-form",
|
||
cgi_edit_actions_url_form,
|
||
NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
|
||
{ "edit-actions-add-url",
|
||
cgi_edit_actions_add_url,
|
||
NULL, FALSE /* Add a URL pattern to the actionsfile */ },
|
||
{ "edit-actions-add-url-form",
|
||
cgi_edit_actions_add_url_form,
|
||
NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
|
||
{ "edit-actions-remove-url",
|
||
cgi_edit_actions_remove_url,
|
||
NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
|
||
{ "edit-actions-remove-url-form",
|
||
cgi_edit_actions_remove_url_form,
|
||
NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
|
||
{ "edit-actions-section-add",
|
||
cgi_edit_actions_section_add,
|
||
NULL, FALSE /* Remove a section from the actionsfile */ },
|
||
{ "edit-actions-section-remove",
|
||
cgi_edit_actions_section_remove,
|
||
NULL, FALSE /* Remove a section from the actionsfile */ },
|
||
{ "edit-actions-section-swap",
|
||
cgi_edit_actions_section_swap,
|
||
NULL, FALSE /* Swap two sections in the actionsfile */ },
|
||
#endif /* def FEATURE_CGI_EDIT_ACTIONS */
|
||
{ "error-favicon.ico",
|
||
cgi_send_error_favicon,
|
||
NULL, TRUE /* Sends the favicon image for error pages. */ },
|
||
{ "favicon.ico",
|
||
cgi_send_default_favicon,
|
||
NULL, TRUE /* Sends the default favicon image. */ },
|
||
{ "robots.txt",
|
||
cgi_robots_txt,
|
||
NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
|
||
{ "send-banner",
|
||
cgi_send_banner,
|
||
NULL, TRUE /* Send a built-in image */ },
|
||
{ "send-stylesheet",
|
||
cgi_send_stylesheet,
|
||
NULL, FALSE /* Send templates/cgi-style.css */ },
|
||
{ "t",
|
||
cgi_transparent_image,
|
||
NULL, TRUE /* Send a transparent image (short name) */ },
|
||
{ "url-info-osd.xml",
|
||
cgi_send_url_info_osd,
|
||
NULL, TRUE /* Send templates/url-info-osd.xml */ },
|
||
{ "user-manual",
|
||
cgi_send_user_manual,
|
||
NULL, TRUE /* Send user-manual */ },
|
||
{ NULL, /* NULL Indicates end of list and default page */
|
||
cgi_error_404,
|
||
NULL, TRUE /* Unknown CGI page */ }
|
||
};
|
||
|
||
|
||
/*
|
||
* Built-in images for ad replacement
|
||
*
|
||
* Hint: You can encode your own images like this:
|
||
* cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
|
||
*/
|
||
|
||
#ifdef FEATURE_NO_GIFS
|
||
|
||
/*
|
||
* Checkerboard pattern, as a PNG.
|
||
*/
|
||
const char image_pattern_data[] =
|
||
"\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
|
||
"\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
|
||
"\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
|
||
"\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
|
||
"\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
|
||
"\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
|
||
"\000\000\000\000\111\105\116\104\256\102\140\202";
|
||
|
||
/*
|
||
* 1x1 transparant PNG.
|
||
*/
|
||
const char image_blank_data[] =
|
||
"\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
|
||
"\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
|
||
"\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
|
||
"\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
|
||
"\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
|
||
"\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
|
||
"\000\000\000\000\111\105\116\104\256\102\140\202";
|
||
#else
|
||
|
||
/*
|
||
* Checkerboard pattern, as a GIF.
|
||
*/
|
||
const char image_pattern_data[] =
|
||
"\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
|
||
"\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
|
||
"\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
|
||
"\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
|
||
"\270\005\000\073";
|
||
|
||
/*
|
||
* 1x1 transparant GIF.
|
||
*/
|
||
const char image_blank_data[] =
|
||
"GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
|
||
"\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
|
||
"\000\001\000\000\002\002D\001\000;";
|
||
#endif
|
||
|
||
const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
|
||
const size_t image_blank_length = sizeof(image_blank_data) - 1;
|
||
|
||
|
||
static struct http_response cgi_error_memory_response[1];
|
||
|
||
static struct http_response *dispatch_known_cgi(struct client_state * csp,
|
||
const char * path);
|
||
static struct map *parse_cgi_parameters(char *argstring);
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : dispatch_cgi
|
||
*
|
||
* Description : Checks if a request URL has either the magical
|
||
* hostname CGI_SITE_1_HOST (usually http://p.p/) or
|
||
* matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
|
||
* http://config.privoxy.org/). If so, it passes
|
||
* the (rest of the) path onto dispatch_known_cgi, which
|
||
* calls the relevant CGI handler function.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
*
|
||
* Returns : http_response if match, NULL if nonmatch or handler fail
|
||
*
|
||
*********************************************************************/
|
||
struct http_response *dispatch_cgi(struct client_state *csp)
|
||
{
|
||
const char *host = csp->http->host;
|
||
const char *path = csp->http->path;
|
||
|
||
/*
|
||
* Should we intercept ?
|
||
*/
|
||
|
||
/* Note: "example.com" and "example.com." are equivalent hostnames. */
|
||
|
||
/* Either the host matches CGI_SITE_1_HOST ..*/
|
||
if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
|
||
|| (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
|
||
&& (path[0] == '/') )
|
||
{
|
||
/* ..then the path will all be for us. Remove leading '/' */
|
||
path++;
|
||
}
|
||
/* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
|
||
else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
|
||
|| (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
|
||
&& (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
|
||
{
|
||
/* take everything following CGI_SITE_2_PATH */
|
||
path += strlen(CGI_SITE_2_PATH);
|
||
if (*path == '/')
|
||
{
|
||
/* skip the forward slash after CGI_SITE_2_PATH */
|
||
path++;
|
||
}
|
||
else if (*path != '\0')
|
||
{
|
||
/*
|
||
* weirdness: URL is /configXXX, where XXX is some string
|
||
* Do *NOT* intercept.
|
||
*/
|
||
return NULL;
|
||
}
|
||
}
|
||
else
|
||
{
|
||
/* Not a CGI */
|
||
return NULL;
|
||
}
|
||
|
||
/*
|
||
* This is a CGI call.
|
||
*/
|
||
|
||
return dispatch_known_cgi(csp, path);
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : grep_cgi_referrer
|
||
*
|
||
* Description : Ugly provisorical fix that greps the value of the
|
||
* referer HTTP header field out of a linked list of
|
||
* strings like found at csp->headers. Will disappear
|
||
* in Privoxy 3.1.
|
||
*
|
||
* FIXME: csp->headers ought to be csp->http->headers
|
||
* FIXME: Parsing all client header lines should
|
||
* happen right after the request is received!
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
*
|
||
* Returns : pointer to value (no copy!), or NULL if none found.
|
||
*
|
||
*********************************************************************/
|
||
static char *grep_cgi_referrer(const struct client_state *csp)
|
||
{
|
||
struct list_entry *p;
|
||
|
||
for (p = csp->headers->first; p != NULL; p = p->next)
|
||
{
|
||
if (p->str == NULL) continue;
|
||
if (strncmpic(p->str, "Referer: ", 9) == 0)
|
||
{
|
||
return ((p->str) + 9);
|
||
}
|
||
}
|
||
return NULL;
|
||
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : referrer_is_safe
|
||
*
|
||
* Description : Decides whether we trust the Referer for
|
||
* CGI pages which are only meant to be reachable
|
||
* through Privoxy's web interface directly.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
*
|
||
* Returns : TRUE if the referrer is safe, or
|
||
* FALSE if the referrer is unsafe or not set.
|
||
*
|
||
*********************************************************************/
|
||
static int referrer_is_safe(const struct client_state *csp)
|
||
{
|
||
char *referrer;
|
||
static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
|
||
|
||
referrer = grep_cgi_referrer(csp);
|
||
|
||
if (NULL == referrer)
|
||
{
|
||
/* No referrer, no access */
|
||
log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
|
||
csp->http->url);
|
||
}
|
||
else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
|
||
|| (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
|
||
{
|
||
/* Trustworthy referrer */
|
||
log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
|
||
csp->http->url, referrer);
|
||
|
||
return TRUE;
|
||
}
|
||
else
|
||
{
|
||
/* Untrustworthy referrer */
|
||
log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
|
||
csp->http->url, referrer);
|
||
}
|
||
|
||
return FALSE;
|
||
|
||
}
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : dispatch_known_cgi
|
||
*
|
||
* Description : Processes a CGI once dispatch_cgi has determined that
|
||
* it matches one of the magic prefixes. Parses the path
|
||
* as a cgi name plus query string, prepares a map that
|
||
* maps CGI parameter names to their values, initializes
|
||
* the http_response struct, and calls the relevant CGI
|
||
* handler function.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : path = Path of CGI, with the CGI prefix removed.
|
||
* Should not have a leading "/".
|
||
*
|
||
* Returns : http_response, or NULL on handler failure or out of
|
||
* memory.
|
||
*
|
||
*********************************************************************/
|
||
static struct http_response *dispatch_known_cgi(struct client_state * csp,
|
||
const char * path)
|
||
{
|
||
const struct cgi_dispatcher *d;
|
||
struct map *param_list;
|
||
struct http_response *rsp;
|
||
char *query_args_start;
|
||
char *path_copy;
|
||
jb_err err;
|
||
|
||
if (NULL == (path_copy = strdup(path)))
|
||
{
|
||
return cgi_error_memory();
|
||
}
|
||
query_args_start = path_copy;
|
||
while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
|
||
{
|
||
query_args_start++;
|
||
}
|
||
if (*query_args_start == '/')
|
||
{
|
||
*query_args_start++ = '\0';
|
||
if ((param_list = new_map()))
|
||
{
|
||
map(param_list, "file", 1, url_decode(query_args_start), 0);
|
||
}
|
||
}
|
||
else
|
||
{
|
||
if (*query_args_start == '?')
|
||
{
|
||
*query_args_start++ = '\0';
|
||
}
|
||
if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
|
||
{
|
||
free(path_copy);
|
||
return cgi_error_memory();
|
||
}
|
||
}
|
||
|
||
/*
|
||
* At this point:
|
||
* path_copy = CGI call name
|
||
* param_list = CGI params, as map
|
||
*/
|
||
|
||
/* Get mem for response or fail*/
|
||
if (NULL == (rsp = alloc_http_response()))
|
||
{
|
||
free(path_copy);
|
||
free_map(param_list);
|
||
return cgi_error_memory();
|
||
}
|
||
|
||
/*
|
||
* Find and start the right CGI function
|
||
*/
|
||
d = cgi_dispatchers;
|
||
for (;;)
|
||
{
|
||
if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
|
||
{
|
||
/*
|
||
* If the called CGI is either harmless, or referred
|
||
* from a trusted source, start it.
|
||
*/
|
||
if (d->harmless || referrer_is_safe(csp))
|
||
{
|
||
err = (d->handler)(csp, rsp, param_list);
|
||
}
|
||
else
|
||
{
|
||
/*
|
||
* Else, modify toggle calls so that they only display
|
||
* the status, and deny all other calls.
|
||
*/
|
||
if (0 == strcmp(path_copy, "toggle"))
|
||
{
|
||
unmap(param_list, "set");
|
||
err = (d->handler)(csp, rsp, param_list);
|
||
}
|
||
else
|
||
{
|
||
err = cgi_error_disabled(csp, rsp);
|
||
}
|
||
}
|
||
|
||
free(path_copy);
|
||
free_map(param_list);
|
||
|
||
if (err == JB_ERR_CGI_PARAMS)
|
||
{
|
||
err = cgi_error_bad_param(csp, rsp);
|
||
}
|
||
if (err && (err != JB_ERR_MEMORY))
|
||
{
|
||
/* Unexpected error! Shouldn't get here */
|
||
log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
|
||
err = cgi_error_unknown(csp, rsp, err);
|
||
}
|
||
if (!err)
|
||
{
|
||
/* It worked */
|
||
rsp->reason = RSP_REASON_CGI_CALL;
|
||
return finish_http_response(csp, rsp);
|
||
}
|
||
else
|
||
{
|
||
/* Error in handler, probably out-of-memory */
|
||
free_http_response(rsp);
|
||
return cgi_error_memory();
|
||
}
|
||
}
|
||
d++;
|
||
}
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : parse_cgi_parameters
|
||
*
|
||
* Description : Parse a URL-encoded argument string into name/value
|
||
* pairs and store them in a struct map list.
|
||
*
|
||
* Parameters :
|
||
* 1 : argstring = string to be parsed. Will be trashed.
|
||
*
|
||
* Returns : pointer to param list, or NULL if out of memory.
|
||
*
|
||
*********************************************************************/
|
||
static struct map *parse_cgi_parameters(char *argstring)
|
||
{
|
||
char *p;
|
||
char *vector[BUFFER_SIZE];
|
||
int pairs, i;
|
||
struct map *cgi_params;
|
||
|
||
if (NULL == (cgi_params = new_map()))
|
||
{
|
||
return NULL;
|
||
}
|
||
|
||
/*
|
||
* IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
|
||
* the fragment identifier along with the request, so we must
|
||
* cut it off here, so it won't pollute the CGI params:
|
||
*/
|
||
if (NULL != (p = strchr(argstring, '#')))
|
||
{
|
||
*p = '\0';
|
||
}
|
||
|
||
pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
|
||
|
||
for (i = 0; i < pairs; i++)
|
||
{
|
||
if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
|
||
{
|
||
*p = '\0';
|
||
if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
|
||
{
|
||
free_map(cgi_params);
|
||
return NULL;
|
||
}
|
||
}
|
||
}
|
||
|
||
return cgi_params;
|
||
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : get_char_param
|
||
*
|
||
* Description : Get a single-character parameter passed to a CGI
|
||
* function.
|
||
*
|
||
* Parameters :
|
||
* 1 : parameters = map of cgi parameters
|
||
* 2 : param_name = The name of the parameter to read
|
||
*
|
||
* Returns : Uppercase character on success, '\0' on error.
|
||
*
|
||
*********************************************************************/
|
||
char get_char_param(const struct map *parameters,
|
||
const char *param_name)
|
||
{
|
||
char ch;
|
||
|
||
assert(parameters);
|
||
assert(param_name);
|
||
|
||
ch = *(lookup(parameters, param_name));
|
||
if ((ch >= 'a') && (ch <= 'z'))
|
||
{
|
||
ch = (char)(ch - 'a' + 'A');
|
||
}
|
||
|
||
return ch;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : get_string_param
|
||
*
|
||
* Description : Get a string paramater, to be used as an
|
||
* ACTION_STRING or ACTION_MULTI paramater.
|
||
* Validates the input to prevent stupid/malicious
|
||
* users from corrupting their action file.
|
||
*
|
||
* Parameters :
|
||
* 1 : parameters = map of cgi parameters
|
||
* 2 : param_name = The name of the parameter to read
|
||
* 3 : pparam = destination for paramater. Allocated as
|
||
* part of the map "parameters", so don't free it.
|
||
* Set to NULL if not specified.
|
||
*
|
||
* Returns : JB_ERR_OK on success, or if the paramater
|
||
* was not specified.
|
||
* JB_ERR_MEMORY on out-of-memory.
|
||
* JB_ERR_CGI_PARAMS if the paramater is not valid.
|
||
*
|
||
*********************************************************************/
|
||
jb_err get_string_param(const struct map *parameters,
|
||
const char *param_name,
|
||
const char **pparam)
|
||
{
|
||
const char *param;
|
||
const char *s;
|
||
char ch;
|
||
|
||
assert(parameters);
|
||
assert(param_name);
|
||
assert(pparam);
|
||
|
||
*pparam = NULL;
|
||
|
||
param = lookup(parameters, param_name);
|
||
if (!*param)
|
||
{
|
||
return JB_ERR_OK;
|
||
}
|
||
|
||
if (strlen(param) >= CGI_PARAM_LEN_MAX)
|
||
{
|
||
/*
|
||
* Too long.
|
||
*
|
||
* Note that the length limit is arbitrary, it just seems
|
||
* sensible to limit it to *something*. There's no
|
||
* technical reason for any limit at all.
|
||
*/
|
||
return JB_ERR_CGI_PARAMS;
|
||
}
|
||
|
||
/* Check every character to see if it's legal */
|
||
s = param;
|
||
while ((ch = *s++) != '\0')
|
||
{
|
||
if ( ((unsigned char)ch < (unsigned char)' ')
|
||
|| (ch == '}') )
|
||
{
|
||
/* Probable hack attempt, or user accidentally used '}'. */
|
||
return JB_ERR_CGI_PARAMS;
|
||
}
|
||
}
|
||
|
||
/* Success */
|
||
*pparam = param;
|
||
|
||
return JB_ERR_OK;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : get_number_param
|
||
*
|
||
* Description : Get a non-negative integer from the parameters
|
||
* passed to a CGI function.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : parameters = map of cgi parameters
|
||
* 3 : name = Name of CGI parameter to read
|
||
* 4 : pvalue = destination for value.
|
||
* Set to -1 on error.
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory
|
||
* JB_ERR_CGI_PARAMS if the parameter was not specified
|
||
* or is not valid.
|
||
*
|
||
*********************************************************************/
|
||
jb_err get_number_param(struct client_state *csp,
|
||
const struct map *parameters,
|
||
char *name,
|
||
unsigned *pvalue)
|
||
{
|
||
const char *param;
|
||
char ch;
|
||
unsigned value;
|
||
|
||
assert(csp);
|
||
assert(parameters);
|
||
assert(name);
|
||
assert(pvalue);
|
||
|
||
*pvalue = 0;
|
||
|
||
param = lookup(parameters, name);
|
||
if (!*param)
|
||
{
|
||
return JB_ERR_CGI_PARAMS;
|
||
}
|
||
|
||
/* We don't use atoi because I want to check this carefully... */
|
||
|
||
value = 0;
|
||
while ((ch = *param++) != '\0')
|
||
{
|
||
if ((ch < '0') || (ch > '9'))
|
||
{
|
||
return JB_ERR_CGI_PARAMS;
|
||
}
|
||
|
||
ch = (char)(ch - '0');
|
||
|
||
/* Note:
|
||
*
|
||
* <limits.h> defines UINT_MAX
|
||
*
|
||
* (UINT_MAX - ch) / 10 is the largest number that
|
||
* can be safely multiplied by 10 then have ch added.
|
||
*/
|
||
if (value > ((UINT_MAX - (unsigned)ch) / 10U))
|
||
{
|
||
return JB_ERR_CGI_PARAMS;
|
||
}
|
||
|
||
value = value * 10 + (unsigned)ch;
|
||
}
|
||
|
||
/* Success */
|
||
*pvalue = value;
|
||
|
||
return JB_ERR_OK;
|
||
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : error_response
|
||
*
|
||
* Description : returns an http_response that explains the reason
|
||
* why a request failed.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : templatename = Which template should be used for the answer
|
||
* 3 : sys_err = system error number
|
||
*
|
||
* Returns : A http_response. If we run out of memory, this
|
||
* will be cgi_error_memory().
|
||
*
|
||
*********************************************************************/
|
||
struct http_response *error_response(struct client_state *csp,
|
||
const char *templatename,
|
||
int sys_err)
|
||
{
|
||
jb_err err;
|
||
struct http_response *rsp;
|
||
struct map *exports = default_exports(csp, NULL);
|
||
char *path = NULL;
|
||
|
||
if (exports == NULL)
|
||
{
|
||
return cgi_error_memory();
|
||
}
|
||
|
||
if (NULL == (rsp = alloc_http_response()))
|
||
{
|
||
free_map(exports);
|
||
return cgi_error_memory();
|
||
}
|
||
|
||
#ifdef FEATURE_FORCE_LOAD
|
||
if (csp->flags & CSP_FLAG_FORCED)
|
||
{
|
||
path = strdup(FORCE_PREFIX);
|
||
}
|
||
else
|
||
#endif /* def FEATURE_FORCE_LOAD */
|
||
{
|
||
path = strdup("");
|
||
}
|
||
err = string_append(&path, csp->http->path);
|
||
|
||
if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
|
||
if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
|
||
if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
|
||
if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
|
||
if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
|
||
if (!err)
|
||
{
|
||
err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
|
||
if (err)
|
||
{
|
||
/* Some failures, like "404 no such domain", don't have an IP address. */
|
||
err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
|
||
}
|
||
}
|
||
|
||
|
||
if (err)
|
||
{
|
||
free_map(exports);
|
||
free_http_response(rsp);
|
||
return cgi_error_memory();
|
||
}
|
||
|
||
if (!strcmp(templatename, "no-such-domain"))
|
||
{
|
||
rsp->status = strdup("404 No such domain");
|
||
if (rsp->status == NULL)
|
||
{
|
||
free_map(exports);
|
||
free_http_response(rsp);
|
||
return cgi_error_memory();
|
||
}
|
||
rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
|
||
}
|
||
else if (!strcmp(templatename, "forwarding-failed"))
|
||
{
|
||
const struct forward_spec *fwd = forward_url(csp, csp->http);
|
||
char *socks_type = NULL;
|
||
if (fwd == NULL)
|
||
{
|
||
log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
|
||
/* Never get here - LOG_LEVEL_FATAL causes program exit */
|
||
}
|
||
|
||
/*
|
||
* XXX: While the template is called forwarding-failed,
|
||
* it currently only handles socks forwarding failures.
|
||
*/
|
||
assert(fwd != NULL);
|
||
assert(fwd->type != SOCKS_NONE);
|
||
|
||
/*
|
||
* Map failure reason, forwarding type and forwarder.
|
||
*/
|
||
if (NULL == csp->error_message)
|
||
{
|
||
/*
|
||
* Either we forgot to record the failure reason,
|
||
* or the memory allocation failed.
|
||
*/
|
||
log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
|
||
csp->error_message = strdup("Failure reason missing. Check the log file for details.");
|
||
}
|
||
if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
|
||
|
||
/*
|
||
* XXX: this is almost the same code as in cgi_show_url_info()
|
||
* and thus should be factored out and shared.
|
||
*/
|
||
switch (fwd->type)
|
||
{
|
||
case SOCKS_4:
|
||
socks_type = "socks4-";
|
||
break;
|
||
case SOCKS_4A:
|
||
socks_type = "socks4a-";
|
||
break;
|
||
case SOCKS_5:
|
||
socks_type = "socks5-";
|
||
break;
|
||
default:
|
||
log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
|
||
}
|
||
|
||
if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
|
||
if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
|
||
|
||
if (!err) rsp->status = strdup("503 Forwarding failure");
|
||
if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
|
||
{
|
||
free_map(exports);
|
||
free_http_response(rsp);
|
||
return cgi_error_memory();
|
||
}
|
||
rsp->reason = RSP_REASON_FORWARDING_FAILED;
|
||
}
|
||
else if (!strcmp(templatename, "connect-failed"))
|
||
{
|
||
rsp->status = strdup("503 Connect failed");
|
||
if (rsp->status == NULL)
|
||
{
|
||
free_map(exports);
|
||
free_http_response(rsp);
|
||
return cgi_error_memory();
|
||
}
|
||
rsp->reason = RSP_REASON_CONNECT_FAILED;
|
||
}
|
||
|
||
err = template_fill_for_cgi(csp, templatename, exports, rsp);
|
||
if (err)
|
||
{
|
||
free_http_response(rsp);
|
||
return cgi_error_memory();
|
||
}
|
||
|
||
return finish_http_response(csp, rsp);
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : cgi_error_disabled
|
||
*
|
||
* Description : CGI function that is called to generate an error
|
||
* response if the actions editor or toggle CGI are
|
||
* accessed despite having being disabled at compile-
|
||
* or run-time, or if the user followed an untrusted link
|
||
* to access a unsafe CGI feature that is only reachable
|
||
* through Privoxy directly.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : rsp = http_response data structure for output
|
||
*
|
||
* CGI Parameters : none
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
jb_err cgi_error_disabled(const struct client_state *csp,
|
||
struct http_response *rsp)
|
||
{
|
||
struct map *exports;
|
||
|
||
assert(csp);
|
||
assert(rsp);
|
||
|
||
if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
|
||
{
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
if (map(exports, "url", 1, html_encode(csp->http->url), 0))
|
||
{
|
||
/* Not important enough to do anything */
|
||
log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
|
||
}
|
||
|
||
return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : cgi_init_error_messages
|
||
*
|
||
* Description : Call at the start of the program to initialize
|
||
* the error message used by cgi_error_memory().
|
||
*
|
||
* Parameters : N/A
|
||
*
|
||
* Returns : N/A
|
||
*
|
||
*********************************************************************/
|
||
void cgi_init_error_messages(void)
|
||
{
|
||
memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
|
||
cgi_error_memory_response->head =
|
||
"HTTP/1.0 500 Internal Privoxy Error\r\n"
|
||
"Content-Type: text/html\r\n"
|
||
"\r\n";
|
||
cgi_error_memory_response->body =
|
||
"<html>\r\n"
|
||
"<head>\r\n"
|
||
" <title>500 Internal Privoxy Error</title>\r\n"
|
||
" <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
|
||
"</head>\r\n"
|
||
"<body>\r\n"
|
||
"<h1>500 Internal Privoxy Error</h1>\r\n"
|
||
"<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
|
||
"<p>Please contact your proxy administrator, or try again later</p>\r\n"
|
||
"</body>\r\n"
|
||
"</html>\r\n";
|
||
|
||
cgi_error_memory_response->head_length =
|
||
strlen(cgi_error_memory_response->head);
|
||
cgi_error_memory_response->content_length =
|
||
strlen(cgi_error_memory_response->body);
|
||
cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : cgi_error_memory
|
||
*
|
||
* Description : Called if a CGI function runs out of memory.
|
||
* Returns a statically-allocated error response.
|
||
*
|
||
* Parameters : N/A
|
||
*
|
||
* Returns : http_response data structure for output. This is
|
||
* statically allocated, for obvious reasons.
|
||
*
|
||
*********************************************************************/
|
||
struct http_response *cgi_error_memory(void)
|
||
{
|
||
/* assert that it's been initialized. */
|
||
assert(cgi_error_memory_response->head);
|
||
|
||
return cgi_error_memory_response;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : cgi_error_no_template
|
||
*
|
||
* Description : Almost-CGI function that is called if a template
|
||
* cannot be loaded. Note this is not a true CGI,
|
||
* it takes a template name rather than a map of
|
||
* parameters.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : rsp = http_response data structure for output
|
||
* 3 : template_name = Name of template that could not
|
||
* be loaded.
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
jb_err cgi_error_no_template(const struct client_state *csp,
|
||
struct http_response *rsp,
|
||
const char *template_name)
|
||
{
|
||
static const char status[] =
|
||
"500 Internal Privoxy Error";
|
||
static const char body_prefix[] =
|
||
"<html>\r\n"
|
||
"<head>\r\n"
|
||
" <title>500 Internal Privoxy Error</title>\r\n"
|
||
" <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
|
||
"</head>\r\n"
|
||
"<body>\r\n"
|
||
"<h1>500 Internal Privoxy Error</h1>\r\n"
|
||
"<p>Privoxy encountered an error while processing your request:</p>\r\n"
|
||
"<p><b>Could not load template file <code>";
|
||
static const char body_suffix[] =
|
||
"</code> or one of its included components.</b></p>\r\n"
|
||
"<p>Please contact your proxy administrator.</p>\r\n"
|
||
"<p>If you are the proxy administrator, please put the required file(s)"
|
||
"in the <code><i>(confdir)</i>/templates</code> directory. The "
|
||
"location of the <code><i>(confdir)</i></code> directory "
|
||
"is specified in the main Privoxy <code>config</code> "
|
||
"file. (It's typically the Privoxy install directory"
|
||
#ifndef _WIN32
|
||
", or <code>/etc/privoxy/</code>"
|
||
#endif /* ndef _WIN32 */
|
||
").</p>\r\n"
|
||
"</body>\r\n"
|
||
"</html>\r\n";
|
||
const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
|
||
|
||
assert(csp);
|
||
assert(rsp);
|
||
assert(template_name);
|
||
|
||
/* Reset rsp, if needed */
|
||
freez(rsp->status);
|
||
freez(rsp->head);
|
||
freez(rsp->body);
|
||
rsp->content_length = 0;
|
||
rsp->head_length = 0;
|
||
rsp->is_static = 0;
|
||
|
||
rsp->body = malloc(body_size);
|
||
if (rsp->body == NULL)
|
||
{
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
strlcpy(rsp->body, body_prefix, body_size);
|
||
strlcat(rsp->body, template_name, body_size);
|
||
strlcat(rsp->body, body_suffix, body_size);
|
||
|
||
rsp->status = strdup(status);
|
||
if (rsp->status == NULL)
|
||
{
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
return JB_ERR_OK;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : cgi_error_unknown
|
||
*
|
||
* Description : Almost-CGI function that is called if an unexpected
|
||
* error occurs in the top-level CGI dispatcher.
|
||
* In this context, "unexpected" means "anything other
|
||
* than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
|
||
* expected to handle all other errors internally,
|
||
* since they can give more relavent error messages
|
||
* that way.
|
||
*
|
||
* Note this is not a true CGI, it takes an error
|
||
* code rather than a map of parameters.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : rsp = http_response data structure for output
|
||
* 3 : error_to_report = Error code to report.
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
jb_err cgi_error_unknown(const struct client_state *csp,
|
||
struct http_response *rsp,
|
||
jb_err error_to_report)
|
||
{
|
||
static const char status[] =
|
||
"500 Internal Privoxy Error";
|
||
static const char body_prefix[] =
|
||
"<html>\r\n"
|
||
"<head>\r\n"
|
||
" <title>500 Internal Privoxy Error</title>\r\n"
|
||
" <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
|
||
"</head>\r\n"
|
||
"<body>\r\n"
|
||
"<h1>500 Internal Privoxy Error</h1>\r\n"
|
||
"<p>Privoxy encountered an error while processing your request:</p>\r\n"
|
||
"<p><b>Unexpected internal error: ";
|
||
static const char body_suffix[] =
|
||
"</b></p>\r\n"
|
||
"<p>Please "
|
||
"<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
|
||
"file a bug report</a>.</p>\r\n"
|
||
"</body>\r\n"
|
||
"</html>\r\n";
|
||
char errnumbuf[30];
|
||
/*
|
||
* Due to sizeof(errnumbuf), body_size will be slightly
|
||
* bigger than necessary but it doesn't really matter.
|
||
*/
|
||
const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
|
||
assert(csp);
|
||
assert(rsp);
|
||
|
||
/* Reset rsp, if needed */
|
||
freez(rsp->status);
|
||
freez(rsp->head);
|
||
freez(rsp->body);
|
||
rsp->content_length = 0;
|
||
rsp->head_length = 0;
|
||
rsp->is_static = 0;
|
||
rsp->reason = RSP_REASON_INTERNAL_ERROR;
|
||
|
||
snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
|
||
|
||
rsp->body = malloc(body_size);
|
||
if (rsp->body == NULL)
|
||
{
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
strlcpy(rsp->body, body_prefix, body_size);
|
||
strlcat(rsp->body, errnumbuf, body_size);
|
||
strlcat(rsp->body, body_suffix, body_size);
|
||
|
||
rsp->status = strdup(status);
|
||
if (rsp->status == NULL)
|
||
{
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
return JB_ERR_OK;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : cgi_error_bad_param
|
||
*
|
||
* Description : CGI function that is called if the parameters
|
||
* (query string) for a CGI were wrong.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : rsp = http_response data structure for output
|
||
*
|
||
* CGI Parameters : none
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
jb_err cgi_error_bad_param(const struct client_state *csp,
|
||
struct http_response *rsp)
|
||
{
|
||
struct map *exports;
|
||
|
||
assert(csp);
|
||
assert(rsp);
|
||
|
||
if (NULL == (exports = default_exports(csp, NULL)))
|
||
{
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : cgi_redirect
|
||
*
|
||
* Description : CGI support function to generate a HTTP redirect
|
||
* message
|
||
*
|
||
* Parameters :
|
||
* 1 : rsp = http_response data structure for output
|
||
* 2 : target = string with the target URL
|
||
*
|
||
* CGI Parameters : None
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
jb_err cgi_redirect (struct http_response * rsp, const char *target)
|
||
{
|
||
jb_err err;
|
||
|
||
assert(rsp);
|
||
assert(target);
|
||
|
||
err = enlist_unique_header(rsp->headers, "Location", target);
|
||
|
||
rsp->status = strdup("302 Local Redirect from Privoxy");
|
||
if (rsp->status == NULL)
|
||
{
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
return err;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : add_help_link
|
||
*
|
||
* Description : Produce a copy of the string given as item,
|
||
* embedded in an HTML link to its corresponding
|
||
* section (item name in uppercase) in the actions
|
||
* chapter of the user manual, (whose URL is given in
|
||
* the config and defaults to our web site).
|
||
*
|
||
* FIXME: I currently only work for actions, and would
|
||
* like to be generalized for other topics.
|
||
*
|
||
* Parameters :
|
||
* 1 : item = item (will NOT be free()d.)
|
||
* It is assumed to be HTML-safe.
|
||
* 2 : config = The current configuration.
|
||
*
|
||
* Returns : String with item embedded in link, or NULL on
|
||
* out-of-memory
|
||
*
|
||
*********************************************************************/
|
||
char *add_help_link(const char *item,
|
||
struct configuration_spec *config)
|
||
{
|
||
char *result;
|
||
|
||
if (!item) return NULL;
|
||
|
||
result = strdup("<a href=\"");
|
||
if (!strncmpic(config->usermanual, "file://", 7) ||
|
||
!strncmpic(config->usermanual, "http", 4))
|
||
{
|
||
string_append(&result, config->usermanual);
|
||
}
|
||
else
|
||
{
|
||
string_append(&result, "http://");
|
||
string_append(&result, CGI_SITE_2_HOST);
|
||
string_append(&result, "/user-manual/");
|
||
}
|
||
string_append(&result, ACTIONS_HELP_PREFIX);
|
||
string_join (&result, string_toupper(item));
|
||
string_append(&result, "\">");
|
||
string_append(&result, item);
|
||
string_append(&result, "</a> ");
|
||
|
||
return result;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : get_http_time
|
||
*
|
||
* Description : Get the time in a format suitable for use in a
|
||
* HTTP header - e.g.:
|
||
* "Sun, 06 Nov 1994 08:49:37 GMT"
|
||
*
|
||
* Parameters :
|
||
* 1 : time_offset = Time returned will be current time
|
||
* plus this number of seconds.
|
||
* 2 : buf = Destination for result.
|
||
* 3 : buffer_size = Size of the buffer above. Must be big
|
||
* enough to hold 29 characters plus a
|
||
* trailing zero.
|
||
*
|
||
* Returns : N/A
|
||
*
|
||
*********************************************************************/
|
||
void get_http_time(int time_offset, char *buf, size_t buffer_size)
|
||
{
|
||
static const char day_names[7][4] =
|
||
{ "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
|
||
static const char month_names[12][4] =
|
||
{ "Jan", "Feb", "Mar", "Apr", "May", "Jun",
|
||
"Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
|
||
|
||
struct tm *t;
|
||
time_t current_time;
|
||
#if defined(HAVE_GMTIME_R)
|
||
struct tm dummy;
|
||
#endif
|
||
|
||
assert(buf);
|
||
assert(buffer_size > (size_t)29);
|
||
|
||
time(¤t_time);
|
||
|
||
current_time += time_offset;
|
||
|
||
/* get and save the gmt */
|
||
#if HAVE_GMTIME_R
|
||
t = gmtime_r(¤t_time, &dummy);
|
||
#elif FEATURE_PTHREAD
|
||
privoxy_mutex_lock(&gmtime_mutex);
|
||
t = gmtime(¤t_time);
|
||
privoxy_mutex_unlock(&gmtime_mutex);
|
||
#else
|
||
t = gmtime(¤t_time);
|
||
#endif
|
||
|
||
/* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
|
||
snprintf(buf, buffer_size,
|
||
"%s, %02d %s %4d %02d:%02d:%02d GMT",
|
||
day_names[t->tm_wday],
|
||
t->tm_mday,
|
||
month_names[t->tm_mon],
|
||
t->tm_year + 1900,
|
||
t->tm_hour,
|
||
t->tm_min,
|
||
t->tm_sec
|
||
);
|
||
|
||
}
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : get_locale_time
|
||
*
|
||
* Description : Get the time in a date(1)-like format
|
||
* according to the current locale - e.g.:
|
||
* "Fri Aug 29 19:37:12 CEST 2008"
|
||
*
|
||
* XXX: Should we allow the user to change the format?
|
||
*
|
||
* Parameters :
|
||
* 1 : buf = Destination for result.
|
||
* 2 : buffer_size = Size of the buffer above. Must be big
|
||
* enough to hold 29 characters plus a
|
||
* trailing zero.
|
||
*
|
||
* Returns : N/A
|
||
*
|
||
*********************************************************************/
|
||
static void get_locale_time(char *buf, size_t buffer_size)
|
||
{
|
||
struct tm *timeptr;
|
||
time_t current_time;
|
||
#if defined(HAVE_LOCALTIME_R)
|
||
struct tm dummy;
|
||
#endif
|
||
|
||
assert(buf);
|
||
assert(buffer_size > (size_t)29);
|
||
|
||
time(¤t_time);
|
||
|
||
#if HAVE_LOCALTIME_R
|
||
timeptr = localtime_r(¤t_time, &dummy);
|
||
#elif FEATURE_PTHREAD
|
||
privoxy_mutex_lock(&localtime_mutex);
|
||
timeptr = localtime(¤t_time);
|
||
privoxy_mutex_unlock(&localtime_mutex);
|
||
#else
|
||
timeptr = localtime(¤t_time);
|
||
#endif
|
||
|
||
strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
|
||
|
||
}
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : finish_http_response
|
||
*
|
||
* Description : Fill in the missing headers in an http response,
|
||
* and flatten the headers to an http head.
|
||
* For HEAD requests the body is freed once
|
||
* the Content-Length header is set.
|
||
*
|
||
* Parameters :
|
||
* 1 : rsp = pointer to http_response to be processed
|
||
*
|
||
* Returns : A http_response, usually the rsp parameter.
|
||
* On error, free()s rsp and returns cgi_error_memory()
|
||
*
|
||
*********************************************************************/
|
||
struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
|
||
{
|
||
char buf[BUFFER_SIZE];
|
||
jb_err err;
|
||
|
||
/* Special case - do NOT change this statically allocated response,
|
||
* which is ready for output anyway.
|
||
*/
|
||
if (rsp == cgi_error_memory_response)
|
||
{
|
||
return rsp;
|
||
}
|
||
|
||
/*
|
||
* Fill in the HTTP Status, using HTTP/1.1
|
||
* unless the client asked for HTTP/1.0.
|
||
*/
|
||
snprintf(buf, sizeof(buf), "%s %s",
|
||
strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
|
||
rsp->status ? rsp->status : "200 OK");
|
||
err = enlist_first(rsp->headers, buf);
|
||
|
||
/*
|
||
* Set the Content-Length
|
||
*/
|
||
if (rsp->content_length == 0)
|
||
{
|
||
rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
|
||
}
|
||
if (!err)
|
||
{
|
||
snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
|
||
err = enlist(rsp->headers, buf);
|
||
}
|
||
|
||
if (0 == strcmpic(csp->http->gpc, "head"))
|
||
{
|
||
/*
|
||
* The client only asked for the head. Dispose
|
||
* the body and log an offensive message.
|
||
*
|
||
* While it may seem to be a bit inefficient to
|
||
* prepare the body if it isn't needed, it's the
|
||
* only way to get the Content-Length right for
|
||
* dynamic pages. We could have disposed the body
|
||
* earlier, but not without duplicating the
|
||
* Content-Length setting code above.
|
||
*/
|
||
log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
|
||
freez(rsp->body);
|
||
rsp->content_length = 0;
|
||
}
|
||
|
||
if (strncmpic(rsp->status, "302", 3))
|
||
{
|
||
/*
|
||
* If it's not a redirect without any content,
|
||
* set the Content-Type to text/html if it's
|
||
* not already specified.
|
||
*/
|
||
if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
|
||
}
|
||
|
||
/*
|
||
* Fill in the rest of the default headers:
|
||
*
|
||
* Date: set to current date/time.
|
||
* Last-Modified: set to date/time the page was last changed.
|
||
* Expires: set to date/time page next needs reloading.
|
||
* Cache-Control: set to "no-cache" if applicable.
|
||
*
|
||
* See http://www.w3.org/Protocols/rfc2068/rfc2068
|
||
*/
|
||
if (rsp->is_static)
|
||
{
|
||
/*
|
||
* Set Expires to about 10 min into the future so it'll get reloaded
|
||
* occasionally, e.g. if Privoxy gets upgraded.
|
||
*/
|
||
|
||
if (!err)
|
||
{
|
||
get_http_time(0, buf, sizeof(buf));
|
||
err = enlist_unique_header(rsp->headers, "Date", buf);
|
||
}
|
||
|
||
/* Some date in the past. */
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
|
||
|
||
if (!err)
|
||
{
|
||
get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
|
||
err = enlist_unique_header(rsp->headers, "Expires", buf);
|
||
}
|
||
}
|
||
else if (!strncmpic(rsp->status, "302", 3))
|
||
{
|
||
get_http_time(0, buf, sizeof(buf));
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
|
||
}
|
||
else
|
||
{
|
||
/*
|
||
* Setting "Cache-Control" to "no-cache" and "Expires" to
|
||
* the current time doesn't exactly forbid caching, it just
|
||
* requires the client to revalidate the cached copy.
|
||
*
|
||
* If a temporary problem occurs and the user tries again after
|
||
* getting Privoxy's error message, a compliant browser may set the
|
||
* If-Modified-Since header with the content of the error page's
|
||
* Last-Modified header. More often than not, the document on the server
|
||
* is older than Privoxy's error message, the server would send status code
|
||
* 304 and the browser would display the outdated error message again and again.
|
||
*
|
||
* For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
|
||
* to Tim Berners-Lee's birthday, which predates the age of any page on the web
|
||
* and can be safely used to "revalidate" without getting a status code 304.
|
||
*
|
||
* There is no need to let the useless If-Modified-Since header reach the
|
||
* server, it is therefore stripped by client_if_modified_since in parsers.c.
|
||
*/
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
|
||
|
||
get_http_time(0, buf, sizeof(buf));
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
|
||
if (!strncmpic(rsp->status, "403", 3)
|
||
|| !strncmpic(rsp->status, "404", 3)
|
||
|| !strncmpic(rsp->status, "503", 3))
|
||
{
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
|
||
}
|
||
else
|
||
{
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
|
||
}
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
|
||
}
|
||
|
||
/*
|
||
* Quoting RFC 2616:
|
||
*
|
||
* HTTP/1.1 applications that do not support persistent connections MUST
|
||
* include the "close" connection option in every message.
|
||
*/
|
||
if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
|
||
|
||
/*
|
||
* Write the head
|
||
*/
|
||
if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
|
||
{
|
||
free_http_response(rsp);
|
||
return cgi_error_memory();
|
||
}
|
||
rsp->head_length = strlen(rsp->head);
|
||
|
||
return rsp;
|
||
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : alloc_http_response
|
||
*
|
||
* Description : Allocates a new http_response structure.
|
||
*
|
||
* Parameters : N/A
|
||
*
|
||
* Returns : pointer to a new http_response, or NULL.
|
||
*
|
||
*********************************************************************/
|
||
struct http_response *alloc_http_response(void)
|
||
{
|
||
return (struct http_response *) zalloc(sizeof(struct http_response));
|
||
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : free_http_response
|
||
*
|
||
* Description : Free the memory occupied by an http_response
|
||
* and its depandant structures.
|
||
*
|
||
* Parameters :
|
||
* 1 : rsp = pointer to http_response to be freed
|
||
*
|
||
* Returns : N/A
|
||
*
|
||
*********************************************************************/
|
||
void free_http_response(struct http_response *rsp)
|
||
{
|
||
/*
|
||
* Must special case cgi_error_memory_response, which is never freed.
|
||
*/
|
||
if (rsp && (rsp != cgi_error_memory_response))
|
||
{
|
||
freez(rsp->status);
|
||
freez(rsp->head);
|
||
freez(rsp->body);
|
||
destroy_list(rsp->headers);
|
||
free(rsp);
|
||
}
|
||
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : template_load
|
||
*
|
||
* Description : CGI support function that loads a given HTML
|
||
* template, ignoring comment lines and following
|
||
* #include statements up to a depth of 1.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : template_ptr = Destination for pointer to loaded
|
||
* template text.
|
||
* 3 : templatename = name of the HTML template to be used
|
||
* 4 : recursive = Flag set if this function calls itself
|
||
* following an #include statament
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
* JB_ERR_FILE if the template file cannot be read
|
||
*
|
||
*********************************************************************/
|
||
jb_err template_load(const struct client_state *csp, char **template_ptr,
|
||
const char *templatename, int recursive)
|
||
{
|
||
jb_err err;
|
||
char *templates_dir_path;
|
||
char *full_path;
|
||
char *file_buffer;
|
||
char *included_module;
|
||
const char *p;
|
||
FILE *fp;
|
||
char buf[BUFFER_SIZE];
|
||
|
||
assert(csp);
|
||
assert(template_ptr);
|
||
assert(templatename);
|
||
|
||
*template_ptr = NULL;
|
||
|
||
/* Validate template name. Paranoia. */
|
||
for (p = templatename; *p != 0; p++)
|
||
{
|
||
if ( ((*p < 'a') || (*p > 'z'))
|
||
&& ((*p < 'A') || (*p > 'Z'))
|
||
&& ((*p < '0') || (*p > '9'))
|
||
&& (*p != '-')
|
||
&& (*p != '.'))
|
||
{
|
||
/* Illegal character */
|
||
return JB_ERR_FILE;
|
||
}
|
||
}
|
||
|
||
/*
|
||
* Generate full path using either templdir
|
||
* or confdir/templates as base directory.
|
||
*/
|
||
if (NULL != csp->config->templdir)
|
||
{
|
||
templates_dir_path = strdup(csp->config->templdir);
|
||
}
|
||
else
|
||
{
|
||
templates_dir_path = make_path(csp->config->confdir, "templates");
|
||
}
|
||
|
||
if (templates_dir_path == NULL)
|
||
{
|
||
log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
|
||
templatename);
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
full_path = make_path(templates_dir_path, templatename);
|
||
free(templates_dir_path);
|
||
if (full_path == NULL)
|
||
{
|
||
log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
|
||
templatename);
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
/* Allocate buffer */
|
||
|
||
file_buffer = strdup("");
|
||
if (file_buffer == NULL)
|
||
{
|
||
log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
|
||
free(full_path);
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
/* Open template file */
|
||
|
||
if (NULL == (fp = fopen(full_path, "r")))
|
||
{
|
||
log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
|
||
free(full_path);
|
||
free(file_buffer);
|
||
return JB_ERR_FILE;
|
||
}
|
||
free(full_path);
|
||
|
||
/*
|
||
* Read the file, ignoring comments, and honoring #include
|
||
* statements, unless we're already called recursively.
|
||
*
|
||
* XXX: The comment handling could break with lines lengths > sizeof(buf).
|
||
* This is unlikely in practise.
|
||
*/
|
||
while (fgets(buf, sizeof(buf), fp))
|
||
{
|
||
if (!recursive && !strncmp(buf, "#include ", 9))
|
||
{
|
||
if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
|
||
{
|
||
free(file_buffer);
|
||
fclose(fp);
|
||
return err;
|
||
}
|
||
|
||
if (string_join(&file_buffer, included_module))
|
||
{
|
||
fclose(fp);
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
continue;
|
||
}
|
||
|
||
/* skip lines starting with '#' */
|
||
if (*buf == '#')
|
||
{
|
||
continue;
|
||
}
|
||
|
||
if (string_append(&file_buffer, buf))
|
||
{
|
||
fclose(fp);
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
}
|
||
fclose(fp);
|
||
|
||
*template_ptr = file_buffer;
|
||
|
||
return JB_ERR_OK;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : template_fill
|
||
*
|
||
* Description : CGI support function that fills in a pre-loaded
|
||
* HTML template by replacing @name@ with value using
|
||
* pcrs, for each item in the output map.
|
||
*
|
||
* Note that a leading '$' charachter in the export map's
|
||
* values will be stripped and toggle on backreference
|
||
* interpretation.
|
||
*
|
||
* Parameters :
|
||
* 1 : template_ptr = IN: Template to be filled out.
|
||
* Will be free()d.
|
||
* OUT: Filled out template.
|
||
* Caller must free().
|
||
* 2 : exports = map with fill in symbol -> name pairs
|
||
*
|
||
* Returns : JB_ERR_OK on success (and for uncritical errors)
|
||
* JB_ERR_MEMORY on out-of-memory error
|
||
*
|
||
*********************************************************************/
|
||
jb_err template_fill(char **template_ptr, const struct map *exports)
|
||
{
|
||
struct map_entry *m;
|
||
pcrs_job *job;
|
||
char buf[BUFFER_SIZE];
|
||
char *tmp_out_buffer;
|
||
char *file_buffer;
|
||
size_t size;
|
||
int error;
|
||
const char *flags;
|
||
|
||
assert(template_ptr);
|
||
assert(*template_ptr);
|
||
assert(exports);
|
||
|
||
file_buffer = *template_ptr;
|
||
size = strlen(file_buffer) + 1;
|
||
|
||
/*
|
||
* Assemble pcrs joblist from exports map
|
||
*/
|
||
for (m = exports->first; m != NULL; m = m->next)
|
||
{
|
||
if (*m->name == '$')
|
||
{
|
||
/*
|
||
* First character of name is '$', so remove this flag
|
||
* character and allow backreferences ($1 etc) in the
|
||
* "replace with" text.
|
||
*/
|
||
snprintf(buf, sizeof(buf), "%s", m->name + 1);
|
||
flags = "sigU";
|
||
}
|
||
else
|
||
{
|
||
/*
|
||
* Treat the "replace with" text as a literal string -
|
||
* no quoting needed, no backreferences allowed.
|
||
* ("Trivial" ['T'] flag).
|
||
*/
|
||
flags = "sigTU";
|
||
|
||
/* Enclose name in @@ */
|
||
snprintf(buf, sizeof(buf), "@%s@", m->name);
|
||
}
|
||
|
||
log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
|
||
|
||
/* Make and run job. */
|
||
job = pcrs_compile(buf, m->value, flags, &error);
|
||
if (job == NULL)
|
||
{
|
||
if (error == PCRS_ERR_NOMEM)
|
||
{
|
||
free(file_buffer);
|
||
*template_ptr = NULL;
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
else
|
||
{
|
||
log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
|
||
/* Hope it wasn't important and silently ignore the invalid job */
|
||
}
|
||
}
|
||
else
|
||
{
|
||
error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
|
||
|
||
pcrs_free_job(job);
|
||
if (NULL == tmp_out_buffer)
|
||
{
|
||
*template_ptr = NULL;
|
||
return JB_ERR_MEMORY;
|
||
}
|
||
|
||
if (error < 0)
|
||
{
|
||
/*
|
||
* Substitution failed, keep the original buffer,
|
||
* log the problem and ignore it.
|
||
*
|
||
* The user might see some unresolved @CGI_VARIABLES@,
|
||
* but returning a special CGI error page seems unreasonable
|
||
* and could mask more important error messages.
|
||
*/
|
||
free(tmp_out_buffer);
|
||
log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
|
||
buf, m->value, flags, pcrs_strerror(error));
|
||
}
|
||
else
|
||
{
|
||
/* Substitution succeeded, use modified buffer. */
|
||
free(file_buffer);
|
||
file_buffer = tmp_out_buffer;
|
||
}
|
||
}
|
||
}
|
||
|
||
/*
|
||
* Return
|
||
*/
|
||
*template_ptr = file_buffer;
|
||
return JB_ERR_OK;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : template_fill_for_cgi
|
||
*
|
||
* Description : CGI support function that loads a HTML template
|
||
* and fills it in. Handles file-not-found errors
|
||
* by sending a HTML error message. For convenience,
|
||
* this function also frees the passed "exports" map.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Client state
|
||
* 2 : templatename = name of the HTML template to be used
|
||
* 3 : exports = map with fill in symbol -> name pairs.
|
||
* Will be freed by this function.
|
||
* 4 : rsp = Response structure to fill in.
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error
|
||
*
|
||
*********************************************************************/
|
||
jb_err template_fill_for_cgi(const struct client_state *csp,
|
||
const char *templatename,
|
||
struct map *exports,
|
||
struct http_response *rsp)
|
||
{
|
||
jb_err err;
|
||
|
||
assert(csp);
|
||
assert(templatename);
|
||
assert(exports);
|
||
assert(rsp);
|
||
|
||
err = template_load(csp, &rsp->body, templatename, 0);
|
||
if (err == JB_ERR_FILE)
|
||
{
|
||
free_map(exports);
|
||
return cgi_error_no_template(csp, rsp, templatename);
|
||
}
|
||
else if (err)
|
||
{
|
||
free_map(exports);
|
||
return err; /* JB_ERR_MEMORY */
|
||
}
|
||
err = template_fill(&rsp->body, exports);
|
||
free_map(exports);
|
||
return err;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : default_exports
|
||
*
|
||
* Description : returns a struct map list that contains exports
|
||
* which are common to all CGI functions.
|
||
*
|
||
* Parameters :
|
||
* 1 : csp = Current client state (buffers, headers, etc...)
|
||
* 2 : caller = name of CGI who calls us and which should
|
||
* be excluded from the generated menu. May be
|
||
* NULL.
|
||
* Returns : NULL if no memory, else a new map. Caller frees.
|
||
*
|
||
*********************************************************************/
|
||
struct map *default_exports(const struct client_state *csp, const char *caller)
|
||
{
|
||
char buf[30];
|
||
jb_err err;
|
||
struct map * exports;
|
||
int local_help_exists = 0;
|
||
char *ip_address = NULL;
|
||
char *hostname = NULL;
|
||
|
||
assert(csp);
|
||
|
||
exports = new_map();
|
||
if (exports == NULL)
|
||
{
|
||
return NULL;
|
||
}
|
||
|
||
if (csp->config->hostname)
|
||
{
|
||
get_host_information(csp->cfd, &ip_address, NULL);
|
||
hostname = strdup(csp->config->hostname);
|
||
}
|
||
else
|
||
{
|
||
get_host_information(csp->cfd, &ip_address, &hostname);
|
||
}
|
||
|
||
err = map(exports, "version", 1, html_encode(VERSION), 0);
|
||
get_locale_time(buf, sizeof(buf));
|
||
if (!err) err = map(exports, "time", 1, html_encode(buf), 0);
|
||
if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
|
||
freez(ip_address);
|
||
if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
|
||
freez(hostname);
|
||
if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
|
||
if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
|
||
if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
|
||
if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
|
||
if (!strncmpic(csp->config->usermanual, "file://", 7) ||
|
||
!strncmpic(csp->config->usermanual, "http", 4))
|
||
{
|
||
/* Manual is located somewhere else, just link to it. */
|
||
if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
|
||
}
|
||
else
|
||
{
|
||
/* Manual is delivered by Privoxy. */
|
||
if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
|
||
}
|
||
if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
|
||
#ifdef FEATURE_TOGGLE
|
||
if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
|
||
#else
|
||
if (!err) err = map_block_killer(exports, "can-toggle");
|
||
#endif
|
||
|
||
snprintf(buf, sizeof(buf), "%d", csp->config->hport);
|
||
if (!err) err = map(exports, "my-port", 1, buf, 1);
|
||
|
||
if(!strcmp(CODE_STATUS, "stable"))
|
||
{
|
||
if (!err) err = map_block_killer(exports, "unstable");
|
||
}
|
||
|
||
if (csp->config->admin_address != NULL)
|
||
{
|
||
if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
|
||
local_help_exists = 1;
|
||
}
|
||
else
|
||
{
|
||
if (!err) err = map_block_killer(exports, "have-adminaddr-info");
|
||
}
|
||
|
||
if (csp->config->proxy_info_url != NULL)
|
||
{
|
||
if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
|
||
local_help_exists = 1;
|
||
}
|
||
else
|
||
{
|
||
if (!err) err = map_block_killer(exports, "have-proxy-info");
|
||
}
|
||
|
||
if (local_help_exists == 0)
|
||
{
|
||
if (!err) err = map_block_killer(exports, "have-help-info");
|
||
}
|
||
|
||
if (err)
|
||
{
|
||
free_map(exports);
|
||
return NULL;
|
||
}
|
||
|
||
return exports;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : map_block_killer
|
||
*
|
||
* Description : Convenience function.
|
||
* Adds a "killer" for the conditional HTML-template
|
||
* block <name>, i.e. a substitution of the regex
|
||
* "if-<name>-start.*if-<name>-end" to the given
|
||
* export list.
|
||
*
|
||
* Parameters :
|
||
* 1 : exports = map to extend
|
||
* 2 : name = name of conditional block
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
jb_err map_block_killer(struct map *exports, const char *name)
|
||
{
|
||
char buf[1000]; /* Will do, since the names are hardwired */
|
||
|
||
assert(exports);
|
||
assert(name);
|
||
assert(strlen(name) < (size_t)490);
|
||
|
||
snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
|
||
return map(exports, buf, 1, "", 1);
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : map_block_keep
|
||
*
|
||
* Description : Convenience function. Removes the markers used
|
||
* by map-block-killer, to save a few bytes.
|
||
* i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
|
||
*
|
||
* Parameters :
|
||
* 1 : exports = map to extend
|
||
* 2 : name = name of conditional block
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
jb_err map_block_keep(struct map *exports, const char *name)
|
||
{
|
||
jb_err err;
|
||
char buf[500]; /* Will do, since the names are hardwired */
|
||
|
||
assert(exports);
|
||
assert(name);
|
||
assert(strlen(name) < (size_t)490);
|
||
|
||
snprintf(buf, sizeof(buf), "if-%s-start", name);
|
||
err = map(exports, buf, 1, "", 1);
|
||
|
||
if (err)
|
||
{
|
||
return err;
|
||
}
|
||
|
||
snprintf(buf, sizeof(buf), "if-%s-end", name);
|
||
return map(exports, buf, 1, "", 1);
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : map_conditional
|
||
*
|
||
* Description : Convenience function.
|
||
* Adds an "if-then-else" for the conditional HTML-template
|
||
* block <name>, i.e. a substitution of the form:
|
||
* @if-<name>-then@
|
||
* True text
|
||
* @else-not-<name>@
|
||
* False text
|
||
* @endif-<name>@
|
||
*
|
||
* The control structure and one of the alternatives
|
||
* will be hidden.
|
||
*
|
||
* Parameters :
|
||
* 1 : exports = map to extend
|
||
* 2 : name = name of conditional block
|
||
* 3 : choose_first = nonzero for first, zero for second.
|
||
*
|
||
* Returns : JB_ERR_OK on success
|
||
* JB_ERR_MEMORY on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
jb_err map_conditional(struct map *exports, const char *name, int choose_first)
|
||
{
|
||
char buf[1000]; /* Will do, since the names are hardwired */
|
||
jb_err err;
|
||
|
||
assert(exports);
|
||
assert(name);
|
||
assert(strlen(name) < (size_t)480);
|
||
|
||
snprintf(buf, sizeof(buf), (choose_first
|
||
? "else-not-%s@.*@endif-%s"
|
||
: "if-%s-then@.*@else-not-%s"),
|
||
name, name);
|
||
|
||
err = map(exports, buf, 1, "", 1);
|
||
if (err)
|
||
{
|
||
return err;
|
||
}
|
||
|
||
snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
|
||
return map(exports, buf, 1, "", 1);
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : make_menu
|
||
*
|
||
* Description : Returns an HTML-formatted menu of the available
|
||
* unhidden CGIs, excluding the one given in <self>
|
||
* and the toggle CGI if toggling is disabled.
|
||
*
|
||
* Parameters :
|
||
* 1 : self = name of CGI to leave out, can be NULL for
|
||
* complete listing.
|
||
* 2 : feature_flags = feature bitmap from csp->config
|
||
*
|
||
*
|
||
* Returns : menu string, or NULL on out-of-memory error.
|
||
*
|
||
*********************************************************************/
|
||
char *make_menu(const char *self, const unsigned feature_flags)
|
||
{
|
||
const struct cgi_dispatcher *d;
|
||
char *result = strdup("");
|
||
|
||
if (self == NULL)
|
||
{
|
||
self = "NO-SUCH-CGI!";
|
||
}
|
||
|
||
/* List available unhidden CGI's and export as "other-cgis" */
|
||
for (d = cgi_dispatchers; d->name; d++)
|
||
{
|
||
|
||
#ifdef FEATURE_TOGGLE
|
||
if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
|
||
{
|
||
/*
|
||
* Suppress the toggle link if remote toggling is disabled.
|
||
*/
|
||
continue;
|
||
}
|
||
#endif /* def FEATURE_TOGGLE */
|
||
|
||
if (d->description && strcmp(d->name, self))
|
||
{
|
||
char *html_encoded_prefix;
|
||
|
||
/*
|
||
* Line breaks would be great, but break
|
||
* the "blocked" template's JavaScript.
|
||
*/
|
||
string_append(&result, "<li><a href=\"");
|
||
html_encoded_prefix = html_encode(CGI_PREFIX);
|
||
if (html_encoded_prefix == NULL)
|
||
{
|
||
return NULL;
|
||
}
|
||
else
|
||
{
|
||
string_append(&result, html_encoded_prefix);
|
||
free(html_encoded_prefix);
|
||
}
|
||
string_append(&result, d->name);
|
||
string_append(&result, "\">");
|
||
string_append(&result, d->description);
|
||
string_append(&result, "</a></li>");
|
||
}
|
||
}
|
||
|
||
return result;
|
||
}
|
||
|
||
|
||
/*********************************************************************
|
||
*
|
||
* Function : dump_map
|
||
*
|
||
* Description : HTML-dump a map for debugging (as table)
|
||
*
|
||
* Parameters :
|
||
* 1 : the_map = map to dump
|
||
*
|
||
* Returns : string with HTML
|
||
*
|
||
*********************************************************************/
|
||
char *dump_map(const struct map *the_map)
|
||
{
|
||
struct map_entry *cur_entry;
|
||
char *ret = strdup("");
|
||
|
||
string_append(&ret, "<table>\n");
|
||
|
||
for (cur_entry = the_map->first;
|
||
(cur_entry != NULL) && (ret != NULL);
|
||
cur_entry = cur_entry->next)
|
||
{
|
||
string_append(&ret, "<tr><td><b>");
|
||
string_join (&ret, html_encode(cur_entry->name));
|
||
string_append(&ret, "</b></td><td>");
|
||
string_join (&ret, html_encode(cur_entry->value));
|
||
string_append(&ret, "</td></tr>\n");
|
||
}
|
||
|
||
string_append(&ret, "</table>\n");
|
||
return ret;
|
||
}
|
||
|
||
|
||
/*
|
||
Local Variables:
|
||
tab-width: 3
|
||
end:
|
||
*/
|