vendor/symfony/asset-mapper/AssetMapperDevServerSubscriber.php line 114

Open in your IDE?
  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\AssetMapper;
  14. use Psr\Cache\CacheItemPoolInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Event\RequestEvent;
  18. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  19. use Symfony\Component\HttpKernel\KernelEvents;
  21. /**
  22.  * Functions like a controller that returns assets from the asset mapper.
  23.  *
  24.  * @experimental
  25.  *
  26.  * @author Ryan Weaver <ryan@symfonycasts.com>
  27.  */
  28. final class AssetMapperDevServerSubscriber implements EventSubscriberInterface
  29. {
  30.     // source: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
  31.     private const EXTENSIONS_MAP = [
  32.         'aac' => 'audio/aac',
  33.         'abw' => 'application/x-abiword',
  34.         'arc' => 'application/x-freearc',
  35.         'avif' => 'image/avif',
  36.         'avi' => 'video/x-msvideo',
  37.         'azw' => 'application/vnd.amazon.ebook',
  38.         'bin' => 'application/octet-stream',
  39.         'bmp' => 'image/bmp',
  40.         'bz' => 'application/x-bzip',
  41.         'bz2' => 'application/x-bzip2',
  42.         'cda' => 'application/x-cdf',
  43.         'csh' => 'application/x-csh',
  44.         'css' => 'text/css',
  45.         'csv' => 'text/csv',
  46.         'doc' => 'application/msword',
  47.         'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
  48.         'eot' => 'application/vnd.ms-fontobject',
  49.         'epub' => 'application/epub+zip',
  50.         'gz' => 'application/gzip',
  51.         'gif' => 'image/gif',
  52.         'htm' => 'text/html',
  53.         'html' => 'text/html',
  54.         'ico' => 'image/vnd.microsoft.icon',
  55.         'ics' => 'text/calendar',
  56.         'jar' => 'application/java-archive',
  57.         'jpeg' => 'image/jpeg',
  58.         'jpg' => 'image/jpeg',
  59.         'js' => 'text/javascript',
  60.         'json' => 'application/json',
  61.         'jsonld' => 'application/ld+json',
  62.         'mid' => 'audio/midi',
  63.         'midi' => 'audio/midi',
  64.         'mjs' => 'text/javascript',
  65.         'mp3' => 'audio/mpeg',
  66.         'mp4' => 'video/mp4',
  67.         'mpeg' => 'video/mpeg',
  68.         'mpkg' => 'application/vnd.apple.installer+xml',
  69.         'odp' => 'application/vnd.oasis.opendocument.presentation',
  70.         'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
  71.         'odt' => 'application/vnd.oasis.opendocument.text',
  72.         'oga' => 'audio/ogg',
  73.         'ogv' => 'video/ogg',
  74.         'ogx' => 'application/ogg',
  75.         'opus' => 'audio/opus',
  76.         'otf' => 'font/otf',
  77.         'png' => 'image/png',
  78.         'pdf' => 'application/pdf',
  79.         'php' => 'application/x-httpd-php',
  80.         'ppt' => 'application/vnd.ms-powerpoint',
  81.         'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
  82.         'rar' => 'application/vnd.rar',
  83.         'rtf' => 'application/rtf',
  84.         'sh' => 'application/x-sh',
  85.         'svg' => 'image/svg+xml',
  86.         'tar' => 'application/x-tar',
  87.         'tif' => 'image/tiff',
  88.         'tiff' => 'image/tiff',
  89.         'ts' => 'video/mp2t',
  90.         'ttf' => 'font/ttf',
  91.         'txt' => 'text/plain',
  92.         'vsd' => 'application/vnd.visio',
  93.         'wav' => 'audio/wav',
  94.         'weba' => 'audio/webm',
  95.         'webm' => 'video/webm',
  96.         'webp' => 'image/webp',
  97.         'woff' => 'font/woff',
  98.         'woff2' => 'font/woff2',
  99.     ];
  101.     private readonly string $publicPrefix;
  102.     private array $extensionsMap;
  104.     public function __construct(
  105.         private readonly AssetMapperInterface $assetMapper,
  106.         string $publicPrefix = '/assets/',
  107.         array $extensionsMap = [],
  108.         private readonly ?CacheItemPoolInterface $cacheMapCache = null,
  109.     ) {
  110.         $this->publicPrefix = rtrim($publicPrefix, '/').'/';
  111.         $this->extensionsMap = array_merge(self::EXTENSIONS_MAP, $extensionsMap);
  112.     }
  114.     public function onKernelRequest(RequestEvent $event): void
  115.     {
  116.         if (!$event->isMainRequest()) {
  117.             return;
  118.         }
  120.         $pathInfo = $event->getRequest()->getPathInfo();
  121.         if (!str_starts_with($pathInfo, $this->publicPrefix)) {
  122.             return;
  123.         }
  125.         $asset = $this->findAssetFromCache($pathInfo);
  127.         if (!$asset) {
  128.             throw new NotFoundHttpException(sprintf('Asset with public path "%s" not found.', $pathInfo));
  129.         }
  131.         $mediaType = $this->getMediaType($asset->publicPath);
  132.         $response = (new Response(
  133.             $asset->content,
  134.             headers: $mediaType ? ['Content-Type' => $mediaType] : [],
  135.         ))
  136.             ->setPublic()
  137.             ->setMaxAge(604800)
  138.             ->setImmutable()
  139.             ->setEtag($asset->digest)
  140.         ;
  142.         $event->setResponse($response);
  143.     }
  145.     public static function getSubscribedEvents(): array
  146.     {
  147.         return [
  148.             // priority higher than RouterListener
  149.             KernelEvents::REQUEST => [['onKernelRequest', 35]],
  150.         ];
  151.     }
  153.     private function getMediaType(string $path): ?string
  154.     {
  155.         $extension = pathinfo($path, \PATHINFO_EXTENSION);
  157.         return $this->extensionsMap[$extension] ?? null;
  158.     }
  160.     private function findAssetFromCache(string $pathInfo): ?MappedAsset
  161.     {
  162.         $cachedAsset = null;
  163.         if (null !== $this->cacheMapCache) {
  164.             $cachedAsset = $this->cacheMapCache->getItem(hash('xxh128', $pathInfo));
  165.             $asset = $cachedAsset->isHit() ? $this->assetMapper->getAsset($cachedAsset->get()) : null;
  167.             if (null !== $asset && $asset->publicPath === $pathInfo) {
  168.                 return $asset;
  169.             }
  170.         }
  172.         // we did not find a match
  173.         $asset = null;
  174.         foreach ($this->assetMapper->allAssets() as $assetCandidate) {
  175.             if ($pathInfo === $assetCandidate->publicPath) {
  176.                 $asset = $assetCandidate;
  177.                 break;
  178.             }
  179.         }
  181.         if (null === $asset) {
  182.             return null;
  183.         }
  185.         if (null !== $cachedAsset) {
  186.             $cachedAsset->set($asset->logicalPath);
  187.             $this->cacheMapCache->save($cachedAsset);
  188.         }
  190.         return $asset;
  191.     }
  192. }