ErrorHandler - Code Metrics - Inspection of "add shutdown handler to even manage fatal errors" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — globalErrorHandling ( f6317b...2c479f )

by Andreas

created 2020-07-13 22:56 UTC

ErrorHandler A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

Metric	Value
dl	0
loc	156
rs	10
c	0
b	0
f	0
wmc	19
lcom	1
cbo	0

7 Methods

Rating	Name	Size	Complexity
A	register()	8	2
A	fatalException()	25	3
A	showExceptionMsg()	6	2
A	errorConverter()	11	2
A	fatalShutdown()	20	3
A	logException()	13	1
B	guessPlugin()	20	6

<?php

namespace dokuwiki;

class ErrorHandler
{

    /**
     * Register the default error handling
     */
    public static function register()
    {
        set_error_handler([ErrorHandler::class, 'errorConverter']);
        if (!defined('DOKU_UNITTEST')) {
            set_exception_handler([ErrorHandler::class, 'fatalException']);
            register_shutdown_function([ErrorHandler::class, 'fatalShutdown']);
        }
    }

    /**
     * Default Exception handler to show a nice user message before dieing
     *
     * The exception is logged to the error log
     *
     * @param \Throwable $e
     */
    public static function fatalException($e)
    {
        $plugin = self::guessPlugin($e);
        $title = hsc(get_class($e) . ': ' . $e->getMessage());
        $msg = 'An unforeseen error has occured. This is most likely a bug somewhere.';
        if ($plugin) $msg .= ' It might be a problem in the ' . $plugin . ' plugin.';
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
        $logged = self::logException($e)
            ? 'More info has been written to the DokuWiki _error.log'
            : $e->getFile() . ':' . $e->getLine();

        echo <<<EOT
<!DOCTYPE html>
<html>
<head><title>$title</title></head>
<body style="font-family: Arial, sans-serif">
    <div style="width:60%; margin: auto; background-color: #fcc;
                border: 1px solid #faa; padding: 0.5em 1em;">
        <h1 style="font-size: 120%">$title</h1>
        <p>$msg</p>
        <p>$logged</p>
    </div>
</body>
</html>
EOT;
    }

    /**
     * Convenience method to display an error message for the given Exception
     *
     * @param \Throwable $e
     * @param string $intro
     */
    public static function showExceptionMsg($e, $intro = 'Error!')
    {
        $msg = hsc($intro) . '<br />' . hsc(get_class($e) . ': ' . $e->getMessage());
        if (self::logException($e)) $msg .= '<br />More info is available in the _error.log';
        msg($msg, -1);
    }

    /**
     * Default error handler to convert old school warnings, notices, etc to exceptions
     *
     * You should not need to call this directly!
     *
     * @param int $errno
     * @param string $errstr
     * @param string $errfile
     * @param int $errline
     * @return bool
     * @throws \ErrorException
     */
    public static function errorConverter($errno, $errstr, $errfile, $errline)
    {

        if (!(error_reporting() & $errno)) {
            // This error code is not included in error_reporting, so let it fall
            // through to the standard PHP error handler
            return false;
        }

        throw new \ErrorException($errstr, 0, $errno, $errfile, $errline);
    }

    /**
     * Last resort to handle fatal errors that still can't be cought
     */
    public static function fatalShutdown()
    {
        $error = error_get_last();
        // Check if it's a core/fatal error, otherwise it's a normal shutdown
        if (
            $error !== null &&
            in_array(
                $error['type'],
                [
                    E_ERROR,
                    E_CORE_ERROR,
                    E_COMPILE_ERROR,
                ]
            )
        ) {
            self::fatalException(
                new \ErrorException($error['message'], 0, $error['type'], $error['file'], $error['line'])
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            );
        }
    }

    /**
     * Log the given exception to the error log
     *
     * @param \Throwable $e
     * @return bool false if the logging failed
     */
    public static function logException($e)
    {
        global $conf;

        $log = join("\t", [
                gmdate('c'),
                get_class($e),
                $e->getFile() . '(' . $e->getLine() . ')',
                $e->getMessage(),
            ]) . "\n";
        $log .= $e->getTraceAsString() . "\n";
        return io_saveFile($conf['cachedir'] . '/_error.log', $log, true);
    }

    /**
     * Checks the the stacktrace for plugin files
     *
     * @param \Throwable $e
     * @return false|string
     */
    protected static function guessPlugin($e)
    {
        foreach ($e->getTrace() as $line) {
            if (
                isset($line['class']) &&
                preg_match('/\w+?_plugin_(\w+)/', $line['class'], $match)
            ) {
                return $match[1];
            }

            if (
                isset($line['file']) &&
                preg_match('/lib\/plugins\/(\w+)\//', str_replace('\\', '/', $line['file']), $match)
            ) {
                return $match[1];
            }
        }

        return false;
    }
}


1			<?php
2
3			namespace dokuwiki;
4
5			class ErrorHandler
6			{
7
8			/**
9			* Register the default error handling
10			*/
11			public static function register()
12			{
13			set_error_handler([ErrorHandler::class, 'errorConverter']);
14			if (!defined('DOKU_UNITTEST')) {
15			set_exception_handler([ErrorHandler::class, 'fatalException']);
16			register_shutdown_function([ErrorHandler::class, 'fatalShutdown']);
17			}
18			}
19
20			/**
21			* Default Exception handler to show a nice user message before dieing
22			*
23			* The exception is logged to the error log
24			*
25			* @param \Throwable $e
26			*/
27			public static function fatalException($e)
28			{
29			$plugin = self::guessPlugin($e);
30			$title = hsc(get_class($e) . ': ' . $e->getMessage());
31			$msg = 'An unforeseen error has occured. This is most likely a bug somewhere.';
32			if ($plugin) $msg .= ' It might be a problem in the ' . $plugin . ' plugin.';
			0 ignored issues – show Bug Best Practice introduced 2020-07-13 17:54 UTC by Report Bug Copy Issue Report The expression `$plugin` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
33			$logged = self::logException($e)
34			? 'More info has been written to the DokuWiki _error.log'
35			: $e->getFile() . ':' . $e->getLine();
36
37			echo <<<EOT
38			<!DOCTYPE html>
39			<html>
40			<head><title>$title</title></head>
41			<body style="font-family: Arial, sans-serif">
42			<div style="width:60%; margin: auto; background-color: #fcc;
43			border: 1px solid #faa; padding: 0.5em 1em;">
44			<h1 style="font-size: 120%">$title</h1>
45			<p>$msg</p>
46			<p>$logged</p>
47			</div>
48			</body>
49			</html>
50			EOT;
51			}
52
53			/**
54			* Convenience method to display an error message for the given Exception
55			*
56			* @param \Throwable $e
57			* @param string $intro
58			*/
59			public static function showExceptionMsg($e, $intro = 'Error!')
60			{
61			$msg = hsc($intro) . '<br />' . hsc(get_class($e) . ': ' . $e->getMessage());
62			if (self::logException($e)) $msg .= '<br />More info is available in the _error.log';
63			msg($msg, -1);
64			}
65
66			/**
67			* Default error handler to convert old school warnings, notices, etc to exceptions
68			*
69			* You should not need to call this directly!
70			*
71			* @param int $errno
72			* @param string $errstr
73			* @param string $errfile
74			* @param int $errline
75			* @return bool
76			* @throws \ErrorException
77			*/
78			public static function errorConverter($errno, $errstr, $errfile, $errline)
79			{
80
81			if (!(error_reporting() & $errno)) {
82			// This error code is not included in error_reporting, so let it fall
83			// through to the standard PHP error handler
84			return false;
85			}
86
87			throw new \ErrorException($errstr, 0, $errno, $errfile, $errline);
88			}
89
90			/**
91			* Last resort to handle fatal errors that still can't be cought
92			*/
93			public static function fatalShutdown()
94			{
95			$error = error_get_last();
96			// Check if it's a core/fatal error, otherwise it's a normal shutdown
97			if (
98			$error !== null &&
99			in_array(
100			$error['type'],
101			[
102			E_ERROR,
103			E_CORE_ERROR,
104			E_COMPILE_ERROR,
105			]
106			)
107			) {
108			self::fatalException(
109			new \ErrorException($error['message'], 0, $error['type'], $error['file'], $error['line'])
			0 ignored issues – show Documentation introduced 2020-07-13 22:59 UTC by Report Bug Copy Issue Report `new \ErrorException($err...file'], $error['line'])` is of type `object<ErrorException>`, but the function expects a `object<Throwable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
110			);
111			}
112			}
113
114			/**
115			* Log the given exception to the error log
116			*
117			* @param \Throwable $e
118			* @return bool false if the logging failed
119			*/
120			public static function logException($e)
121			{
122			global $conf;
123
124			$log = join("\t", [
125			gmdate('c'),
126			get_class($e),
127			$e->getFile() . '(' . $e->getLine() . ')',
128			$e->getMessage(),
129			]) . "\n";
130			$log .= $e->getTraceAsString() . "\n";
131			return io_saveFile($conf['cachedir'] . '/_error.log', $log, true);
132			}
133
134			/**
135			* Checks the the stacktrace for plugin files
136			*
137			* @param \Throwable $e
138			* @return false\|string
139			*/
140			protected static function guessPlugin($e)
141			{
142			foreach ($e->getTrace() as $line) {
143			if (
144			isset($line['class']) &&
145			preg_match('/\w+?_plugin_(\w+)/', $line['class'], $match)
146			) {
147			return $match[1];
148			}
149
150			if (
151			isset($line['file']) &&
152			preg_match('/lib\/plugins\/(\w+)\//', str_replace('\\', '/', $line['file']), $match)
153			) {
154			return $match[1];
155			}
156			}
157
158			return false;
159			}
160			}
161

splitbrain / dokuwiki

Push — globalErrorHandling ( f6317b...2c479f )

ErrorHandler A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like