src/Storefront/Theme/Subscriber/PluginLifecycleSubscriber.php line 63

  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(private readonly StorefrontPluginRegistryInterface $storefrontPluginRegistry, private readonly string $projectDirectory, private readonly AbstractStorefrontPluginConfigurationFactory $pluginConfigurationFactory, private readonly ThemeLifecycleHandler $themeLifecycleHandler, private readonly ThemeLifecycleService $themeLifecycleService)
  35.     {
  36.     }
  38.     /**
  39.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  40.      */
  41.     public static function getSubscribedEvents(): array
  42.     {
  43.         return [
  44.             PluginPostActivateEvent::class => 'pluginPostActivate',
  45.             PluginPreUpdateEvent::class => 'pluginUpdate',
  46.             PluginPreDeactivateEvent::class => 'pluginDeactivateAndUninstall',
  47.             PluginPostDeactivationFailedEvent::class => 'pluginPostDeactivateFailed',
  48.             PluginPreUninstallEvent::class => 'pluginDeactivateAndUninstall',
  49.             PluginPostUninstallEvent::class => 'pluginPostUninstall',
  50.         ];
  51.     }
  53.     public function pluginPostActivate(PluginPostActivateEvent $event): void
  54.     {
  55.         $this->doPostActivate($event);
  56.     }
  58.     public function pluginPostDeactivateFailed(PluginPostDeactivationFailedEvent $event): void
  59.     {
  60.         $this->doPostActivate($event);
  61.     }
  63.     public function pluginUpdate(PluginPreUpdateEvent $event): void
  64.     {
  65.         if ($this->skipCompile($event->getContext()->getContext())) {
  66.             return;
  67.         }
  69.         $pluginName = $event->getPlugin()->getName();
  70.         $config = $this->storefrontPluginRegistry->getConfigurations()->getByTechnicalName($pluginName);
  72.         if (!$config) {
  73.             return;
  74.         }
  76.         $this->themeLifecycleHandler->handleThemeInstallOrUpdate(
  77.             $config,
  78.             $this->storefrontPluginRegistry->getConfigurations(),
  79.             $event->getContext()->getContext()
  80.         );
  81.     }
  83.     public function pluginDeactivateAndUninstall(PluginPreDeactivateEvent|PluginPreUninstallEvent $event): void
  84.     {
  85.         if ($this->skipCompile($event->getContext()->getContext())) {
  86.             return;
  87.         }
  89.         $pluginName = $event->getPlugin()->getName();
  90.         $config = $this->storefrontPluginRegistry->getConfigurations()->getByTechnicalName($pluginName);
  92.         if (!$config) {
  93.             return;
  94.         }
  96.         $this->themeLifecycleHandler->handleThemeUninstall($config, $event->getContext()->getContext());
  97.     }
  99.     public function pluginPostUninstall(PluginPostUninstallEvent $event): void
  100.     {
  101.         if ($event->getContext()->keepUserData()) {
  102.             return;
  103.         }
  105.         $this->themeLifecycleService->removeTheme($event->getPlugin()->getName(), $event->getContext()->getContext());
  106.     }
  108.     /**
  109.      * @throws ThemeCompileException
  110.      * @throws InvalidThemeBundleException
  111.      */
  112.     private function createConfigFromClassName(string $pluginPath, string $className): StorefrontPluginConfiguration
  113.     {
  114.         /** @var Plugin $plugin */
  115.         $plugin = new $className(true, $pluginPath, $this->projectDirectory);
  117.         if (!$plugin instanceof Plugin) {
  118.             throw new \RuntimeException(
  119.                 sprintf('Plugin class "%s" must extend "%s"', $plugin::class, Plugin::class)
  120.             );
  121.         }
  123.         return $this->pluginConfigurationFactory->createFromBundle($plugin);
  124.     }
  126.     private function doPostActivate(PluginLifecycleEvent $event): void
  127.     {
  128.         if (!($event instanceof PluginPostActivateEvent) && !($event instanceof PluginPostDeactivationFailedEvent)) {
  129.             return;
  130.         }
  132.         if ($this->skipCompile($event->getContext()->getContext())) {
  133.             return;
  134.         }
  136.         // create instance of the plugin to create a configuration
  137.         // (the kernel boot is already finished and the activated plugin is missing)
  138.         $storefrontPluginConfig = $this->createConfigFromClassName(
  139.             $event->getPlugin()->getPath() ?: '',
  140.             $event->getPlugin()->getBaseClass()
  141.         );
  143.         // ensure plugin configuration is in the list of all active plugin configurations
  144.         $configurationCollection = clone $this->storefrontPluginRegistry->getConfigurations();
  145.         $configurationCollection->add($storefrontPluginConfig);
  147.         $this->themeLifecycleHandler->handleThemeInstallOrUpdate(
  148.             $storefrontPluginConfig,
  149.             $configurationCollection,
  150.             $event->getContext()->getContext()
  151.         );
  152.     }
  154.     private function skipCompile(Context $context): bool
  155.     {
  156.         return $context->hasState(PluginLifecycleService::STATE_SKIP_ASSET_BUILDING);
  157.     }
  158. }