vendor/liip/imagine-bundle/Binary/Locator/FileSystemLocator.php line 47

  1. <?php
  3. /*
  4.  * This file is part of the `liip/LiipImagineBundle` project.
  5.  *
  6.  * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE.md
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Liip\ImagineBundle\Binary\Locator;
  14. use Liip\ImagineBundle\Exception\Binary\Loader\NotLoadableException;
  15. use Liip\ImagineBundle\Exception\InvalidArgumentException;
  17. class FileSystemLocator implements LocatorInterface
  18. {
  19.     /**
  20.      * @var string[]
  21.      */
  22.     private $roots = [];
  24.     /**
  25.      * @param string[] $roots
  26.      */
  27.     public function __construct(array $roots = [], bool $allowUnresolvable = false)
  28.     {
  29.         $this->roots = array_filter(array_map(function (string $root) use ($allowUnresolvable): ?string {
  30.             return $this->sanitizeRootPath($root, $allowUnresolvable);
  31.         }, $roots));
  32.     }
  34.     /**
  35.      * @throws NotLoadableException
  36.      */
  37.     public function locate(string $path): string
  38.     {
  39.         if (null !== $absolute = $this->locateUsingRootPlaceholder($path)) {
  40.             return $this->sanitizeAbsolutePath($absolute);
  41.         }
  43.         if (null !== $absolute = $this->locateUsingRootPathsSearch($path)) {
  44.             return $this->sanitizeAbsolutePath($absolute);
  45.         }
  47.         throw new NotLoadableException(sprintf('Source image not resolvable "%s" in root path(s) "%s"', $path, implode(':', $this->roots)));
  48.     }
  50.     protected function generateAbsolutePath(string $root, string $path): ?string
  51.     {
  52.         if (false !== $absolute = realpath($root.DIRECTORY_SEPARATOR.$path)) {
  53.             return $absolute;
  54.         }
  56.         return null;
  57.     }
  59.     private function locateUsingRootPathsSearch(string $path): ?string
  60.     {
  61.         foreach ($this->roots as $root) {
  62.             if (null !== $absolute = $this->generateAbsolutePath($root, $path)) {
  63.                 return $absolute;
  64.             }
  65.         }
  67.         return null;
  68.     }
  70.     private function locateUsingRootPlaceholder(string $path): ?string
  71.     {
  72.         if (0 !== mb_strpos($path, '@') || 1 !== preg_match('{^@(?<name>[^:]+):(?<path>.+)$}', $path, $match)) {
  73.             return null;
  74.         }
  76.         if (isset($this->roots[$match['name']])) {
  77.             return $this->generateAbsolutePath($this->roots[$match['name']], $match['path']);
  78.         }
  80.         throw new NotLoadableException(sprintf('Invalid root placeholder "@%s" for path "%s"', $match['name'], $match['path']));
  81.     }
  83.     /**
  84.      * @throws InvalidArgumentException
  85.      */
  86.     private function sanitizeRootPath(string $path, bool $allowUnresolvable): ?string
  87.     {
  88.         if (!empty($path) && false !== $real = realpath($path)) {
  89.             return $real;
  90.         }
  92.         if ($allowUnresolvable) {
  93.             return null;
  94.         }
  96.         throw new InvalidArgumentException(sprintf('Root image path not resolvable "%s"', $path));
  97.     }
  99.     /**
  100.      * @throws NotLoadableException
  101.      */
  102.     private function sanitizeAbsolutePath(string $path): string
  103.     {
  104.         $roots = array_filter($this->roots, function (string $root) use ($path): bool {
  105.             return 0 === mb_strpos($path, $root);
  106.         });
  108.         if (0 === \count($roots)) {
  109.             throw new NotLoadableException(sprintf('Source image invalid "%s" as it is outside of the defined root path(s) "%s"', $path, implode(':', $this->roots)));
  110.         }
  112.         if (!is_readable($path)) {
  113.             throw new NotLoadableException(sprintf('Source image invalid "%s" as it is not readable', $path));
  114.         }
  116.         return $path;
  117.     }
  118. }