vendor/shopware/core/Framework/Adapter/Twig/EntityTemplateLoader.php line 40

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Adapter\Twig;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\DevOps\Environment\EnvironmentHelper;
  7. use Shopware\Core\Framework\DependencyInjection\CompilerPass\TwigLoaderConfigCompilerPass;
  8. use Shopware\Core\Framework\Log\Package;
  9. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  10. use Symfony\Contracts\Service\ResetInterface;
  11. use Twig\Error\LoaderError;
  12. use Twig\Loader\LoaderInterface;
  13. use Twig\Source;
  15. /**
  16.  * @internal
  17.  */
  18. #[Package('core')]
  19. class EntityTemplateLoader implements LoaderInterface, EventSubscriberInterface, ResetInterface
  20. {
  21.     /**
  22.      * @var array<string, array<string, array{template: string, updatedAt: \DateTimeInterface|null}|null>>
  23.      */
  24.     private array $databaseTemplateCache = [];
  26.     /**
  27.      * @internal
  28.      */
  29.     public function __construct(
  30.         private readonly Connection $connection,
  31.         private readonly string $environment
  32.     ) {
  33.     }
  35.     public static function getSubscribedEvents(): array
  36.     {
  37.         return ['app_template.written' => 'reset'];
  38.     }
  40.     public function reset(): void
  41.     {
  42.         $this->databaseTemplateCache = [];
  43.     }
  45.     public function getSourceContext(string $name): Source
  46.     {
  47.         $template = $this->findDatabaseTemplate($name);
  49.         if (!$template) {
  50.             throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
  51.         }
  53.         return new Source($template['template'], $name);
  54.     }
  56.     public function getCacheKey(string $name): string
  57.     {
  58.         return $name;
  59.     }
  61.     public function isFresh(string $name, int $time): bool
  62.     {
  63.         $template = $this->findDatabaseTemplate($name);
  64.         if (!$template) {
  65.             return false;
  66.         }
  68.         return $template['updatedAt'] === null || $template['updatedAt']->getTimestamp() < $time;
  69.     }
  71.     /**
  72.      * @return bool
  73.      */
  74.     public function exists(string $name)
  75.     {
  76.         $template = $this->findDatabaseTemplate($name);
  77.         if (!$template) {
  78.             return false;
  79.         }
  81.         return true;
  82.     }
  84.     /**
  85.      * @return array{template: string, updatedAt: \DateTimeInterface|null}|null
  86.      */
  87.     private function findDatabaseTemplate(string $name): ?array
  88.     {
  89.         if (EnvironmentHelper::getVariable('DISABLE_EXTENSIONS', false)) {
  90.             return null;
  91.         }
  93.         /*
  94.          * In dev env app templates are directly loaded over the filesystem
  95.          * @see TwigLoaderConfigCompilerPass::addAppTemplatePaths()
  96.          */
  97.         if ($this->environment === 'dev') {
  98.             return null;
  99.         }
  101.         $templateName = $this->splitTemplateName($name);
  102.         $namespace = $templateName['namespace'];
  103.         $path = $templateName['path'];
  105.         if (empty($this->databaseTemplateCache)) {
  106.             /** @var array<array{path: string, template: string, updatedAt: string|null, namespace: string}> $templates */
  107.             $templates = $this->connection->fetchAllAssociative('
  108.                 SELECT
  109.                     `app_template`.`path` AS `path`,
  110.                     `app_template`.`template` AS `template`,
  111.                     `app_template`.`updated_at` AS `updatedAt`,
  112.                     `app`.`name` AS `namespace`
  113.                 FROM `app_template`
  114.                 INNER JOIN `app` ON `app_template`.`app_id` = `app`.`id`
  115.                 WHERE `app_template`.`active` = 1 AND `app`.`active` = 1
  116.             ');
  118.             foreach ($templates as $template) {
  119.                 $this->databaseTemplateCache[$template['path']][$template['namespace']] = [
  120.                     'template' => $template['template'],
  121.                     'updatedAt' => $template['updatedAt'] ? new \DateTimeImmutable($template['updatedAt']) : null,
  122.                 ];
  123.             }
  124.         }
  126.         if (\array_key_exists($path, $this->databaseTemplateCache) && \array_key_exists($namespace, $this->databaseTemplateCache[$path])) {
  127.             return $this->databaseTemplateCache[$path][$namespace];
  128.         }
  130.         // we have already loaded all DB templates
  131.         // if the namespace is not included return null
  132.         return $this->databaseTemplateCache[$path][$namespace] = null;
  133.     }
  135.     /**
  136.      * @return array{namespace: string, path: string}
  137.      */
  138.     private function splitTemplateName(string $template): array
  139.     {
  140.         // remove static template inheritance prefix
  141.         if (mb_strpos($template, '@') !== 0) {
  142.             return ['path' => $template, 'namespace' => ''];
  143.         }
  145.         // remove "@"
  146.         $template = mb_substr($template, 1);
  148.         $template = explode('/', $template);
  149.         $namespace = array_shift($template);
  150.         $template = implode('/', $template);
  152.         return ['path' => $template, 'namespace' => $namespace];
  153.     }
  154. }