custom/plugins/PickwareWms/src/PickwareWms.php line 42

Open in your IDE?
  1. <?php
  2. /*
  3.  * Copyright (c) Pickware GmbH. All rights reserved.
  4.  * This file is part of software that is released under a proprietary license.
  5.  * You must not copy, modify, distribute, make publicly available, or execute
  6.  * its contents or parts thereof without express permission by the copyright
  7.  * holder, unless otherwise permitted by law.
  8.  */
  10. declare(strict_types=1);
  12. namespace Pickware\PickwareWms;
  14. use Doctrine\DBAL\Connection;
  15. use Pickware\BundleInstaller\BundleInstaller;
  16. use Pickware\DalBundle\DalBundle;
  17. use Pickware\DocumentBundle\DocumentBundle;
  18. use Pickware\MobileAppAuthBundle\PickwareMobileAppAuthBundle;
  19. use Pickware\PickwareWms\Installation\PickwareWmsInstaller;
  20. use Pickware\ShopwareExtensionsBundle\PickwareShopwareExtensionsBundle;
  21. use Pickware\ValidationBundle\PickwareValidationBundle;
  22. use Shopware\Core\Framework\Bundle;
  23. use Shopware\Core\Framework\Migration\MigrationCollectionLoader;
  24. use Shopware\Core\Framework\Migration\MigrationRuntime;
  25. use Shopware\Core\Framework\Migration\MigrationSource;
  26. use Shopware\Core\Framework\Parameter\AdditionalBundleParameters;
  27. use Shopware\Core\Framework\Plugin;
  28. use Shopware\Core\Framework\Plugin\Context\ActivateContext;
  29. use Shopware\Core\Framework\Plugin\Context\InstallContext;
  30. use Shopware\Core\Framework\Plugin\Context\UninstallContext;
  31. use Shopware\Core\Framework\Plugin\Context\UpdateContext;
  32. use Shopware\Core\Framework\Struct\Collection;
  33. use Symfony\Bridge\Monolog\Logger;
  34. use Symfony\Component\Config\FileLocator;
  35. use Symfony\Component\DependencyInjection\ContainerBuilder;
  36. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  38. if (file_exists(__DIR__ . '/../vendor/pickware/dependency-loader/src/DependencyLoader.php')) {
  39.     require_once __DIR__ . '/../vendor/pickware/dependency-loader/src/DependencyLoader.php';
  40. }
  42. class PickwareWms extends Plugin
  43. {
  44.     public const GLOBAL_PLUGIN_CONFIG_DOMAIN = 'PickwareWms.global-plugin-config';
  46.     /**
  47.      * Note that the PickwareShippingBundle is a composer dependency of this plugin. But it is not loaded (it is not
  48.      * part of this bundle list).
  49.      * This is because we have a conflict to older versions of the PickwareShippingBundle (conflict with version <1.5.0)
  50.      * which we cannot properly ensure in the Shopware plugin system. By shipping the code without loading it we ensure
  51.      * that, when a shipping adapter is loading the PickwareShippingBundle, this new version is loaded. See this issue
  52.      * for more details: https://github.com/pickware/shopware-plugins/issues/2755
  53.      *
  54.      * @var class-string<Bundle>[]
  55.      */
  56.     private const ADDITIONAL_BUNDLES = [
  57.         DalBundle::class,
  58.         DocumentBundle::class,
  59.         PickwareMobileAppAuthBundle::class,
  60.         PickwareShopwareExtensionsBundle::class,
  61.         PickwareValidationBundle::class,
  62.     ];
  64.     public function getAdditionalBundles(AdditionalBundleParameters $parameters): array
  65.     {
  66.         // Ensure the bundle classes can be loaded via auto-loading.
  67.         if (isset($GLOBALS['PICKWARE_DEPENDENCY_LOADER'])) {
  68.             $kernelParameters = $parameters->getKernelParameters();
  69.             $GLOBALS['PICKWARE_DEPENDENCY_LOADER']->ensureLatestDependenciesOfPluginsLoaded(
  70.                 $kernelParameters['kernel.plugin_infos'],
  71.                 $kernelParameters['kernel.project_dir'],
  72.             );
  73.         }
  75.         // For some reason Collection is abstract
  76.         // phpcs:ignore Squiz.WhiteSpace.ScopeClosingBrace.ContentBefore -- PHP CS does not understand the PHP 7 syntax
  77.         $bundleCollection = new class() extends Collection {};
  78.         foreach (self::ADDITIONAL_BUNDLES as $bundle) {
  79.             $bundle::register($bundleCollection);
  80.         }
  82.         return $bundleCollection->getElements();
  83.     }
  85.     public static function getDistPackages(): array
  86.     {
  87.         return include __DIR__ . '/../Packages.php';
  88.     }
  90.     public function build(ContainerBuilder $containerBuilder): void
  91.     {
  92.         parent::build($containerBuilder);
  94.         $loader = new XmlFileLoader($containerBuilder, new FileLocator(__DIR__));
  95.         $loader->load('Config/DependencyInjection/controller.xml');
  96.         $loader->load('Config/DependencyInjection/service.xml');
  97.         $loader->load('Installation/DependencyInjection/service.xml');
  98.         $loader->load('PickingProcess/DependencyInjection/controller.xml');
  99.         $loader->load('PickingProcess/DependencyInjection/model.xml');
  100.         $loader->load('PickingProcess/DependencyInjection/model-extension.xml');
  101.         $loader->load('PickingProcess/DependencyInjection/service.xml');
  102.     }
  104.     public function install(InstallContext $installContext): void
  105.     {
  106.         $this->loadDependenciesForSetup();
  108.         $this->executeMigrationsOfBundles();
  110.         BundleInstaller::createForContainerAndClass($this->container, self::class)
  111.             ->install(self::ADDITIONAL_BUNDLES, $installContext);
  112.     }
  114.     public function postInstall(InstallContext $installContext): void
  115.     {
  116.         $installer = PickwareWmsInstaller::initFromContainer($this->container);
  117.         $installer->postInstall();
  118.     }
  120.     public function update(UpdateContext $updateContext): void
  121.     {
  122.         $this->loadDependenciesForSetup();
  124.         $this->executeMigrationsOfBundles();
  126.         BundleInstaller::createForContainerAndClass($this->container, self::class)
  127.             ->install(self::ADDITIONAL_BUNDLES, $updateContext);
  128.     }
  130.     public function postUpdate(UpdateContext $updateContext): void
  131.     {
  132.         $installer = PickwareWmsInstaller::initFromContainer($this->container);
  133.         $installer->postUpdate();
  135.         if ($updateContext->getPlugin()->isActive()) {
  136.             $this->container
  137.                 ->get('pickware_wms.bundle_supporting_asset_service')
  138.                 ->copyAssetsFromBundle('PickwareMobileAppAuthBundle');
  140.             BundleInstaller::createForContainerAndClass($this->container, self::class)
  141.                 ->onAfterActivate(self::ADDITIONAL_BUNDLES, $updateContext);
  142.         }
  143.     }
  145.     private function executeMigrationsOfBundles(): void
  146.     {
  147.         // All the services required for migration execution are private in the DI-Container. As a workaround the
  148.         // services are instantiated explicitly here.
  149.         $db = $this->container->get(Connection::class);
  150.         // See vendor/symfony/monolog-bundle/Resources/config/monolog.xml on how the logger is defined.
  151.         $logger = new Logger('app');
  152.         $logger->useMicrosecondTimestamps($this->container->getParameter('monolog.use_microseconds'));
  153.         $migrationCollectionLoader = new MigrationCollectionLoader($db, new MigrationRuntime($db, $logger));
  154.         $migrationSource = new MigrationSource('PickwareWms');
  156.         foreach (self::ADDITIONAL_BUNDLES as $bundle) {
  157.             $bundle::registerMigrations($migrationSource);
  158.         }
  159.         $migrationCollectionLoader->addSource($migrationSource);
  161.         foreach ($migrationCollectionLoader->collectAll() as $migrationCollection) {
  162.             $migrationCollection->sync();
  163.             $migrationCollection->migrateInPlace();
  164.         }
  165.     }
  167.     public function uninstall(UninstallContext $uninstallContext): void
  168.     {
  169.         parent::uninstall($uninstallContext);
  171.         if ($uninstallContext->keepUserData()) {
  172.             return;
  173.         }
  175.         $this->loadDependenciesForSetup();
  177.         $this->container->get(Connection::class)->exec('
  178.             SET FOREIGN_KEY_CHECKS = 0;
  180.             -- Migration1649747949AddPickingProcessSchema.php
  181.             DROP TABLE IF EXISTS `pickware_wms_picking_process`;
  182.             DROP TABLE IF EXISTS `pickware_wms_picking_process_tracking_code`;
  183.             DROP TABLE IF EXISTS `pickware_wms_picking_process_reserved_item`;
  184.             DROP TABLE IF EXISTS `pickware_wms_picking_process_order_document_mapping`;
  185.             DROP TABLE IF EXISTS `pickware_wms_picking_process_document_mapping`;
  187.             SET FOREIGN_KEY_CHECKS = 1;
  188.         ');
  190.         BundleInstaller::createForContainerAndClass($this->container, self::class)->uninstall($uninstallContext);
  191.     }
  193.     public function activate(ActivateContext $activateContext): void
  194.     {
  195.         BundleInstaller::createForContainerAndClass($this->container, self::class)
  196.             ->onAfterActivate(self::ADDITIONAL_BUNDLES, $activateContext);
  198.         $this->container
  199.             ->get('pickware_wms.bundle_supporting_asset_service')
  200.             ->copyAssetsFromBundle('PickwareMobileAppAuthBundle');
  201.     }
  203.     /**
  204.      * Run the dependency loader for a setup step like install/update/uninstall
  205.      *
  206.      * When executing one of these steps but no Pickware plugin is activated, the dependency loader did never run until
  207.      * the call of the corresponding method. You can trigger it with a call of this method.
  208.      */
  209.     private function loadDependenciesForSetup(): void
  210.     {
  211.         if (isset($GLOBALS['PICKWARE_DEPENDENCY_LOADER'])) {
  212.             $plugins = $this->container->get('kernel')->getPluginLoader()->getPluginInfos();
  213.             $projectDir = $this->container->getParameter('kernel.project_dir');
  214.             $GLOBALS['PICKWARE_DEPENDENCY_LOADER']->ensureLatestDependenciesOfPluginsLoaded($plugins, $projectDir);
  215.         }
  216.     }
  217. }