ExceptionHandler.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.6.0

matomo / app / core / ExceptionHandler.php

matomo / app / core Last commit date

API 7 months ago Access 7 months ago Application 1 year ago Archive 7 months ago ArchiveProcessor 7 months ago Archiver 2 years ago AssetManager 7 months ago Auth 7 months ago Category 7 months ago Changes 7 months ago CliMulti 1 year ago Columns 7 months ago Concurrency 7 months ago Config 7 months ago Container 7 months ago CronArchive 7 months ago DataAccess 7 months ago DataFiles 2 years ago DataTable 7 months ago Db 7 months ago DeviceDetector 1 year ago Email 2 years ago Exception 1 year ago Http 1 year ago Intl 7 months ago Log 2 years ago Mail 1 year ago Measurable 7 months ago Menu 7 months ago Metrics 7 months ago Notification 7 months ago Period 7 months ago Plugin 7 months ago Policy 7 months ago ProfessionalServices 1 year ago Report 1 year ago ReportRenderer 1 year ago Request 7 months ago Scheduler 7 months ago Segment 7 months ago Session 7 months ago Settings 7 months ago Tracker 7 months ago Translation 1 year ago Twig 1 year ago UpdateCheck 7 months ago Updater 7 months ago Updates 7 months ago Validators 1 year ago View 7 months ago ViewDataTable 7 months ago Visualization 1 year ago Widget 1 year ago .htaccess 2 years ago Access.php 7 months ago Archive.php 7 months ago ArchiveProcessor.php 7 months ago AssetManager.php 1 year ago Auth.php 7 months ago AuthResult.php 7 months ago BaseFactory.php 2 years ago Cache.php 2 years ago CacheId.php 1 year ago CliMulti.php 7 months ago Common.php 7 months ago Config.php 1 year ago Console.php 1 year ago Context.php 2 years ago Cookie.php 1 year ago CronArchive.php 7 months ago DI.php 1 year ago DataArray.php 1 year ago DataTable.php 7 months ago Date.php 7 months ago Db.php 1 year ago DbHelper.php 7 months ago Development.php 1 year ago ErrorHandler.php 7 months ago EventDispatcher.php 1 year ago ExceptionHandler.php 7 months ago FileIntegrity.php 1 year ago Filechecks.php 1 year ago Filesystem.php 1 year ago FrontController.php 7 months ago Http.php 7 months ago IP.php 1 year ago Log.php 7 months ago LogDeleter.php 1 year ago Mail.php 1 year ago Metrics.php 7 months ago NoAccessException.php 2 years ago Nonce.php 7 months ago Notification.php 7 months ago NumberFormatter.php 1 year ago Option.php 1 year ago Period.php 1 year ago Piwik.php 7 months ago Plugin.php 1 year ago Process.php 1 year ago Profiler.php 7 months ago ProxyHeaders.php 2 years ago ProxyHttp.php 1 year ago QuickForm2.php 1 year ago RankingQuery.php 7 months ago ReportRenderer.php 1 year ago Request.php 1 year ago Segment.php 7 months ago Sequence.php 7 months ago Session.php 1 year ago SettingsPiwik.php 1 year ago SettingsServer.php 1 year ago Singleton.php 2 years ago Site.php 7 months ago SiteContentDetector.php 1 year ago SupportedBrowser.php 2 years ago TCPDF.php 1 year ago Theme.php 1 year ago Timer.php 2 years ago Tracker.php 1 year ago Twig.php 7 months ago Unzip.php 1 year ago UpdateCheck.php 1 year ago Updater.php 1 year ago UpdaterErrorException.php 2 years ago Updates.php 1 year ago Url.php 7 months ago UrlHelper.php 1 year ago Version.php 7 months ago View.php 7 months ago bootstrap.php 1 year ago dispatch.php 2 years ago testMinimumPhpVersion.php 7 months ago

ExceptionHandler.php

198 lines

1	<?php
2
3	/**
4	* Matomo - free/libre analytics platform
5	*
6	* @link https://matomo.org
7	* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
8	*/
9	namespace Piwik;
10
11	use Piwik\Exception\DI\DependencyException;
12	use Exception;
13	use Piwik\API\Request;
14	use Piwik\API\ResponseBuilder;
15	use Piwik\Container\ContainerDoesNotExistException;
16	use Piwik\Container\StaticContainer;
17	use Piwik\Exception\IRedirectException;
18	use Piwik\Plugins\CoreAdminHome\CustomLogo;
19	use Piwik\Plugins\Monolog\Processor\ExceptionToTextProcessor;
20	use Piwik\Log\LoggerInterface;
21	/**
22	* Contains Piwik's uncaught exception handler.
23	*/
24	class ExceptionHandler
25	{
26	public static function setUp()
27	{
28	set_exception_handler(['Piwik\\ExceptionHandler', 'handleException']);
29	}
30	/**
31	* @param Exception\|\Throwable $exception
32	*/
33	public static function handleException($exception)
34	{
35	if (\Piwik\Common::isPhpCliMode()) {
36	self::dieWithCliError($exception);
37	}
38	self::dieWithHtmlErrorPage($exception);
39	}
40	/**
41	* @param Exception\|\Throwable $exception
42	*/
43	public static function dieWithCliError($exception)
44	{
45	self::logException($exception);
46	$message = $exception->getMessage();
47	if (!method_exists($exception, 'isHtmlMessage') \|\| !$exception->isHtmlMessage()) {
48	$message = strip_tags(str_replace('<br />', \PHP_EOL, $message));
49	}
50	$message = sprintf("Uncaught exception in %s line %d:\n%s\n", $exception->getFile(), $exception->getLine(), ExceptionToTextProcessor::getMessageAndWholeBacktrace($exception));
51	echo $message;
52	exit(1);
53	}
54	/**
55	* @param Exception\|\Throwable $exception
56	*/
57	public static function dieWithHtmlErrorPage($exception)
58	{
59	// Set an appropriate HTTP response code.
60	switch (\true) {
61	case ($exception instanceof \Piwik\Http\HttpCodeException \|\| $exception instanceof \Piwik\Exception\NotSupportedBrowserException) && $exception->getCode() > 0:
62	// For these exception types, use the exception-provided error code.
63	http_response_code($exception->getCode());
64	break;
65	case $exception instanceof \Piwik\Exception\NotYetInstalledException:
66	http_response_code(404);
67	break;
68	default:
69	http_response_code(500);
70	}
71	// Log the error with an appropriate loglevel.
72	switch (\true) {
73	case $exception instanceof \Piwik\Exception\NotSupportedBrowserException:
74	// These unsupported browsers are really a client-side problem, so log only at DEBUG level.
75	self::logException($exception, \Piwik\Log::DEBUG);
76	break;
77	default:
78	self::logException($exception);
79	}
80	\Piwik\Common::sendHeader('Content-Type: text/html; charset=utf-8');
81	try {
82	echo self::getErrorResponse($exception);
83	} catch (Exception $e) {
84	// When there are failures while generating the HTML error response itself,
85	// we simply print out the error message instead.
86	echo $exception->getMessage();
87	}
88	exit(1);
89	}
90	public static function replaceSensitiveValues(string $message) : string
91	{
92	$dbConfig = \Piwik\Db::getDatabaseConfig();
93	$valuesToReplace = ['tokenauth' => \Piwik\Piwik::getCurrentUserTokenAuth(), 'generalSalt' => \Piwik\SettingsPiwik::getSalt(), 'dbuser' => $dbConfig['username'], 'dbpass' => $dbConfig['password']];
94	$mailConfig = \Piwik\Config::getInstance()->mail;
95	if (!empty($mailConfig['username'])) {
96	$valuesToReplace['smtpuser'] = $mailConfig['username'];
97	}
98	if (!empty($mailConfig['password'])) {
99	$valuesToReplace['smtppass'] = $mailConfig['password'];
100	}
101	// Remove possible empty entries
102	$valuesToReplace = array_filter($valuesToReplace);
103	// replace all sensitive values
104	$message = str_replace(array_values($valuesToReplace), array_keys($valuesToReplace), $message);
105	// remove the document root from all messages
106	return str_replace(PIWIK_DOCUMENT_ROOT, '', $message);
107	}
108	/**
109	* @param Exception\|\Throwable $ex
110	*/
111	private static function getErrorResponse($ex)
112	{
113	$debugTrace = self::replaceSensitiveValues($ex->getTraceAsString());
114	$message = $ex->getMessage();
115	$isHtmlMessage = method_exists($ex, 'isHtmlMessage') && $ex->isHtmlMessage();
116	if (!$isHtmlMessage && Request::isApiRequest($_GET)) {
117	$outputFormat = strtolower(\Piwik\Common::getRequestVar('format', 'xml', 'string', $_GET + $_POST));
118	$response = new ResponseBuilder($outputFormat);
119	return $response->getResponseException($ex);
120	} elseif (!$isHtmlMessage) {
121	$message = \Piwik\Common::sanitizeInputValue($message);
122	}
123	$logoHeaderUrl = 'plugins/Morpheus/images/logo.svg';
124	$logoFaviconUrl = 'plugins/CoreHome/images/favicon.png';
125	try {
126	$logo = new CustomLogo();
127	if ($logo->hasSVGLogo()) {
128	$logoHeaderUrl = $logo->getSVGLogoUrl();
129	} else {
130	$logoHeaderUrl = $logo->getHeaderLogoUrl();
131	}
132	$logoFaviconUrl = $logo->getPathUserFavicon();
133	} catch (Exception $ex) {
134	try {
135	\Piwik\Log::debug($ex);
136	} catch (\Exception $otherEx) {
137	// DI container may not be setup at this point
138	}
139	}
140	// Unsupported browser errors shouldn't be written to the web server log. At DEBUG logging level this error will
141	// be written to the application log instead
142	$writeErrorLog = !$ex instanceof \Piwik\Exception\NotSupportedBrowserException;
143	$redirectUrl = null;
144	$countdownToRedirect = null;
145	if ($ex instanceof IRedirectException) {
146	$redirectUrl = $ex->getRedirectionUrl();
147	$countdownToRedirect = $ex->getCountdown();
148	}
149	$hostname = \Piwik\Url::getRFCValidHostname();
150	$hostStr = $hostname ? "[{$hostname}] " : '- ';
151	$result = Piwik_GetErrorMessagePage($message, $debugTrace, \true, \true, $logoHeaderUrl, $logoFaviconUrl, null, $hostStr, $writeErrorLog, $redirectUrl, $countdownToRedirect);
152	try {
153	/**
154	* Triggered before a Piwik error page is displayed to the user.
155	*
156	* This event can be used to modify the content of the error page that is displayed when
157	* an exception is caught.
158	*
159	* @param string &$result The HTML of the error page.
160	* @param Exception $ex The Exception displayed in the error page.
161	*/
162	\Piwik\Piwik::postEvent('FrontController.modifyErrorPage', [&$result, $ex]);
163	} catch (ContainerDoesNotExistException $ex) {
164	// this can happen when an error occurs before the Piwik environment is created
165	}
166	return $result;
167	}
168	public static function shouldPrintBackTraceWithMessage() : bool
169	{
170	if (class_exists('\\Piwik\\SettingsServer') && class_exists('\\Piwik\\Common') && \Piwik\SettingsServer::isArchivePhpTriggered() && \Piwik\Common::isPhpCliMode()) {
171	return \true;
172	}
173	try {
174	$isDevelopmentModeEnabled = \Piwik\Development::isEnabled();
175	} catch (Exception $e) {
176	$isDevelopmentModeEnabled = \false;
177	}
178	return $isDevelopmentModeEnabled \|\| defined('PIWIK_PRINT_ERROR_BACKTRACE') && PIWIK_PRINT_ERROR_BACKTRACE \|\| !empty($GLOBALS['PIWIK_PRINT_ERROR_BACKTRACE']) \|\| !empty($GLOBALS['PIWIK_TRACKER_DEBUG']);
179	}
180	private static function logException($exception, $loglevel = \Piwik\Log::ERROR)
181	{
182	try {
183	switch ($loglevel) {
184	case \Piwik\Log::DEBUG:
185	StaticContainer::get(LoggerInterface::class)->debug('Uncaught exception: {exception}', ['exception' => $exception, 'ignoreInScreenWriter' => \true]);
186	break;
187	case \Piwik\Log::ERROR:
188	default:
189	StaticContainer::get(LoggerInterface::class)->error('Uncaught exception: {exception}', ['exception' => $exception, 'ignoreInScreenWriter' => \true]);
190	}
191	} catch (DependencyException $ex) {
192	// ignore (occurs if exception is thrown when resolving DI entries)
193	} catch (ContainerDoesNotExistException $ex) {
194	// ignore
195	}
196	}
197	}
198