ExceptionHandler::exceptionHandler() - Code Metrics - Inspection of "Merge branch 'master' into multiproject/db" - enwikipedia-acc/waca - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — multiproject/db ( 16c0c4...9dd649 )

by Simon

created 2021-08-08 21:20 UTC

ExceptionHandler::exceptionHandler() A

↳ Parent: ExceptionHandler

Complexity

Conditions	4
Paths	8

Size

Total Lines	55
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	24
c	2
b	0
f	0
dl	0
loc	55
ccs	0
cts	41
cp	0
rs	9.536
cc	4
nc	8
nop	1
crap	20

How to fix Long Method

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca;

use ErrorException;
use Throwable;

class ExceptionHandler
{
    /**
     * Global exception handler
     *
     * Smarty would be nice to use, but it COULD BE smarty that throws the errors.
     * Let's build something ourselves, and hope it works.
     *
     * @param $exception
     *
     * @category Security-Critical - has the potential to leak data when exception is thrown.
     */
    public static function exceptionHandler(Throwable $exception)
    {
        /** @global $siteConfiguration SiteConfiguration */
        global $siteConfiguration;

        $errorDocument = <<<HTML
<!DOCTYPE html>
<html lang="en"><head>
<meta charset="utf-8">
<title>Oops! Something went wrong!</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="{$siteConfiguration->getBaseUrl()}/resources/generated/bootstrap-main.css" rel="stylesheet">
<style>
  body {
    padding-top: 60px;
  }
</style>
</head><body><div class="container">
<h1>Oops! Something went wrong!</h1>
<p>We'll work on fixing this for you, so why not come back later?</p>
<p class="muted">If our trained monkeys ask, tell them this error ID: <code>$1$</code></p>
$2$
</div></body></html>
HTML;

        list($errorData, $errorId) = self::logExceptionToDisk($exception, $siteConfiguration, true);

        // clear and discard any content that's been saved to the output buffer
        if (ob_get_level() > 0) {
            ob_end_clean();
        }

        // push error ID into the document.
        $message = str_replace('$1$', $errorId, $errorDocument);

        if ($siteConfiguration->getDebuggingTraceEnabled()) {
            ob_start();
            var_dump($errorData);

            $textErrorData = ob_get_contents();
            ob_end_clean();

            $message = str_replace('$2$', $textErrorData, $message);
        }
        else {
            $message = str_replace('$2$', "", $message);
        }

        // While we *shouldn't* have sent headers by now due to the output buffering, PHPUnit does weird things.
        // This is "only" needed for the tests, but it's a good idea to wrap this anyway.
        if (!headers_sent()) {
            header('HTTP/1.1 500 Internal Server Error');
        }

        // output the document
        print $message;
    }

    /**
     * @param int    $errorSeverity The severity level of the exception.
     * @param string $errorMessage  The Exception message to throw.
     * @param string $errorFile     The filename where the exception is thrown.
     * @param int    $errorLine     The line number where the exception is thrown.
     *
     * @throws ErrorException
     */
    public static function errorHandler($errorSeverity, $errorMessage, $errorFile, $errorLine)
    {
        // call into the main exception handler above
        throw new ErrorException($errorMessage, 0, $errorSeverity, $errorFile, $errorLine);
    }

    /**
     * @param Throwable $exception
     *
     * @return null|array
     */
    public static function getExceptionData($exception)
    {
        if ($exception == null) {
            return null;
        }

        $array = array(
            'exception' => get_class($exception),
            'message'   => $exception->getMessage(),
            'stack'     => $exception->getTraceAsString(),
        );

        $array['previous'] = self::getExceptionData($exception->getPrevious());

        return $array;
    }

    /**
     * @param Throwable         $exception
     * @param SiteConfiguration $siteConfiguration
     * @param bool              $fromGlobalHandler
     *
     * @return array
     */
    public static function logExceptionToDisk(
        Throwable $exception,
        SiteConfiguration $siteConfiguration,
        bool $fromGlobalHandler = false
    ): array {
        $errorData = self::getExceptionData($exception);
        $errorData['server'] = $_SERVER;
        $errorData['get'] = $_GET;
        $errorData['post'] = $_POST;

        if ($fromGlobalHandler) {
            $errorData['globalHandler'] = true;
        }
        else {
            $errorData['globalHandler'] = false;
        }

        $state = serialize($errorData);
        $errorId = sha1($state);

        // Save the error for later analysis
        file_put_contents($siteConfiguration->getErrorLog() . '/' . $errorId . '.log', $state);

        return array($errorData, $errorId);
    }
}


1			<?php
2			/******************************************************************************
3			* Wikipedia Account Creation Assistance tool *
4			* *
5			* All code in this file is released into the public domain by the ACC *
6			* Development Team. Please see team.json for a list of contributors. *
7			******************************************************************************/
8
9			namespace Waca;
10
11			use ErrorException;
12			use Throwable;
13
14			class ExceptionHandler
15			{
16			/**
17			* Global exception handler
18			*
19			* Smarty would be nice to use, but it COULD BE smarty that throws the errors.
20			* Let's build something ourselves, and hope it works.
21			*
22			* @param $exception
23			*
24			* @category Security-Critical - has the potential to leak data when exception is thrown.
25			*/
26			public static function exceptionHandler(Throwable $exception)
27			{
28			/** @global $siteConfiguration SiteConfiguration */
29			global $siteConfiguration;
30
31			$errorDocument = <<<HTML
32			<!DOCTYPE html>
33			<html lang="en"><head>
34			<meta charset="utf-8">
35			<title>Oops! Something went wrong!</title>
36			<meta name="viewport" content="width=device-width, initial-scale=1.0">
37			<link href="{$siteConfiguration->getBaseUrl()}/resources/generated/bootstrap-main.css" rel="stylesheet">
38			<style>
39			body {
40			padding-top: 60px;
41			}
42			</style>
43			</head><body><div class="container">
44			<h1>Oops! Something went wrong!</h1>
45			<p>We'll work on fixing this for you, so why not come back later?</p>
46			<p class="muted">If our trained monkeys ask, tell them this error ID: <code>$1$</code></p>
47			$2$
48			</div></body></html>
49			HTML;
50
51			list($errorData, $errorId) = self::logExceptionToDisk($exception, $siteConfiguration, true);
52
53			// clear and discard any content that's been saved to the output buffer
54			if (ob_get_level() > 0) {
55			ob_end_clean();
56			}
57
58			// push error ID into the document.
59			$message = str_replace('$1$', $errorId, $errorDocument);
60
61			if ($siteConfiguration->getDebuggingTraceEnabled()) {
62			ob_start();
63			var_dump($errorData);
			1 ignored issue – show Security Debugging Code introduced 2020-05-09 22:40 UTC by Report Bug Copy Issue Report `var_dump($errorData)` looks like debug code. Are you sure you do not want to remove it? Loading history...
64			$textErrorData = ob_get_contents();
65			ob_end_clean();
66
67			$message = str_replace('$2$', $textErrorData, $message);
68			}
69			else {
70			$message = str_replace('$2$', "", $message);
71			}
72
73			// While we shouldn't have sent headers by now due to the output buffering, PHPUnit does weird things.
74			// This is "only" needed for the tests, but it's a good idea to wrap this anyway.
75			if (!headers_sent()) {
76			header('HTTP/1.1 500 Internal Server Error');
77			}
78
79			// output the document
80			print $message;
81			}
82
83			/**
84			* @param int $errorSeverity The severity level of the exception.
85			* @param string $errorMessage The Exception message to throw.
86			* @param string $errorFile The filename where the exception is thrown.
87			* @param int $errorLine The line number where the exception is thrown.
88			*
89			* @throws ErrorException
90			*/
91			public static function errorHandler($errorSeverity, $errorMessage, $errorFile, $errorLine)
92			{
93			// call into the main exception handler above
94			throw new ErrorException($errorMessage, 0, $errorSeverity, $errorFile, $errorLine);
95			}
96
97			/**
98			* @param Throwable $exception
99			*
100			* @return null\|array
101			*/
102			public static function getExceptionData($exception)
103			{
104			if ($exception == null) {
105			return null;
106			}
107
108			$array = array(
109			'exception' => get_class($exception),
110			'message' => $exception->getMessage(),
111			'stack' => $exception->getTraceAsString(),
112			);
113
114			$array['previous'] = self::getExceptionData($exception->getPrevious());
115
116			return $array;
117			}
118
119			/**
120			* @param Throwable $exception
121			* @param SiteConfiguration $siteConfiguration
122			* @param bool $fromGlobalHandler
123			*
124			* @return array
125			*/
126			public static function logExceptionToDisk(
127			Throwable $exception,
128			SiteConfiguration $siteConfiguration,
129			bool $fromGlobalHandler = false
130			): array {
131			$errorData = self::getExceptionData($exception);
132			$errorData['server'] = $_SERVER;
133			$errorData['get'] = $_GET;
134			$errorData['post'] = $_POST;
135
136			if ($fromGlobalHandler) {
137			$errorData['globalHandler'] = true;
138			}
139			else {
140			$errorData['globalHandler'] = false;
141			}
142
143			$state = serialize($errorData);
144			$errorId = sha1($state);
145
146			// Save the error for later analysis
147			file_put_contents($siteConfiguration->getErrorLog() . '/' . $errorId . '.log', $state);
148
149			return array($errorData, $errorId);
150			}
151			}
152

enwikipedia-acc / waca

Push — multiproject/db ( 16c0c4...9dd649 )

ExceptionHandler::exceptionHandler() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like