src/Core/Framework/Script/Execution/ScriptLoader.php line 61

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Script\Execution;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\DevOps\Environment\EnvironmentHelper;
  7. use Shopware\Core\Framework\Adapter\Cache\CacheCompressor;
  8. use Shopware\Core\Framework\App\Lifecycle\Persister\ScriptPersister;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Doctrine\FetchModeHelper;
  10. use Shopware\Core\Framework\Log\Package;
  11. use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. use Twig\Cache\FilesystemCache;
  15. /**
  16.  * @internal only for use by the app-system
  17.  *
  18.  * @phpstan-type ScriptInfo = array{app_id: ?string, scriptName: string, script: string, hook: string, appName: ?string, integrationId: ?string, lastModified: string, appVersion: string, active: bool}
  19.  * @phpstan-type IncludesInfo = array{app_id: ?string, name: string, script: string, appName: ?string, integrationId: ?string, lastModified: string}
  20.  */
  21. #[Package('core')]
  22. class ScriptLoader implements EventSubscriberInterface
  23. {
  24.     final public const CACHE_KEY = 'shopware-app-scripts';
  26.     private readonly string $cacheDir;
  28.     public function __construct(
  29.         private readonly Connection $connection,
  30.         private readonly ScriptPersister $scriptPersister,
  31.         private readonly TagAwareAdapterInterface $cache,
  32.         string $cacheDir,
  33.         private readonly bool $debug
  34.     ) {
  35.         $this->cacheDir = $cacheDir . '/scripts';
  36.     }
  38.     public static function getSubscribedEvents(): array
  39.     {
  40.         return ['script.written' => 'invalidateCache'];
  41.     }
  43.     /**
  44.      * @return Script[]
  45.      */
  46.     public function get(string $hook): array
  47.     {
  48.         $cacheItem = $this->cache->getItem(self::CACHE_KEY);
  49.         if ($cacheItem->isHit() && $cacheItem->get() && !$this->debug) {
  50.             return CacheCompressor::uncompress($cacheItem)[$hook] ?? [];
  51.         }
  53.         $scripts = $this->load();
  55.         $cacheItem = CacheCompressor::compress($cacheItem, $scripts);
  56.         $this->cache->save($cacheItem);
  58.         return $scripts[$hook] ?? [];
  59.     }
  61.     public function invalidateCache(): void
  62.     {
  63.         $this->cache->deleteItem(self::CACHE_KEY);
  64.     }
  66.     /**
  67.      * @return array<string, list<Script>>
  68.      */
  69.     private function load(): array
  70.     {
  71.         if ($this->debug) {
  72.             $this->scriptPersister->refresh();
  73.         }
  75.         /** @var list<ScriptInfo> $scripts */
  76.         $scripts = $this->connection->fetchAllAssociative('
  77.             SELECT LOWER(HEX(`script`.`app_id`)) as `app_id`,
  78.                    `script`.`name` AS scriptName,
  79.                    `script`.`script` AS script,
  80.                    `script`.`hook` AS hook,
  81.                    IFNULL(`script`.`updated_at`, `script`.`created_at`) AS lastModified,
  82.                    `app`.`name` AS appName,
  83.                    LOWER(HEX(`app`.`integration_id`)) AS integrationId,
  84.                    `app`.`version` AS appVersion,
  85.                    `script`.`active` AS active
  86.             FROM `script`
  87.             LEFT JOIN `app` ON `script`.`app_id` = `app`.`id`
  88.             WHERE `script`.`hook` != \'include\'
  89.             ORDER BY `app`.`created_at`, `app`.`id`, `script`.`name`
  90.         ');
  92.         $includes = $this->connection->fetchAllAssociative('
  93.             SELECT LOWER(HEX(`script`.`app_id`)) as `app_id`,
  94.                    `script`.`name` AS name,
  95.                    `script`.`script` AS script,
  96.                    `app`.`name` AS appName,
  97.                    LOWER(HEX(`app`.`integration_id`)) AS integrationId,
  98.                    IFNULL(`script`.`updated_at`, `script`.`created_at`) AS lastModified
  99.             FROM `script`
  100.             LEFT JOIN `app` ON `script`.`app_id` = `app`.`id`
  101.             WHERE `script`.`hook` = \'include\'
  102.             ORDER BY `app`.`created_at`, `app`.`id`, `script`.`name`
  103.         ');
  105.         /** @var array<string, list<IncludesInfo>> $allIncludes */
  106.         $allIncludes = FetchModeHelper::group($includes);
  108.         $executableScripts = [];
  109.         foreach ($scripts as $script) {
  110.             $appId = $script['app_id'];
  112.             $includes = $allIncludes[$appId] ?? [];
  114.             $dates = [...[$script['lastModified']], ...array_column($includes, 'lastModified')];
  116.             /** @var \DateTimeInterface $lastModified */
  117.             $lastModified = new \DateTimeImmutable(max($dates));
  119.             /** @var string $cachePrefix */
  120.             $cachePrefix = $script['appName'] ? md5($script['appName'] . $script['appVersion']) : EnvironmentHelper::getVariable('INSTANCE_ID', '');
  122.             $includes = array_map(function (array $script) use ($appId) {
  123.                 $script['app_id'] = $appId;
  125.                 return new Script(
  126.                     $script['name'],
  127.                     $script['script'],
  128.                     new \DateTimeImmutable($script['lastModified']),
  129.                     $this->getAppInfo($script)
  130.                 );
  131.             }, $includes);
  133.             $options = [];
  134.             if (!$this->debug) {
  135.                 $options['cache'] = new FilesystemCache($this->cacheDir . '/' . $cachePrefix);
  136.             } else {
  137.                 $options['debug'] = true;
  138.             }
  140.             $executableScripts[$script['hook']][] = new Script(
  141.                 $script['scriptName'],
  142.                 $script['script'],
  143.                 $lastModified,
  144.                 $this->getAppInfo($script),
  145.                 $options,
  146.                 $includes,
  147.                 (bool) $script['active']
  148.             );
  149.         }
  151.         return $executableScripts;
  152.     }
  154.     /**
  155.      * @param ScriptInfo|IncludesInfo $script
  156.      */
  157.     private function getAppInfo(array $script): ?ScriptAppInformation
  158.     {
  159.         if (!$script['app_id'] || !$script['appName'] || !$script['integrationId']) {
  160.             return null;
  161.         }
  163.         return new ScriptAppInformation(
  164.             $script['app_id'],
  165.             $script['appName'],
  166.             $script['integrationId']
  167.         );
  168.     }
  169. }