[Routing] Allow to inject service to expression condition

renanbr · renanbr · commit cc6df1c84a22 · 2021-12-01T22:40:50.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/ExpressionConditionVariableResolverPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/ExpressionConditionVariableResolverPass.php
@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class ExpressionConditionVariableResolverPass implements CompilerPassInterface
+{
+    use PriorityTaggedServiceTrait;
+
+    public function process(ContainerBuilder $container): void
+    {
+        if (false === $container->hasDefinition('routing.router')) {
+            return;
+        }
+
+        $routerDefinition = $container->getDefinition('routing.router');
+
+        foreach ($this->findAndSortTaggedServices('routing.expression_condition_variable', $container) as $reference) {
+            $serviceId = (string) $reference;
+            $serviceDefinition = $container->getDefinition($serviceId);
+            $tag = $serviceDefinition->getTag('routing.expression_condition_variable');
+            $name = $tag[0]['name'] ?? null;
+            $routerDefinition->addMethodCall('setExpressionConditionVariable', [$name, $reference]);
+        }
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -170,6 +170,7 @@
 use Symfony\Component\RateLimiter\LimiterInterface;
 use Symfony\Component\RateLimiter\RateLimiterFactory;
 use Symfony\Component\RateLimiter\Storage\CacheStorage;
+use Symfony\Component\Routing\Attribute\AsRouteExpressionConditionVariable;
 use Symfony\Component\Routing\Loader\AnnotationDirectoryLoader;
 use Symfony\Component\Routing\Loader\AnnotationFileLoader;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
@@ -616,6 +617,12 @@ public function load(array $configs, ContainerBuilder $container)
             'kernel.locale_aware',
             'kernel.reset',
         ]);
+
+        $container->registerAttributeForAutoconfiguration(AsRouteExpressionConditionVariable::class, static function (ChildDefinition $definition, AsRouteExpressionConditionVariable $attribute): void {
+            $definition->addTag('routing.expression_condition_variable', [
+                'name' => $attribute->name,
+            ]);
+        });
     }
 
     /**
diff --git a/src/Symfony/Component/Routing/Attribute/AsRouteExpressionConditionVariable.php b/src/Symfony/Component/Routing/Attribute/AsRouteExpressionConditionVariable.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class AsRouteExpressionConditionVariable
+{
+    public function __construct(
+        public string $name,
+        public int $priority = 0,
+    ) {
+    }
+}
diff --git a/src/Symfony/Component/Routing/Matcher/UrlMatcher.php b/src/Symfony/Component/Routing/Matcher/UrlMatcher.php
@@ -56,6 +56,11 @@ class UrlMatcher implements UrlMatcherInterface, RequestMatcherInterface
      */
     protected $expressionLanguageProviders = [];
 
+    /**
+     * @var array<string, mixed>
+     */
+    private $expressionConditionVariables = [];
+
     public function __construct(RouteCollection $routes, RequestContext $context)
     {
         $this->routes = $routes;
@@ -115,6 +120,11 @@ public function addExpressionLanguageProvider(ExpressionFunctionProviderInterfac
         $this->expressionLanguageProviders[] = $provider;
     }
 
+    public function setExpressionConditionVariable(string $name, mixed $value): void
+    {
+        $this->expressionConditionVariables[$name] = $value;
+    }
+
     /**
      * Tries to match a URL with a set of routes.
      *
@@ -223,7 +233,13 @@ protected function getAttributes(Route $route, string $name, array $attributes):
     protected function handleRouteRequirements(string $pathinfo, string $name, Route $route): array
     {
         // expression condition
-        if ($route->getCondition() && !$this->getExpressionLanguage()->evaluate($route->getCondition(), ['context' => $this->context, 'request' => $this->request ?: $this->createRequest($pathinfo)])) {
+        if (
+            $route->getCondition() &&
+            !$this->getExpressionLanguage()->evaluate($route->getCondition(), array_merge($this->expressionConditionVariables, [
+                'context' => $this->context,
+                'request' => $this->request ?: $this->createRequest($pathinfo),
+            ]))
+        ) {
             return [self::REQUIREMENT_MISMATCH, null];
         }
 
