ErrorHandler.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress trunk

matomo / app / core / ErrorHandler.php

matomo / app / core Last commit date

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

ErrorHandler.php

194 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\Container\StaticContainer;
12	use Piwik\Exception\ErrorException;
13	use Piwik\Log\LoggerInterface;
14	/**
15	* Piwik's error handler function.
16	*/
17	class ErrorHandler
18	{
19	private static $fatalErrorStackTrace = [];
20	private static $lastError = '';
21	/**
22	* Fatal errors in PHP do not leave behind backtraces, which can make it impossible to determine
23	* the exact cause of one. We can, however, save a partial stack trace by remembering certain execution
24	* points. This method and popFatalErrorBreadcrumb() are used for that purpose.
25	*
26	* To use this method, surround a function call w/ pushFatalErrorBreadcrumb() & popFatalErrorBreadcrumb()
27	* like so:
28	*
29	* public function theMethodIWantToAppearInFatalErrorStackTraces()
30	* {
31	* try {
32	* ErrorHandler::pushFatalErrorBreadcrumb(static::class);
33	*
34	* // ...
35	* } finally {
36	* ErrorHandler::popFatalErrorBreadcrumb();
37	* }
38	* }
39	*
40	* If a fatal error occurs, theMethodIWantToAppearInFatalErrorStackTraces will appear in the stack trace,
41	* if PIWIK_PRINT_ERROR_BACKTRACE is true.
42	*/
43	public static function pushFatalErrorBreadcrumb($className = null, $importantArgs = null)
44	{
45	$backtrace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, $limit = 2);
46	$backtrace[1]['class'] = $className;
47	// knowing the derived class name is far more useful
48	$backtrace[1]['args'] = empty($importantArgs) ? [] : array_map('json_encode', $importantArgs);
49	array_unshift(self::$fatalErrorStackTrace, $backtrace[1]);
50	}
51	public static function popFatalErrorBreadcrumb()
52	{
53	array_shift(self::$fatalErrorStackTrace);
54	}
55	public static function getFatalErrorPartialBacktrace()
56	{
57	$result = '';
58	foreach (self::$fatalErrorStackTrace as $index => $entry) {
59	$function = $entry['function'];
60	if (!empty($entry['class'])) {
61	$function = $entry['class'] . $entry['type'] . $function;
62	}
63	$args = '';
64	if (!empty($entry['args'])) {
65	$isFirst = \true;
66	foreach ($entry['args'] as $name => $value) {
67	if ($isFirst) {
68	$isFirst = \false;
69	} else {
70	$args .= ', ';
71	}
72	$args .= $name . '=' . $value;
73	}
74	}
75	$result .= sprintf("#%s %s(%s): %s(%s)\n", $index, $entry['file'], $entry['line'], $function, $args);
76	}
77	return $result;
78	}
79	/**
80	* Returns a string description of a PHP error number.
81	*
82	* @param int $errno `E_ERROR`, `E_WARNING`, `E_PARSE`, etc.
83	* @return string
84	*/
85	public static function getErrNoString($errno)
86	{
87	switch ($errno) {
88	case \E_ERROR:
89	return "Error";
90	case \E_WARNING:
91	return "Warning";
92	case \E_PARSE:
93	return "Parse Error";
94	case \E_NOTICE:
95	return "Notice";
96	case \E_CORE_ERROR:
97	return "Core Error";
98	case \E_CORE_WARNING:
99	return "Core Warning";
100	case \E_COMPILE_ERROR:
101	return "Compile Error";
102	case \E_COMPILE_WARNING:
103	return "Compile Warning";
104	case \E_USER_ERROR:
105	return "User Error";
106	case \E_USER_WARNING:
107	return "User Warning";
108	case \E_USER_NOTICE:
109	return "User Notice";
110	// E_STRICT is deprecated as of PHP 8.4
111	// @todo can be removed once only PHP 8 is supported
112	case @\E_STRICT:
113	return "Strict Notice";
114	case \E_RECOVERABLE_ERROR:
115	return "Recoverable Error";
116	case \E_DEPRECATED:
117	return "Deprecated";
118	case \E_USER_DEPRECATED:
119	return "User Deprecated";
120	default:
121	return "Unknown error ({$errno})";
122	}
123	}
124	public static function registerErrorHandler()
125	{
126	set_error_handler(array('Piwik\\ErrorHandler', 'errorHandler'));
127	}
128	public static function errorHandler($errno, $errstr, $errfile, $errline)
129	{
130	self::$lastError = self::createLogMessage($errno, $errstr, $errfile, $errline);
131	// if the error has been suppressed by the @ we don't handle the error
132	if (!(error_reporting() & $errno)) {
133	return;
134	}
135	switch ($errno) {
136	case \E_ERROR:
137	case \E_PARSE:
138	case \E_CORE_ERROR:
139	case \E_CORE_WARNING:
140	case \E_COMPILE_ERROR:
141	case \E_COMPILE_WARNING:
142	case \E_USER_ERROR:
143	\Piwik\Common::sendResponseCode(500);
144	// Convert the error to an exception with an HTML message
145	$e = new \Exception();
146	$backtrace = \Piwik\ExceptionHandler::shouldPrintBackTraceWithMessage() ? $e->getTraceAsString() : '';
147	$message = self::getHtmlMessage($errno, $errstr, $errfile, $errline, $backtrace);
148	throw new ErrorException($message, 0, $errno, $errfile, $errline);
149	case \E_WARNING:
150	case \E_NOTICE:
151	case \E_USER_WARNING:
152	case \E_USER_NOTICE:
153	// E_STRICT is deprecated as of PHP 8.4
154	// @todo can be removed once only PHP 8 is supported
155	case @\E_STRICT:
156	case \E_RECOVERABLE_ERROR:
157	case \E_DEPRECATED:
158	case \E_USER_DEPRECATED:
159	default:
160	$context = array('trace' => debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 15));
161	try {
162	StaticContainer::get(LoggerInterface::class)->warning(self::createLogMessage($errno, $errstr, $errfile, $errline), $context);
163	} catch (\Exception $ex) {
164	// ignore (it's possible for this to happen if the StaticContainer hasn't been created yet)
165	}
166	break;
167	}
168	}
169	public static function getLastError()
170	{
171	$lastError = error_get_last();
172	if (!empty($lastError['message'])) {
173	return $lastError['message'];
174	}
175	return self::$lastError;
176	}
177	private static function createLogMessage($errno, $errstr, $errfile, $errline)
178	{
179	return sprintf("%s(%d): %s - %s - Matomo " . (class_exists('Piwik\\Version') ? \Piwik\Version::VERSION : '') . " - Please report this message in the Matomo forums: https://forum.matomo.org (please do a search first as it might have been reported already)", $errfile, $errline, \Piwik\ErrorHandler::getErrNoString($errno), $errstr);
180	}
181	private static function getHtmlMessage($errno, $errstr, $errfile, $errline, $trace)
182	{
183	$trace = \Piwik\Log::$debugBacktraceForTests ?: $trace;
184	$message = \Piwik\ErrorHandler::getErrNoString($errno) . ' - ' . $errstr;
185	$html = "<p>There is an error. Please report the message (Matomo " . (class_exists('Piwik\\Version') ? \Piwik\Version::VERSION : '') . ")\n and full backtrace in the <a target='_blank' rel='noreferrer noopener' href='https://forum.matomo.org'>Matomo forums</a> (please do a search first as it might have been reported already!).</p>";
186	$html .= "<p><strong>{$message}</strong> in <em>{$errfile}</em>";
187	$html .= " on line {$errline}</p>";
188	$html .= "Backtrace:<pre>";
189	$html .= str_replace("\n", "\n", $trace);
190	$html .= "</pre>";
191	return $html;
192	}
193	}
194