src/Core/Framework/Adapter/Twig/EntityTemplateLoader.php line 38

  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(private readonly Connection $connection, private readonly string $environment)
  30.     {
  31.     }
  33.     public static function getSubscribedEvents(): array
  34.     {
  35.         return ['app_template.written' => 'reset'];
  36.     }
  38.     public function reset(): void
  39.     {
  40.         $this->databaseTemplateCache = [];
  41.     }
  43.     public function getSourceContext(string $name): Source
  44.     {
  45.         $template = $this->findDatabaseTemplate($name);
  47.         if (!$template) {
  48.             throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
  49.         }
  51.         return new Source($template['template'], $name);
  52.     }
  54.     public function getCacheKey(string $name): string
  55.     {
  56.         return $name;
  57.     }
  59.     public function isFresh(string $name, int $time): bool
  60.     {
  61.         $template = $this->findDatabaseTemplate($name);
  62.         if (!$template) {
  63.             return false;
  64.         }
  66.         return $template['updatedAt'] === null || $template['updatedAt']->getTimestamp() < $time;
  67.     }
  69.     /**
  70.      * @return bool
  71.      */
  72.     public function exists(string $name)
  73.     {
  74.         $template = $this->findDatabaseTemplate($name);
  75.         if (!$template) {
  76.             return false;
  77.         }
  79.         return true;
  80.     }
  82.     /**
  83.      * @return array{template: string, updatedAt: \DateTimeInterface|null}|null
  84.      */
  85.     private function findDatabaseTemplate(string $name): ?array
  86.     {
  87.         if (EnvironmentHelper::getVariable('DISABLE_EXTENSIONS', false)) {
  88.             return null;
  89.         }
  91.         /*
  92.          * In dev env app templates are directly loaded over the filesystem
  93.          * @see TwigLoaderConfigCompilerPass::addAppTemplatePaths()
  94.          */
  95.         if ($this->environment === 'dev') {
  96.             return null;
  97.         }
  99.         $templateName = $this->splitTemplateName($name);
  100.         $namespace = $templateName['namespace'];
  101.         $path = $templateName['path'];
  103.         if (empty($this->databaseTemplateCache)) {
  104.             /** @var array<array{path: string, template: string, updatedAt: string|null, namespace: string}> $templates */
  105.             $templates = $this->connection->fetchAllAssociative('
  106.                 SELECT
  107.                     `app_template`.`path` AS `path`,
  108.                     `app_template`.`template` AS `template`,
  109.                     `app_template`.`updated_at` AS `updatedAt`,
  110.                     `app`.`name` AS `namespace`
  111.                 FROM `app_template`
  112.                 INNER JOIN `app` ON `app_template`.`app_id` = `app`.`id`
  113.                 WHERE `app_template`.`active` = 1 AND `app`.`active` = 1
  114.             ');
  116.             foreach ($templates as $template) {
  117.                 $this->databaseTemplateCache[$template['path']][$template['namespace']] = [
  118.                     'template' => $template['template'],
  119.                     'updatedAt' => $template['updatedAt'] ? new \DateTimeImmutable($template['updatedAt']) : null,
  120.                 ];
  121.             }
  122.         }
  124.         if (\array_key_exists($path, $this->databaseTemplateCache) && \array_key_exists($namespace, $this->databaseTemplateCache[$path])) {
  125.             return $this->databaseTemplateCache[$path][$namespace];
  126.         }
  128.         // we have already loaded all DB templates
  129.         // if the namespace is not included return null
  130.         return $this->databaseTemplateCache[$path][$namespace] = null;
  131.     }
  133.     /**
  134.      * @return array{namespace: string, path: string}
  135.      */
  136.     private function splitTemplateName(string $template): array
  137.     {
  138.         // remove static template inheritance prefix
  139.         if (mb_strpos($template, '@') !== 0) {
  140.             return ['path' => $template, 'namespace' => ''];
  141.         }
  143.         // remove "@"
  144.         $template = mb_substr($template, 1);
  146.         $template = explode('/', $template);
  147.         $namespace = array_shift($template);
  148.         $template = implode('/', $template);
  150.         return ['path' => $template, 'namespace' => $namespace];
  151.     }
  152. }