You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
333 lines
10 KiB
333 lines
10 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\base; |
|
|
|
use Yii; |
|
use yii\web\HttpException; |
|
|
|
/** |
|
* ErrorHandler handles uncaught PHP errors and exceptions. |
|
* |
|
* ErrorHandler displays these errors using appropriate views based on the |
|
* nature of the errors and the mode the application runs at. |
|
* |
|
* ErrorHandler is configured as an application component in [[\yii\base\Application]] by default. |
|
* You can access that instance via `Yii::$app->errorHandler`. |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @author Timur Ruziev <resurtm@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class ErrorHandler extends Component |
|
{ |
|
/** |
|
* @var integer maximum number of source code lines to be displayed. Defaults to 25. |
|
*/ |
|
public $maxSourceLines = 25; |
|
/** |
|
* @var integer maximum number of trace source code lines to be displayed. Defaults to 10. |
|
*/ |
|
public $maxTraceSourceLines = 10; |
|
/** |
|
* @var boolean whether to discard any existing page output before error display. Defaults to true. |
|
*/ |
|
public $discardExistingOutput = true; |
|
/** |
|
* @var string the route (e.g. 'site/error') to the controller action that will be used |
|
* to display external errors. Inside the action, it can retrieve the error information |
|
* by Yii::$app->exception. This property defaults to null, meaning ErrorHandler |
|
* will handle the error display. |
|
*/ |
|
public $errorAction; |
|
/** |
|
* @var string the path of the view file for rendering exceptions without call stack information. |
|
*/ |
|
public $errorView = '@yii/views/errorHandler/error.php'; |
|
/** |
|
* @var string the path of the view file for rendering exceptions. |
|
*/ |
|
public $exceptionView = '@yii/views/errorHandler/exception.php'; |
|
/** |
|
* @var string the path of the view file for rendering exceptions and errors call stack element. |
|
*/ |
|
public $callStackItemView = '@yii/views/errorHandler/callStackItem.php'; |
|
/** |
|
* @var string the path of the view file for rendering previous exceptions. |
|
*/ |
|
public $previousExceptionView = '@yii/views/errorHandler/previousException.php'; |
|
/** |
|
* @var \Exception the exception that is being handled currently. |
|
*/ |
|
public $exception; |
|
|
|
|
|
/** |
|
* Handles exception. |
|
* @param \Exception $exception to be handled. |
|
*/ |
|
public function handle($exception) |
|
{ |
|
$this->exception = $exception; |
|
if ($this->discardExistingOutput) { |
|
$this->clearOutput(); |
|
} |
|
$this->renderException($exception); |
|
} |
|
|
|
/** |
|
* Renders the exception. |
|
* @param \Exception $exception the exception to be handled. |
|
*/ |
|
protected function renderException($exception) |
|
{ |
|
if (Yii::$app instanceof \yii\console\Application || YII_ENV_TEST) { |
|
echo Yii::$app->renderException($exception); |
|
if (!YII_ENV_TEST) { |
|
exit(1); |
|
} |
|
return; |
|
} |
|
|
|
$response = Yii::$app->getResponse(); |
|
|
|
$useErrorView = $response->format === \yii\web\Response::FORMAT_HTML && (!YII_DEBUG || $exception instanceof UserException); |
|
|
|
if ($useErrorView && $this->errorAction !== null) { |
|
$result = Yii::$app->runAction($this->errorAction); |
|
if ($result instanceof Response) { |
|
$response = $result; |
|
} else { |
|
$response->data = $result; |
|
} |
|
} elseif ($response->format === \yii\web\Response::FORMAT_HTML) { |
|
if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest') { |
|
// AJAX request |
|
$response->data = Yii::$app->renderException($exception); |
|
} else { |
|
// if there is an error during error rendering it's useful to |
|
// display PHP error in debug mode instead of a blank screen |
|
if (YII_DEBUG) { |
|
ini_set('display_errors', 1); |
|
} |
|
$file = $useErrorView ? $this->errorView : $this->exceptionView; |
|
$response->data = $this->renderFile($file, [ |
|
'exception' => $exception, |
|
]); |
|
} |
|
} elseif ($exception instanceof Arrayable) { |
|
$response->data = $exception->toArray(); |
|
} else { |
|
$response->data = [ |
|
'type' => get_class($exception), |
|
'name' => 'Exception', |
|
'message' => $exception->getMessage(), |
|
'code' => $exception->getCode(), |
|
]; |
|
} |
|
|
|
if ($exception instanceof HttpException) { |
|
$response->setStatusCode($exception->statusCode); |
|
} else { |
|
$response->setStatusCode(500); |
|
} |
|
|
|
$response->send(); |
|
} |
|
|
|
/** |
|
* Converts special characters to HTML entities. |
|
* @param string $text to encode. |
|
* @return string encoded original text. |
|
*/ |
|
public function htmlEncode($text) |
|
{ |
|
return htmlspecialchars($text, ENT_QUOTES, Yii::$app->charset); |
|
} |
|
|
|
/** |
|
* Removes all output echoed before calling this method. |
|
*/ |
|
public function clearOutput() |
|
{ |
|
// the following manual level counting is to deal with zlib.output_compression set to On |
|
for ($level = ob_get_level(); $level > 0; --$level) { |
|
if (!@ob_end_clean()) { |
|
ob_clean(); |
|
} |
|
} |
|
} |
|
|
|
/** |
|
* Adds informational links to the given PHP type/class. |
|
* @param string $code type/class name to be linkified. |
|
* @return string linkified with HTML type/class name. |
|
*/ |
|
public function addTypeLinks($code) |
|
{ |
|
$html = ''; |
|
if (strpos($code, '\\') !== false) { |
|
// namespaced class |
|
foreach (explode('\\', $code) as $part) { |
|
$html .= '<a href="http://yiiframework.com/doc/api/2.0/' . $this->htmlEncode($part) . '" target="_blank">' . $this->htmlEncode($part) . '</a>\\'; |
|
} |
|
$html = rtrim($html, '\\'); |
|
} elseif (strpos($code, '()') !== false) { |
|
// method/function call |
|
$html = preg_replace_callback('/^(.*)\(\)$/', function ($matches) { |
|
return '<a href="http://yiiframework.com/doc/api/2.0/' . $this->htmlEncode($matches[1]) . '" target="_blank">' . |
|
$this->htmlEncode($matches[1]) . '</a>()'; |
|
}, $code); |
|
} |
|
return $html; |
|
} |
|
|
|
/** |
|
* Renders a view file as a PHP script. |
|
* @param string $_file_ the view file. |
|
* @param array $_params_ the parameters (name-value pairs) that will be extracted and made available in the view file. |
|
* @return string the rendering result |
|
*/ |
|
public function renderFile($_file_, $_params_) |
|
{ |
|
$_params_['handler'] = $this; |
|
if ($this->exception instanceof ErrorException) { |
|
ob_start(); |
|
ob_implicit_flush(false); |
|
extract($_params_, EXTR_OVERWRITE); |
|
require(Yii::getAlias($_file_)); |
|
return ob_get_clean(); |
|
} else { |
|
return Yii::$app->getView()->renderFile($_file_, $_params_, $this); |
|
} |
|
} |
|
|
|
/** |
|
* Renders the previous exception stack for a given Exception. |
|
* @param \Exception $exception the exception whose precursors should be rendered. |
|
* @return string HTML content of the rendered previous exceptions. |
|
* Empty string if there are none. |
|
*/ |
|
public function renderPreviousExceptions($exception) |
|
{ |
|
if (($previous = $exception->getPrevious()) !== null) { |
|
return $this->renderFile($this->previousExceptionView, ['exception' => $previous]); |
|
} else { |
|
return ''; |
|
} |
|
} |
|
|
|
/** |
|
* Renders a single call stack element. |
|
* @param string|null $file name where call has happened. |
|
* @param integer|null $line number on which call has happened. |
|
* @param string|null $class called class name. |
|
* @param string|null $method called function/method name. |
|
* @param integer $index number of the call stack element. |
|
* @return string HTML content of the rendered call stack element. |
|
*/ |
|
public function renderCallStackItem($file, $line, $class, $method, $index) |
|
{ |
|
$lines = []; |
|
$begin = $end = 0; |
|
if ($file !== null && $line !== null) { |
|
$line--; // adjust line number from one-based to zero-based |
|
$lines = @file($file); |
|
if ($line < 0 || $lines === false || ($lineCount = count($lines)) < $line + 1) { |
|
return ''; |
|
} |
|
|
|
$half = (int)(($index == 0 ? $this->maxSourceLines : $this->maxTraceSourceLines) / 2); |
|
$begin = $line - $half > 0 ? $line - $half : 0; |
|
$end = $line + $half < $lineCount ? $line + $half : $lineCount - 1; |
|
} |
|
|
|
return $this->renderFile($this->callStackItemView, [ |
|
'file' => $file, |
|
'line' => $line, |
|
'class' => $class, |
|
'method' => $method, |
|
'index' => $index, |
|
'lines' => $lines, |
|
'begin' => $begin, |
|
'end' => $end, |
|
]); |
|
} |
|
|
|
/** |
|
* Renders the request information. |
|
* @return string the rendering result |
|
*/ |
|
public function renderRequest() |
|
{ |
|
$request = ''; |
|
foreach (['_GET', '_POST', '_SERVER', '_FILES', '_COOKIE', '_SESSION', '_ENV'] as $name) { |
|
if (!empty($GLOBALS[$name])) { |
|
$request .= '$' . $name . ' = ' . var_export($GLOBALS[$name], true) . ";\n\n"; |
|
} |
|
} |
|
return '<pre>' . rtrim($request, "\n") . '</pre>'; |
|
} |
|
|
|
/** |
|
* Determines whether given name of the file belongs to the framework. |
|
* @param string $file name to be checked. |
|
* @return boolean whether given name of the file belongs to the framework. |
|
*/ |
|
public function isCoreFile($file) |
|
{ |
|
return $file === null || strpos(realpath($file), YII_PATH . DIRECTORY_SEPARATOR) === 0; |
|
} |
|
|
|
/** |
|
* Creates HTML containing link to the page with the information on given HTTP status code. |
|
* @param integer $statusCode to be used to generate information link. |
|
* @param string $statusDescription Description to display after the the status code. |
|
* @return string generated HTML with HTTP status code information. |
|
*/ |
|
public function createHttpStatusLink($statusCode, $statusDescription) |
|
{ |
|
return '<a href="http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#' . (int)$statusCode . '" target="_blank">HTTP ' . (int)$statusCode . ' – ' . $statusDescription . '</a>'; |
|
} |
|
|
|
/** |
|
* Creates string containing HTML link which refers to the home page of determined web-server software |
|
* and its full name. |
|
* @return string server software information hyperlink. |
|
*/ |
|
public function createServerInformationLink() |
|
{ |
|
static $serverUrls = [ |
|
'http://httpd.apache.org/' => ['apache'], |
|
'http://nginx.org/' => ['nginx'], |
|
'http://lighttpd.net/' => ['lighttpd'], |
|
'http://gwan.com/' => ['g-wan', 'gwan'], |
|
'http://iis.net/' => ['iis', 'services'], |
|
'http://php.net/manual/en/features.commandline.webserver.php' => ['development'], |
|
]; |
|
if (isset($_SERVER['SERVER_SOFTWARE'])) { |
|
foreach ($serverUrls as $url => $keywords) { |
|
foreach ($keywords as $keyword) { |
|
if (stripos($_SERVER['SERVER_SOFTWARE'], $keyword) !== false) { |
|
return '<a href="' . $url . '" target="_blank">' . $this->htmlEncode($_SERVER['SERVER_SOFTWARE']) . '</a>'; |
|
} |
|
} |
|
} |
|
} |
|
return ''; |
|
} |
|
|
|
/** |
|
* Creates string containing HTML link which refers to the page with the current version |
|
* of the framework and version number text. |
|
* @return string framework version information hyperlink. |
|
*/ |
|
public function createFrameworkVersionLink() |
|
{ |
|
return '<a href="http://github.com/yiisoft/yii2/" target="_blank">' . $this->htmlEncode(Yii::getVersion()) . '</a>'; |
|
} |
|
}
|
|
|