ErrorHandler::getSourceCode() - Code Metrics - Inspection of "Merge pull request #42 from armanist/master" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e43f1a...57db71 )

by Arman

created 2021-06-29 17:15 UTC

ErrorHandler::getSourceCode() A

↳ Parent: ErrorHandler

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	8
c	1
b	0
f	0
dl	0
loc	15
rs	10
cc	3
nc	3
nop	3

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.4.0
 */

namespace Quantum\Tracer;

use Quantum\Libraries\Storage\FileSystem;
use Quantum\Factory\ViewFactory;
use Quantum\Http\Request\File;
use Quantum\Logger\FileLogger;
use Quantum\Http\Response;
use Quantum\Logger\Logger;
use Quantum\Di\Di;
use ErrorException;
use Throwable;

/**
 * Class ErrorHandler
 * @package Quantum\Tracer
 */
class ErrorHandler
{

    /**
     * Number of lines to be returned
     */
    const NUM_LINES = 10;

    /**
     * @var array
     */
    private static $trace = [];

    /**
     * @var \string[][]
     */
    private static $errorTypes = [
        E_ERROR => ['fn' => 'error', 'severity' => 'Error'],
        E_WARNING => ['fn' => 'warning', 'severity' => 'Warning'],
        E_PARSE => ['fn' => 'error', 'severity' => 'Parsing Error'],
        E_NOTICE => ['fn' => 'notice', 'severity' => 'Notice'],
        E_CORE_ERROR => ['fn' => 'error', 'severity' => 'Core Error'],
        E_CORE_WARNING => ['fn' => 'warning', 'severity' => 'Core Warning'],
        E_COMPILE_ERROR => ['fn' => 'error', 'severity' => 'Compile Error'],
        E_COMPILE_WARNING => ['fn' => 'warning', 'severity' => 'Compile Warning'],
        E_USER_ERROR => ['fn' => 'error', 'severity' => 'User Error'],
        E_USER_WARNING => ['fn' => 'warning', 'severity' => 'User Warning'],
        E_USER_NOTICE => ['fn' => 'notice', 'severity' => 'User Notice'],
        E_STRICT => ['fn' => 'notice', 'severity' => 'Runtime Notice'],
        E_RECOVERABLE_ERROR => ['fn' => 'error', 'severity' => 'Catchable Fatal Error']
    ];

    /**
     * Setups the handlers
     * @throws \ErrorException
     */
    public static function setup()
    {
        set_error_handler(function ($severity, $message, $file, $line) {

            if (!(error_reporting() && $severity)) {
                return;
            }

            throw new ErrorException($message, 0, $severity, $file, $line);
        });

        set_exception_handler(function (Throwable $e) {
            self::handle($e);
        });
    }

    /**
     * Handles errors and exceptions
     * @param \Throwable $e
     * @throws \Quantum\Exceptions\DiException
     * @throws \Quantum\Exceptions\ViewException
     * @throws \ReflectionException
     */
    protected static function handle(Throwable $e)
    {
        self::composeStackTrace($e);

        $fn = 'info';
        $severity = null;

        $errorType = self::getErrorType($e);

        if ($errorType) {
            extract($errorType);
        }

        $view = ViewFactory::getInstance();

        if (filter_var(config()->get('debug'), FILTER_VALIDATE_BOOLEAN)) {
            Response::html($view->renderPartial('errors/trace', ['stackTrace' => self::$trace, 'errorMessage' => $e->getMessage(), 'severity' => $severity]));
            Response::send();
        } else {
            $logFile = LOGS_DIR . DS . date('Y-m-d') . '.log';

            $fileLogger = new FileLogger($logFile);

            $logger = new Logger($fileLogger);

            $logMessage = '[' . date('Y-m-d H:i:s') . '] ' . $severity . ': ' . $e->getMessage() . PHP_EOL . $e->getTraceAsString() . PHP_EOL;

            $logger->$fn($logMessage);

            Response::html($view->renderPartial('errors/500'));
            Response::send();
        }

        exit;

    }

    /**
     * Composes the stack trace
     * @param \Throwable $e
     */
    protected static function composeStackTrace(Throwable $e)
    {
        self::$trace[] = [
            'file' => $e->getFile(),
            'code' => self::getSourceCode($e->getFile(), $e->getLine(), 'error-line')
        ];

        foreach ($e->getTrace() as $item) {
            if (isset($item['class']) && $item['class'] == __CLASS__) {
                continue;
            }

            if (isset($item['file'])) {
                self::$trace[] = [
                    'file' => $item['file'],
                    'code' => self::getSourceCode($item['file'], $item['line'], 'switch-line')
                ];
            }
        }
    }

    /**
     * Gets the source code where the error happens
     * @param string $filename
     * @param int $lineNumber
     * @param string $className
     * @return string
     * @throws \Quantum\Exceptions\DiException
     * @throws \ReflectionException
     */
    protected static function getSourceCode(string $filename, int $lineNumber, string $className)
    {
        $fs = Di::get(FileSystem::class);

        $start = max($lineNumber - floor(self::NUM_LINES / 2), 1);

        $lines = $fs->getLines($filename, $start, self::NUM_LINES, FILE_IGNORE_NEW_LINES);

        $code = '<ol start="' . key($lines) . '">';
        foreach ($lines as $currentLineNumber => $line) {
            $code .= '<li ' . ($currentLineNumber == $lineNumber - 1 ? 'class="' . $className . '"' : '') . '><pre>' . $line . '</pre></li>';
        }
        $code .= '</ol>';

        return $code;
    }

    /**
     * Gets the error type
     * @param \Throwable $e
     * @return string[]|null
     */
    private static function getErrorType(Throwable $e)
    {
        if ($e instanceof ErrorException) {
            $severity = $e->getSeverity();

            return self::$errorTypes[$severity] ?? null;
        } else if ($e->getCode()) {
            return self::$errorTypes[$e->getCode()] ?? null;
        }

        return null;
    }
}

1			<?php
2
3			/**
4			* Quantum PHP Framework
5			*
6			* An open source software development framework for PHP
7			*
8			* @package Quantum
9			* @author Arman Ag. <[email protected]>
10			* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
11			* @link http://quantum.softberg.org/
12			* @since 2.4.0
13			*/
14
15			namespace Quantum\Tracer;
16
17			use Quantum\Libraries\Storage\FileSystem;
18			use Quantum\Factory\ViewFactory;
19			use Quantum\Http\Request\File;
20			use Quantum\Logger\FileLogger;
21			use Quantum\Http\Response;
22			use Quantum\Logger\Logger;
23			use Quantum\Di\Di;
24			use ErrorException;
25			use Throwable;
26
27			/**
28			* Class ErrorHandler
29			* @package Quantum\Tracer
30			*/
31			class ErrorHandler
32			{
33
34			/**
35			* Number of lines to be returned
36			*/
37			const NUM_LINES = 10;
38
39			/**
40			* @var array
41			*/
42			private static $trace = [];
43
44			/**
45			* @var \string[][]
46			*/
47			private static $errorTypes = [
48			E_ERROR => ['fn' => 'error', 'severity' => 'Error'],
49			E_WARNING => ['fn' => 'warning', 'severity' => 'Warning'],
50			E_PARSE => ['fn' => 'error', 'severity' => 'Parsing Error'],
51			E_NOTICE => ['fn' => 'notice', 'severity' => 'Notice'],
52			E_CORE_ERROR => ['fn' => 'error', 'severity' => 'Core Error'],
53			E_CORE_WARNING => ['fn' => 'warning', 'severity' => 'Core Warning'],
54			E_COMPILE_ERROR => ['fn' => 'error', 'severity' => 'Compile Error'],
55			E_COMPILE_WARNING => ['fn' => 'warning', 'severity' => 'Compile Warning'],
56			E_USER_ERROR => ['fn' => 'error', 'severity' => 'User Error'],
57			E_USER_WARNING => ['fn' => 'warning', 'severity' => 'User Warning'],
58			E_USER_NOTICE => ['fn' => 'notice', 'severity' => 'User Notice'],
59			E_STRICT => ['fn' => 'notice', 'severity' => 'Runtime Notice'],
60			E_RECOVERABLE_ERROR => ['fn' => 'error', 'severity' => 'Catchable Fatal Error']
61			];
62
63			/**
64			* Setups the handlers
65			* @throws \ErrorException
66			*/
67			public static function setup()
68			{
69			set_error_handler(function ($severity, $message, $file, $line) {
70
71			if (!(error_reporting() && $severity)) {
72			return;
73			}
74
75			throw new ErrorException($message, 0, $severity, $file, $line);
76			});
77
78			set_exception_handler(function (Throwable $e) {
79			self::handle($e);
80			});
81			}
82
83			/**
84			* Handles errors and exceptions
85			* @param \Throwable $e
86			* @throws \Quantum\Exceptions\DiException
87			* @throws \Quantum\Exceptions\ViewException
88			* @throws \ReflectionException
89			*/
90			protected static function handle(Throwable $e)
91			{
92			self::composeStackTrace($e);
93
94			$fn = 'info';
95			$severity = null;
96
97			$errorType = self::getErrorType($e);
98
99			if ($errorType) {
100			extract($errorType);
101			}
102
103			$view = ViewFactory::getInstance();
104
105			if (filter_var(config()->get('debug'), FILTER_VALIDATE_BOOLEAN)) {
106			Response::html($view->renderPartial('errors/trace', ['stackTrace' => self::$trace, 'errorMessage' => $e->getMessage(), 'severity' => $severity]));
107			Response::send();
108			} else {
109			$logFile = LOGS_DIR . DS . date('Y-m-d') . '.log';
110
111			$fileLogger = new FileLogger($logFile);
112
113			$logger = new Logger($fileLogger);
114
115			$logMessage = '[' . date('Y-m-d H:i:s') . '] ' . $severity . ': ' . $e->getMessage() . PHP_EOL . $e->getTraceAsString() . PHP_EOL;
116
117			$logger->$fn($logMessage);
118
119			Response::html($view->renderPartial('errors/500'));
120			Response::send();
121			}
122
123			exit;
			0 ignored issues – show Best Practice introduced 2021-06-29 16:37 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
124			}
125
126			/**
127			* Composes the stack trace
128			* @param \Throwable $e
129			*/
130			protected static function composeStackTrace(Throwable $e)
131			{
132			self::$trace[] = [
133			'file' => $e->getFile(),
134			'code' => self::getSourceCode($e->getFile(), $e->getLine(), 'error-line')
135			];
136
137			foreach ($e->getTrace() as $item) {
138			if (isset($item['class']) && $item['class'] == __CLASS__) {
139			continue;
140			}
141
142			if (isset($item['file'])) {
143			self::$trace[] = [
144			'file' => $item['file'],
145			'code' => self::getSourceCode($item['file'], $item['line'], 'switch-line')
146			];
147			}
148			}
149			}
150
151			/**
152			* Gets the source code where the error happens
153			* @param string $filename
154			* @param int $lineNumber
155			* @param string $className
156			* @return string
157			* @throws \Quantum\Exceptions\DiException
158			* @throws \ReflectionException
159			*/
160			protected static function getSourceCode(string $filename, int $lineNumber, string $className)
161			{
162			$fs = Di::get(FileSystem::class);
163
164			$start = max($lineNumber - floor(self::NUM_LINES / 2), 1);
165
166			$lines = $fs->getLines($filename, $start, self::NUM_LINES, FILE_IGNORE_NEW_LINES);
167
168			$code = '<ol start="' . key($lines) . '">';
169			foreach ($lines as $currentLineNumber => $line) {
170			$code .= '<li ' . ($currentLineNumber == $lineNumber - 1 ? 'class="' . $className . '"' : '') . '><pre>' . $line . '</pre></li>';
171			}
172			$code .= '</ol>';
173
174			return $code;
175			}
176
177			/**
178			* Gets the error type
179			* @param \Throwable $e
180			* @return string[]\|null
181			*/
182			private static function getErrorType(Throwable $e)
183			{
184			if ($e instanceof ErrorException) {
185			$severity = $e->getSeverity();
186
187			return self::$errorTypes[$severity] ?? null;
188			} else if ($e->getCode()) {
189			return self::$errorTypes[$e->getCode()] ?? null;
190			}
191
192			return null;
193			}
194			}

softberg / quantum-php-core

Push — master ( e43f1a...57db71 )

ErrorHandler::getSourceCode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like