API
2 years ago
Access
2 years ago
Application
2 years ago
Archive
2 years ago
ArchiveProcessor
2 years ago
Archiver
2 years ago
AssetManager
2 years ago
Auth
2 years ago
Category
2 years ago
Changes
2 years ago
CliMulti
2 years ago
Columns
2 years ago
Concurrency
2 years ago
Config
2 years ago
Container
2 years ago
CronArchive
2 years ago
DataAccess
2 years ago
DataFiles
2 years ago
DataTable
2 years ago
Db
1 year ago
DeviceDetector
2 years ago
Email
2 years ago
Exception
2 years ago
Http
2 years ago
Intl
2 years ago
Log
2 years ago
Mail
2 years ago
Measurable
2 years ago
Menu
2 years ago
Metrics
2 years ago
Notification
2 years ago
Period
1 year ago
Plugin
2 years ago
ProfessionalServices
2 years ago
Report
2 years ago
ReportRenderer
2 years ago
Scheduler
2 years ago
Segment
2 years ago
Session
2 years ago
Settings
2 years ago
Tracker
1 year ago
Translation
2 years ago
Twig
2 years ago
UpdateCheck
2 years ago
Updater
1 year ago
Updates
1 year ago
Validators
2 years ago
View
2 years ago
ViewDataTable
2 years ago
Visualization
2 years ago
Widget
2 years ago
.htaccess
2 years ago
Access.php
2 years ago
Archive.php
2 years ago
ArchiveProcessor.php
2 years ago
AssetManager.php
2 years ago
Auth.php
2 years ago
AuthResult.php
2 years ago
BaseFactory.php
2 years ago
Cache.php
2 years ago
CacheId.php
2 years ago
CliMulti.php
2 years ago
Common.php
2 years ago
Config.php
2 years ago
Console.php
2 years ago
Context.php
2 years ago
Cookie.php
2 years ago
CronArchive.php
2 years ago
DI.php
2 years ago
DataArray.php
2 years ago
DataTable.php
2 years ago
Date.php
2 years ago
Db.php
1 year ago
DbHelper.php
1 year ago
Development.php
2 years ago
ErrorHandler.php
2 years ago
EventDispatcher.php
2 years ago
ExceptionHandler.php
2 years ago
FileIntegrity.php
2 years ago
Filechecks.php
2 years ago
Filesystem.php
2 years ago
FrontController.php
2 years ago
Http.php
2 years ago
IP.php
2 years ago
Log.php
2 years ago
LogDeleter.php
2 years ago
Mail.php
2 years ago
Metrics.php
2 years ago
NoAccessException.php
2 years ago
Nonce.php
2 years ago
Notification.php
2 years ago
NumberFormatter.php
2 years ago
Option.php
2 years ago
Period.php
2 years ago
Piwik.php
2 years ago
Plugin.php
2 years ago
Profiler.php
2 years ago
ProxyHeaders.php
2 years ago
ProxyHttp.php
2 years ago
QuickForm2.php
2 years ago
RankingQuery.php
2 years ago
ReportRenderer.php
2 years ago
Request.php
2 years ago
Segment.php
2 years ago
Sequence.php
2 years ago
Session.php
2 years ago
SettingsPiwik.php
2 years ago
SettingsServer.php
2 years ago
Singleton.php
2 years ago
Site.php
2 years ago
SiteContentDetector.php
2 years ago
SupportedBrowser.php
2 years ago
TCPDF.php
2 years ago
Theme.php
2 years ago
Timer.php
2 years ago
Tracker.php
2 years ago
Twig.php
2 years ago
Unzip.php
2 years ago
UpdateCheck.php
2 years ago
Updater.php
2 years ago
UpdaterErrorException.php
2 years ago
Updates.php
2 years ago
Url.php
2 years ago
UrlHelper.php
1 year ago
Version.php
1 year ago
View.php
2 years ago
bootstrap.php
2 years ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
2 years ago
ExceptionHandler.php
168 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 | /** |
| 91 | * @param Exception|\Throwable $ex |
| 92 | */ |
| 93 | private static function getErrorResponse($ex) |
| 94 | { |
| 95 | $debugTrace = $ex->getTraceAsString(); |
| 96 | $message = $ex->getMessage(); |
| 97 | $isHtmlMessage = method_exists($ex, 'isHtmlMessage') && $ex->isHtmlMessage(); |
| 98 | if (!$isHtmlMessage && Request::isApiRequest($_GET)) { |
| 99 | $outputFormat = strtolower(\Piwik\Common::getRequestVar('format', 'xml', 'string', $_GET + $_POST)); |
| 100 | $response = new ResponseBuilder($outputFormat); |
| 101 | return $response->getResponseException($ex); |
| 102 | } elseif (!$isHtmlMessage) { |
| 103 | $message = \Piwik\Common::sanitizeInputValue($message); |
| 104 | } |
| 105 | $logoHeaderUrl = 'plugins/Morpheus/images/logo.svg'; |
| 106 | $logoFaviconUrl = 'plugins/CoreHome/images/favicon.png'; |
| 107 | try { |
| 108 | $logo = new CustomLogo(); |
| 109 | if ($logo->hasSVGLogo()) { |
| 110 | $logoHeaderUrl = $logo->getSVGLogoUrl(); |
| 111 | } else { |
| 112 | $logoHeaderUrl = $logo->getHeaderLogoUrl(); |
| 113 | } |
| 114 | $logoFaviconUrl = $logo->getPathUserFavicon(); |
| 115 | } catch (Exception $ex) { |
| 116 | try { |
| 117 | \Piwik\Log::debug($ex); |
| 118 | } catch (\Exception $otherEx) { |
| 119 | // DI container may not be setup at this point |
| 120 | } |
| 121 | } |
| 122 | // Unsupported browser errors shouldn't be written to the web server log. At DEBUG logging level this error will |
| 123 | // be written to the application log instead |
| 124 | $writeErrorLog = !$ex instanceof \Piwik\Exception\NotSupportedBrowserException; |
| 125 | $redirectUrl = null; |
| 126 | $countdownToRedirect = null; |
| 127 | if ($ex instanceof IRedirectException) { |
| 128 | $redirectUrl = $ex->getRedirectionUrl(); |
| 129 | $countdownToRedirect = $ex->getCountdown(); |
| 130 | } |
| 131 | $hostname = \Piwik\Url::getRFCValidHostname(); |
| 132 | $hostStr = $hostname ? "[{$hostname}] " : '- '; |
| 133 | $result = Piwik_GetErrorMessagePage($message, $debugTrace, true, true, $logoHeaderUrl, $logoFaviconUrl, null, $hostStr, $writeErrorLog, $redirectUrl, $countdownToRedirect); |
| 134 | try { |
| 135 | /** |
| 136 | * Triggered before a Piwik error page is displayed to the user. |
| 137 | * |
| 138 | * This event can be used to modify the content of the error page that is displayed when |
| 139 | * an exception is caught. |
| 140 | * |
| 141 | * @param string &$result The HTML of the error page. |
| 142 | * @param Exception $ex The Exception displayed in the error page. |
| 143 | */ |
| 144 | \Piwik\Piwik::postEvent('FrontController.modifyErrorPage', [&$result, $ex]); |
| 145 | } catch (ContainerDoesNotExistException $ex) { |
| 146 | // this can happen when an error occurs before the Piwik environment is created |
| 147 | } |
| 148 | return $result; |
| 149 | } |
| 150 | private static function logException($exception, $loglevel = \Piwik\Log::ERROR) |
| 151 | { |
| 152 | try { |
| 153 | switch ($loglevel) { |
| 154 | case \Piwik\Log::DEBUG: |
| 155 | StaticContainer::get(LoggerInterface::class)->debug('Uncaught exception: {exception}', ['exception' => $exception, 'ignoreInScreenWriter' => true]); |
| 156 | break; |
| 157 | case \Piwik\Log::ERROR: |
| 158 | default: |
| 159 | StaticContainer::get(LoggerInterface::class)->error('Uncaught exception: {exception}', ['exception' => $exception, 'ignoreInScreenWriter' => true]); |
| 160 | } |
| 161 | } catch (DependencyException $ex) { |
| 162 | // ignore (occurs if exception is thrown when resolving DI entries) |
| 163 | } catch (ContainerDoesNotExistException $ex) { |
| 164 | // ignore |
| 165 | } |
| 166 | } |
| 167 | } |
| 168 |