HandleExceptions::process() - Code Metrics - Inspection of "Missing list of moderators/managers in control pan..." - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6d5769...1ab2f3 )

by Greg

created 2019-11-02 09:57 UTC

HandleExceptions::process() B

↳ Parent: HandleExceptions

Complexity

Conditions	9
Paths	50

Size

Total Lines	54
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	9
eloc	25
c	2
b	0
f	0
nc	50
nop	2
dl	0
loc	54
rs	8.0555

How to fix Long Method

<?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\Localization\Locale\LocaleEnUs;
use Fisharebest\Webtrees\Http\ViewResponseTrait;
use Fisharebest\Webtrees\Log;
use Fisharebest\Webtrees\Services\TreeService;
use Fisharebest\Webtrees\Site;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Throwable;

use function app;
use function dirname;
use function ob_end_clean;
use function ob_get_level;
use function response;
use function str_replace;
use function view;

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
    {
        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 (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;
            }

            // No locale set in the request?
            if ($request->getAttribute('locale') === null) {
                $request = $request->withAttribute('locale', new LocaleEnUs());
                app()->instance(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();

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

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

    /**
     * @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);
        $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);
        }

        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\Localization\Locale\LocaleEnUs;
25			use Fisharebest\Webtrees\Http\ViewResponseTrait;
26			use Fisharebest\Webtrees\Log;
27			use Fisharebest\Webtrees\Services\TreeService;
28			use Fisharebest\Webtrees\Site;
29			use Psr\Http\Message\ResponseInterface;
30			use Psr\Http\Message\ServerRequestInterface;
31			use Psr\Http\Server\MiddlewareInterface;
32			use Psr\Http\Server\RequestHandlerInterface;
33			use Symfony\Component\HttpKernel\Exception\HttpException;
34			use Throwable;
35
36			use function app;
37			use function dirname;
38			use function ob_end_clean;
39			use function ob_get_level;
40			use function response;
41			use function str_replace;
42			use function view;
43
44			use const PHP_EOL;
45
46			/**
47			* Middleware to handle and render errors.
48			*/
49			class HandleExceptions implements MiddlewareInterface, StatusCodeInterface
50			{
51			use ViewResponseTrait;
52
53			/** @var TreeService */
54			private $tree_service;
55
56			/**
57			* HandleExceptions constructor.
58			*
59			* @param TreeService $tree_service
60			*/
61			public function __construct(TreeService $tree_service)
62			{
63			$this->tree_service = $tree_service;
64			}
65
66			/**
67			* @param ServerRequestInterface $request
68			* @param RequestHandlerInterface $handler
69			*
70			* @return ResponseInterface
71			* @throws Throwable
72			*/
73			public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
74			{
75			try {
76			return $handler->handle($request);
77			} catch (HttpException $exception) {
78			// The router added the tree attribute to the request, and we need it for the error response.
79			$request = app(ServerRequestInterface::class) ?? $request;
80
81			return $this->httpExceptionResponse($request, $exception);
82			} catch (Throwable $exception) {
83			// Exception thrown while buffering output?
84			while (ob_get_level() > 0) {
85			ob_end_clean();
86			}
87
88			// The Router middleware may have added a tree attribute to the request.
89			// This might be usable in the error page.
90			if (app()->has(ServerRequestInterface::class)) {
91			$request = app(ServerRequestInterface::class) ?? $request;
92			}
93
94			// No locale set in the request?
95			if ($request->getAttribute('locale') === null) {
96			$request = $request->withAttribute('locale', new LocaleEnUs());
97			app()->instance(ServerRequestInterface::class, $request);
98			}
99
100			// Show the exception in a standard webtrees page (if we can).
101			try {
102			return $this->unhandledExceptionResponse($request, $exception);
103			} catch (Throwable $e) {
104			// That didn't work. Try something else.
105			}
106
107			// Show the exception in a tree-less webtrees page (if we can).
108			try {
109			$request = $request->withAttribute('tree', null);
110
111			return $this->unhandledExceptionResponse($request, $exception);
112			} catch (Throwable $e) {
113			// That didn't work. Try something else.
114			}
115
116			// Show the exception in an error page (if we can).
117			try {
118			$this->layout = 'layouts/error';
119
120			return $this->unhandledExceptionResponse($request, $exception);
121			} catch (Throwable $e) {
122			// That didn't work. Try something else.
123			}
124
125			// Show a stack dump.
126			return response((string) $exception, StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
127			}
128			}
129
130			/**
131			* @param ServerRequestInterface $request
132			* @param HttpException $exception
133			*
134			* @return ResponseInterface
135			*/
136			private function httpExceptionResponse(ServerRequestInterface $request, HttpException $exception): ResponseInterface
137			{
138			$tree = $request->getAttribute('tree');
139
140			$default = Site::getPreference('DEFAULT_GEDCOM');
141			$tree = $tree ?? $this->tree_service->all()[$default] ?? $this->tree_service->all()->first();
142
143			if ($request->getHeaderLine('X-Requested-With') !== '') {
144			$this->layout = 'layouts/ajax';
145			}
146
147			return $this->viewResponse('components/alert-danger', [
148			'alert' => $exception->getMessage(),
149			'title' => $exception->getMessage(),
150			'tree' => $tree,
151			], $exception->getStatusCode());
152			}
153
154			/**
155			* @param ServerRequestInterface $request
156			* @param Throwable $exception
157			*
158			* @return ResponseInterface
159			*/
160			private function unhandledExceptionResponse(ServerRequestInterface $request, Throwable $exception): ResponseInterface
161			{
162			$this->layout = 'layouts/default';
163
164			// Create a stack dump for the exception
165			$base_path = dirname(__DIR__, 3);
166			$trace = $exception->getMessage() . ' ' . $exception->getFile() . ':' . $exception->getLine() . PHP_EOL . $exception->getTraceAsString();
167			$trace = str_replace($base_path, '…', $trace);
168			$trace = e($trace);
169			$trace = preg_replace('/^.modules_v4.$/m', '<b>$0</b>', $trace);
170
171			try {
172			Log::addErrorLog($trace);
173			} catch (Throwable $exception) {
174			// Must have been a problem with the database. Nothing we can do here.
175			}
176
177			if ($request->getHeaderLine('X-Requested-With') !== '') {
178			// If this was a GET request, then we were probably fetching HTML to display, for
179			// example a chart or tab.
180			if ($request->getMethod() === RequestMethodInterface::METHOD_GET) {
181			$status_code = StatusCodeInterface::STATUS_OK;
182			} else {
183			$status_code = StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR;
184			}
185
186			return response(view('components/alert-danger', ['alert' => $trace]), $status_code);
187			}
188
189			return $this->viewResponse('errors/unhandled-exception', [
190			'title' => 'Error',
191			'error' => $trace,
192			'request' => $request,
193			'tree' => null,
194			], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
195			}
196			}
197

fisharebest / webtrees

Push — master ( 6d5769...1ab2f3 )

HandleExceptions::process() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like