Skip to content

Y
yii2
Commit d4ad533d by Carsten Brandt
Options

moved error handling related methods from app to errorhandler

parent 33c8f703
Showing with 11 additions and 190 deletions
framework/base/Application.php
...@@ -64,7 +64,6 @@ abstract class Application extends Module ...@@ -64,7 +64,6 @@ abstract class Application extends Module
* it will use the "app\controllers" namespace. * it will use the "app\controllers" namespace.
*/ */
public $controllerNamespace = 'app\\controllers'; public $controllerNamespace = 'app\\controllers';
/** /**
* @var string the application name. * @var string the application name.
*/ */
...@@ -98,13 +97,6 @@ abstract class Application extends Module ...@@ -98,13 +97,6 @@ abstract class Application extends Module
*/ */
public $layout = 'main'; public $layout = 'main';
/** /**
* @var integer the size of the reserved memory. A portion of memory is pre-allocated so that
* when an out-of-memory issue occurs, the error handler is able to handle the error with
* the help of this reserved memory. If you set this value to be 0, no memory will be reserved.
* Defaults to 256KB.
*/
public $memoryReserveSize = 262144;
/**
* @var string the requested route * @var string the requested route
*/ */
public $requestedRoute; public $requestedRoute;
...@@ -139,16 +131,7 @@ abstract class Application extends Module ...@@ -139,16 +131,7 @@ abstract class Application extends Module
* will be invoked at the beginning of [[init()]]. * will be invoked at the beginning of [[init()]].
*/ */
public $bootstrap = []; public $bootstrap = [];
/**
* @var \Exception the exception that is being handled currently. When this is not null,
* it means the application is handling some exception and extra care should be taken.
*/
public $exception;
/**
* @var string Used to reserve memory for fatal error handler.
*/
private $_memoryReserve;
/** /**
* Constructor. * Constructor.
...@@ -160,8 +143,15 @@ abstract class Application extends Module ...@@ -160,8 +143,15 @@ abstract class Application extends Module
{ {
Yii::$app = $this; Yii::$app = $this;
// TODO how to deal with exceptions thrown in preInit()
$this->preInit($config); $this->preInit($config);
$this->registerErrorHandlers(); if (YII_ENABLE_ERROR_HANDLER) {
if (isset($config['components']['errorHandler'])) {
$this->set('errorHandler', $config['components']['errorHandler']);
unset($config['components']['errorHandler']);
}
$this->getErrorHandler()->register();
}
Component::__construct($config); Component::__construct($config);
} }
...@@ -264,22 +254,6 @@ abstract class Application extends Module ...@@ -264,22 +254,6 @@ abstract class Application extends Module
} }
/** /**
* Registers error handlers.
*/
public function registerErrorHandlers()
{
if (YII_ENABLE_ERROR_HANDLER) {
ini_set('display_errors', 0);
set_exception_handler([$this, 'handleException']);
set_error_handler([$this, 'handleError']);
if ($this->memoryReserveSize > 0) {
$this->_memoryReserve = str_repeat('x', $this->memoryReserveSize);
}
register_shutdown_function([$this, 'handleFatalError']);
}
}
/**
* Returns an ID that uniquely identifies this module among all modules within the current application. * Returns an ID that uniquely identifies this module among all modules within the current application.
* Since this is an application instance, it will always return an empty string. * Since this is an application instance, it will always return an empty string.
* @return string the unique ID of the module. * @return string the unique ID of the module.
...@@ -429,7 +403,7 @@ abstract class Application extends Module ...@@ -429,7 +403,7 @@ abstract class Application extends Module
*/ */
public function getErrorHandler() public function getErrorHandler()
{ {
return $this->get('errorHandler'); return $this->get('errorHandler', false);
} }
/** /**
...@@ -531,156 +505,4 @@ abstract class Application extends Module ...@@ -531,156 +505,4 @@ abstract class Application extends Module
'assetManager' => ['class' => 'yii\web\AssetManager'], 'assetManager' => ['class' => 'yii\web\AssetManager'],
]; ];
} }
/**
* Handles uncaught PHP exceptions.
*
* This method is implemented as a PHP exception handler.
*
* @param \Exception $exception the exception that is not caught
*/
public function handleException($exception)
{
$this->exception = $exception;
// disable error capturing to avoid recursive errors while handling exceptions
restore_error_handler();
restore_exception_handler();
try {
$this->logException($exception);
if (($handler = $this->getErrorHandler()) !== null) {
$handler->handle($exception);
} else {
echo $this->renderException($exception);
if (PHP_SAPI === 'cli' && !YII_ENV_TEST) {
exit(1);
}
}
} catch (\Exception $e) {
// exception could be thrown in ErrorHandler::handle()
$msg = (string) $e;
$msg .= "\nPrevious exception:\n";
$msg .= (string) $exception;
if (YII_DEBUG) {
if (PHP_SAPI === 'cli') {
echo $msg . "\n";
} else {
echo '<pre>' . htmlspecialchars($msg, ENT_QUOTES, $this->charset) . '</pre>';
}
}
$msg .= "\n\$_SERVER = " . var_export($_SERVER, true);
error_log($msg);
exit(1);
}
}
/**
* Handles PHP execution errors such as warnings, notices.
*
* This method is used as a PHP error handler. It will simply raise an `ErrorException`.
*
* @param integer $code the level of the error raised
* @param string $message the error message
* @param string $file the filename that the error was raised in
* @param integer $line the line number the error was raised at
*
* @throws ErrorException
*/
public function handleError($code, $message, $file, $line)
{
if (error_reporting() & $code) {
// load ErrorException manually here because autoloading them will not work
// when error occurs while autoloading a class
if (!class_exists('\\yii\\base\\Exception', false)) {
require_once(__DIR__ . '/Exception.php');
}
if (!class_exists('\\yii\\base\\ErrorException', false)) {
require_once(__DIR__ . '/ErrorException.php');
}
$exception = new ErrorException($message, $code, $code, $file, $line);
// in case error appeared in __toString method we can't throw any exception
$trace = debug_backtrace(false);
array_shift($trace);
foreach ($trace as $frame) {
if ($frame['function'] == '__toString') {
$this->handleException($exception);
exit(1);
}
}
throw $exception;
}
}
/**
* Handles fatal PHP errors
*/
public function handleFatalError()
{
unset($this->_memoryReserve);
// load ErrorException manually here because autoloading them will not work
// when error occurs while autoloading a class
if (!class_exists('\\yii\\base\\Exception', false)) {
require_once(__DIR__ . '/Exception.php');
}
if (!class_exists('\\yii\\base\\ErrorException', false)) {
require_once(__DIR__ . '/ErrorException.php');
}
$error = error_get_last();
if (ErrorException::isFatalError($error)) {
$exception = new ErrorException($error['message'], $error['type'], $error['type'], $error['file'], $error['line']);
$this->exception = $exception;
// use error_log because it's too late to use Yii log
error_log($exception);
if (($handler = $this->getErrorHandler()) !== null) {
$handler->handle($exception);
} else {
echo $this->renderException($exception);
}
exit(1);
}
}
/**
* Renders an exception without using rich format.
* @param \Exception $exception the exception to be rendered.
* @return string the rendering result
*/
public function renderException($exception)
{
if ($exception instanceof Exception && ($exception instanceof UserException || !YII_DEBUG)) {
$message = $exception->getName() . ': ' . $exception->getMessage();
if (Yii::$app->controller instanceof \yii\console\Controller) {
$message = Yii::$app->controller->ansiFormat($message, Console::FG_RED);
}
} else {
$message = YII_DEBUG ? (string) $exception : 'Error: ' . $exception->getMessage();
}
if (PHP_SAPI === 'cli') {
return $message . "\n";
} else {
return '<pre>' . htmlspecialchars($message, ENT_QUOTES, $this->charset) . '</pre>';
}
}
/**
* Logs the given exception
* @param \Exception $exception the exception to be logged
*/
protected function logException($exception)
{
$category = get_class($exception);
if ($exception instanceof HttpException) {
$category = 'yii\\web\\HttpException:' . $exception->statusCode;
} elseif ($exception instanceof \ErrorException) {
$category .= ':' . $exception->getSeverity();
}
Yii::error((string) $exception, $category);
}
} }
framework/web/Controller.php
...@@ -105,10 +105,9 @@ class Controller extends \yii\base\Controller ...@@ -105,10 +105,9 @@ class Controller extends \yii\base\Controller
public function beforeAction($action) public function beforeAction($action)
{ {
if (parent::beforeAction($action)) { if (parent::beforeAction($action)) {
if ($this->enableCsrfValidation && Yii::$app->exception === null && !Yii::$app->getRequest()->validateCsrfToken()) { if ($this->enableCsrfValidation && Yii::$app->errorHandler->exception === null && !Yii::$app->getRequest()->validateCsrfToken()) {
throw new BadRequestHttpException(Yii::t('yii', 'Unable to verify your data submission.')); throw new BadRequestHttpException(Yii::t('yii', 'Unable to verify your data submission.'));
} }
return true; return true;
} else { } else {
return false; return false;
......
framework/web/ErrorAction.php
...@@ -68,7 +68,7 @@ class ErrorAction extends Action ...@@ -68,7 +68,7 @@ class ErrorAction extends Action
public function run() public function run()
{ {
if (($exception = Yii::$app->exception) === null) { if (($exception = Yii::$app->errorHandler->exception) === null) {
return ''; return '';
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment