<?php
/*
* Copyright (c) Pickware GmbH. All rights reserved.
* This file is part of software that is released under a proprietary license.
* You must not copy, modify, distribute, make publicly available, or execute
* its contents or parts thereof without express permission by the copyright
* holder, unless otherwise permitted by law.
*/
declare(strict_types=1);
namespace Pickware\PickwareWms;
use Doctrine\DBAL\Connection;
use Pickware\ApiErrorHandlingBundle\PickwareApiErrorHandlingBundle;
use Pickware\ApiVersioningBundle\PickwareApiVersioningBundle;
use Pickware\BundleInstaller\BundleInstaller;
use Pickware\DalBundle\DalBundle;
use Pickware\DocumentBundle\DocumentBundle;
use Pickware\InstallationLibrary\DependencyAwareTableDropper;
use Pickware\MobileAppAuthBundle\PickwareMobileAppAuthBundle;
use Pickware\PickwareWms\Installation\PickwareWmsInstaller;
use Pickware\ShopwareExtensionsBundle\PickwareShopwareExtensionsBundle;
use Pickware\ShopwarePlugins\ShopwareIntegrationTestPlugin\ShopwareIntegrationTestPlugin;
use Pickware\ValidationBundle\PickwareValidationBundle;
use Shopware\Core\Framework\Bundle;
use Shopware\Core\Framework\Migration\MigrationCollectionLoader;
use Shopware\Core\Framework\Migration\MigrationRuntime;
use Shopware\Core\Framework\Migration\MigrationSource;
use Shopware\Core\Framework\Parameter\AdditionalBundleParameters;
use Shopware\Core\Framework\Plugin;
use Shopware\Core\Framework\Plugin\Context\ActivateContext;
use Shopware\Core\Framework\Plugin\Context\InstallContext;
use Shopware\Core\Framework\Plugin\Context\UninstallContext;
use Shopware\Core\Framework\Plugin\Context\UpdateContext;
use Shopware\Core\Framework\Struct\Collection;
use Symfony\Bridge\Monolog\Logger;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
if (file_exists(__DIR__ . '/../vendor/pickware/dependency-loader/src/DependencyLoader.php')) {
require_once __DIR__ . '/../vendor/pickware/dependency-loader/src/DependencyLoader.php';
}
class PickwareWms extends Plugin
{
public const GLOBAL_PLUGIN_CONFIG_DOMAIN = 'PickwareWms.global-plugin-config';
/**
* Note that the PickwareShippingBundle is a composer dependency of this plugin. But it is not loaded (it is not
* part of this bundle list).
* This is because we have a conflict to older versions of the PickwareShippingBundle (conflict with version <1.5.0)
* which we cannot properly ensure in the Shopware plugin system. By shipping the code without loading it we ensure
* that, when a shipping adapter is loading the PickwareShippingBundle, this new version is loaded. See this issue
* for more details: https://github.com/pickware/shopware-plugins/issues/2755
*
* @var array<class-string<Bundle>>
*/
private const ADDITIONAL_BUNDLES = [
DalBundle::class,
DocumentBundle::class,
PickwareApiErrorHandlingBundle::class,
PickwareApiVersioningBundle::class,
PickwareMobileAppAuthBundle::class,
PickwareShopwareExtensionsBundle::class,
PickwareValidationBundle::class,
];
public function getAdditionalBundles(AdditionalBundleParameters $parameters): array
{
// Ensure the bundle classes can be loaded via auto-loading.
if (isset($GLOBALS['PICKWARE_DEPENDENCY_LOADER'])) {
$kernelParameters = $parameters->getKernelParameters();
$GLOBALS['PICKWARE_DEPENDENCY_LOADER']->ensureLatestDependenciesOfPluginsLoaded(
$kernelParameters['kernel.plugin_infos'],
$kernelParameters['kernel.project_dir'],
);
}
// For some reason Collection is abstract
// phpcs:ignore Squiz.WhiteSpace.ScopeClosingBrace.ContentBefore -- PHP CS does not understand the PHP 7 syntax
$bundleCollection = new class() extends Collection {};
foreach (self::ADDITIONAL_BUNDLES as $bundle) {
$bundle::register($bundleCollection);
}
return $bundleCollection->getElements();
}
public static function getDistPackages(): array
{
return include __DIR__ . '/../Packages.php';
}
public function build(ContainerBuilder $containerBuilder): void
{
parent::build($containerBuilder);
$loader = new XmlFileLoader($containerBuilder, new FileLocator(__DIR__));
$loader->load('Config/DependencyInjection/api-versioning.xml');
$loader->load('Config/DependencyInjection/controller.xml');
$loader->load('Config/DependencyInjection/service.xml');
$loader->load('Delivery/DependencyInjection/controller.xml');
$loader->load('Delivery/DependencyInjection/model.xml');
$loader->load('Delivery/DependencyInjection/model-extension.xml');
$loader->load('Delivery/DependencyInjection/service.xml');
$loader->load('DeliveryNote/DependencyInjection/service.xml');
$loader->load('DocumentPrintingConfig/DependencyInjection/model.xml');
$loader->load('DocumentPrintingConfig/DependencyInjection/model-extension.xml');
$loader->load('DemodataGeneration/DependencyInjection/command.xml');
$loader->load('Installation/DependencyInjection/service.xml');
$loader->load('OrderDocument/DependencyInjection/twig-extension.xml');
$loader->load('OrderStateValidation/DependencyInjection/service.xml');
$loader->load('PickingProcess/DependencyInjection/controller.xml');
$loader->load('PickingProcess/DependencyInjection/model.xml');
$loader->load('PickingProcess/DependencyInjection/model-extension.xml');
$loader->load('PickingProcess/DependencyInjection/service.xml');
$loader->load('StockContainerClearing/DependencyInjection/service.xml');
$loader->load('StockReservation/DependencyInjection/service.xml');
$loader->load('WmsAppVersionValidation/DependencyInjection/subscriber.xml');
// Register test services. Should never be loaded in production.
if (in_array(ShopwareIntegrationTestPlugin::class, $containerBuilder->getParameter('kernel.bundles'), true)) {
$loader->load('../test/TestEntityCreation/DependencyInjection/service.xml');
}
}
public function install(InstallContext $installContext): void
{
$this->loadDependenciesForSetup();
$this->executeMigrationsOfBundles();
BundleInstaller::createForContainerAndClass($this->container, self::class)
->install(self::ADDITIONAL_BUNDLES, $installContext);
}
public function postInstall(InstallContext $installContext): void
{
PickwareWmsInstaller::initFromContainer($this->container)->postInstall();
}
public function update(UpdateContext $updateContext): void
{
$this->loadDependenciesForSetup();
$this->executeMigrationsOfBundles();
BundleInstaller::createForContainerAndClass($this->container, self::class)
->install(self::ADDITIONAL_BUNDLES, $updateContext);
}
public function postUpdate(UpdateContext $updateContext): void
{
PickwareWmsInstaller::initFromContainer($this->container)->postUpdate($updateContext);
if ($updateContext->getPlugin()->isActive()) {
$this->container
->get('pickware_wms.bundle_supporting_asset_service')
->copyAssetsFromBundle('PickwareMobileAppAuthBundle');
BundleInstaller::createForContainerAndClass($this->container, self::class)
->onAfterActivate(self::ADDITIONAL_BUNDLES, $updateContext);
}
}
private function executeMigrationsOfBundles(): void
{
// All the services required for migration execution are private in the DI-Container. As a workaround the
// services are instantiated explicitly here.
$db = $this->container->get(Connection::class);
// See vendor/symfony/monolog-bundle/Resources/config/monolog.xml on how the logger is defined.
$logger = new Logger('app');
$logger->useMicrosecondTimestamps($this->container->getParameter('monolog.use_microseconds'));
$migrationCollectionLoader = new MigrationCollectionLoader($db, new MigrationRuntime($db, $logger));
$migrationSource = new MigrationSource('PickwareWms');
foreach (self::ADDITIONAL_BUNDLES as $bundle) {
$bundle::registerMigrations($migrationSource);
}
$migrationCollectionLoader->addSource($migrationSource);
foreach ($migrationCollectionLoader->collectAll() as $migrationCollection) {
$migrationCollection->sync();
$migrationCollection->migrateInPlace();
}
}
public function uninstall(UninstallContext $uninstallContext): void
{
parent::uninstall($uninstallContext);
if ($uninstallContext->keepUserData()) {
return;
}
$this->loadDependenciesForSetup();
DependencyAwareTableDropper::createForContainer($this->container)->dropTables([
'pickware_wms_picking_process',
'pickware_wms_picking_process_tracking_code',
'pickware_wms_picking_process_reserved_item',
'pickware_wms_picking_process_order_document_mapping',
'pickware_wms_picking_process_document_mapping',
'pickware_wms_delivery',
'pickware_wms_delivery_tracking_code',
'pickware_wms_delivery_order_document_mapping',
'pickware_wms_delivery_document_mapping',
'pickware_wms_delivery_line_item',
]);
PickwareWmsInstaller::initFromContainer($this->container)->uninstall($uninstallContext);
BundleInstaller::createForContainerAndClass($this->container, self::class)->uninstall($uninstallContext);
}
public function activate(ActivateContext $activateContext): void
{
BundleInstaller::createForContainerAndClass($this->container, self::class)
->onAfterActivate(self::ADDITIONAL_BUNDLES, $activateContext);
$this->container
->get('pickware_wms.bundle_supporting_asset_service')
->copyAssetsFromBundle('PickwareMobileAppAuthBundle');
}
/**
* Run the dependency loader for a setup step like install/update/uninstall
*
* When executing one of these steps but no Pickware plugin is activated, the dependency loader did never run until
* the call of the corresponding method. You can trigger it with a call of this method.
*/
private function loadDependenciesForSetup(): void
{
if (isset($GLOBALS['PICKWARE_DEPENDENCY_LOADER'])) {
$plugins = $this->container->get('kernel')->getPluginLoader()->getPluginInfos();
$projectDir = $this->container->getParameter('kernel.project_dir');
$GLOBALS['PICKWARE_DEPENDENCY_LOADER']->ensureLatestDependenciesOfPluginsLoaded($plugins, $projectDir);
}
}
}