ErrorController::handleDefaultError() - Code Metrics - Inspection of "[BUGFIX] Streamline frontend 5xx error handling" - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d94b1b...759e8d )

unknown

created 2021-01-06 11:48 UTC

ErrorController::handleDefaultError() A

↳ Parent: ErrorController

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	2
nop	3
dl	0
loc	10
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

namespace TYPO3\CMS\Frontend\Controller;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Controller\ErrorPageController;
use TYPO3\CMS\Core\Error\Http\InternalServerErrorException;
use TYPO3\CMS\Core\Error\Http\PageNotFoundException;
use TYPO3\CMS\Core\Error\Http\ServiceUnavailableException;
use TYPO3\CMS\Core\Error\PageErrorHandler\PageErrorHandlerInterface;
use TYPO3\CMS\Core\Error\PageErrorHandler\PageErrorHandlerNotConfiguredException;
use TYPO3\CMS\Core\Http\HtmlResponse;
use TYPO3\CMS\Core\Http\JsonResponse;
use TYPO3\CMS\Core\Site\Entity\Site;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Handles error requests,
 * returns a response object.
 */
class ErrorController
{
    /**
     * Used for creating a 500 response ("Internal Server Error"), usually due some misconfiguration
     * but if configured, a RedirectResponse could be returned as well.
     *
     * @param ServerRequestInterface $request
     * @param string $message
     * @param array $reasons
     * @return ResponseInterface
     * @throws InternalServerErrorException
     */
    public function internalErrorAction(ServerRequestInterface $request, string $message, array $reasons = []): ResponseInterface
    {
        if (!$this->isPageUnavailableHandlerConfigured()) {
            throw new InternalServerErrorException($message, 1607585445);
        }
        $errorHandler = $this->getErrorHandlerFromSite($request, 500);
        if ($errorHandler instanceof PageErrorHandlerInterface) {
            return $errorHandler->handlePageError($request, $message, $reasons);
        }
        return $this->handleDefaultError($request, 500, $message ?: 'Internal Server Error');
    }

    /**
     * Used for creating a 503 response ("Service Unavailable"), to be used for maintenance mode
     * or when the server is overloaded, a RedirectResponse could be returned as well.
     *
     * @param ServerRequestInterface $request
     * @param string $message
     * @param array $reasons
     * @return ResponseInterface
     * @throws ServiceUnavailableException
     */
    public function unavailableAction(ServerRequestInterface $request, string $message, array $reasons = []): ResponseInterface
    {
        if (!$this->isPageUnavailableHandlerConfigured()) {
            throw new ServiceUnavailableException($message, 1518472181);
        }
        $errorHandler = $this->getErrorHandlerFromSite($request, 503);
        if ($errorHandler instanceof PageErrorHandlerInterface) {
            return $errorHandler->handlePageError($request, $message, $reasons);
        }
        return $this->handleDefaultError($request, 503, $message ?: 'Service Unavailable');
    }

    /**
     * Used for creating a 404 response ("Page Not Found"),
     * but if configured, a RedirectResponse could be returned as well.
     *
     * @param ServerRequestInterface $request
     * @param string $message
     * @param array $reasons
     * @return ResponseInterface
     * @throws PageNotFoundException
     */
    public function pageNotFoundAction(ServerRequestInterface $request, string $message, array $reasons = []): ResponseInterface
    {
        $errorHandler = $this->getErrorHandlerFromSite($request, 404);
        if ($errorHandler instanceof PageErrorHandlerInterface) {
            return $errorHandler->handlePageError($request, $message, $reasons);
        }
        try {
            return $this->handleDefaultError($request, 404, $message);
        } catch (\RuntimeException $e) {
            throw new PageNotFoundException($message, 1518472189);
        }
    }

    /**
     * Used for creating a 403 response ("Access denied"),
     * but if configured, a RedirectResponse could be returned as well.
     *
     * @param ServerRequestInterface $request
     * @param string $message
     * @param array $reasons
     * @return ResponseInterface
     * @throws PageNotFoundException
     */
    public function accessDeniedAction(ServerRequestInterface $request, string $message, array $reasons = []): ResponseInterface
    {
        $errorHandler = $this->getErrorHandlerFromSite($request, 403);
        if ($errorHandler instanceof PageErrorHandlerInterface) {
            return $errorHandler->handlePageError($request, $message, $reasons);
        }
        try {
            return $this->handleDefaultError($request, 403, $message);
        } catch (\RuntimeException $e) {
            throw new PageNotFoundException($message, 1518472195);
        }
    }

    /**
     * Checks whether the devIPMask matches the current visitor's IP address.
     * Note: the name of this method is a misnomer (legacy code),
     *
     * @return bool True if the server error handler should be used.
     */
    protected function isPageUnavailableHandlerConfigured(): bool
    {
        return !GeneralUtility::cmpIP(GeneralUtility::getIndpEnv('REMOTE_ADDR'), $GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']);
    }

    /**
     * Checks if a site is configured, and an error handler is configured for this specific status code.
     *
     * @param ServerRequestInterface $request
     * @param int $statusCode
     * @return PageErrorHandlerInterface|null
     */
    protected function getErrorHandlerFromSite(ServerRequestInterface $request, int $statusCode): ?PageErrorHandlerInterface
    {
        $site = $request->getAttribute('site');
        if ($site instanceof Site) {
            try {
                return $site->getErrorHandler($statusCode);
            } catch (PageErrorHandlerNotConfiguredException $e) {
                // No error handler found, so fallback back to the generic TYPO3 error handler.
            }
        }
        return null;
    }

    /**
     * Ensures that a response object is created as a "fallback" when no error handler is configured.
     *
     * @param ServerRequestInterface $request
     * @param int $statusCode
     * @param string $reason
     * @return ResponseInterface
     */
    protected function handleDefaultError(ServerRequestInterface $request, int $statusCode, string $reason = ''): ResponseInterface
    {
        if (strpos($request->getHeaderLine('Accept'), 'application/json') !== false) {
            return new JsonResponse(['reason' => $reason], $statusCode);
        }
        $content = GeneralUtility::makeInstance(ErrorPageController::class)->errorAction(
            'Page Not Found',
            'The page did not exist or was inaccessible.' . ($reason ? ' Reason: ' . $reason : '')
        );
        return new HtmlResponse($content, $statusCode);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the TYPO3 CMS project.
7			*
8			* It is free software; you can redistribute it and/or modify it under
9			* the terms of the GNU General Public License, either version 2
10			* of the License, or any later version.
11			*
12			* For the full copyright and license information, please read the
13			* LICENSE.txt file that was distributed with this source code.
14			*
15			* The TYPO3 project - inspiring people to share!
16			*/
17
18			namespace TYPO3\CMS\Frontend\Controller;
19
20			use Psr\Http\Message\ResponseInterface;
21			use Psr\Http\Message\ServerRequestInterface;
22			use TYPO3\CMS\Core\Controller\ErrorPageController;
23			use TYPO3\CMS\Core\Error\Http\InternalServerErrorException;
24			use TYPO3\CMS\Core\Error\Http\PageNotFoundException;
25			use TYPO3\CMS\Core\Error\Http\ServiceUnavailableException;
26			use TYPO3\CMS\Core\Error\PageErrorHandler\PageErrorHandlerInterface;
27			use TYPO3\CMS\Core\Error\PageErrorHandler\PageErrorHandlerNotConfiguredException;
28			use TYPO3\CMS\Core\Http\HtmlResponse;
29			use TYPO3\CMS\Core\Http\JsonResponse;
30			use TYPO3\CMS\Core\Site\Entity\Site;
31			use TYPO3\CMS\Core\Utility\GeneralUtility;
32
33			/**
34			* Handles error requests,
35			* returns a response object.
36			*/
37			class ErrorController
38			{
39			/**
40			* Used for creating a 500 response ("Internal Server Error"), usually due some misconfiguration
41			* but if configured, a RedirectResponse could be returned as well.
42			*
43			* @param ServerRequestInterface $request
44			* @param string $message
45			* @param array $reasons
46			* @return ResponseInterface
47			* @throws InternalServerErrorException
48			*/
49			public function internalErrorAction(ServerRequestInterface $request, string $message, array $reasons = []): ResponseInterface
50			{
51			if (!$this->isPageUnavailableHandlerConfigured()) {
52			throw new InternalServerErrorException($message, 1607585445);
53			}
54			$errorHandler = $this->getErrorHandlerFromSite($request, 500);
55			if ($errorHandler instanceof PageErrorHandlerInterface) {
56			return $errorHandler->handlePageError($request, $message, $reasons);
57			}
58			return $this->handleDefaultError($request, 500, $message ?: 'Internal Server Error');
59			}
60
61			/**
62			* Used for creating a 503 response ("Service Unavailable"), to be used for maintenance mode
63			* or when the server is overloaded, a RedirectResponse could be returned as well.
64			*
65			* @param ServerRequestInterface $request
66			* @param string $message
67			* @param array $reasons
68			* @return ResponseInterface
69			* @throws ServiceUnavailableException
70			*/
71			public function unavailableAction(ServerRequestInterface $request, string $message, array $reasons = []): ResponseInterface
72			{
73			if (!$this->isPageUnavailableHandlerConfigured()) {
74			throw new ServiceUnavailableException($message, 1518472181);
75			}
76			$errorHandler = $this->getErrorHandlerFromSite($request, 503);
77			if ($errorHandler instanceof PageErrorHandlerInterface) {
78			return $errorHandler->handlePageError($request, $message, $reasons);
79			}
80			return $this->handleDefaultError($request, 503, $message ?: 'Service Unavailable');
81			}
82
83			/**
84			* Used for creating a 404 response ("Page Not Found"),
85			* but if configured, a RedirectResponse could be returned as well.
86			*
87			* @param ServerRequestInterface $request
88			* @param string $message
89			* @param array $reasons
90			* @return ResponseInterface
91			* @throws PageNotFoundException
92			*/
93			public function pageNotFoundAction(ServerRequestInterface $request, string $message, array $reasons = []): ResponseInterface
94			{
95			$errorHandler = $this->getErrorHandlerFromSite($request, 404);
96			if ($errorHandler instanceof PageErrorHandlerInterface) {
97			return $errorHandler->handlePageError($request, $message, $reasons);
98			}
99			try {
100			return $this->handleDefaultError($request, 404, $message);
101			} catch (\RuntimeException $e) {
102			throw new PageNotFoundException($message, 1518472189);
103			}
104			}
105
106			/**
107			* Used for creating a 403 response ("Access denied"),
108			* but if configured, a RedirectResponse could be returned as well.
109			*
110			* @param ServerRequestInterface $request
111			* @param string $message
112			* @param array $reasons
113			* @return ResponseInterface
114			* @throws PageNotFoundException
115			*/
116			public function accessDeniedAction(ServerRequestInterface $request, string $message, array $reasons = []): ResponseInterface
117			{
118			$errorHandler = $this->getErrorHandlerFromSite($request, 403);
119			if ($errorHandler instanceof PageErrorHandlerInterface) {
120			return $errorHandler->handlePageError($request, $message, $reasons);
121			}
122			try {
123			return $this->handleDefaultError($request, 403, $message);
124			} catch (\RuntimeException $e) {
125			throw new PageNotFoundException($message, 1518472195);
126			}
127			}
128
129			/**
130			* Checks whether the devIPMask matches the current visitor's IP address.
131			* Note: the name of this method is a misnomer (legacy code),
132			*
133			* @return bool True if the server error handler should be used.
134			*/
135			protected function isPageUnavailableHandlerConfigured(): bool
136			{
137			return !GeneralUtility::cmpIP(GeneralUtility::getIndpEnv('REMOTE_ADDR'), $GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']);
138			}
139
140			/**
141			* Checks if a site is configured, and an error handler is configured for this specific status code.
142			*
143			* @param ServerRequestInterface $request
144			* @param int $statusCode
145			* @return PageErrorHandlerInterface\|null
146			*/
147			protected function getErrorHandlerFromSite(ServerRequestInterface $request, int $statusCode): ?PageErrorHandlerInterface
148			{
149			$site = $request->getAttribute('site');
150			if ($site instanceof Site) {
151			try {
152			return $site->getErrorHandler($statusCode);
153			} catch (PageErrorHandlerNotConfiguredException $e) {
154			// No error handler found, so fallback back to the generic TYPO3 error handler.
155			}
156			}
157			return null;
158			}
159
160			/**
161			* Ensures that a response object is created as a "fallback" when no error handler is configured.
162			*
163			* @param ServerRequestInterface $request
164			* @param int $statusCode
165			* @param string $reason
166			* @return ResponseInterface
167			*/
168			protected function handleDefaultError(ServerRequestInterface $request, int $statusCode, string $reason = ''): ResponseInterface
169			{
170			if (strpos($request->getHeaderLine('Accept'), 'application/json') !== false) {
171			return new JsonResponse(['reason' => $reason], $statusCode);
172			}
173			$content = GeneralUtility::makeInstance(ErrorPageController::class)->errorAction(
174			'Page Not Found',
175			'The page did not exist or was inaccessible.' . ($reason ? ' Reason: ' . $reason : '')
176			);
177			return new HtmlResponse($content, $statusCode);
178			}
179			}
180

TYPO3 / TYPO3.CMS

Push — master ( d94b1b...759e8d )

ErrorController::handleDefaultError() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like