[Routing][FrameworkBundle] Allow using env() in route conditions

Author: atailouloute

CHANGELOG.md

@@ -12,6 +12,7 @@ CHANGELOG
  * Deprecated passing a `RouteCollectionBuiler` to `MicroKernelTrait::configureRoutes()`, type-hint `RoutingConfigurator` instead
  * The `TemplateController` now accepts context argument
  * Deprecated *not* setting the "framework.router.utf8" configuration option as it will default to `true` in Symfony 6.0
+ * Added tag `routing.expression_language_function` to define functions available in route conditions
 
 5.0.0
 -----

Command/RouterMatchCommand.php

@@ -33,12 +33,14 @@ class RouterMatchCommand extends Command
     protected static $defaultName = 'router:match';
 
     private $router;
+    private $expressionLanguageProviders;
 
-    public function __construct(RouterInterface $router)
+    public function __construct(RouterInterface $router, iterable $expressionLanguageProviders = [])
     {
         parent::__construct();
 
         $this->router = $router;
+        $this->expressionLanguageProviders = $expressionLanguageProviders;
     }
 
     /**
@@ -87,6 +89,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         $matcher = new TraceableUrlMatcher($this->router->getRouteCollection(), $context);
+        foreach ($this->expressionLanguageProviders as $provider) {
+            $matcher->addExpressionLanguageProvider($provider);
+        }
 
         $traces = $matcher->getTraces($input->getArgument('path_info'));
 

DependencyInjection/Compiler/UnusedTagsPass.php

@@ -49,6 +49,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'mime.mime_type_guesser',
         'monolog.logger',
         'proxy',
+        'routing.expression_language_function',
         'routing.expression_language_provider',
         'routing.loader',
         'routing.route_loader',

Resources/config/console.xml

@@ -145,6 +145,7 @@
 
         <service id="console.command.router_match" class="Symfony\Bundle\FrameworkBundle\Command\RouterMatchCommand">
             <argument type="service" id="router" />
+            <argument type="tagged_iterator" tag="routing.expression_language_provider" />
             <tag name="console.command" command="router:match" />
         </service>
 

Resources/config/routing.xml

@@ -86,9 +86,18 @@
             <argument></argument> <!-- scheme -->
             <argument>%request_listener.http_port%</argument>
             <argument>%request_listener.https_port%</argument>
+            <call method="setParameter">
+                <argument>_functions</argument>
+                <argument type="service" id="router.expression_language_provider" />
+            </call>
         </service>
         <service id="Symfony\Component\Routing\RequestContext" alias="router.request_context" />
 
+        <service id="router.expression_language_provider" class="Symfony\Component\Routing\Matcher\ExpressionLanguageProvider">
+            <argument type="tagged_locator" tag="routing.expression_language_function" index-by="function" />
+            <tag name="routing.expression_language_provider" />
+        </service>
+
         <service id="router.cache_warmer" class="Symfony\Bundle\FrameworkBundle\CacheWarmer\RouterCacheWarmer">
             <tag name="container.service_subscriber" id="router" />
             <tag name="kernel.cache_warmer" />

Resources/config/secrets.xml

@@ -11,8 +11,8 @@
             <argument type="service" id="secrets.decryption_key" on-invalid="ignore" />
         </service>
 
-        <service id="secrets.decryption_key" parent="getenv">
-            <argument />
+        <service id="secrets.decryption_key" parent="container.env">
+            <argument /><!-- the name of the env var to read -->
         </service>
 
         <service id="secrets.local_vault" class="Symfony\Bundle\FrameworkBundle\Secrets\DotenvVault">

Resources/config/services.xml

@@ -130,18 +130,19 @@
         </service>
         <service id="Symfony\Component\String\Slugger\SluggerInterface" alias="slugger" />
 
+        <service id="container.getenv" class="Closure">
+            <factory class="Closure" method="fromCallable" />
+            <argument type="collection">
+                <argument type="service" id="service_container" />
+                <argument>getEnv</argument>
+            </argument>
+            <tag name="routing.expression_language_function" function="env" />
+        </service>
+
         <!-- inherit from this service to lazily access env vars -->
-        <service id="getenv" class="Symfony\Component\String\LazyString" abstract="true">
+        <service id="container.env" class="Symfony\Component\String\LazyString" abstract="true">
             <factory class="Symfony\Component\String\LazyString" method="fromCallable" />
-            <argument type="service">
-                <service class="Closure">
-                    <factory class="Closure" method="fromCallable" />
-                    <argument type="collection">
-                        <argument type="service" id="service_container" />
-                        <argument>getEnv</argument>
-                    </argument>
-                </service>
-            </argument>
+            <argument type="service" id="container.getenv" />
         </service>
     </services>
 </container>