fix: Ensure compatibility with newer xmllib2 versions on linux distri…

…butions
shopware5 · Jan 3, 2024 · 25927ae · 25927ae
1 parent c93747a
commit 25927ae
Show file tree

Hide file tree

Showing 12 changed files with 95 additions and 457 deletions.
diff --git a/.phpstan-baseline.neon b/.phpstan-baseline.neon
diff --git a/engine/Shopware/Bundle/PluginInstallerBundle/Service/PluginInstaller.php b/engine/Shopware/Bundle/PluginInstallerBundle/Service/PluginInstaller.php
@@ -26,7 +26,8 @@
 use DateTime;
 use DateTimeInterface;
 use Doctrine\DBAL\Connection;
-use Doctrine\DBAL\Driver\ResultStatement;
+use Doctrine\DBAL\DBALException;
+use Doctrine\ORM\OptimisticLockException;
 use Enlight_Event_EventManager;
 use Exception;
 use InvalidArgumentException;
@@ -69,66 +70,39 @@
 
 class PluginInstaller
 {
-    /**
-     * @var ModelManager
-     */
-    private $em;
+    private ModelManager $em;
 
-    /**
-     * @var Connection
-     */
-    private $connection;
+    private Connection $connection;
 
-    /**
-     * @var DatabaseHandler
-     */
-    private $snippetHandler;
+    private DatabaseHandler $snippetHandler;
 
-    /**
-     * @var RequirementValidator
-     */
-    private $requirementValidator;
+    private RequirementValidator $requirementValidator;
 
-    /**
-     * @var PDO
-     */
-    private $pdo;
+    private PDO $pdo;
 
     /**
-     * @var string[]
+     * @var array<string, string>
      */
-    private $pluginDirectories;
+    private array $pluginDirectories;
 
-    /**
-     * @var ShopwareReleaseStruct
-     */
-    private $release;
+    private ShopwareReleaseStruct $release;
 
-    /**
-     * @var Enlight_Event_EventManager
-     */
-    private $events;
+    private Enlight_Event_EventManager $events;
 
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
+    private LoggerInterface $logger;
 
-    /**
-     * @var Kernel
-     */
-    private $kernel;
+    private Kernel $kernel;
 
     /**
-     * @param string|string[] $pluginDirectories
+     * @param array<string, string> $pluginDirectories
      */
     public function __construct(
         ModelManager $em,
         DatabaseHandler $snippetHandler,
         RequirementValidator $requirementValidator,
         PDO $pdo,
         Enlight_Event_EventManager $events,
-        $pluginDirectories,
+        array $pluginDirectories,
         ShopwareReleaseStruct $release,
         LoggerInterface $logger,
         Kernel $kernel
@@ -139,7 +113,7 @@ public function __construct(
         $this->requirementValidator = $requirementValidator;
         $this->pdo = $pdo;
         $this->events = $events;
-        $this->pluginDirectories = (array) $pluginDirectories;
+        $this->pluginDirectories = $pluginDirectories;
         $this->release = $release;
         $this->logger = $logger;
         $this->kernel = $kernel;
@@ -186,8 +160,8 @@ public function installPlugin(Plugin $plugin)
      * @param bool $removeData
      *
      * @throws Exception
-     * @throws \Doctrine\DBAL\DBALException
-     * @throws \Doctrine\ORM\OptimisticLockException
+     * @throws DBALException
+     * @throws OptimisticLockException
      *
      * @return UninstallContext
      */
@@ -267,7 +241,7 @@ public function updatePlugin(Plugin $plugin)
 
     /**
      * @throws Exception
-     * @throws \Doctrine\ORM\OptimisticLockException
+     * @throws OptimisticLockException
      *
      * @return ActivateContext
      */
@@ -292,7 +266,7 @@ public function activatePlugin(Plugin $plugin)
 
     /**
      * @throws Exception
-     * @throws \Doctrine\ORM\OptimisticLockException
+     * @throws OptimisticLockException
      *
      * @return DeactivateContext
      */
@@ -315,6 +289,8 @@ public function deactivatePlugin(Plugin $plugin)
 
     /**
      * @throws RuntimeException
+     *
+     * @return void
      */
     public function refreshPluginList(DateTimeInterface $refreshDate)
     {
@@ -323,13 +299,10 @@ public function refreshPluginList(DateTimeInterface $refreshDate)
             $this->pluginDirectories
         );
 
-        $plugins = $initializer->initializePlugins();
-
-        foreach ($plugins as $plugin) {
+        foreach ($initializer->initializePlugins() as $plugin) {
             $pluginInfoPath = $plugin->getPath() . '/plugin.xml';
             if (is_file($pluginInfoPath)) {
-                $xmlConfigReader = new XmlPluginReader();
-                $info = $xmlConfigReader->read($pluginInfoPath);
+                $info = (new XmlPluginReader())->read($pluginInfoPath);
             } else {
                 $info = [];
             }
@@ -407,9 +380,7 @@ public function refreshPluginList(DateTimeInterface $refreshDate)
      */
     public function getPluginPath(Plugin $plugin)
     {
-        $pluginBootstrap = $this->getPluginByName($plugin->getName());
-
-        return $pluginBootstrap->getPath();
+        return $this->getPluginByName($plugin->getName())->getPath();
     }
 
     /**
@@ -423,7 +394,7 @@ private function removeSnippets(PluginBootstrap $bootstrap, $removeDirty)
     /**
      * @throws Exception
      */
-    private function installResources(PluginBootstrap $bootstrap, Plugin $plugin)
+    private function installResources(PluginBootstrap $bootstrap, Plugin $plugin): void
     {
         if (is_file($bootstrap->getPath() . '/Resources/config.xml')) {
             $this->installForm($plugin, $bootstrap->getPath() . '/Resources/config.xml');
@@ -442,72 +413,53 @@ private function installResources(PluginBootstrap $bootstrap, Plugin $plugin)
         }
     }
 
-    private function installSnippets(PluginBootstrap $bootstrap)
+    private function installSnippets(PluginBootstrap $bootstrap): void
     {
         $this->snippetHandler->loadToDatabase($bootstrap->getPath() . '/Resources/snippets/');
     }
 
     /**
-     * @param string $file
-     *
      * @throws Exception
      */
-    private function installForm(Plugin $plugin, $file)
+    private function installForm(Plugin $plugin, string $file): void
     {
-        $xmlConfigReader = new XmlConfigReader();
-        $config = $xmlConfigReader->read($file);
+        $config = (new XmlConfigReader())->read($file);
 
         $formSynchronizer = new FormSynchronizer($this->em);
         $formSynchronizer->synchronize($plugin, $config);
     }
 
     /**
-     * @param string $file
-     *
      * @throws InvalidArgumentException
      */
-    private function installMenu(Plugin $plugin, $file)
+    private function installMenu(Plugin $plugin, string $file): void
     {
-        $menuReader = new XmlMenuReader();
-        $menu = $menuReader->read($file);
+        $menu = (new XmlMenuReader())->read($file);
 
         $menuSynchronizer = new MenuSynchronizer($this->em);
         $menuSynchronizer->synchronize($plugin, $menu);
     }
 
     /**
-     * @param string $file
-     *
      * @throws InvalidArgumentException
      */
-    private function installCronjob(Plugin $plugin, $file)
+    private function installCronjob(Plugin $plugin, string $file): void
     {
-        $cronjobReader = new XmlCronjobReader();
-        $cronjobs = $cronjobReader->read($file);
+        $cronjobs = (new XmlCronjobReader())->read($file);
 
         $cronjobSynchronizer = new CronjobSynchronizer($this->em->getConnection());
         $cronjobSynchronizer->synchronize($plugin, $cronjobs);
     }
 
-    /**
-     * @param string $updateVersion
-     * @param string $currentVersion
-     *
-     * @return bool
-     */
-    private function hasInfoNewerVersion($updateVersion, $currentVersion)
+    private function hasInfoNewerVersion(string $updateVersion, string $currentVersion): bool
     {
         return version_compare($updateVersion, $currentVersion, '>');
     }
 
     /**
-     * @param string $pluginName
-     *
      * @throws Exception
-     *
-     * @return PluginBootstrap
      */
-    private function getPluginByName($pluginName)
+    private function getPluginByName(string $pluginName): PluginComponent
     {
         $plugins = $this->kernel->getPlugins();
 
@@ -519,11 +471,9 @@ private function getPluginByName($pluginName)
     }
 
     /**
-     * @param int $pluginId
-     *
-     * @throws \Doctrine\DBAL\DBALException
+     * @throws DBALException
      */
-    private function removeEmotionComponents($pluginId)
+    private function removeEmotionComponents(int $pluginId): void
     {
         // Remove emotion-components
         $sql = 'DELETE s_emotion_element_value, s_emotion_element
@@ -546,11 +496,9 @@ private function removeEmotionComponents($pluginId)
     }
 
     /**
-     * @param int $pluginId
-     *
-     * @throws \Doctrine\DBAL\DBALException
+     * @throws DBALException
      */
-    private function removeFormsAndElements($pluginId)
+    private function removeFormsAndElements(int $pluginId): void
     {
         $sql = <<<SQL
 DELETE s_core_config_forms, s_core_config_form_translations, s_core_config_elements, s_core_config_element_translations, s_core_config_values
@@ -565,31 +513,26 @@ private function removeFormsAndElements($pluginId)
     }
 
     /**
-     * @param int $pluginId
-     *
-     * @throws \Doctrine\DBAL\DBALException
+     * @throws DBALException
      */
-    private function removeTemplates($pluginId)
+    private function removeTemplates(int $pluginId): void
     {
         $sql = 'DELETE FROM s_core_templates WHERE plugin_id = :pluginId';
         $this->connection->executeStatement($sql, [':pluginId' => $pluginId]);
     }
 
     /**
-     * @throws \Doctrine\DBAL\DBALException
+     * @throws DBALException
      */
-    private function removeMenuEntries(int $pluginId)
+    private function removeMenuEntries(int $pluginId): void
     {
-        $builder = $this->em->getConnection()->createQueryBuilder();
-        $builder->select(['id', 'controller', 'action']);
-        $builder->from('s_core_menu');
-        $builder->andWhere('pluginID = :pluginId');
-        $builder->setParameter(':pluginId', $pluginId);
-
-        /** @var ResultStatement<array> $statement */
-        $statement = $builder->execute();
-
-        $menuItems = $statement->fetchAll();
+        $menuItems = $this->em->getConnection()->createQueryBuilder()
+            ->select(['id', 'controller', 'action'])
+            ->from('s_core_menu')
+            ->andWhere('pluginID = :pluginId')
+            ->setParameter(':pluginId', $pluginId)
+            ->execute()
+            ->fetchAllAssociative();
 
         if (\count($menuItems) === 0) {
             return;
@@ -619,22 +562,18 @@ private function removeMenuEntries(int $pluginId)
     }
 
     /**
-     * @param int $pluginId
-     *
-     * @throws \Doctrine\DBAL\DBALException
+     * @throws DBALException
      */
-    private function removeCrontabEntries($pluginId)
+    private function removeCrontabEntries(int $pluginId): void
     {
         $sql = 'DELETE FROM s_crontab WHERE pluginID = :pluginId';
         $this->connection->executeStatement($sql, [':pluginId' => $pluginId]);
     }
 
     /**
-     * @param int $pluginId
-     *
-     * @throws \Doctrine\DBAL\DBALException
+     * @throws DBALException
      */
-    private function removeEventSubscribers($pluginId)
+    private function removeEventSubscribers(int $pluginId): void
     {
         $sql = 'DELETE FROM s_core_subscribes WHERE pluginID = :pluginId';
         $this->connection->executeStatement($sql, [':pluginId' => $pluginId]);