ErrorHandler.php 12.7 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8
namespace yii\base;
Qiang Xue committed
9

10
use Yii;
Qiang Xue committed
11
use yii\web\HttpException;
12

Qiang Xue committed
13
/**
Qiang Xue committed
14
 * ErrorHandler handles uncaught PHP errors and exceptions.
Qiang Xue committed
15
 *
Qiang Xue committed
16 17 18
 * ErrorHandler displays these errors using appropriate views based on the
 * nature of the errors and the mode the application runs at.
 *
19
 * ErrorHandler is configured as an application component in [[\yii\base\Application]] by default.
20 21
 * You can access that instance via `Yii::$app->errorHandler`.
 *
Qiang Xue committed
22
 * @author Qiang Xue <qiang.xue@gmail.com>
resurtm committed
23
 * @author Timur Ruziev <resurtm@gmail.com>
Qiang Xue committed
24
 * @since 2.0
Qiang Xue committed
25
 */
26
class ErrorHandler extends Component
Qiang Xue committed
27
{
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
    /**
     * @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;
Qiang Xue committed
67

68 69 70 71 72 73 74 75 76 77 78 79
    /**
     * Handles exception.
     * @param \Exception $exception to be handled.
     */
    public function handle($exception)
    {
        $this->exception = $exception;
        if ($this->discardExistingOutput) {
            $this->clearOutput();
        }
        $this->renderException($exception);
    }
Qiang Xue committed
80

81 82 83 84 85 86 87 88 89 90 91
    /**
     * 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);
            }
Qiang Xue committed
92

93 94
            return;
        }
95

96
        $response = Yii::$app->getResponse();
97

98
        $useErrorView = $response->format === \yii\web\Response::FORMAT_HTML && (!YII_DEBUG || $exception instanceof UserException);
99

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
        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,
                ]);
            }
        } else {
            $response->data = $this->convertExceptionToArray($exception);
        }
125

126 127 128 129 130
        if ($exception instanceof HttpException) {
            $response->setStatusCode($exception->statusCode);
        } else {
            $response->setStatusCode(500);
        }
131

132 133
        $response->send();
    }
Qiang Xue committed
134

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
    /**
     * Converts an exception into an array.
     * @param  \Exception $exception the exception being converted
     * @return array      the array representation of the exception.
     */
    protected function convertExceptionToArray($exception)
    {
        $array = [
            'type' => get_class($exception),
            'name' => $exception instanceof \yii\base\Exception || $exception instanceof \yii\base\ErrorException ? $exception->getName() : 'Exception',
            'message' => $exception->getMessage(),
            'code' => $exception->getCode(),
        ];
        if ($exception instanceof HttpException) {
            $array['status'] = $exception->statusCode;
        }
        if (($prev = $exception->getPrevious()) !== null) {
            $array['previous'] = $this->convertExceptionToArray($prev);
        }
154

155 156
        return $array;
    }
Qiang Xue committed
157

158 159 160 161 162 163 164 165 166
    /**
     * 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);
    }
resurtm committed
167

168 169 170 171 172 173 174 175 176 177 178 179
    /**
     * 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();
            }
        }
    }
resurtm committed
180

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
    /**
     * 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);
        }
resurtm committed
202

203 204
        return $html;
    }
205

206 207 208 209 210 211 212 213 214 215 216 217 218 219
    /**
     * 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_));
resurtm committed
220

221 222 223 224 225
            return ob_get_clean();
        } else {
            return Yii::$app->getView()->renderFile($_file_, $_params_, $this);
        }
    }
resurtm committed
226

227 228 229 230 231 232 233 234 235 236 237 238 239 240
    /**
     * 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 '';
        }
    }
resurtm committed
241

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
    /**
     * 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 '';
            }
261

262 263 264 265
            $half = (int) (($index == 0 ? $this->maxSourceLines : $this->maxTraceSourceLines) / 2);
            $begin = $line - $half > 0 ? $line - $half : 0;
            $end = $line + $half < $lineCount ? $line + $half : $lineCount - 1;
        }
resurtm committed
266

267 268 269 270 271 272 273 274 275 276 277
        return $this->renderFile($this->callStackItemView, [
            'file' => $file,
            'line' => $line,
            'class' => $class,
            'method' => $method,
            'index' => $index,
            'lines' => $lines,
            'begin' => $begin,
            'end' => $end,
        ]);
    }
278

279 280 281 282 283 284 285 286 287 288 289 290
    /**
     * 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";
            }
        }
resurtm committed
291

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
        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 . ' &ndash; ' . $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>';
    }
Qiang Xue committed
353
}