core/core.services.yml | 2 +- .../CustomPageExceptionHtmlSubscriber.php | 74 ++++-------------- .../DefaultExceptionHtmlSubscriber.php | 90 +++++++++------------- .../system/src/Controller/Http4xxController.php | 41 ++++++++++ .../src/Tests/Routing/ExceptionHandlingTest.php | 27 ++----- core/modules/system/system.routing.yml | 16 ++++ 6 files changed, 115 insertions(+), 135 deletions(-) diff --git a/core/core.services.yml b/core/core.services.yml index 7f9ed9b..18f4cd9 100644 --- a/core/core.services.yml +++ b/core/core.services.yml @@ -774,7 +774,7 @@ services: class: Drupal\Core\EventSubscriber\DefaultExceptionHtmlSubscriber tags: - { name: event_subscriber } - arguments: ['@html_fragment_renderer', '@html_page_renderer'] + arguments: ['@http_kernel'] exception.default: class: Drupal\Core\EventSubscriber\DefaultExceptionSubscriber tags: diff --git a/core/lib/Drupal/Core/EventSubscriber/CustomPageExceptionHtmlSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/CustomPageExceptionHtmlSubscriber.php index ae3d944..eb054a0 100644 --- a/core/lib/Drupal/Core/EventSubscriber/CustomPageExceptionHtmlSubscriber.php +++ b/core/lib/Drupal/Core/EventSubscriber/CustomPageExceptionHtmlSubscriber.php @@ -19,7 +19,7 @@ /** * Exception subscriber for handling core custom error pages. */ -class CustomPageExceptionHtmlSubscriber extends HttpExceptionSubscriberBase { +class CustomPageExceptionHtmlSubscriber extends DefaultExceptionHtmlSubscriber { /** * The configuration factory. @@ -36,13 +36,6 @@ class CustomPageExceptionHtmlSubscriber extends HttpExceptionSubscriberBase { protected $aliasManager; /** - * The HTTP kernel. - * - * @var \Symfony\Component\HttpKernel\HttpKernelInterface - */ - protected $httpKernel; - - /** * The logger instance. * * @var \Psr\Log\LoggerInterface @@ -62,9 +55,9 @@ class CustomPageExceptionHtmlSubscriber extends HttpExceptionSubscriberBase { * The logger service. */ public function __construct(ConfigFactoryInterface $config_factory, AliasManagerInterface $alias_manager, HttpKernelInterface $http_kernel, LoggerInterface $logger) { + parent::__construct($http_kernel); $this->configFactory = $config_factory; $this->aliasManager = $alias_manager; - $this->httpKernel = $http_kernel; $this->logger = $logger; } @@ -76,17 +69,7 @@ protected static function getPriority() { } /** - * {@inheritDoc} - */ - protected function getHandledFormats() { - return ['html']; - } - - /** - * Handles a 403 error for HTML. - * - * @param \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent $event - * The event to process. + * {@inheritdoc} */ public function on403(GetResponseForExceptionEvent $event) { $path = $this->aliasManager->getPathByAlias($this->configFactory->get('system.site')->get('page.403')); @@ -94,10 +77,7 @@ public function on403(GetResponseForExceptionEvent $event) { } /** - * Handles a 404 error for HTML. - * - * @param \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent $event - * The event to process. + * {@inheritdoc} */ public function on404(GetResponseForExceptionEvent $event) { $path = $this->aliasManager->getPathByAlias($this->configFactory->get('system.site')->get('page.404')); @@ -105,44 +85,18 @@ public function on404(GetResponseForExceptionEvent $event) { } /** - * Makes a subrequest to retrieve a custom error page. - * - * @param \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent $event - * The event to process - * @param string $path - * The path to which to make a subrequest for this error message. - * @param int $status_code - * The status code for the error being handled. + * {@inheritdoc} */ protected function makeSubrequest(GetResponseForExceptionEvent $event, $path, $status_code) { - $request = $event->getRequest(); - - // @todo Remove dependency on the internal _system_path attribute: - // https://www.drupal.org/node/2293523. - $system_path = $request->attributes->get('_system_path'); - - if ($path && $path != $system_path) { - // @todo The create() method expects a slash-prefixed path, but we store a - // normal system path in the site_404 variable. - if ($request->getMethod() === 'POST') { - $sub_request = Request::create($request->getBaseUrl() . '/' . $path, 'POST', ['destination' => $system_path, '_exception_statuscode' => $status_code] + $request->request->all(), $request->cookies->all(), [], $request->server->all()); - } - else { - $sub_request = Request::create($request->getBaseUrl() . '/' . $path, 'GET', $request->query->all() + ['destination' => $system_path, '_exception_statuscode' => $status_code], $request->cookies->all(), [], $request->server->all()); - } - - try { - $response = $this->httpKernel->handle($sub_request, HttpKernelInterface::SUB_REQUEST); - $response->setStatusCode($status_code); - $event->setResponse($response); - } - catch (\Exception $e) { - // If an error happened in the subrequest we can't do much else. - // Instead, just log it. The DefaultExceptionHandler will catch the - // original exception and handle it normally. - $error = Error::decodeException($e); - $this->logger->log($error['severity_level'], '%type: !message in %function (line %line of %file).', $error); - } + try { + parent::makeSubrequest($event, $path, $status_code); + } + catch (\Exception $e) { + // If an error happened in the subrequest we can't do much else. Instead, + // just log it. The DefaultExceptionSubscriber will catch the original + // exception and handle it normally. + $error = Error::decodeException($e); + $this->logger->log($error['severity_level'], '%type: !message in %function (line %line of %file).', $error); } } diff --git a/core/lib/Drupal/Core/EventSubscriber/DefaultExceptionHtmlSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/DefaultExceptionHtmlSubscriber.php index 0df6a30..cef8eb4 100644 --- a/core/lib/Drupal/Core/EventSubscriber/DefaultExceptionHtmlSubscriber.php +++ b/core/lib/Drupal/Core/EventSubscriber/DefaultExceptionHtmlSubscriber.php @@ -7,44 +7,31 @@ namespace Drupal\Core\EventSubscriber; -use Drupal\Core\Page\HtmlFragment; -use Drupal\Core\Page\HtmlFragmentRendererInterface; -use Drupal\Core\Page\HtmlPageRendererInterface; -use Drupal\Core\StringTranslation\StringTranslationTrait; +use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent; +use Symfony\Component\HttpKernel\HttpKernelInterface; /** - * Handle most HTTP errors for HTML. + * Exception subscriber for handling core default error pages. */ class DefaultExceptionHtmlSubscriber extends HttpExceptionSubscriberBase { - use StringTranslationTrait; /** - * The HTML fragment renderer. + * The HTTP kernel. * - * @var \Drupal\Core\Page\HtmlFragmentRendererInterface + * @var \Symfony\Component\HttpKernel\HttpKernelInterface */ - protected $fragmentRenderer; - - /** - * The HTML page renderer. - * - * @var \Drupal\Core\Page\HtmlPageRendererInterface - */ - protected $htmlPageRenderer; + protected $httpKernel; /** * Constructs a new DefaultExceptionHtmlSubscriber. * - * @param \Drupal\Core\Page\HtmlFragmentRendererInterface $fragment_renderer - * The fragment renderer. - * @param \Drupal\Core\Page\HtmlPageRendererInterface $page_renderer - * The page renderer. + * @param \Symfony\Component\HttpKernel\HttpKernelInterface $http_kernel + * The HTTP kernel. */ - public function __construct(HtmlFragmentRendererInterface $fragment_renderer, HtmlPageRendererInterface $page_renderer) { - $this->fragmentRenderer = $fragment_renderer; - $this->htmlPageRenderer = $page_renderer; + public function __construct(HttpKernelInterface $http_kernel) { + $this->httpKernel = $http_kernel; } /** @@ -70,9 +57,7 @@ protected function getHandledFormats() { * The event to process. */ public function on403(GetResponseForExceptionEvent $event) { - $response = $this->createResponse($this->t('Access denied'), $this->t('You are not authorized to access this page.'), Response::HTTP_FORBIDDEN); - $response->headers->set('Content-type', 'text/html'); - $event->setResponse($response); + $this->makeSubrequest($event, 'system/403', Response::HTTP_FORBIDDEN); } /** @@ -82,40 +67,41 @@ public function on403(GetResponseForExceptionEvent $event) { * The event to process. */ public function on404(GetResponseForExceptionEvent $event) { - $path = $event->getRequest()->getPathInfo(); - $response = $this->createResponse($this->t('Page not found'), $this->t('The requested page "@path" could not be found.', ['@path' => $path]), Response::HTTP_NOT_FOUND); - $response->headers->set('Content-type', 'text/html'); - $event->setResponse($response); + $this->makeSubrequest($event, 'system/404', Response::HTTP_NOT_FOUND); } /** - * Handles a 405 error for HTML. + * Makes a subrequest to retrieve the default error page. * * @param \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent $event - * The event to process. + * The event to process + * @param string $path + * The path to which to make a subrequest for this error message. + * @param int $status_code + * The status code for the error being handled. */ - public function on405(GetResponseForExceptionEvent $event) { - $response = new Response('Method Not Allowed', Response::HTTP_METHOD_NOT_ALLOWED); - $response->headers->set('Content-type', 'text/html'); - $event->setResponse($response); - } + protected function makeSubrequest(GetResponseForExceptionEvent $event, $path, $status_code) { + $request = $event->getRequest(); - /** - * @param $title - * The page title of the response. - * @param $body - * The body of the error page. - * @param $response_code - * The HTTP response code of the response. - * @return Response - * An error Response object ready to return to the browser. - */ - protected function createResponse($title, $body, $response_code) { - $fragment = new HtmlFragment($body); - $fragment->setTitle($title); + // @todo Remove dependency on the internal _system_path attribute: + // https://www.drupal.org/node/2293523. + $system_path = $request->attributes->get('_system_path'); + + if ($path && $path != $system_path) { + if ($request->getMethod() === 'POST') { + $sub_request = Request::create($request->getBaseUrl() . '/' . $path, 'POST', ['destination' => $system_path, '_exception_statuscode' => $status_code] + $request->request->all(), $request->cookies->all(), [], $request->server->all()); + } + else { + $sub_request = Request::create($request->getBaseUrl() . '/' . $path, 'GET', $request->query->all() + ['destination' => $system_path, '_exception_statuscode' => $status_code], $request->cookies->all(), [], $request->server->all()); + } + + // Persist the 'exception' attribute to the subrequest. + $sub_request->attributes->set('exception', $request->attributes->get('exception')); - $page = $this->fragmentRenderer->render($fragment, $response_code); - return new Response($this->htmlPageRenderer->render($page), $page->getStatusCode()); + $response = $this->httpKernel->handle($sub_request, HttpKernelInterface::SUB_REQUEST); + $response->setStatusCode($status_code); + $event->setResponse($response); + } } } diff --git a/core/modules/system/src/Controller/Http4xxController.php b/core/modules/system/src/Controller/Http4xxController.php new file mode 100644 index 0000000..7add79e --- /dev/null +++ b/core/modules/system/src/Controller/Http4xxController.php @@ -0,0 +1,41 @@ + $this->t('You are not authorized to access this page.'), + ]; + } + + /** + * The default 404 content. + * + * @return array + * A render array containing the message to display for 404 pages. + */ + public function on404() { + return [ + '#markup' => $this->t('The requested page could not be found.'), + ]; + } + +} diff --git a/core/modules/system/src/Tests/Routing/ExceptionHandlingTest.php b/core/modules/system/src/Tests/Routing/ExceptionHandlingTest.php index b6ed513..0d925b7 100644 --- a/core/modules/system/src/Tests/Routing/ExceptionHandlingTest.php +++ b/core/modules/system/src/Tests/Routing/ExceptionHandlingTest.php @@ -77,14 +77,14 @@ public function testHtml403() { /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */ $kernel = \Drupal::getContainer()->get('http_kernel'); - $response = $kernel->handle($request); + $response = $kernel->handle($request)->prepare($request); $this->assertEqual($response->getStatusCode(), Response::HTTP_FORBIDDEN); - $this->assertEqual($response->headers->get('Content-type'), 'text/html'); + $this->assertEqual($response->headers->get('Content-type'), 'text/html; charset=UTF-8'); } /** - * Tests the exception handling for HTML and 403 status code. + * Tests the exception handling for HTML and 404 status code. */ public function testHtml404() { $request = Request::create('/not-found'); @@ -93,27 +93,10 @@ public function testHtml404() { /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */ $kernel = \Drupal::getContainer()->get('http_kernel'); - $response = $kernel->handle($request); + $response = $kernel->handle($request)->prepare($request); $this->assertEqual($response->getStatusCode(), Response::HTTP_NOT_FOUND); - $this->assertEqual($response->headers->get('Content-type'), 'text/html'); - } - - /** - * Tests the exception handling for HTML and 405 status code. - */ - public function testHtml405() { - $request = Request::create('/admin', 'NOT_EXISTING'); - $request->headers->set('Accept', 'text/html'); - $request->setFormat('html', ['text/html']); - - /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */ - $kernel = \Drupal::getContainer()->get('http_kernel'); - $response = $kernel->handle($request); - - $this->assertEqual($response->getStatusCode(), Response::HTTP_METHOD_NOT_ALLOWED); - $this->assertEqual($response->headers->get('Content-type'), 'text/html'); - $this->assertEqual($response->getContent(), 'Method Not Allowed'); + $this->assertEqual($response->headers->get('Content-type'), 'text/html; charset=UTF-8'); } } diff --git a/core/modules/system/system.routing.yml b/core/modules/system/system.routing.yml index b285bcf..4d54d00 100644 --- a/core/modules/system/system.routing.yml +++ b/core/modules/system/system.routing.yml @@ -7,6 +7,22 @@ system.ajax: requirements: _access: 'TRUE' +system.403: + path: '/system/403' + defaults: + _content: '\Drupal\system\Controller\Http4xxController:on403' + _title: 'Access denied' + requirements: + _access: 'TRUE' + +system.404: + path: '/system/404' + defaults: + _content: '\Drupal\system\Controller\Http4xxController:on404' + _title: 'Page not found' + requirements: + _access: 'TRUE' + system.admin: path: '/admin' defaults: