src/Core/Framework/App/Lifecycle/Persister/ScriptPersister.php line 27

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\App\Lifecycle\Persister;
  5. use Shopware\Core\Framework\App\AppEntity;
  6. use Shopware\Core\Framework\App\Lifecycle\ScriptFileReaderInterface;
  7. use Shopware\Core\Framework\Context;
  8. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  11. use Shopware\Core\Framework\Log\Package;
  12. use Shopware\Core\Framework\Script\ScriptCollection;
  13. use Shopware\Core\Framework\Script\ScriptEntity;
  15. /**
  16.  * @internal only for use by the app-system
  17.  */
  18. #[Package('core')]
  19. class ScriptPersister
  20. {
  21.     public function __construct(private readonly ScriptFileReaderInterface $scriptReader, private readonly EntityRepository $scriptRepository, private readonly EntityRepository $appRepository)
  22.     {
  23.     }
  25.     public function updateScripts(string $appId, Context $context): void
  26.     {
  27.         $app = $this->getAppWithExistingScripts($appId, $context);
  29.         /** @var ScriptCollection $existingScripts */
  30.         $existingScripts = $app->getScripts();
  32.         $scriptPaths = $this->scriptReader->getScriptPathsForApp($app->getPath());
  34.         $upserts = [];
  35.         foreach ($scriptPaths as $scriptPath) {
  36.             $payload = [
  37.                 'script' => $this->scriptReader->getScriptContent($scriptPath, $app->getPath()),
  38.             ];
  40.             /** @var ScriptEntity|null $existing */
  41.             $existing = $existingScripts->filterByProperty('name', $scriptPath)->first();
  42.             if ($existing) {
  43.                 $existingScripts->remove($existing->getId());
  45.                 if ($existing->getScript() === $payload['script']) {
  46.                     // Don't update DB when content is identical
  47.                     continue;
  48.                 }
  49.                 $payload['id'] = $existing->getId();
  50.             } else {
  51.                 $payload['appId'] = $appId;
  52.                 $payload['active'] = $app->isActive();
  53.                 $payload['name'] = $scriptPath;
  54.                 $payload['hook'] = explode('/', $scriptPath)[0];
  55.             }
  57.             $upserts[] = $payload;
  58.         }
  60.         if (!empty($upserts)) {
  61.             $this->scriptRepository->upsert($upserts, $context);
  62.         }
  64.         $this->deleteOldScripts($existingScripts, $context);
  65.     }
  67.     public function activateAppScripts(string $appId, Context $context): void
  68.     {
  69.         $criteria = new Criteria();
  70.         $criteria->setTitle('app-scripts::activate');
  71.         $criteria->addFilter(new EqualsFilter('appId', $appId));
  72.         $criteria->addFilter(new EqualsFilter('active', false));
  74.         /** @var array<string> $scripts */
  75.         $scripts = $this->scriptRepository->searchIds($criteria, $context)->getIds();
  77.         $updateSet = array_map(fn (string $id) => ['id' => $id, 'active' => true], $scripts);
  79.         $this->scriptRepository->update($updateSet, $context);
  80.     }
  82.     public function deactivateAppScripts(string $appId, Context $context): void
  83.     {
  84.         $criteria = new Criteria();
  85.         $criteria->setTitle('app-scripts::deactivate');
  86.         $criteria->addFilter(new EqualsFilter('appId', $appId));
  87.         $criteria->addFilter(new EqualsFilter('active', true));
  89.         /** @var array<string> $scripts */
  90.         $scripts = $this->scriptRepository->searchIds($criteria, $context)->getIds();
  92.         $updateSet = array_map(fn (string $id) => ['id' => $id, 'active' => false], $scripts);
  94.         $this->scriptRepository->update($updateSet, $context);
  95.     }
  97.     public function refresh(): void
  98.     {
  99.         $criteria = new Criteria();
  100.         $criteria->setTitle('app-scripts::refresh');
  101.         $criteria->addFilter(new EqualsFilter('active', true));
  103.         $apps = $this->appRepository->search($criteria, Context::createDefaultContext())->getEntities();
  105.         /** @var AppEntity $app */
  106.         foreach ($apps as $app) {
  107.             $this->updateScripts($app->getId(), Context::createDefaultContext());
  108.         }
  109.     }
  111.     private function deleteOldScripts(ScriptCollection $toBeRemoved, Context $context): void
  112.     {
  113.         /** @var array<string> $ids */
  114.         $ids = $toBeRemoved->getIds();
  116.         if (!empty($ids)) {
  117.             $ids = array_map(static fn (string $id): array => ['id' => $id], array_values($ids));
  119.             $this->scriptRepository->delete($ids, $context);
  120.         }
  121.     }
  123.     private function getAppWithExistingScripts(string $appId, Context $context): AppEntity
  124.     {
  125.         $criteria = new Criteria([$appId]);
  126.         $criteria->addAssociation('scripts');
  128.         /** @var AppEntity $app */
  129.         $app = $this->appRepository->search($criteria, $context)->first();
  131.         return $app;
  132.     }
  133. }