*
  • development views, named as exception.php; *
  • production views, named as error<StatusCode>.php; * * where <StatusCode> stands for the HTTP error code (e.g. error500.php). * Localized views are named similarly but located under a subdirectory * whose name is the language code (e.g. zh_cn/error500.php). * * Development views are displayed when the application is in debug mode * (i.e. YII_DEBUG is defined as true). Detailed error information with source code * are displayed in these views. Production views are meant to be shown * to end-users and are used when the application is in production mode. * For security reasons, they only display the error message without any * sensitive information. * * ErrorHandler looks for the view templates from the following locations in order: *
      *
    1. themes/ThemeName/views/system: when a theme is active.
      2. *
    2. protected/views/system
      3. *
    3. framework/views
      4. *
    * If the view is not found in a directory, it will be looked for in the next directory. * * The property {@link maxSourceLines} can be changed to specify the number * of source code lines to be displayed in development views. * * ErrorHandler is a core application component that can be accessed via * {@link CApplication::getErrorHandler()}. * * @property array $error The error details. Null if there is no error. * @property string $versionInfo * * @author Qiang Xue * @since 2.0 */ class ErrorHandler extends ApplicationComponent { /** * @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 (eg '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()->errorHandler->error. * This property defaults to null, meaning ErrorHandler will handle the error display. */ public $errorAction; public $exceptionView = '@yii/views/exception.php'; public $errorView = '@yii/views/error.php'; /** * @var \Exception the exception that is being handled currently */ public $exception; public function init() { set_exception_handler(array($this, 'handleException')); set_error_handler(array($this, 'handleError'), error_reporting()); } /** * Handles PHP execution errors such as warnings, notices. * * This method is used as a PHP error handler. It requires * that constant YII_ENABLE_ERROR_HANDLER be defined true. * * This method will first raise an `error` event. * If the error is not handled by any event handler, it will call * {@link getErrorHandler errorHandler} to process the error. * * The application will be terminated by this method. * * @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 */ public function handleError($code, $message, $file, $line) { throw new \ErrorException($message, 0, $code, $file, $line); } /** * @param \Exception $exception */ public function handleException($exception) { // disable error capturing to avoid recursive errors while handling exceptions restore_error_handler(); restore_exception_handler(); $this->exception = $exception; $this->logException($exception); if ($this->discardExistingOutput) { $this->clearOutput(); } try { $this->render($exception); } catch (\Exception $e) { // use the most primitive way to display exception thrown in the error view $this->renderAsText($e); } } protected function render($exception) { if ($this->errorAction !== null) { \Yii::$application->runController($this->errorAction); } elseif (\Yii::$application instanceof \yii\web\Application) { if (!headers_sent()) { $errorCode = $exception instanceof HttpException ? $exception->statusCode : 500; header("HTTP/1.0 $errorCode " . get_class($exception)); } if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest') { $this->renderAsText($exception); } else { $this->renderAsHtml($exception); } } else { $this->renderAsText($exception); } } /** * Returns server and Yii version information. * @return string server version information. */ public function getVersionInfo() { $version = 'Yii Framework/' . \Yii::getVersion(); if (isset($_SERVER['SERVER_SOFTWARE'])) { $version = $_SERVER['SERVER_SOFTWARE'] . ' ' . $version; } return $version; } /** * Converts arguments array to its string representation * * @param array $args arguments array to be converted * @return string string representation of the arguments array */ public function argumentsToString($args) { $isAssoc = $args !== array_values($args); $count = 0; foreach ($args as $key => $value) { $count++; if ($count >= 5) { if ($count > 5) { unset($args[$key]); } else { $args[$key] = '...'; } continue; } if (is_object($value)) { $args[$key] = get_class($value); } elseif (is_bool($value)) { $args[$key] = $value ? 'true' : 'false'; } elseif (is_string($value)) { if (strlen($value) > 64) { $args[$key] = '"' . substr($value, 0, 64) . '..."'; } else { $args[$key] = '"' . $value . '"'; } } elseif (is_array($value)) { $args[$key] = 'array(' . $this->argumentsToString($value) . ')'; } elseif ($value === null) { $args[$key] = 'null'; } elseif (is_resource($value)) { $args[$key] = 'resource'; } if (is_string($key)) { $args[$key] = '"' . $key . '" => ' . $args[$key]; } elseif ($isAssoc) { $args[$key] = $key . ' => ' . $args[$key]; } } return implode(', ', $args); } /** * Returns a value indicating whether the call stack is from application code. * @param array $trace the trace data * @return boolean whether the call stack is from application code. */ public function isCoreCode($trace) { if (isset($trace['file'])) { return $trace['file'] === 'unknown' || strpos(realpath($trace['file']), YII_PATH . DIRECTORY_SEPARATOR) === 0; } return false; } /** * Renders the source code around the error line. * @param string $file source file path * @param integer $errorLine the error line number * @param integer $maxLines maximum number of lines to display */ public function renderSourceCode($file, $errorLine, $maxLines) { $errorLine--; // adjust line number to 0-based from 1-based if ($errorLine < 0 || ($lines = @file($file)) === false || ($lineCount = count($lines)) <= $errorLine) { return; } $halfLines = (int)($maxLines / 2); $beginLine = $errorLine - $halfLines > 0 ? $errorLine - $halfLines : 0; $endLine = $errorLine + $halfLines < $lineCount ? $errorLine + $halfLines : $lineCount - 1; $lineNumberWidth = strlen($endLine + 1); $output = ''; for ($i = $beginLine; $i <= $endLine; ++$i) { $isErrorLine = $i === $errorLine; $code = sprintf("%0{$lineNumberWidth}d %s", $i + 1, $this->htmlEncode(str_replace("\t", ' ', $lines[$i]))); if (!$isErrorLine) { $output .= $code; } else { $output .= '' . $code . ''; } } echo '
    ' . $output . '
    '; } public function renderTrace($trace) { $count = 0; echo "\n"; foreach ($trace as $n => $t) { if ($this->isCoreCode($t)) { $cssClass = 'core collapsed'; } elseif (++$count > 3) { $cssClass = 'app collapsed'; } else { $cssClass = 'app expanded'; } $hasCode = $t['file'] !== 'unknown' && is_file($t['file']); echo "\n"; } echo '
    #$n"; echo '
    '; if ($hasCode) { echo '
    +
    -
    '; } echo ' '; echo $this->htmlEncode($t['file']) . '(' . $t['line'] . '): '; if (!empty($t['class'])) { echo '' . $t['class'] . '' . $t['type']; } echo '' . $t['function'] . ''; echo '(' . (empty($t['args']) ? '' : $this->htmlEncode($this->argumentsToString($t['args']))) . ')'; echo '
    '; if ($hasCode) { $this->renderSourceCode($t['file'], $t['line'], $this->maxTraceSourceLines); } echo "
    '; } public function htmlEncode($text) { return htmlspecialchars($text, ENT_QUOTES, \Yii::$application->charset); } public function logException($exception) { $category = get_class($exception); if ($exception instanceof HttpException) { $category .= '\\' . $exception->statusCode; } elseif ($exception instanceof \ErrorException) { $category .= '\\' . $exception->getSeverity(); } \Yii::error((string)$exception, $category); } 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) { @ob_end_clean(); } } /** * @param \Exception $exception */ public function renderAsText($exception) { if (YII_DEBUG) { echo $exception; } else { echo get_class($exception) . ':' . $exception->getMessage(); } } /** * @param \Exception $exception */ public function renderAsHtml($exception) { $view = new View; $view->owner = $this; $name = !YII_DEBUG || $exception instanceof HttpException ? $this->errorView : $this->exceptionView; $view->render($name, array( 'exception' => $exception, )); } }