Render the Contao login page even if the current route is not a Contao page

core-bundle/src/EventListener/PrettyErrorScreenListener.php

@@ -22,6 +22,7 @@
 use Contao\PageModel;
 use Contao\StringUtil;
 use Symfony\Component\HttpFoundation\AcceptHeader;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
@@ -30,6 +31,7 @@
 use Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException;
 use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationCredentialsNotFoundException;
 use Symfony\Component\Security\Core\Security;
 use Twig\Environment;
@@ -46,15 +48,17 @@ class PrettyErrorScreenListener
     private Security $security;
     private PageRegistry $pageRegistry;
     private HttpKernelInterface $httpKernel;
+    private RequestMatcherInterface $requestMatcher;
 
-    public function __construct(bool $prettyErrorScreens, Environment $twig, ContaoFramework $framework, Security $security, PageRegistry $pageRegistry, HttpKernelInterface $httpKernel)
+    public function __construct(bool $prettyErrorScreens, Environment $twig, ContaoFramework $framework, Security $security, PageRegistry $pageRegistry, HttpKernelInterface $httpKernel, RequestMatcherInterface $requestMatcher)
     {
         $this->prettyErrorScreens = $prettyErrorScreens;
         $this->twig = $twig;
         $this->framework = $framework;
         $this->security = $security;
         $this->pageRegistry = $pageRegistry;
         $this->httpKernel = $httpKernel;
+        $this->requestMatcher = $requestMatcher;
     }
 
     /**
@@ -146,14 +150,7 @@ private function renderErrorScreenByType(int $type, ExceptionEvent $event): void
             $this->framework->initialize(true);
 
             $request = $event->getRequest();
-            $pageModel = $request->attributes->get('pageModel');
-
-            if (!$pageModel instanceof PageModel) {
-                return;
-            }
-
-            $pageAdapter = $this->framework->getAdapter(PageModel::class);
-            $errorPage = $pageAdapter->findFirstPublishedByTypeAndPid('error_'.$type, $pageModel->loadDetails()->rootId);
+            $errorPage = $this->findErrorPage($type, $request);
 
             if (null === $errorPage) {
                 return;
@@ -250,4 +247,25 @@ private function getStatusCodeForException(\Throwable $exception): int
 
         return 500;
     }
+
+    private function findErrorPage(int $type, Request $request): PageModel|null
+    {
+        $pageModel = $request->attributes->get('pageModel');
+
+        if (!$pageModel instanceof PageModel) {
+            $rootRequest = Request::create('http://'.$request->getHost());
+            $rootRequest->headers->set('Accept-Language', $rootRequest->headers->get('Accept-Language'));
+            $parameters = $this->requestMatcher->matchRequest($request);
+
+            if (($parameters['pageModel'] ?? null) instanceof PageModel) {
+                $pageModel = $parameters['pageModel'];
+            } else {
+                return null;
+            }
+        }
+
+        $pageAdapter = $this->framework->getAdapter(PageModel::class);
+
+        return $pageAdapter->findFirstPublishedByTypeAndPid('error_'.$type, $pageModel->loadDetails()->rootId);
+    }
 }

core-bundle/src/Resources/config/listener.yml

@@ -389,6 +389,7 @@ services:
             - '@security.helper'
             - '@contao.routing.page_registry'
             - '@http_kernel'
+            - '@router'
         tags:
             # The priority must be higher than the one of the Twig exception listener (defaults to -128)
             - { name: kernel.event_listener, priority: -96 }

core-bundle/tests/EventListener/PrettyErrorScreenListenerTest.php

@@ -22,6 +22,7 @@
 use Contao\CoreBundle\Exception\PageNotFoundException;
 use Contao\CoreBundle\Exception\ResponseException;
 use Contao\CoreBundle\Exception\ServiceUnavailableException;
+use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\CoreBundle\Routing\Page\PageRegistry;
 use Contao\CoreBundle\Routing\Page\PageRoute;
 use Contao\CoreBundle\Tests\TestCase;
@@ -37,6 +38,7 @@
 use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
+use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationCredentialsNotFoundException;
 use Symfony\Component\Security\Core\Security;
 use Twig\Environment;
@@ -49,7 +51,7 @@
         $exception = new InternalServerErrorHttpException('', new InternalServerErrorException());
         $event = $this->getResponseEvent($exception);
 
-        $listener = $this->getListener(true, true);
+        $listener = $this->getListener(true);
         $listener($event);
 
         $this->assertTrue($event->hasResponse());
@@ -62,6 +64,7 @@
         $framework = $this->mockContaoFramework();
         $pageRegistry = $this->createMock(PageRegistry::class);
         $httpKernel = $this->createMock(HttpKernelInterface::class);
+        $requestMatcher = $this->createMock(RequestMatcherInterface::class);
 
         $security = $this->createMock(Security::class);
         $security
@@ -73,7 +76,7 @@
         $exception = new InternalServerErrorHttpException('', new InternalServerErrorException());
         $event = $this->getResponseEvent($exception);
 
-        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel);
+        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel, $requestMatcher);
         $listener($event);
 
         $this->assertTrue($event->hasResponse());
@@ -86,6 +89,7 @@
         $framework = $this->mockContaoFramework();
         $pageRegistry = $this->createMock(PageRegistry::class);
         $httpKernel = $this->createMock(HttpKernelInterface::class);
+        $requestMatcher = $this->createMock(RequestMatcherInterface::class);
 
         $security = $this->createMock(Security::class);
         $security
@@ -96,7 +100,7 @@
         $exception = new InternalServerErrorHttpException('', new InternalServerErrorException());
         $event = $this->getResponseEvent($exception);
 
-        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel);
+        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel, $requestMatcher);
         $listener($event);
 
         $this->assertTrue($event->hasResponse());
@@ -126,7 +130,38 @@
 
         $event = $this->getResponseEvent($exception, $request);
 
-        $listener = $this->getListener(false, false, null, $errorPage, $httpKernel);
+        $listener = $this->getListener(false, null, $errorPage, $httpKernel);
+        $listener($event);
+
+        $this->assertTrue($event->hasResponse());
+        $this->assertSame($type, $event->getResponse()->getStatusCode());
+    }
+
+    /**
+     * @dataProvider getErrorTypes
+     */
+    public function testFindsPageModelIfRequestHasNone(int $type, \Exception $exception): void
+    {
+        $errorPage = $this->mockPageWithProperties([
+            'pid' => 1,
+            'type' => 'error_'.$type,
+            'rootLanguage' => '',
+        ]);
+
+        $rootPage = $this->mockPageWithProperties(['rootId' => 1]);
+
+        $request = $this->getRequest('frontend');
+
+        $httpKernel = $this->createMock(HttpKernelInterface::class);
+        $httpKernel
+            ->expects($this->once())
+            ->method('handle')
+            ->willReturn(new Response('foo', $type))
+        ;
+
+        $event = $this->getResponseEvent($exception, $request);
+
+        $listener = $this->getListener(false, null, $errorPage, $httpKernel, $rootPage);
         $listener($event);
 
         $this->assertTrue($event->hasResponse());
@@ -163,7 +198,7 @@
         $exception = new UnauthorizedHttpException('', '', new InsufficientAuthenticationException());
         $event = $this->getResponseEvent($exception, $request);
 
-        $listener = $this->getListener(false, false, null, $errorPage, $httpKernel);
+        $listener = $this->getListener(false, null, $errorPage, $httpKernel);
         $listener($event);
 
         $this->assertTrue($event->hasResponse());
@@ -192,7 +227,7 @@
         $exception = new AccessDeniedHttpException('', new AccessDeniedException());
         $event = $this->getResponseEvent($exception, $request);
 
-        $listener = $this->getListener(false, false, null, $errorPage, $httpKernel);
+        $listener = $this->getListener(false, null, $errorPage, $httpKernel);
         $listener($event);
 
         $this->assertTrue($event->hasResponse());
@@ -222,7 +257,7 @@
         $exception = new AccessDeniedHttpException('', new AccessDeniedException());
         $event = $this->getResponseEvent($exception, $request);
 
-        $listener = $this->getListener(false, false, null, $errorPage, $httpKernel);
+        $listener = $this->getListener(false, null, $errorPage, $httpKernel);
         $listener($event);
 
         $this->assertFalse($event->hasResponse());
@@ -247,9 +282,11 @@
         $event = $this->getResponseEvent($exception, $this->getRequest('frontend'));
 
         $twig = $this->createMock(Environment::class);
-        $framework = $this->mockContaoFramework();
+        $adapters = [PageModel::class => $this->mockAdapter(['findFirstPublishedRootByHostAndLanguage'])];
+        $framework = $this->mockContaoFramework($adapters);
         $pageRegistry = $this->createMock(PageRegistry::class);
         $httpKernel = $this->createMock(HttpKernelInterface::class);
+        $requestMatcher = $this->createMock(RequestMatcherInterface::class);
 
         $security = $this->createMock(Security::class);
         $security
@@ -258,7 +295,7 @@
             ->willReturn(false)
         ;
 
-        $listener = new PrettyErrorScreenListener(false, $twig, $framework, $security, $pageRegistry, $httpKernel);
+        $listener = new PrettyErrorScreenListener(false, $twig, $framework, $security, $pageRegistry, $httpKernel, $requestMatcher);
         $listener($event);
 
         $this->assertFalse($event->hasResponse());
@@ -270,6 +307,7 @@
         $framework = $this->mockContaoFramework();
         $pageRegistry = $this->createMock(PageRegistry::class);
         $httpKernel = $this->createMock(HttpKernelInterface::class);
+        $requestMatcher = $this->createMock(RequestMatcherInterface::class);
 
         $security = $this->createMock(Security::class);
         $security
@@ -281,7 +319,7 @@
         $exception = new ServiceUnavailableHttpException(null, '', new ServiceUnavailableException(''));
         $event = $this->getResponseEvent($exception, null, true);
 
-        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel);
+        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel, $requestMatcher);
         $listener($event);
 
         $this->assertFalse($event->hasResponse());
@@ -291,7 +329,7 @@
     {
         $event = $this->getResponseEvent(new ConflictHttpException(), $this->getRequest('frontend'));
 
-        $listener = $this->getListener(false, true);
+        $listener = $this->getListener(false);
         $listener($event);
 
         $this->assertTrue($event->hasResponse());
@@ -318,7 +356,7 @@
             )
         ;
 
-        $listener = $this->getListener(false, true, $twig);
+        $listener = $this->getListener(false, $twig);
         $listener($event);
 
         $this->assertTrue($event->hasResponse());
@@ -331,6 +369,7 @@
         $framework = $this->mockContaoFramework();
         $pageRegistry = $this->createMock(PageRegistry::class);
         $httpKernel = $this->createMock(HttpKernelInterface::class);
+        $requestMatcher = $this->createMock(RequestMatcherInterface::class);
 
         $security = $this->createMock(Security::class);
         $security
@@ -342,7 +381,7 @@
         $exception = new InternalServerErrorHttpException('', new InsecureInstallationException());
         $event = $this->getResponseEvent($exception, $this->getRequest('frontend', 'json'));
 
-        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel);
+        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel, $requestMatcher);
         $listener($event);
 
         $this->assertFalse($event->hasResponse());
@@ -357,6 +396,7 @@
         $framework = $this->mockContaoFramework();
         $pageRegistry = $this->createMock(PageRegistry::class);
         $httpKernel = $this->createMock(HttpKernelInterface::class);
+        $requestMatcher = $this->createMock(RequestMatcherInterface::class);
 
         $security = $this->createMock(Security::class);
         $security
@@ -368,7 +408,7 @@
         $exception = new InternalServerErrorHttpException('', new InsecureInstallationException());
         $event = $this->getResponseEvent($exception, $this->getRequest('backend', 'html', 'application/json'));
 
-        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel);
+        $listener = new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel, $requestMatcher);
         $listener($event);
 
         $this->assertFalse($event->hasResponse());
@@ -397,16 +437,31 @@
         $this->assertSame(500, $event->getResponse()->getStatusCode());
     }
 
-    private function getListener(bool $isBackendUser = false, bool $expectLogging = false, Environment $twig = null, PageModel $errorPage = null, HttpKernelInterface $httpKernel = null): PrettyErrorScreenListener
+    protected function mockContaoFramework(array $adapters = []): ContaoFramework
+    {
+        if (!isset($adapters[PageModel::class])) {
+            $pageAdapter = $this->mockAdapter(['findFirstPublishedRootByHostAndLanguage']);
+            $pageAdapter
+                ->method('findFirstPublishedRootByHostAndLanguage')
+                ->willReturn(null)
+            ;
+
+            $adapters[PageModel::class] = $pageAdapter;
+        }
+
+        return parent::mockContaoFramework($adapters);
+    }
+
+    private function getListener(bool $isBackendUser = false, Environment $twig = null, PageModel $errorPage = null, HttpKernelInterface $httpKernel = null, PageModel $rootPage = null): PrettyErrorScreenListener
     {
         $twig ??= $this->createMock(Environment::class);
         $httpKernel ??= $this->createMock(HttpKernelInterface::class);
+        $requestMatcher ??= $this->createMock(RequestMatcherInterface::class);
 
-        $adapters = [];
         $pageRegistry = $this->createMock(PageRegistry::class);
+        $pageAdapter = $this->mockAdapter(['findFirstPublishedByTypeAndPid']);
 
         if (null !== $errorPage) {
-            $pageAdapter = $this->mockAdapter(['findFirstPublishedByTypeAndPid']);
             $pageAdapter
                 ->expects($this->once())
                 ->method('findFirstPublishedByTypeAndPid')
@@ -420,11 +475,17 @@
                 ->with($errorPage)
                 ->willReturn(new PageRoute($errorPage))
             ;
+        }
 
-            $adapters[PageModel::class] = $pageAdapter;
+        if (null !== $rootPage) {
+            $requestMatcher
+                ->expects($this->once())
+                ->method('matchRequest')
+                ->willReturn(['pageModel' => $rootPage])
+            ;
         }
 
-        $framework = $this->mockContaoFramework($adapters);
+        $framework = $this->mockContaoFramework([PageModel::class => $pageAdapter]);
 
         $security = $this->createMock(Security::class);
         $security
@@ -433,7 +494,7 @@
             ->willReturn($isBackendUser)
         ;
 
-        return new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel);
+        return new PrettyErrorScreenListener(true, $twig, $framework, $security, $pageRegistry, $httpKernel, $requestMatcher);
     }
 
     private function getRequest(string $scope = 'backend', string $format = 'html', string $accept = 'text/html'): Request