vendor/symfony/config/Loader/FileLoader.php line 94

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Config\Loader;
  14. use Symfony\Component\Config\Exception\FileLoaderImportCircularReferenceException;
  15. use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException;
  16. use Symfony\Component\Config\Exception\LoaderLoadException;
  17. use Symfony\Component\Config\FileLocatorInterface;
  18. use Symfony\Component\Config\Resource\FileExistenceResource;
  19. use Symfony\Component\Config\Resource\GlobResource;
  21. /**
  22.  * FileLoader is the abstract class used by all built-in loaders that are file based.
  23.  *
  24.  * @author Fabien Potencier <fabien@symfony.com>
  25.  */
  26. abstract class FileLoader extends Loader
  27. {
  28.     protected static $loading = [];
  30.     protected $locator;
  32.     private ?string $currentDir = null;
  34.     public function __construct(FileLocatorInterface $locator, string $env = null)
  35.     {
  36.         $this->locator = $locator;
  37.         parent::__construct($env);
  38.     }
  40.     /**
  41.      * Sets the current directory.
  42.      */
  43.     public function setCurrentDir(string $dir)
  44.     {
  45.         $this->currentDir = $dir;
  46.     }
  48.     /**
  49.      * Returns the file locator used by this loader.
  50.      */
  51.     public function getLocator(): FileLocatorInterface
  52.     {
  53.         return $this->locator;
  54.     }
  56.     /**
  57.      * Imports a resource.
  58.      *
  59.      * @param mixed                $resource       A Resource
  60.      * @param string|null          $type           The resource type or null if unknown
  61.      * @param bool                 $ignoreErrors   Whether to ignore import errors or not
  62.      * @param string|null          $sourceResource The original resource importing the new resource
  63.      * @param string|string[]|null $exclude        Glob patterns to exclude from the import
  64.      *
  65.      * @throws LoaderLoadException
  66.      * @throws FileLoaderImportCircularReferenceException
  67.      * @throws FileLocatorFileNotFoundException
  68.      */
  69.     public function import(mixed $resource, string $type = null, bool $ignoreErrors = false, string $sourceResource = null, string|array $exclude = null)
  70.     {
  71.         if (\is_string($resource) && \strlen($resource) !== ($i = strcspn($resource, '*?{[')) && !str_contains($resource, "\n")) {
  72.             $excluded = [];
  73.             foreach ((array) $exclude as $pattern) {
  74.                 foreach ($this->glob($pattern, true, $_, false, true) as $path => $info) {
  75.                     // normalize Windows slashes and remove trailing slashes
  76.                     $excluded[rtrim(str_replace('\\', '/', $path), '/')] = true;
  77.                 }
  78.             }
  80.             $ret = [];
  81.             $isSubpath = 0 !== $i && str_contains(substr($resource, 0, $i), '/');
  82.             foreach ($this->glob($resource, false, $_, $ignoreErrors || !$isSubpath, false, $excluded) as $path => $info) {
  83.                 if (null !== $res = $this->doImport($path, 'glob' === $type ? null : $type, $ignoreErrors, $sourceResource)) {
  84.                     $ret[] = $res;
  85.                 }
  86.                 $isSubpath = true;
  87.             }
  89.             if ($isSubpath) {
  90.                 return isset($ret[1]) ? $ret : ($ret[0] ?? null);
  91.             }
  92.         }
  94.         return $this->doImport($resource, $type, $ignoreErrors, $sourceResource);
  95.     }
  97.     /**
  98.      * @internal
  99.      */
  100.     protected function glob(string $pattern, bool $recursive, array|GlobResource &$resource = null, bool $ignoreErrors = false, bool $forExclusion = false, array $excluded = [])
  101.     {
  102.         if (\strlen($pattern) === $i = strcspn($pattern, '*?{[')) {
  103.             $prefix = $pattern;
  104.             $pattern = '';
  105.         } elseif (0 === $i || !str_contains(substr($pattern, 0, $i), '/')) {
  106.             $prefix = '.';
  107.             $pattern = '/'.$pattern;
  108.         } else {
  109.             $prefix = \dirname(substr($pattern, 0, 1 + $i));
  110.             $pattern = substr($pattern, \strlen($prefix));
  111.         }
  113.         try {
  114.             $prefix = $this->locator->locate($prefix, $this->currentDir, true);
  115.         } catch (FileLocatorFileNotFoundException $e) {
  116.             if (!$ignoreErrors) {
  117.                 throw $e;
  118.             }
  120.             $resource = [];
  121.             foreach ($e->getPaths() as $path) {
  122.                 $resource[] = new FileExistenceResource($path);
  123.             }
  125.             return;
  126.         }
  127.         $resource = new GlobResource($prefix, $pattern, $recursive, $forExclusion, $excluded);
  129.         yield from $resource;
  130.     }
  132.     private function doImport(mixed $resource, string $type = null, bool $ignoreErrors = false, string $sourceResource = null)
  133.     {
  134.         try {
  135.             $loader = $this->resolve($resource, $type);
  137.             if ($loader instanceof DirectoryAwareLoaderInterface) {
  138.                 $loader = $loader->forDirectory($this->currentDir);
  139.             }
  141.             if (!$loader instanceof self) {
  142.                 return $loader->load($resource, $type);
  143.             }
  145.             if (null !== $this->currentDir) {
  146.                 $resource = $loader->getLocator()->locate($resource, $this->currentDir, false);
  147.             }
  149.             $resources = \is_array($resource) ? $resource : [$resource];
  150.             for ($i = 0; $i < $resourcesCount = \count($resources); ++$i) {
  151.                 if (isset(self::$loading[$resources[$i]])) {
  152.                     if ($i == $resourcesCount - 1) {
  153.                         throw new FileLoaderImportCircularReferenceException(array_keys(self::$loading));
  154.                     }
  155.                 } else {
  156.                     $resource = $resources[$i];
  157.                     break;
  158.                 }
  159.             }
  160.             self::$loading[$resource] = true;
  162.             try {
  163.                 $ret = $loader->load($resource, $type);
  164.             } finally {
  165.                 unset(self::$loading[$resource]);
  166.             }
  168.             return $ret;
  169.         } catch (FileLoaderImportCircularReferenceException $e) {
  170.             throw $e;
  171.         } catch (\Exception $e) {
  172.             if (!$ignoreErrors) {
  173.                 // prevent embedded imports from nesting multiple exceptions
  174.                 if ($e instanceof LoaderLoadException) {
  175.                     throw $e;
  176.                 }
  178.                 throw new LoaderLoadException($resource, $sourceResource, 0, $e, $type);
  179.             }
  180.         }
  182.         return null;
  183.     }
  184. }