added support for glob loaders in Config #21635

fabpot · 2017-02-16T20:30:47Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	not yet

In #21270, we added the possibility to use glob patterns to import (not load) config files, but it was restricted to the container. The same feature could be useful (and I actually have a use case) for the routing.

So, this PR moves the logic to the Config component. It also adds a new GlobFileLoader class that allows to load glob patterns (not just import them as in #21270).

Last, but not least, the new glob file loader is registered in both the routing and the container default loaders.

Here is a simple, but powerful example, using the Symfony micro kernel (actually, this is a snippet from the Kernel used in Symfony Flex :)):

<?php

namespace Symfony\Flex;

use Symfony\Component\HttpKernel\Kernel as BaseKernel;

class Kernel extends BaseKernel
{
    use MicroKernelTrait;

    const CONFIG_EXTS = '.{php,xml,yaml,yml}';

    // ...

    protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader)
    {
        $confDir = dirname($this->getRootDir()).'/etc';
        $loader->import($confDir.'/packages/*'.self::CONFIG_EXTS, 'glob');
        $loader->import($confDir.'/packages/'.$this->getEnvironment().'/**/*'.self::CONFIG_EXTS, 'glob');
        $loader->import($confDir.'/container'.self::CONFIG_EXTS, 'glob');
    }

    protected function configureRoutes(RouteCollectionBuilder $routes)
    {
        $confDir = dirname($this->getRootDir()).'/etc';
        $routes->import($confDir.'/routing/*'.self::CONFIG_EXTS, '/', 'glob');
        $routes->import($confDir.'/routing/'.$this->getEnvironment().'/**/*'.self::CONFIG_EXTS, '/', 'glob');
        $routes->import($confDir.'/routing'.self::CONFIG_EXTS, '/', 'glob');
    }
}

fabpot · 2017-02-16T20:32:23Z

src/Symfony/Component/Config/Loader/FileLoader.php

+            $ret[] = $this->doImport($resource, $type, $ignoreErrors, $sourceResource);
+        }
+
+        return $ct > 1 ? $ret : $ret[0] ?? null;


This is ugly as load and import are not supposed to return anything, but the routing loaders do expect some return value (something that should probably be fixed at some point).

even if already ugly enough as is, do we really want this to require php 7+ for such syntactic sugar ???

nicolas-grekas · 2017-02-16T20:47:08Z

src/Symfony/Component/DependencyInjection/Loader/FileLoader.php

@@ -88,8 +68,12 @@ private function findClasses($namespace, $resource)
    {
        $classes = array();
        $extRegexp = defined('HHVM_VERSION') ? '/\\.(?:php|hh)$/' : '/\\.php$/';
+        $prefixLen = null;
+        foreach ($this->glob($resource, true, $prefix) as $path => $info) {


if you call glob outside of the loop, you can compute prefixLen outside of the foreach

that does not work

nicolas-grekas · 2017-02-16T20:51:23Z

src/Symfony/Component/Config/Loader/FileLoader.php

+            $ret[] = $this->doImport($resource, $type, $ignoreErrors, $sourceResource);
+        }
+
+        return $ct > 1 ? $ret : isset($ret[0]) ? $ret[0] : null;


drop $ct then:
isset($ret[1]) ? $ret : ($ret ? $ret[0] : null) or
$ret ? (isset($ret[1]) ? $ret : $ret[0]) : null ?

which would be less readable

nicolas-grekas · 2017-02-16T20:54:32Z

src/Symfony/Component/Config/Loader/FileLoader.php

+    {
+        if (strlen($resource) === $i = strcspn($resource, '*?{[')) {
+            if (!$recursive) {
+                yield $resource => new \SplFileInfo($resource);


just in case, $prefix should be set to null here

nicolas-grekas · 2017-02-16T20:58:19Z

src/Symfony/Component/Config/Loader/GlobFileLoader.php

+     */
+    public function supports($resource, $type = null)
+    {
+        return 'glob' === $type;


add a check on $resource, like false === strpbrk($resource, '*?{[')?

Not needed as we force $type to be glob

@nicolas-grekas could the check be done at some other place, see #22160
Actually just a check if a glob pattern is used but not the correct type (type: glob) is configured to return a meaningful errormessage?

nicolas-grekas · 2017-02-16T21:01:44Z

src/Symfony/Component/Routing/RouteCollectionBuilder.php

@@ -61,21 +61,28 @@ public function __construct(LoaderInterface $loader = null)
     */
    public function import($resource, $prefix = '/', $type = null)


in case of a glob, this is missing tracking of the directory prefixing the pattern - see "$this->container->fileExists($resourcePrefix, '/^$/');" in DI.
Should we do it inline here? Would be like a leak but do we have a better choice?

Not about the "leak", as routing resources are tracked in a different file, so we cannot reused the same logic.

By the way, we have the same issue with the container.

I think there is nothing to fix here. Calling import does not imply that you were using a glob. However, the previous implementation made this assumption and always added the direction as a resource, even for non-globs, I don't think this is something we want.

nicolas-grekas

👍 after rebase

This PR was merged into the 3.3-dev branch. Discussion ---------- added support for glob loaders in Config | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | not yet In #21270, we added the possibility to use glob patterns to import (not load) config files, but it was restricted to the container. The same feature could be useful (and I actually have a use case) for the routing. So, this PR moves the logic to the Config component. It also adds a new `GlobFileLoader` class that allows to load glob patterns (not just import them as in #21270). Last, but not least, the new glob file loader is registered in both the routing and the container default loaders. Here is a simple, but powerful example, using the Symfony micro kernel (actually, this is a snippet from the Kernel used in Symfony Flex :)): ```php <?php namespace Symfony\Flex; use Symfony\Component\HttpKernel\Kernel as BaseKernel; class Kernel extends BaseKernel { use MicroKernelTrait; const CONFIG_EXTS = '.{php,xml,yaml,yml}'; // ... protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader) { $confDir = dirname($this->getRootDir()).'/etc'; $loader->import($confDir.'/packages/*'.self::CONFIG_EXTS, 'glob'); $loader->import($confDir.'/packages/'.$this->getEnvironment().'/**/*'.self::CONFIG_EXTS, 'glob'); $loader->import($confDir.'/container'.self::CONFIG_EXTS, 'glob'); } protected function configureRoutes(RouteCollectionBuilder $routes) { $confDir = dirname($this->getRootDir()).'/etc'; $routes->import($confDir.'/routing/*'.self::CONFIG_EXTS, '/', 'glob'); $routes->import($confDir.'/routing/'.$this->getEnvironment().'/**/*'.self::CONFIG_EXTS, '/', 'glob'); $routes->import($confDir.'/routing'.self::CONFIG_EXTS, '/', 'glob'); } } ``` Commits ------- 025585d added support for glob loaders in Config

carsonbot added Status: Needs Review Feature labels Feb 16, 2017

fabpot force-pushed the glob-loader branch from 71cab75 to fbbcf9f Compare February 16, 2017 20:31

fabpot commented Feb 16, 2017

View reviewed changes

fabpot force-pushed the glob-loader branch from fbbcf9f to 1ebbcf7 Compare February 16, 2017 20:48

nicolas-grekas reviewed Feb 16, 2017

View reviewed changes

fabpot force-pushed the glob-loader branch 2 times, most recently from a183027 to ce72d21 Compare February 16, 2017 21:53

nicolas-grekas added this to the 3.3 milestone Feb 18, 2017

nicolas-grekas approved these changes Feb 18, 2017

View reviewed changes

added support for glob loaders in Config

025585d

fabpot force-pushed the glob-loader branch from ce72d21 to 025585d Compare February 18, 2017 16:06

fabpot merged commit 025585d into symfony:master Feb 18, 2017

javiereguiluz mentioned this pull request Feb 26, 2017

Added support for glob patterns everywhere symfony/symfony-docs#7537

Closed

ro0NL mentioned this pull request Mar 27, 2017

[DI] Allow imports in string format for YAML #22176

Merged

fabpot deleted the glob-loader branch April 7, 2017 17:17

pierredup mentioned this pull request Apr 9, 2017

[HttpKernel] Add glob support for bundle resource locator #22350

Closed

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

This was referenced May 25, 2017

Symfony 3.3 - BC break due to changed routing loading logic Sylius/Sylius#7896

Closed

[3.3] Glob loader breaks loading inline YAML resources #22938

Closed

bet0x mentioned this pull request Oct 30, 2019

AH01630: client denied by server configuration: /homez.599 PrestaShop/PrestaShop#16198

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added support for glob loaders in Config #21635

added support for glob loaders in Config #21635

fabpot commented Feb 16, 2017

fabpot Feb 16, 2017

chalasr Feb 16, 2017

fabpot Feb 16, 2017

nicolas-grekas Feb 16, 2017

fabpot Feb 16, 2017

nicolas-grekas Feb 16, 2017

fabpot Feb 16, 2017

nicolas-grekas Feb 16, 2017

fabpot Feb 16, 2017

nicolas-grekas Feb 16, 2017

fabpot Feb 16, 2017

lunetics Mar 26, 2017

nicolas-grekas Feb 16, 2017

fabpot Feb 16, 2017

fabpot Feb 16, 2017

fabpot Feb 16, 2017

nicolas-grekas left a comment

		@@ -61,21 +61,28 @@ public function __construct(LoaderInterface $loader = null)
		*/
		public function import($resource, $prefix = '/', $type = null)

added support for glob loaders in Config #21635

added support for glob loaders in Config #21635

Conversation

fabpot commented Feb 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment