RedirectableUrlMatcher (#465)

Author: johndodev

CHANGELOG.md

@@ -1,5 +1,11 @@
 Changelog
 =========
+2.6.0
+-----
+
+* Implemented a new configuration option `redirectable_url_matcher` under `dynamic`.
+  If set to `true`, the router will try to detect and redirect between URLs with and without trailing slashes. See https://symfony.com/doc/4.1/routing.html#routing-trailing-slash-redirection.
+
 2.5.1
 -----
 

src/CmfRoutingBundle.php

@@ -18,6 +18,7 @@
 use Doctrine\ORM\Mapping\Driver\XmlDriver as ORMXmlDriver;
 use Doctrine\ORM\Version as ORMVersion;
 use Doctrine\Persistence\Mapping\Driver\DefaultFileLocator;
+use Symfony\Cmf\Bundle\RoutingBundle\DependencyInjection\Compiler\RedirectableMatcherPass;
 use Symfony\Cmf\Bundle\RoutingBundle\DependencyInjection\Compiler\SetRouterPass;
 use Symfony\Cmf\Bundle\RoutingBundle\DependencyInjection\Compiler\TemplatingValidatorPass;
 use Symfony\Cmf\Bundle\RoutingBundle\DependencyInjection\Compiler\ValidationPass;
@@ -41,6 +42,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new SetRouterPass());
         $container->addCompilerPass(new ValidationPass());
         $container->addCompilerPass(new TemplatingValidatorPass());
+        $container->addCompilerPass(new RedirectableMatcherPass());
 
         $this->buildPhpcrCompilerPass($container);
         $this->buildOrmCompilerPass($container);

src/DependencyInjection/CmfRoutingExtension.php

@@ -82,6 +82,8 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
     {
         $loader->load('routing-dynamic.xml');
 
+        $container->setParameter('cmf_routing.redirectable_url_matcher', $config['redirectable_url_matcher']);
+
         // strip whitespace (XML support)
         foreach (['controllers_by_type', 'controllers_by_class', 'templates_by_class', 'route_filters_by_id'] as $option) {
             $config[$option] = array_map('trim', $config[$option]);

src/DependencyInjection/Compiler/RedirectableMatcherPass.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\DependencyInjection\Compiler;
+
+use Symfony\Cmf\Bundle\RoutingBundle\Routing\RedirectableRequestMatcher;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * If enabled, change the nested matcher implementation to the redirectable matcher.
+ */
+class RedirectableMatcherPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        // only replace the nested matcher if config tells us to
+        if (!$container->hasParameter('cmf_routing.redirectable_url_matcher') || false === $container->getParameter('cmf_routing.redirectable_url_matcher')) {
+            return;
+        }
+
+        $definition = new Definition(RedirectableRequestMatcher::class);
+
+        $container->setDefinition('cmf_routing.redirectable_request_matcher', $definition)
+            ->setDecoratedService('cmf_routing.nested_matcher', 'cmf_routing.nested_matcher.inner')
+            ->addArgument(new Reference('cmf_routing.nested_matcher.inner'))
+            ->addArgument(new Reference('router.request_context'));
+    }
+}

src/DependencyInjection/Configuration.php

@@ -151,6 +151,7 @@ private function addDynamicSection(ArrayNodeDefinition $root)
                         ->end() // locales
                         ->integerNode('limit_candidates')->defaultValue(20)->end()
                         ->booleanNode('match_implicit_locale')->defaultValue(true)->end()
+                        ->booleanNode('redirectable_url_matcher')->defaultValue(false)->end()
                         ->booleanNode('auto_locale_pattern')->defaultValue(false)->end()
                         ->scalarNode('url_generator')
                             ->defaultValue('cmf_routing.generator')

src/Routing/RedirectableRequestMatcher.php

@@ -0,0 +1,93 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Routing;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Routing\Exception\ExceptionInterface;
+use Symfony\Component\Routing\Exception\ResourceNotFoundException;
+use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
+use Symfony\Component\Routing\RequestContext;
+
+/**
+ * Reproduce the behaviour of the Symfony router to redirect paths with a trailing slash if necessary.
+ *
+ * The logic is taken from Symfony\Component\Routing\Matcher\RedirectableUrlMatcher and Symfony\Bundle\FrameworkBundle\Routing\RedirectableCompiledUrlMatcher
+ *
+ * @see https://symfony.com/doc/4.1/routing.html#routing-trailing-slash-redirection
+ */
+class RedirectableRequestMatcher implements RequestMatcherInterface
+{
+    private RequestMatcherInterface $decorated;
+
+    private RequestContext $requestContext;
+
+    public function __construct(RequestMatcherInterface $decorated, RequestContext $requestContext)
+    {
+        $this->decorated = $decorated;
+        $this->requestContext = $requestContext;
+    }
+
+    /**
+     * If the matcher can not find a match,
+     * it will try to add or remove a trailing slash to the path and match again.
+     */
+    public function matchRequest(Request $request)
+    {
+        try {
+            return $this->decorated->matchRequest($request);
+        } catch (ResourceNotFoundException $e) {
+            if (!\in_array($request->getMethod(), ['HEAD', 'GET'], true)) {
+                throw $e;
+            }
+
+            $pathinfo = $request->getPathInfo();
+
+            if ('/' === $trimmedPathinfo = rtrim($pathinfo, '/') ?: '/') {
+                throw $e;
+            }
+
+            $pathinfo = $trimmedPathinfo === $pathinfo ? $pathinfo.'/' : $trimmedPathinfo;
+
+            try {
+                $parameters = $this->decorated->matchRequest($this->rebuildRequest($request, $pathinfo));
+            } catch (ExceptionInterface $e2) {
+                throw $e;
+            }
+
+            return $this->redirect($pathinfo, $parameters['_route'] ?? null, $this->requestContext->getScheme()) + $parameters;
+        }
+    }
+
+    private function redirect(string $path, string $route, string $scheme = null): array
+    {
+        return [
+            '_controller' => 'Symfony\\Bundle\\FrameworkBundle\\Controller\\RedirectController::urlRedirectAction',
+            'path' => $path,
+            'permanent' => true,
+            'scheme' => $scheme,
+            'httpPort' => $this->requestContext->getHttpPort(),
+            'httpsPort' => $this->requestContext->getHttpsPort(),
+            '_route' => $route,
+        ];
+    }
+
+    /**
+     * Return a duplicated version of $request with the new $newpath as request_uri.
+     */
+    private function rebuildRequest(Request $request, string $newPath): Request
+    {
+        $server = $request->server->all();
+        $server['REQUEST_URI'] = $newPath;
+
+        return $request->duplicate(null, null, null, null, null, $server);
+    }
+}

tests/Fixtures/fixtures/config/config.php

@@ -40,5 +40,6 @@
         'locales' => ['en', 'fr'],
         'auto_locale_pattern' => true,
         'match_implicit_locale' => true,
+        'redirectable_url_matcher' => false,
     ],
 ]);

tests/Fixtures/fixtures/config/config.yml

@@ -21,3 +21,4 @@ cmf_routing:
         locales: [en, fr]
         auto_locale_pattern: true
         match_implicit_locale: true
+        redirectable_url_matcher: false

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -76,6 +76,7 @@ public function testSupportsAllConfigFormats()
                 'auto_locale_pattern' => true,
                 'match_implicit_locale' => true,
                 'url_generator' => 'cmf_routing.generator',
+                'redirectable_url_matcher' => false,
             ],
         ];
 

tests/Unit/Routing/RedirectableRequestMatcherTest.php

@@ -0,0 +1,88 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Tests\Unit\Routing;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Symfony\Cmf\Bundle\RoutingBundle\Routing\RedirectableRequestMatcher;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Routing\Exception\ResourceNotFoundException;
+use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
+use Symfony\Component\Routing\RequestContext;
+
+class RedirectableRequestMatcherTest extends TestCase
+{
+    /**
+     * @var RedirectableRequestMatcher
+     */
+    private $redirectableRequestMatcher;
+
+    /**
+     * @var RequestMatcherInterface|MockObject
+     */
+    private $decoratedRequestMatcher;
+
+    /**
+     * @var Request
+     */
+    private $requestWithoutSlash;
+
+    /**
+     * @var Request
+     */
+    private $requestWithSlash;
+
+    /**
+     * @var RequestContext|MockObject
+     */
+    private $context;
+
+    public function setUp(): void
+    {
+        $this->requestWithoutSlash = Request::create('/foo');
+        $this->requestWithSlash = Request::create('/foo/');
+        $this->decoratedRequestMatcher = $this->createMock(RequestMatcherInterface::class);
+        $this->context = $this->createMock(RequestContext::class);
+        $this->redirectableRequestMatcher = new RedirectableRequestMatcher($this->decoratedRequestMatcher, $this->context);
+    }
+
+    public function testMatchRequest()
+    {
+        $this->decoratedRequestMatcher
+            ->expects($this->once())
+            ->method('matchRequest')
+            ->with($this->requestWithoutSlash)
+            ->will($this->returnValue(['foo' => 'bar']));
+
+        $parameters = $this->redirectableRequestMatcher->matchRequest($this->requestWithoutSlash);
+        $this->assertEquals(['foo' => 'bar'], $parameters);
+    }
+
+    public function testMatchRequestWithSlash()
+    {
+        $this->decoratedRequestMatcher
+            ->method('matchRequest')
+            ->withConsecutive([$this->callback(function (Request $request) {
+                return '/foo/' === $request->getPathInfo();
+            })], [$this->callback(function (Request $request) {
+                return '/foo' === $request->getPathInfo();
+            })])
+            ->will($this->onConsecutiveCalls(
+                $this->throwException(new ResourceNotFoundException()),
+                $this->returnValue(['_route' => 'foobar'])
+            ));
+
+        $parameters = $this->redirectableRequestMatcher->matchRequest($this->requestWithSlash);
+        $this->assertTrue('foobar' === $parameters['_route']);
+        $this->assertTrue('/foo' === $parameters['path']);
+    }
+}