vendor/shopware/storefront/Theme/Subscriber/PluginLifecycleSubscriber.php line 58

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Theme\Subscriber;
  5. use Shopware\Core\Framework\Context;
  6. use Shopware\Core\Framework\Log\Package;
  7. use Shopware\Core\Framework\Plugin;
  8. use Shopware\Core\Framework\Plugin\Event\PluginLifecycleEvent;
  9. use Shopware\Core\Framework\Plugin\Event\PluginPostActivateEvent;
  10. use Shopware\Core\Framework\Plugin\Event\PluginPostDeactivationFailedEvent;
  11. use Shopware\Core\Framework\Plugin\Event\PluginPostUninstallEvent;
  12. use Shopware\Core\Framework\Plugin\Event\PluginPreDeactivateEvent;
  13. use Shopware\Core\Framework\Plugin\Event\PluginPreUninstallEvent;
  14. use Shopware\Core\Framework\Plugin\Event\PluginPreUpdateEvent;
  15. use Shopware\Core\Framework\Plugin\PluginLifecycleService;
  16. use Shopware\Storefront\Theme\Exception\InvalidThemeBundleException;
  17. use Shopware\Storefront\Theme\Exception\ThemeCompileException;
  18. use Shopware\Storefront\Theme\StorefrontPluginConfiguration\AbstractStorefrontPluginConfigurationFactory;
  19. use Shopware\Storefront\Theme\StorefrontPluginConfiguration\StorefrontPluginConfiguration;
  20. use Shopware\Storefront\Theme\StorefrontPluginRegistryInterface;
  21. use Shopware\Storefront\Theme\ThemeLifecycleHandler;
  22. use Shopware\Storefront\Theme\ThemeLifecycleService;
  23. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  25. /**
  26.  * @internal
  27.  */
  28. #[Package('storefront')]
  29. class PluginLifecycleSubscriber implements EventSubscriberInterface
  30. {
  31.     /**
  32.      * @internal
  33.      */
  34.     public function __construct(
  35.         private readonly StorefrontPluginRegistryInterface $storefrontPluginRegistry,
  36.         private readonly string $projectDirectory,
  37.         private readonly AbstractStorefrontPluginConfigurationFactory $pluginConfigurationFactory,
  38.         private readonly ThemeLifecycleHandler $themeLifecycleHandler,
  39.         private readonly ThemeLifecycleService $themeLifecycleService
  40.     ) {
  41.     }
  43.     /**
  44.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  45.      */
  46.     public static function getSubscribedEvents(): array
  47.     {
  48.         return [
  49.             PluginPostActivateEvent::class => 'pluginPostActivate',
  50.             PluginPreUpdateEvent::class => 'pluginUpdate',
  51.             PluginPreDeactivateEvent::class => 'pluginDeactivateAndUninstall',
  52.             PluginPostDeactivationFailedEvent::class => 'pluginPostDeactivateFailed',
  53.             PluginPreUninstallEvent::class => 'pluginDeactivateAndUninstall',
  54.             PluginPostUninstallEvent::class => 'pluginPostUninstall',
  55.         ];
  56.     }
  58.     public function pluginPostActivate(PluginPostActivateEvent $event): void
  59.     {
  60.         $this->doPostActivate($event);
  61.     }
  63.     public function pluginPostDeactivateFailed(PluginPostDeactivationFailedEvent $event): void
  64.     {
  65.         $this->doPostActivate($event);
  66.     }
  68.     public function pluginUpdate(PluginPreUpdateEvent $event): void
  69.     {
  70.         if ($this->skipCompile($event->getContext()->getContext())) {
  71.             return;
  72.         }
  74.         $pluginName = $event->getPlugin()->getName();
  75.         $config = $this->storefrontPluginRegistry->getConfigurations()->getByTechnicalName($pluginName);
  77.         if (!$config) {
  78.             return;
  79.         }
  81.         $this->themeLifecycleHandler->handleThemeInstallOrUpdate(
  82.             $config,
  83.             $this->storefrontPluginRegistry->getConfigurations(),
  84.             $event->getContext()->getContext()
  85.         );
  86.     }
  88.     public function pluginDeactivateAndUninstall(PluginPreDeactivateEvent|PluginPreUninstallEvent $event): void
  89.     {
  90.         if ($this->skipCompile($event->getContext()->getContext())) {
  91.             return;
  92.         }
  94.         $pluginName = $event->getPlugin()->getName();
  95.         $config = $this->storefrontPluginRegistry->getConfigurations()->getByTechnicalName($pluginName);
  97.         if (!$config) {
  98.             return;
  99.         }
  101.         $this->themeLifecycleHandler->handleThemeUninstall($config, $event->getContext()->getContext());
  102.     }
  104.     public function pluginPostUninstall(PluginPostUninstallEvent $event): void
  105.     {
  106.         if ($event->getContext()->keepUserData()) {
  107.             return;
  108.         }
  110.         $this->themeLifecycleService->removeTheme($event->getPlugin()->getName(), $event->getContext()->getContext());
  111.     }
  113.     /**
  114.      * @throws ThemeCompileException
  115.      * @throws InvalidThemeBundleException
  116.      */
  117.     private function createConfigFromClassName(string $pluginPath, string $className): StorefrontPluginConfiguration
  118.     {
  119.         /** @var Plugin $plugin */
  120.         $plugin = new $className(true, $pluginPath, $this->projectDirectory);
  122.         if (!$plugin instanceof Plugin) {
  123.             throw new \RuntimeException(
  124.                 sprintf('Plugin class "%s" must extend "%s"', $plugin::class, Plugin::class)
  125.             );
  126.         }
  128.         return $this->pluginConfigurationFactory->createFromBundle($plugin);
  129.     }
  131.     private function doPostActivate(PluginLifecycleEvent $event): void
  132.     {
  133.         if (!($event instanceof PluginPostActivateEvent) && !($event instanceof PluginPostDeactivationFailedEvent)) {
  134.             return;
  135.         }
  137.         if ($this->skipCompile($event->getContext()->getContext())) {
  138.             return;
  139.         }
  141.         // create instance of the plugin to create a configuration
  142.         // (the kernel boot is already finished and the activated plugin is missing)
  143.         $storefrontPluginConfig = $this->createConfigFromClassName(
  144.             $event->getPlugin()->getPath() ?: '',
  145.             $event->getPlugin()->getBaseClass()
  146.         );
  148.         // ensure plugin configuration is in the list of all active plugin configurations
  149.         $configurationCollection = clone $this->storefrontPluginRegistry->getConfigurations();
  150.         $configurationCollection->add($storefrontPluginConfig);
  152.         $this->themeLifecycleHandler->handleThemeInstallOrUpdate(
  153.             $storefrontPluginConfig,
  154.             $configurationCollection,
  155.             $event->getContext()->getContext()
  156.         );
  157.     }
  159.     private function skipCompile(Context $context): bool
  160.     {
  161.         return $context->hasState(PluginLifecycleService::STATE_SKIP_ASSET_BUILDING);
  162.     }
  163. }