vendor/shopware/core/Framework/App/Lifecycle/Persister/ScriptPersister.php line 106

  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(
  22.         private readonly ScriptFileReaderInterface $scriptReader,
  23.         private readonly EntityRepository $scriptRepository,
  24.         private readonly EntityRepository $appRepository
  25.     ) {
  26.     }
  28.     public function updateScripts(string $appId, Context $context): void
  29.     {
  30.         $app = $this->getAppWithExistingScripts($appId, $context);
  32.         /** @var ScriptCollection $existingScripts */
  33.         $existingScripts = $app->getScripts();
  35.         $scriptPaths = $this->scriptReader->getScriptPathsForApp($app->getPath());
  37.         $upserts = [];
  38.         foreach ($scriptPaths as $scriptPath) {
  39.             $payload = [
  40.                 'script' => $this->scriptReader->getScriptContent($scriptPath, $app->getPath()),
  41.             ];
  43.             /** @var ScriptEntity|null $existing */
  44.             $existing = $existingScripts->filterByProperty('name', $scriptPath)->first();
  45.             if ($existing) {
  46.                 $existingScripts->remove($existing->getId());
  48.                 if ($existing->getScript() === $payload['script']) {
  49.                     // Don't update DB when content is identical
  50.                     continue;
  51.                 }
  52.                 $payload['id'] = $existing->getId();
  53.             } else {
  54.                 $payload['appId'] = $appId;
  55.                 $payload['active'] = $app->isActive();
  56.                 $payload['name'] = $scriptPath;
  57.                 $payload['hook'] = explode('/', $scriptPath)[0];
  58.             }
  60.             $upserts[] = $payload;
  61.         }
  63.         if (!empty($upserts)) {
  64.             $this->scriptRepository->upsert($upserts, $context);
  65.         }
  67.         $this->deleteOldScripts($existingScripts, $context);
  68.     }
  70.     public function activateAppScripts(string $appId, Context $context): void
  71.     {
  72.         $criteria = new Criteria();
  73.         $criteria->setTitle('app-scripts::activate');
  74.         $criteria->addFilter(new EqualsFilter('appId', $appId));
  75.         $criteria->addFilter(new EqualsFilter('active', false));
  77.         /** @var array<string> $scripts */
  78.         $scripts = $this->scriptRepository->searchIds($criteria, $context)->getIds();
  80.         $updateSet = array_map(fn (string $id) => ['id' => $id, 'active' => true], $scripts);
  82.         $this->scriptRepository->update($updateSet, $context);
  83.     }
  85.     public function deactivateAppScripts(string $appId, Context $context): void
  86.     {
  87.         $criteria = new Criteria();
  88.         $criteria->setTitle('app-scripts::deactivate');
  89.         $criteria->addFilter(new EqualsFilter('appId', $appId));
  90.         $criteria->addFilter(new EqualsFilter('active', true));
  92.         /** @var array<string> $scripts */
  93.         $scripts = $this->scriptRepository->searchIds($criteria, $context)->getIds();
  95.         $updateSet = array_map(fn (string $id) => ['id' => $id, 'active' => false], $scripts);
  97.         $this->scriptRepository->update($updateSet, $context);
  98.     }
  100.     public function refresh(): void
  101.     {
  102.         $criteria = new Criteria();
  103.         $criteria->setTitle('app-scripts::refresh');
  104.         $criteria->addFilter(new EqualsFilter('active', true));
  106.         $apps = $this->appRepository->search($criteria, Context::createDefaultContext())->getEntities();
  108.         /** @var AppEntity $app */
  109.         foreach ($apps as $app) {
  110.             $this->updateScripts($app->getId(), Context::createDefaultContext());
  111.         }
  112.     }
  114.     private function deleteOldScripts(ScriptCollection $toBeRemoved, Context $context): void
  115.     {
  116.         /** @var array<string> $ids */
  117.         $ids = $toBeRemoved->getIds();
  119.         if (!empty($ids)) {
  120.             $ids = array_map(static fn (string $id): array => ['id' => $id], array_values($ids));
  122.             $this->scriptRepository->delete($ids, $context);
  123.         }
  124.     }
  126.     private function getAppWithExistingScripts(string $appId, Context $context): AppEntity
  127.     {
  128.         $criteria = new Criteria([$appId]);
  129.         $criteria->addAssociation('scripts');
  131.         /** @var AppEntity $app */
  132.         $app = $this->appRepository->search($criteria, $context)->first();
  134.         return $app;
  135.     }
  136. }