Leitgedanken/msd2/tracking/piwik/core/ExceptionHandler.php
2023-01-23 11:03:31 +01:00

162 lines
4.7 KiB
PHP

<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
use Exception;
use Interop\Container\Exception\ContainerException;
use Piwik\API\Request;
use Piwik\API\ResponseBuilder;
use Piwik\Container\ContainerDoesNotExistException;
use Piwik\Container\StaticContainer;
use Piwik\Plugins\CoreAdminHome\CustomLogo;
use Psr\Log\LoggerInterface;
/**
* Contains Piwik's uncaught exception handler.
*/
class ExceptionHandler
{
public static function setUp()
{
set_exception_handler(array('Piwik\ExceptionHandler', 'handleException'));
}
/**
* @param Exception|\Throwable $exception
*/
public static function handleException($exception)
{
if (Common::isPhpCliMode()) {
self::dieWithCliError($exception);
}
self::dieWithHtmlErrorPage($exception);
}
/**
* @param Exception|\Throwable $exception
*/
public static function dieWithCliError($exception)
{
self::logException($exception);
$message = $exception->getMessage();
if (!method_exists($exception, 'isHtmlMessage') || !$exception->isHtmlMessage()) {
$message = strip_tags(str_replace('<br />', PHP_EOL, $message));
}
$message = sprintf(
"Uncaught exception: %s\nin %s line %d\n%s\n",
$message,
$exception->getFile(),
$exception->getLine(),
$exception->getTraceAsString()
);
echo $message;
exit(1);
}
/**
* @param Exception|\Throwable $exception
*/
public static function dieWithHtmlErrorPage($exception)
{
self::logException($exception);
Common::sendHeader('Content-Type: text/html; charset=utf-8');
try {
echo self::getErrorResponse($exception);
} catch(Exception $e) {
// When there are failures while generating the HTML error response itself,
// we simply print out the error message instead.
echo $exception->getMessage();
}
exit(1);
}
/**
* @param Exception|\Throwable $ex
*/
private static function getErrorResponse($ex)
{
$debugTrace = $ex->getTraceAsString();
$message = $ex->getMessage();
$isHtmlMessage = method_exists($ex, 'isHtmlMessage') && $ex->isHtmlMessage();
if (!$isHtmlMessage && Request::isApiRequest($_GET)) {
$outputFormat = strtolower(Common::getRequestVar('format', 'xml', 'string', $_GET + $_POST));
$response = new ResponseBuilder($outputFormat);
return $response->getResponseException($ex);
} elseif (!$isHtmlMessage) {
$message = Common::sanitizeInputValue($message);
}
$logoHeaderUrl = 'plugins/Morpheus/images/logo.svg';
$logoFaviconUrl = 'plugins/CoreHome/images/favicon.png';
try {
$logo = new CustomLogo();
if ($logo->hasSVGLogo()) {
$logoHeaderUrl = $logo->getSVGLogoUrl();
} else {
$logoHeaderUrl = $logo->getHeaderLogoUrl();
}
$logoFaviconUrl = $logo->getPathUserFavicon();
} catch (Exception $ex) {
try {
Log::debug($ex);
} catch (\Exception $otherEx) {
// DI container may not be setup at this point
}
}
$result = Piwik_GetErrorMessagePage($message, $debugTrace, true, true, $logoHeaderUrl, $logoFaviconUrl);
try {
/**
* Triggered before a Piwik error page is displayed to the user.
*
* This event can be used to modify the content of the error page that is displayed when
* an exception is caught.
*
* @param string &$result The HTML of the error page.
* @param Exception $ex The Exception displayed in the error page.
*/
Piwik::postEvent('FrontController.modifyErrorPage', array(&$result, $ex));
} catch (ContainerDoesNotExistException $ex) {
// this can happen when an error occurs before the Piwik environment is created
}
return $result;
}
private static function logException($exception)
{
try {
StaticContainer::get(LoggerInterface::class)->error('Uncaught exception: {exception}', [
'exception' => $exception,
'ignoreInScreenWriter' => true,
]);
} catch (ContainerException $ex) {
// ignore (occurs if exception is thrown when resolving DI entries)
} catch (ContainerDoesNotExistException $ex) {
// ignore
}
}
}