HandleExceptions::process() - Code Metrics - Inspection of "Fix: #3123 - display fatal errors - even if displa..." - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( dadc6d...837498 )

by Greg

created 2020-03-22 15:28 UTC

HandleExceptions::process() C

↳ Parent: HandleExceptions

Complexity

Conditions	12
Paths	27

Size

Total Lines	67
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
cc	12
eloc	31
c	2
b	0
f	1
nc	27
nop	2
dl	0
loc	67
rs	6.9666

How to fix Long Method Complexity

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2019 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Http\Middleware;

use Fig\Http\Message\RequestMethodInterface;
use Fig\Http\Message\StatusCodeInterface;
use Fisharebest\Webtrees\Exceptions\HttpException;
use Fisharebest\Webtrees\Http\ViewResponseTrait;
use Fisharebest\Webtrees\Log;
use Fisharebest\Webtrees\Services\TreeService;
use Fisharebest\Webtrees\Site;
use League\Flysystem\NotSupportedException;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Throwable;

use function app;
use function dirname;
use function error_get_last;
use function ini_get;
use function ob_end_clean;
use function ob_get_level;
use function register_shutdown_function;
use function response;
use function str_replace;
use function strpos;
use function view;

use const E_ERROR;
use const PHP_EOL;

/**
 * Middleware to handle and render errors.
 */
class HandleExceptions implements MiddlewareInterface, StatusCodeInterface
{
    use ViewResponseTrait;

    /** @var TreeService */
    private $tree_service;

    /**
     * HandleExceptions constructor.
     *
     * @param TreeService $tree_service
     */
    public function __construct(TreeService $tree_service)
    {
        $this->tree_service = $tree_service;
    }

    /**
     * @param ServerRequestInterface  $request
     * @param RequestHandlerInterface $handler
     *
     * @return ResponseInterface
     * @throws Throwable
     */
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        // Fatal errors.  We may be out of memory, so do not create any variables.
        register_shutdown_function(static function () {
            if (error_get_last()['type'] & E_ERROR) {
                // If PHP does not display the error, then we must display it.
                if (ini_get('display_errors') !== '1') {
                    echo error_get_last()['message'], '<br><br>', error_get_last()['file'] , ': ', error_get_last()['line'];
                }
                // Not our fault?
                if (strpos(error_get_last()['file'], '/modules_v4/') !== false) {
                    echo '<br><br>This is an error in a webtrees module.  Upgrade it or disable it.';
                }
            }
        });

        try {
            return $handler->handle($request);
        } catch (HttpException $exception) {
            // The router added the tree attribute to the request, and we need it for the error response.
            $request = app(ServerRequestInterface::class) ?? $request;

            return $this->httpExceptionResponse($request, $exception);
        } catch (NotSupportedException $exception) {
            // The router added the tree attribute to the request, and we need it for the error response.
            $request = app(ServerRequestInterface::class) ?? $request;

            return $this->thirdPartyExceptionResponse($request, $exception);
        } catch (Throwable $exception) {
            // Exception thrown while buffering output?
            while (ob_get_level() > 0) {
                ob_end_clean();
            }

            // The Router middleware may have added a tree attribute to the request.
            // This might be usable in the error page.
            if (app()->has(ServerRequestInterface::class)) {
                $request = app(ServerRequestInterface::class) ?? $request;
            }

            // Show the exception in a standard webtrees page (if we can).
            try {
                return $this->unhandledExceptionResponse($request, $exception);
            } catch (Throwable $e) {
                // That didn't work.  Try something else.
            }

            // Show the exception in a tree-less webtrees page (if we can).
            try {
                $request = $request->withAttribute('tree', null);

                return $this->unhandledExceptionResponse($request, $exception);
            } catch (Throwable $e) {
                // That didn't work.  Try something else.
            }

            // Show the exception in an error page (if we can).
            try {
                $this->layout = 'layouts/error';

                return $this->unhandledExceptionResponse($request, $exception);
            } catch (Throwable $e) {
                // That didn't work.  Try something else.
            }

            // Show a stack dump.
            return response((string) $exception, StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
        }
    }

    /**
     * @param ServerRequestInterface $request
     * @param HttpException          $exception
     *
     * @return ResponseInterface
     */
    private function httpExceptionResponse(ServerRequestInterface $request, HttpException $exception): ResponseInterface
    {
        $tree = $request->getAttribute('tree');

        $default = Site::getPreference('DEFAULT_GEDCOM');
        $tree = $tree ?? $this->tree_service->all()[$default] ?? $this->tree_service->all()->first();

        $status_code = $exception->getCode();

        // If this was a GET request, then we were probably fetching HTML to display, for
        // example a chart or tab.
        if (
            $request->getHeaderLine('X-Requested-With') !== '' &&
            $request->getMethod() === RequestMethodInterface::METHOD_GET
        ) {
            $this->layout = 'layouts/ajax';
            $status_code = StatusCodeInterface::STATUS_OK;
        }

        return $this->viewResponse('components/alert-danger', [
            'alert' => $exception->getMessage(),
            'title' => $exception->getMessage(),
            'tree'  => $tree,
        ], $status_code);
    }

    /**
     * @param ServerRequestInterface $request
     * @param Throwable              $exception
     *
     * @return ResponseInterface
     */
    private function thirdPartyExceptionResponse(ServerRequestInterface $request, Throwable $exception): ResponseInterface
    {
        $tree = $request->getAttribute('tree');

        $default = Site::getPreference('DEFAULT_GEDCOM');
        $tree = $tree ?? $this->tree_service->all()[$default] ?? $this->tree_service->all()->first();

        if ($request->getHeaderLine('X-Requested-With') !== '') {
            $this->layout = 'layouts/ajax';
        }

        return $this->viewResponse('components/alert-danger', [
            'alert' => $exception->getMessage(),
            'title' => $exception->getMessage(),
            'tree'  => $tree,
        ], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
    }

    /**
     * @param ServerRequestInterface $request
     * @param Throwable              $exception
     *
     * @return ResponseInterface
     */
    private function unhandledExceptionResponse(ServerRequestInterface $request, Throwable $exception): ResponseInterface
    {
        $this->layout = 'layouts/default';

        // Create a stack dump for the exception
        $base_path = dirname(__DIR__, 3);
        $trace     = $exception->getMessage() . ' ' . $exception->getFile() . ':' . $exception->getLine() . PHP_EOL . $exception->getTraceAsString();
        $trace     = str_replace($base_path, '…', $trace);
        // User data may contain non UTF-8 characters.
        $trace     = mb_convert_encoding($trace, 'UTF-8', 'UTF-8');
        $trace     = e($trace);
        $trace     = preg_replace('/^.*modules_v4.*$/m', '<b>$0</b>', $trace);

        try {
            Log::addErrorLog($trace);
        } catch (Throwable $exception) {
            // Must have been a problem with the database.  Nothing we can do here.
        }

        if ($request->getHeaderLine('X-Requested-With') !== '') {
            // If this was a GET request, then we were probably fetching HTML to display, for
            // example a chart or tab.
            if ($request->getMethod() === RequestMethodInterface::METHOD_GET) {
                $status_code = StatusCodeInterface::STATUS_OK;
            } else {
                $status_code = StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR;
            }

            return response(view('components/alert-danger', ['alert' => $trace]), $status_code);
        }

        try {
            // Try with a full header/menu
            return $this->viewResponse('errors/unhandled-exception', [
                'title'   => 'Error',
                'error'   => $trace,
                'request' => $request,
                'tree'    => $request->getAttribute('tree'),
            ], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
        } catch (Throwable $ex) {
            // Try with a minimal header/menu
            return $this->viewResponse('errors/unhandled-exception', [
                'title'   => 'Error',
                'error'   => $trace,
                'request' => $request,
                'tree'    => null,
            ], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
        }
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2019 webtrees development team
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			* You should have received a copy of the GNU General Public License
15			* along with this program. If not, see <http://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Http\Middleware;
21
22			use Fig\Http\Message\RequestMethodInterface;
23			use Fig\Http\Message\StatusCodeInterface;
24			use Fisharebest\Webtrees\Exceptions\HttpException;
25			use Fisharebest\Webtrees\Http\ViewResponseTrait;
26			use Fisharebest\Webtrees\Log;
27			use Fisharebest\Webtrees\Services\TreeService;
28			use Fisharebest\Webtrees\Site;
29			use League\Flysystem\NotSupportedException;
30			use Psr\Http\Message\ResponseInterface;
31			use Psr\Http\Message\ServerRequestInterface;
32			use Psr\Http\Server\MiddlewareInterface;
33			use Psr\Http\Server\RequestHandlerInterface;
34			use Throwable;
35
36			use function app;
37			use function dirname;
38			use function error_get_last;
39			use function ini_get;
40			use function ob_end_clean;
41			use function ob_get_level;
42			use function register_shutdown_function;
43			use function response;
44			use function str_replace;
45			use function strpos;
46			use function view;
47
48			use const E_ERROR;
49			use const PHP_EOL;
50
51			/**
52			* Middleware to handle and render errors.
53			*/
54			class HandleExceptions implements MiddlewareInterface, StatusCodeInterface
55			{
56			use ViewResponseTrait;
57
58			/** @var TreeService */
59			private $tree_service;
60
61			/**
62			* HandleExceptions constructor.
63			*
64			* @param TreeService $tree_service
65			*/
66			public function __construct(TreeService $tree_service)
67			{
68			$this->tree_service = $tree_service;
69			}
70
71			/**
72			* @param ServerRequestInterface $request
73			* @param RequestHandlerInterface $handler
74			*
75			* @return ResponseInterface
76			* @throws Throwable
77			*/
78			public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
79			{
80			// Fatal errors. We may be out of memory, so do not create any variables.
81			register_shutdown_function(static function () {
82			if (error_get_last()['type'] & E_ERROR) {
83			// If PHP does not display the error, then we must display it.
84			if (ini_get('display_errors') !== '1') {
85			echo error_get_last()['message'], '<br><br>', error_get_last()['file'] , ': ', error_get_last()['line'];
86			}
87			// Not our fault?
88			if (strpos(error_get_last()['file'], '/modules_v4/') !== false) {
89			echo '<br><br>This is an error in a webtrees module. Upgrade it or disable it.';
90			}
91			}
92			});
93
94			try {
95			return $handler->handle($request);
96			} catch (HttpException $exception) {
97			// The router added the tree attribute to the request, and we need it for the error response.
98			$request = app(ServerRequestInterface::class) ?? $request;
99
100			return $this->httpExceptionResponse($request, $exception);
101			} catch (NotSupportedException $exception) {
102			// The router added the tree attribute to the request, and we need it for the error response.
103			$request = app(ServerRequestInterface::class) ?? $request;
104
105			return $this->thirdPartyExceptionResponse($request, $exception);
106			} catch (Throwable $exception) {
107			// Exception thrown while buffering output?
108			while (ob_get_level() > 0) {
109			ob_end_clean();
110			}
111
112			// The Router middleware may have added a tree attribute to the request.
113			// This might be usable in the error page.
114			if (app()->has(ServerRequestInterface::class)) {
115			$request = app(ServerRequestInterface::class) ?? $request;
116			}
117
118			// Show the exception in a standard webtrees page (if we can).
119			try {
120			return $this->unhandledExceptionResponse($request, $exception);
121			} catch (Throwable $e) {
122			// That didn't work. Try something else.
123			}
124
125			// Show the exception in a tree-less webtrees page (if we can).
126			try {
127			$request = $request->withAttribute('tree', null);
128
129			return $this->unhandledExceptionResponse($request, $exception);
130			} catch (Throwable $e) {
131			// That didn't work. Try something else.
132			}
133
134			// Show the exception in an error page (if we can).
135			try {
136			$this->layout = 'layouts/error';
137
138			return $this->unhandledExceptionResponse($request, $exception);
139			} catch (Throwable $e) {
140			// That didn't work. Try something else.
141			}
142
143			// Show a stack dump.
144			return response((string) $exception, StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
145			}
146			}
147
148			/**
149			* @param ServerRequestInterface $request
150			* @param HttpException $exception
151			*
152			* @return ResponseInterface
153			*/
154			private function httpExceptionResponse(ServerRequestInterface $request, HttpException $exception): ResponseInterface
155			{
156			$tree = $request->getAttribute('tree');
157
158			$default = Site::getPreference('DEFAULT_GEDCOM');
159			$tree = $tree ?? $this->tree_service->all()[$default] ?? $this->tree_service->all()->first();
160
161			$status_code = $exception->getCode();
162
163			// If this was a GET request, then we were probably fetching HTML to display, for
164			// example a chart or tab.
165			if (
166			$request->getHeaderLine('X-Requested-With') !== '' &&
167			$request->getMethod() === RequestMethodInterface::METHOD_GET
168			) {
169			$this->layout = 'layouts/ajax';
170			$status_code = StatusCodeInterface::STATUS_OK;
171			}
172
173			return $this->viewResponse('components/alert-danger', [
174			'alert' => $exception->getMessage(),
175			'title' => $exception->getMessage(),
176			'tree' => $tree,
177			], $status_code);
178			}
179
180			/**
181			* @param ServerRequestInterface $request
182			* @param Throwable $exception
183			*
184			* @return ResponseInterface
185			*/
186			private function thirdPartyExceptionResponse(ServerRequestInterface $request, Throwable $exception): ResponseInterface
187			{
188			$tree = $request->getAttribute('tree');
189
190			$default = Site::getPreference('DEFAULT_GEDCOM');
191			$tree = $tree ?? $this->tree_service->all()[$default] ?? $this->tree_service->all()->first();
192
193			if ($request->getHeaderLine('X-Requested-With') !== '') {
194			$this->layout = 'layouts/ajax';
195			}
196
197			return $this->viewResponse('components/alert-danger', [
198			'alert' => $exception->getMessage(),
199			'title' => $exception->getMessage(),
200			'tree' => $tree,
201			], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
202			}
203
204			/**
205			* @param ServerRequestInterface $request
206			* @param Throwable $exception
207			*
208			* @return ResponseInterface
209			*/
210			private function unhandledExceptionResponse(ServerRequestInterface $request, Throwable $exception): ResponseInterface
211			{
212			$this->layout = 'layouts/default';
213
214			// Create a stack dump for the exception
215			$base_path = dirname(__DIR__, 3);
216			$trace = $exception->getMessage() . ' ' . $exception->getFile() . ':' . $exception->getLine() . PHP_EOL . $exception->getTraceAsString();
217			$trace = str_replace($base_path, '…', $trace);
218			// User data may contain non UTF-8 characters.
219			$trace = mb_convert_encoding($trace, 'UTF-8', 'UTF-8');
220			$trace = e($trace);
221			$trace = preg_replace('/^.modules_v4.$/m', '<b>$0</b>', $trace);
222
223			try {
224			Log::addErrorLog($trace);
225			} catch (Throwable $exception) {
226			// Must have been a problem with the database. Nothing we can do here.
227			}
228
229			if ($request->getHeaderLine('X-Requested-With') !== '') {
230			// If this was a GET request, then we were probably fetching HTML to display, for
231			// example a chart or tab.
232			if ($request->getMethod() === RequestMethodInterface::METHOD_GET) {
233			$status_code = StatusCodeInterface::STATUS_OK;
234			} else {
235			$status_code = StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR;
236			}
237
238			return response(view('components/alert-danger', ['alert' => $trace]), $status_code);
239			}
240
241			try {
242			// Try with a full header/menu
243			return $this->viewResponse('errors/unhandled-exception', [
244			'title' => 'Error',
245			'error' => $trace,
246			'request' => $request,
247			'tree' => $request->getAttribute('tree'),
248			], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
249			} catch (Throwable $ex) {
250			// Try with a minimal header/menu
251			return $this->viewResponse('errors/unhandled-exception', [
252			'title' => 'Error',
253			'error' => $trace,
254			'request' => $request,
255			'tree' => null,
256			], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
257			}
258			}
259			}
260

fisharebest / webtrees

Push — master ( dadc6d...837498 )

HandleExceptions::process() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like