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

matomo / app / core / ExceptionHandler.php

matomo / app / core Last commit date

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

ExceptionHandler.php

169 lines

1	<?php
2	/**
3	* Matomo - free/libre analytics platform
4	*
5	* @link https://matomo.org
6	* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
7	*
8	*/
9	namespace Piwik;
10
11	use DI\DependencyException;
12	use Exception;
13	use Piwik\API\Request;
14	use Piwik\API\ResponseBuilder;
15	use Piwik\Container\ContainerDoesNotExistException;
16	use Piwik\Http\HttpCodeException;
17	use Piwik\Container\StaticContainer;
18	use Piwik\Plugins\CoreAdminHome\CustomLogo;
19	use Piwik\Plugins\Monolog\Processor\ExceptionToTextProcessor;
20	use Psr\Log\LoggerInterface;
21
22	/**
23	* Contains Piwik's uncaught exception handler.
24	*/
25	class ExceptionHandler
26	{
27	public static function setUp()
28	{
29	set_exception_handler(array('Piwik\ExceptionHandler', 'handleException'));
30	}
31
32	/**
33	* @param Exception\|\Throwable $exception
34	*/
35	public static function handleException($exception)
36	{
37	if (Common::isPhpCliMode()) {
38	self::dieWithCliError($exception);
39	}
40
41	self::dieWithHtmlErrorPage($exception);
42	}
43
44	/**
45	* @param Exception\|\Throwable $exception
46	*/
47	public static function dieWithCliError($exception)
48	{
49	self::logException($exception);
50
51	$message = $exception->getMessage();
52
53	if (!method_exists($exception, 'isHtmlMessage') \|\| !$exception->isHtmlMessage()) {
54	$message = strip_tags(str_replace('<br />', PHP_EOL, $message));
55	}
56
57	$message = sprintf(
58	"Uncaught exception in %s line %d:\n%s\n",
59	$exception->getFile(),
60	$exception->getLine(),
61	ExceptionToTextProcessor::getMessageAndWholeBacktrace($exception)
62	);
63
64	echo $message;
65
66	exit(1);
67	}
68
69	/**
70	* @param Exception\|\Throwable $exception
71	*/
72	public static function dieWithHtmlErrorPage($exception)
73	{
74	if ($exception instanceof HttpCodeException
75	&& $exception->getCode() > 0
76	) {
77	http_response_code($exception->getCode());
78	}
79
80	self::logException($exception);
81
82	Common::sendHeader('Content-Type: text/html; charset=utf-8');
83
84	try {
85	echo self::getErrorResponse($exception);
86	} catch(Exception $e) {
87	// When there are failures while generating the HTML error response itself,
88	// we simply print out the error message instead.
89	echo $exception->getMessage();
90	}
91
92	exit(1);
93	}
94
95	/**
96	* @param Exception\|\Throwable $ex
97	*/
98	private static function getErrorResponse($ex)
99	{
100	$debugTrace = $ex->getTraceAsString();
101
102	$message = $ex->getMessage();
103
104	$isHtmlMessage = method_exists($ex, 'isHtmlMessage') && $ex->isHtmlMessage();
105
106	if (!$isHtmlMessage && Request::isApiRequest($_GET)) {
107
108	$outputFormat = strtolower(Common::getRequestVar('format', 'xml', 'string', $_GET + $_POST));
109	$response = new ResponseBuilder($outputFormat);
110	return $response->getResponseException($ex);
111
112	} elseif (!$isHtmlMessage) {
113	$message = Common::sanitizeInputValue($message);
114	}
115
116
117	$logoHeaderUrl = 'plugins/Morpheus/images/logo.svg';
118	$logoFaviconUrl = 'plugins/CoreHome/images/favicon.png';
119	try {
120	$logo = new CustomLogo();
121	if ($logo->hasSVGLogo()) {
122	$logoHeaderUrl = $logo->getSVGLogoUrl();
123	} else {
124	$logoHeaderUrl = $logo->getHeaderLogoUrl();
125	}
126	$logoFaviconUrl = $logo->getPathUserFavicon();
127	} catch (Exception $ex) {
128	try {
129	Log::debug($ex);
130	} catch (\Exception $otherEx) {
131	// DI container may not be setup at this point
132	}
133	}
134
135	$result = Piwik_GetErrorMessagePage($message, $debugTrace, true, true, $logoHeaderUrl, $logoFaviconUrl);
136
137	try {
138	/**
139	* Triggered before a Piwik error page is displayed to the user.
140	*
141	* This event can be used to modify the content of the error page that is displayed when
142	* an exception is caught.
143	*
144	* @param string &$result The HTML of the error page.
145	* @param Exception $ex The Exception displayed in the error page.
146	*/
147	Piwik::postEvent('FrontController.modifyErrorPage', array(&$result, $ex));
148	} catch (ContainerDoesNotExistException $ex) {
149	// this can happen when an error occurs before the Piwik environment is created
150	}
151
152	return $result;
153	}
154
155	private static function logException($exception)
156	{
157	try {
158	StaticContainer::get(LoggerInterface::class)->error('Uncaught exception: {exception}', [
159	'exception' => $exception,
160	'ignoreInScreenWriter' => true,
161	]);
162	} catch (DependencyException $ex) {
163	// ignore (occurs if exception is thrown when resolving DI entries)
164	} catch (ContainerDoesNotExistException $ex) {
165	// ignore
166	}
167	}
168	}
169