vendor/symfony/asset/VersionStrategy/JsonManifestVersionStrategy.php line 43

  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\Asset\VersionStrategy;
  14. use Symfony\Component\Asset\Exception\AssetNotFoundException;
  15. use Symfony\Component\Asset\Exception\LogicException;
  16. use Symfony\Component\Asset\Exception\RuntimeException;
  17. use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
  18. use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
  19. use Symfony\Contracts\HttpClient\HttpClientInterface;
  21. /**
  22.  * Reads the versioned path of an asset from a JSON manifest file.
  23.  *
  24.  * For example, the manifest file might look like this:
  25.  *     {
  26.  *         "main.js": "main.abc123.js",
  27.  *         "css/styles.css": "css/styles.555abc.css"
  28.  *     }
  29.  *
  30.  * You could then ask for the version of "main.js" or "css/styles.css".
  31.  */
  32. class JsonManifestVersionStrategy implements VersionStrategyInterface
  33. {
  34.     private string $manifestPath;
  35.     private array $manifestData;
  36.     private ?HttpClientInterface $httpClient;
  37.     private bool $strictMode;
  39.     /**
  40.      * @param string $manifestPath Absolute path to the manifest file
  41.      * @param bool   $strictMode   Throws an exception for unknown paths
  42.      */
  43.     public function __construct(string $manifestPath, HttpClientInterface $httpClient = null, bool $strictMode = false)
  44.     {
  45.         $this->manifestPath = $manifestPath;
  46.         $this->httpClient = $httpClient;
  47.         $this->strictMode = $strictMode;
  49.         if (null === $this->httpClient && ($scheme = parse_url($this->manifestPath, \PHP_URL_SCHEME)) && str_starts_with($scheme, 'http')) {
  50.             throw new LogicException(sprintf('The "%s" class needs an HTTP client to use a remote manifest. Try running "composer require symfony/http-client".', self::class));
  51.         }
  52.     }
  54.     /**
  55.      * With a manifest, we don't really know or care about what
  56.      * the version is. Instead, this returns the path to the
  57.      * versioned file.
  58.      */
  59.     public function getVersion(string $path): string
  60.     {
  61.         return $this->applyVersion($path);
  62.     }
  64.     public function applyVersion(string $path): string
  65.     {
  66.         return $this->getManifestPath($path) ?: $path;
  67.     }
  69.     private function getManifestPath(string $path): ?string
  70.     {
  71.         if (!isset($this->manifestData)) {
  72.             if (null !== $this->httpClient && ($scheme = parse_url($this->manifestPath, \PHP_URL_SCHEME)) && str_starts_with($scheme, 'http')) {
  73.                 try {
  74.                     $this->manifestData = $this->httpClient->request('GET', $this->manifestPath, [
  75.                         'headers' => ['accept' => 'application/json'],
  76.                     ])->toArray();
  77.                 } catch (DecodingExceptionInterface $e) {
  78.                     throw new RuntimeException(sprintf('Error parsing JSON from asset manifest URL "%s".', $this->manifestPath), 0, $e);
  79.                 } catch (ClientExceptionInterface $e) {
  80.                     throw new RuntimeException(sprintf('Error loading JSON from asset manifest URL "%s".', $this->manifestPath), 0, $e);
  81.                 }
  82.             } else {
  83.                 if (!is_file($this->manifestPath)) {
  84.                     throw new RuntimeException(sprintf('Asset manifest file "%s" does not exist. Did you forget to build the assets with npm or yarn?', $this->manifestPath));
  85.                 }
  87.                 try {
  88.                     $this->manifestData = json_decode(file_get_contents($this->manifestPath), true, flags: \JSON_THROW_ON_ERROR);
  89.                 } catch (\JsonException $e) {
  90.                     throw new RuntimeException(sprintf('Error parsing JSON from asset manifest file "%s": ', $this->manifestPath).$e->getMessage(), previous: $e);
  91.                 }
  92.             }
  93.         }
  95.         if (isset($this->manifestData[$path])) {
  96.             return $this->manifestData[$path];
  97.         }
  99.         if ($this->strictMode) {
  100.             $message = sprintf('Asset "%s" not found in manifest "%s".', $path, $this->manifestPath);
  101.             $alternatives = $this->findAlternatives($path, $this->manifestData);
  102.             if (\count($alternatives) > 0) {
  103.                 $message .= sprintf(' Did you mean one of these? "%s".', implode('", "', $alternatives));
  104.             }
  106.             throw new AssetNotFoundException($message, $alternatives);
  107.         }
  109.         return null;
  110.     }
  112.     private function findAlternatives(string $path, array $manifestData): array
  113.     {
  114.         $path = strtolower($path);
  115.         $alternatives = [];
  117.         foreach ($manifestData as $key => $value) {
  118.             $lev = levenshtein($path, strtolower($key));
  119.             if ($lev <= \strlen($path) / 3 || false !== stripos($key, $path)) {
  120.                 $alternatives[$key] = isset($alternatives[$key]) ? min($lev, $alternatives[$key]) : $lev;
  121.             }
  123.             $lev = levenshtein($path, strtolower($value));
  124.             if ($lev <= \strlen($path) / 3 || false !== stripos($key, $path)) {
  125.                 $alternatives[$key] = isset($alternatives[$key]) ? min($lev, $alternatives[$key]) : $lev;
  126.             }
  127.         }
  129.         asort($alternatives);
  131.         return array_keys($alternatives);
  132.     }
  133. }