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

matomo / app / core / ExceptionHandler.php

matomo / app / core Last commit date

API 3 months ago Access 3 months ago Application 3 months ago Archive 3 months ago ArchiveProcessor 3 months ago Archiver 2 years ago AssetManager 3 months ago Auth 6 months ago Category 6 months ago Changes 3 months ago CliMulti 1 year ago Columns 3 months ago Concurrency 3 months ago Config 3 months ago Container 3 months ago CronArchive 3 months ago DataAccess 3 months ago DataFiles 2 years ago DataTable 3 months ago Db 3 months ago DeviceDetector 1 year ago Email 2 years ago Exception 4 months ago Http 4 months ago Intl 3 months ago Log 2 years ago Mail 1 year ago Measurable 6 months ago Menu 3 months ago Metrics 3 months ago Notification 6 months ago Period 3 months ago Plugin 3 months ago Policy 3 months ago ProfessionalServices 1 year ago Report 1 year ago ReportRenderer 3 months ago Request 3 months ago Scheduler 3 months ago Segment 3 months ago Session 3 months ago Settings 3 months ago Tracker 3 months ago Translation 3 months ago Twig 1 year ago UpdateCheck 3 months ago Updater 4 months ago Updates 3 months ago Validators 1 year ago View 6 months ago ViewDataTable 3 months ago Visualization 1 year ago Widget 3 months ago .htaccess 2 years ago Access.php 3 months ago Archive.php 3 months ago ArchiveProcessor.php 4 months ago AssetManager.php 3 months ago Auth.php 6 months ago AuthResult.php 6 months ago BaseFactory.php 2 years ago Cache.php 2 years ago CacheId.php 4 months ago CliMulti.php 3 months ago Common.php 3 months ago Config.php 3 months ago Console.php 3 months ago Context.php 2 years ago Cookie.php 1 year ago CronArchive.php 3 months ago DI.php 3 months ago DataArray.php 5 months ago DataTable.php 3 months ago Date.php 3 months ago Db.php 3 months ago DbHelper.php 3 months ago Development.php 1 year ago ErrorHandler.php 6 months ago EventDispatcher.php 1 year ago ExceptionHandler.php 4 months ago FileIntegrity.php 3 months ago Filechecks.php 1 year ago Filesystem.php 3 months ago FrontController.php 4 months ago Http.php 4 months ago IP.php 1 year ago Log.php 3 months ago LogDeleter.php 1 year ago Mail.php 1 year ago Metrics.php 3 months ago NoAccessException.php 2 years ago Nonce.php 6 months ago Notification.php 6 months ago NumberFormatter.php 5 months ago Option.php 5 months ago Period.php 3 months ago Piwik.php 3 months ago Plugin.php 3 months ago Process.php 1 year ago Profiler.php 6 months ago ProxyHeaders.php 4 months ago ProxyHttp.php 5 months ago QuickForm2.php 3 months ago RankingQuery.php 5 months ago ReportRenderer.php 3 months ago Request.php 3 months ago Segment.php 3 months ago Sequence.php 6 months ago Session.php 3 months ago SettingsPiwik.php 3 months ago SettingsServer.php 1 year ago Singleton.php 2 years ago Site.php 4 months ago SiteContentDetector.php 3 months ago SupportedBrowser.php 2 years ago TCPDF.php 1 year ago Theme.php 1 year ago Timer.php 2 years ago Tracker.php 3 months ago Twig.php 3 months ago Unzip.php 1 year ago UpdateCheck.php 3 months ago Updater.php 3 months ago UpdaterErrorException.php 2 years ago Updates.php 3 months ago Url.php 3 months ago UrlHelper.php 3 months ago Version.php 3 months ago View.php 3 months ago bootstrap.php 1 year ago dispatch.php 2 years ago testMinimumPhpVersion.php 6 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\Http\HttpCodeException;
19	use Piwik\Plugins\CoreAdminHome\CustomLogo;
20	use Piwik\Plugins\Monolog\Processor\ExceptionToTextProcessor;
21	use Piwik\Log\LoggerInterface;
22	/**
23	* Contains Piwik's uncaught exception handler.
24	*/
25	class ExceptionHandler
26	{
27	public static function setUp()
28	{
29	set_exception_handler(['Piwik\\ExceptionHandler', 'handleException']);
30	}
31	/**
32	* @param Exception\|\Throwable $exception
33	*/
34	public static function handleException($exception)
35	{
36	if (\Piwik\Common::isPhpCliMode()) {
37	self::dieWithCliError($exception);
38	}
39	self::dieWithHtmlErrorPage($exception);
40	}
41	/**
42	* @param Exception\|\Throwable $exception
43	*/
44	public static function dieWithCliError($exception)
45	{
46	self::logException($exception);
47	$message = $exception->getMessage();
48	if (!method_exists($exception, 'isHtmlMessage') \|\| !$exception->isHtmlMessage()) {
49	$message = strip_tags(str_replace('<br />', \PHP_EOL, $message));
50	}
51	$message = sprintf("Uncaught exception in %s line %d:\n%s\n", $exception->getFile(), $exception->getLine(), ExceptionToTextProcessor::getMessageAndWholeBacktrace($exception));
52	echo $message;
53	exit(1);
54	}
55	/**
56	* @param Exception\|\Throwable $exception
57	*/
58	public static function dieWithHtmlErrorPage($exception)
59	{
60	// Set an appropriate HTTP response code.
61	switch (\true) {
62	case $exception instanceof HttpCodeException && $exception->getCode() > 0:
63	// For these exception types, use the exception-provided error code.
64	http_response_code($exception->getCode());
65	break;
66	case $exception instanceof \Piwik\Exception\NotYetInstalledException:
67	http_response_code(404);
68	break;
69	default:
70	http_response_code(500);
71	}
72	// Log the error with an appropriate loglevel.
73	switch (\true) {
74	case $exception instanceof HttpCodeException && $exception->getCode() >= 400 && $exception->getCode() < 500:
75	// Log exceptions, resulting in 4xx HTTP status code, only at debug level
76	self::logException($exception, \Piwik\Log::DEBUG);
77	break;
78	default:
79	self::logException($exception);
80	}
81	\Piwik\Common::sendHeader('Content-Type: text/html; charset=utf-8');
82	try {
83	echo self::getErrorResponse($exception);
84	} catch (Exception $e) {
85	// When there are failures while generating the HTML error response itself,
86	// we simply print out the error message instead.
87	echo $exception->getMessage();
88	}
89	exit(1);
90	}
91	public static function replaceSensitiveValues(string $message) : string
92	{
93	$dbConfig = \Piwik\Db::getDatabaseConfig();
94	$valuesToReplace = ['tokenauth' => \Piwik\Piwik::getCurrentUserTokenAuth(), 'generalSalt' => \Piwik\SettingsPiwik::getSalt(), 'dbuser' => $dbConfig['username'], 'dbpass' => $dbConfig['password']];
95	$mailConfig = \Piwik\Config::getInstance()->mail;
96	if (!empty($mailConfig['username'])) {
97	$valuesToReplace['smtpuser'] = $mailConfig['username'];
98	}
99	if (!empty($mailConfig['password'])) {
100	$valuesToReplace['smtppass'] = $mailConfig['password'];
101	}
102	// Remove possible empty entries
103	$valuesToReplace = array_filter($valuesToReplace);
104	// replace all sensitive values
105	$message = str_replace(array_values($valuesToReplace), array_keys($valuesToReplace), $message);
106	// remove the document root from all messages
107	return str_replace(PIWIK_DOCUMENT_ROOT, '', $message);
108	}
109	/**
110	* @param Exception\|\Throwable $ex
111	*/
112	private static function getErrorResponse($ex)
113	{
114	$debugTrace = self::replaceSensitiveValues($ex->getTraceAsString());
115	$message = $ex->getMessage();
116	$isHtmlMessage = method_exists($ex, 'isHtmlMessage') && $ex->isHtmlMessage();
117	if (!$isHtmlMessage && Request::isApiRequest($_GET)) {
118	$outputFormat = strtolower(\Piwik\Common::getRequestVar('format', 'xml', 'string', $_GET + $_POST));
119	$response = new ResponseBuilder($outputFormat);
120	return $response->getResponseException($ex);
121	} elseif (!$isHtmlMessage) {
122	$message = \Piwik\Common::sanitizeInputValue($message);
123	}
124	$logoHeaderUrl = 'plugins/Morpheus/images/logo.svg';
125	$logoFaviconUrl = 'plugins/CoreHome/images/favicon.png';
126	try {
127	$logo = new CustomLogo();
128	if ($logo->hasSVGLogo()) {
129	$logoHeaderUrl = $logo->getSVGLogoUrl();
130	} else {
131	$logoHeaderUrl = $logo->getHeaderLogoUrl();
132	}
133	$logoFaviconUrl = $logo->getPathUserFavicon();
134	} catch (Exception $ex) {
135	try {
136	\Piwik\Log::debug($ex);
137	} catch (\Exception $otherEx) {
138	// DI container may not be setup at this point
139	}
140	}
141	// Exceptions that should result in 4xx status code should not be logged
142	$writeErrorLog = !($ex instanceof HttpCodeException && $ex->getCode() >= 400 && $ex->getCode() < 500);
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