improve bundle connector management (#193)

solverat · web-flow · commit a2f392f947d1 · 2023-05-24T13:57:06.000+02:00
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ The Toolbox is a Kickstarter for your every day project. It provides some import
 
 | Release | Supported Pimcore Versions        | Supported Symfony Versions | Release Date | Maintained     | Branch     |
 |---------|-----------------------------------|----------------------------|--------------|----------------|------------|
-| **4.x** | `10.1` - `10.5`                   | `5.4`                      | 01.10.2021   | Feature Branch | master     |
+| **4.x** | `10.5` - `10.6 `                  | `5.4`                      | 01.10.2021   | Feature Branch | master     |
 | **3.x** | `6.0` - `6.9`                     | `3.4`, `^4.4`              | 16.07.2019   | Unsupported    | 3.x        |
 | **2.8** | `5.4`, `5.5`, `5.6`, `5.7`, `5.8` | `3.4`                      | 30.06.2019   | Unsupported    | 2.8        |
 | **1.8** | `4.0`                             | --                         | 28.04.2017   | Unsupported    | pimcore4   |
@@ -24,7 +24,7 @@ The Toolbox is a Kickstarter for your every day project. It provides some import
 
 ```json
 "require" : {
-    "dachcom-digital/toolbox" : "~4.0.0"
+    "dachcom-digital/toolbox" : "~4.1.0"
 }
 ```
 
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,11 @@
 # Upgrade Notes
 
+## Version 4.1.0
+- [FEATURE] PIMCORE 10.5 support only
+- [IMPROVEMENT] Compatibility with Members 4.1 added
+- [IMPROVEMENT] Remove unused js classes
+- [BUGFIX] [VHS Element] Use right element context in video type selector
+
 ## Version 4.0.10
 - [BUGFIX] fix case sensitivity for accordion in bootstrap3 theme `Resources/views/toolbox/bootstrap3/accordion/partial/Accordion => Resources/views/toolbox/bootstrap3/accordion/partial/accordion`
 
diff --git a/composer.json b/composer.json
@@ -31,7 +31,7 @@
         }
     },
     "require": {
-        "pimcore/pimcore": "^10.1"
+        "pimcore/pimcore": "^10.5"
     },
     "require-dev": {
         "codeception/codeception": "^4.1",
diff --git a/src/ToolboxBundle/Connector/BundleConnector.php b/src/ToolboxBundle/Connector/BundleConnector.php
@@ -2,17 +2,16 @@
 
 namespace ToolboxBundle\Connector;
 
-use Pimcore\Extension\Bundle\PimcoreBundleManager;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 
 class BundleConnector
 {
-    protected PimcoreBundleManager $bundleManager;
+    protected array $activeBundles = [];
     protected array $services = [];
 
-    public function __construct(PimcoreBundleManager $bundleManager)
+    public function addActiveBundle(string $bundleName): void
     {
-        $this->bundleManager = $bundleManager;
+        $this->activeBundles[$bundleName] = true;
     }
 
     public function registerBundleService(string $serviceId, mixed $service): void
@@ -29,14 +28,8 @@ public function getBundleService(string $serviceId): mixed
         return $this->services[$serviceId];
     }
 
-    public function hasBundle(string $bundleName = 'ExtensionBundle\ExtensionBundle'): bool
+    public function hasBundle(string $bundleName): bool
     {
-        try {
-            $hasExtension = $this->bundleManager->isEnabled($bundleName);
-        } catch (\Exception $e) {
-            $hasExtension = false;
-        }
-
-        return $hasExtension;
+        return array_key_exists($bundleName, $this->activeBundles);
     }
 }
diff --git a/src/ToolboxBundle/DependencyInjection/Compiler/MembersBundlePass.php b/src/ToolboxBundle/DependencyInjection/Compiler/MembersBundlePass.php
@@ -18,21 +18,17 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
-        $toolboxBundleConnector = $container->getDefinition(BundleConnector::class);
-        foreach ($this->getRequiredServices() as $service) {
-            $toolboxBundleConnector->addMethodCall(
-                'registerBundleService',
-                [$service, new Reference($service)]
-            );
-        }
-    }
-
-    private function getRequiredServices(): array
-    {
-        return [
+        $requiredServices = [
             \MembersBundle\Manager\RestrictionManager::class,
             \MembersBundle\Security\RestrictionUri::class,
             \MembersBundle\Security\RestrictionQuery::class,
         ];
+
+        $toolboxBundleConnector = $container->getDefinition(BundleConnector::class);
+        $toolboxBundleConnector->addMethodCall('addActiveBundle', ['MembersBundle']);
+
+        foreach ($requiredServices as $service) {
+            $toolboxBundleConnector->addMethodCall('registerBundleService', [$service, new Reference($service)]);
+        }
     }
 }
diff --git a/src/ToolboxBundle/Document/Areabrick/Download/Download.php b/src/ToolboxBundle/Document/Areabrick/Download/Download.php
@@ -2,6 +2,7 @@
 
 namespace ToolboxBundle\Document\Areabrick\Download;
 
+use Doctrine\DBAL\Query\QueryBuilder;
 use Pimcore\Model\Document\Editable\Relations;
 use Symfony\Component\HttpFoundation\Response;
 use ToolboxBundle\Connector\BundleConnector;
@@ -11,11 +12,8 @@
 
 class Download extends AbstractAreabrick
 {
-    protected BundleConnector $bundleConnector;
-
-    public function __construct(BundleConnector $bundleConnector)
+    public function __construct(protected BundleConnector $bundleConnector)
     {
-        $this->bundleConnector = $bundleConnector;
     }
 
     public function action(Info $info): ?Response
@@ -44,7 +42,7 @@ public function action(Info $info): ?Response
 
     protected function getByFile(Asset $node): array
     {
-        if (!$this->hasMembersBundle()) {
+        if (!$this->bundleConnector->hasBundle('MembersBundle')) {
             return [$node];
         }
 
@@ -64,9 +62,10 @@ protected function getByFolder(Asset\Folder $node): array
         $assetListing->addConditionParam('path LIKE ?', $fullPath . '%');
         $assetListing->addConditionParam('type != ?', 'folder');
 
-        if ($this->hasMembersBundle()) {
-            $assetListing->onCreateQueryBuilder(function (\Doctrine\DBAL\Query\QueryBuilder $query) use ($assetListing) {
-                $this->bundleConnector->getBundleService(\MembersBundle\Security\RestrictionQuery::class)
+        if ($this->bundleConnector->hasBundle('MembersBundle')) {
+            $assetListing->onCreateQueryBuilder(function (QueryBuilder $query) use ($assetListing) {
+                $this->bundleConnector
+                    ->getBundleService(\MembersBundle\Security\RestrictionQuery::class)
                     ->addRestrictionInjection($query, $assetListing, 'id');
             });
         }
@@ -77,11 +76,6 @@ protected function getByFolder(Asset\Folder $node): array
         return $assetListing->getAssets();
     }
 
-    protected function hasMembersBundle(): bool
-    {
-        return $this->bundleConnector->hasBundle('MembersBundle\MembersBundle');
-    }
-
     public function getName(): string
     {
         return 'Downloads';
diff --git a/src/ToolboxBundle/Resources/public/js/backend/toolbox.js b/src/ToolboxBundle/Resources/public/js/backend/toolbox.js
diff --git a/src/ToolboxBundle/Resources/public/js/document/editables/vhs/editor.js b/src/ToolboxBundle/Resources/public/js/document/editables/vhs/editor.js
@@ -93,11 +93,11 @@ pimcore.plugin.toolbox.vhs.editor = Class.create({
                                     }.bind(this),
                                     keyup: function (el) {
                                         if ((el.getValue().indexOf('youtu.be') >= 0 || el.getValue().indexOf('youtube.com') >= 0) && el.getValue().indexOf('http') >= 0) {
-                                            this.up('form').getComponent('type').setValue('youtube');
+                                            el.up('form').getComponent('type').setValue('youtube');
                                         } else if (el.getValue().indexOf('vimeo') >= 0 && el.getValue().indexOf('http') >= 0) {
-                                            this.up('form').getComponent('type').setValue('vimeo');
+                                            el.up('form').getComponent('type').setValue('vimeo');
                                         } else if ((el.getValue().indexOf('dai.ly') >= 0 || el.getValue().indexOf('dailymotion') >= 0) && el.getValue().indexOf('http') >= 0) {
-                                            this.up('form').getComponent('type').setValue('dailymotion');
+                                            el.up('form').getComponent('type').setValue('dailymotion');
                                         }
                                     }.bind(this)
                                 }
@@ -334,7 +334,6 @@ pimcore.plugin.toolbox.vhs.editor = Class.create({
         values['videoParameter'] = videoParameter;
 
         return values;
-
     },
 
     hideWindow: function () {
@@ -344,7 +343,6 @@ pimcore.plugin.toolbox.vhs.editor = Class.create({
         this.form = {};
 
         document.body.classList.remove('toolbox-modal-open');
-
     },
 
     onNodeOver: function (target, dd, e, data) {
diff --git a/src/ToolboxBundle/Resources/public/js/startup.js b/src/ToolboxBundle/Resources/public/js/startup.js
diff --git a/src/ToolboxBundle/ToolboxBundle.php b/src/ToolboxBundle/ToolboxBundle.php
@@ -41,15 +41,13 @@ public function getJsPaths(): array
         return [
             '/admin/toolbox-ckeditor-object-style.js',
             '/bundles/toolbox/js/toolbox-ckeditor-plugins.js',
-            '/bundles/toolbox/js/document/edit.js',
-            '/bundles/toolbox/js/startup.js',
+            '/bundles/toolbox/js/document/edit.js'
         ];
     }
 
     public function getEditmodeJsPaths(): array
     {
         return [
-            '/bundles/toolbox/js/backend/toolbox.js',
             '/bundles/toolbox/js/toolbox-ckeditor-plugins.js',
             '/bundles/toolbox/js/document/editables/areablock.js',
             '/bundles/toolbox/js/document/editables/googlemap.js',
diff --git a/src/ToolboxBundle/Twig/Extension/DownloadExtension.php b/src/ToolboxBundle/Twig/Extension/DownloadExtension.php
@@ -2,6 +2,7 @@
 
 namespace ToolboxBundle\Twig\Extension;
 
+use Pimcore\File;
 use Pimcore\Model\Asset;
 use ToolboxBundle\Connector\BundleConnector;
 use Pimcore\Translation\Translator;
@@ -11,15 +12,11 @@
 
 class DownloadExtension extends AbstractExtension
 {
-    protected ConfigManagerInterface $configManager;
-    protected BundleConnector $bundleConnector;
-    protected Translator $translator;
-
-    public function __construct(ConfigManagerInterface $configManager, BundleConnector $bundleConnector, Translator $translator)
-    {
-        $this->configManager = $configManager;
-        $this->bundleConnector = $bundleConnector;
-        $this->translator = $translator;
+    public function __construct(
+        protected ConfigManagerInterface $configManager,
+        protected BundleConnector $bundleConnector,
+        protected Translator $translator
+    ) {
     }
 
     public function getFunctions(): array
@@ -35,14 +32,9 @@ public function getFunctions(): array
     }
 
     /**
-     * @param string|array $areaType toolbox element or custom config
-     * @param null|object  $element  related element to track
-     *
-     * @return string
-     *
      * @throws \Exception
      */
-    public function getDownloadTracker($areaType, $element = null)
+    public function getDownloadTracker(mixed $areaType, mixed $element = null): string
     {
         if (empty($areaType)) {
             return '';
@@ -62,7 +54,7 @@ public function getDownloadTracker($areaType, $element = null)
 
         $str = 'data-tracking="active" ';
 
-        $str .= implode(' ', array_map(function ($key) use ($trackerInfo, $element) {
+        $str .= implode(' ', array_map(static function ($key) use ($trackerInfo, $element) {
             $val = $trackerInfo[$key];
 
             if (is_bool($val)) {
@@ -85,20 +77,19 @@ public function getDownloadTracker($areaType, $element = null)
     }
 
     /**
-     * @param Asset  $download
-     * @param bool   $showPreviewImage
-     * @param string $fileSizeUnit
-     * @param int    $fileSizePrecision
-     * @param bool   $showFileNameIfTitleEmpty
-     *
-     * @return array
-     *
      * @throws \Exception
      */
-    public function getDownloadInfo($download, $showPreviewImage = false, $fileSizeUnit = 'optimized', $fileSizePrecision = 0, $showFileNameIfTitleEmpty = false)
-    {
-        if ($this->bundleConnector->hasBundle('MembersBundle\MembersBundle') === true
-            && strpos($download->getFullPath(), \MembersBundle\Security\RestrictionUri::PROTECTED_ASSET_FOLDER) !== false
+    public function getDownloadInfo(
+        Asset $download,
+        bool $showPreviewImage = false,
+        string $fileSizeUnit = 'optimized',
+        int $fileSizePrecision = 0,
+        bool $showFileNameIfTitleEmpty = false
+    ): array {
+
+        if (
+            $this->bundleConnector->hasBundle('MembersBundle') === true &&
+            $this->bundleConnector->getBundleService(\MembersBundle\Manager\RestrictionManager::class)->elementIsInProtectedStorageFolder($download)
         ) {
             $dPath = $this->bundleConnector->getBundleService(\MembersBundle\Security\RestrictionUri::class)->generateAssetUrl($download);
         } else {
@@ -112,7 +103,7 @@ public function getDownloadInfo($download, $showPreviewImage = false, $fileSizeU
             $dSize = $download->getFileSize($fileSizeUnit, $fileSizePrecision);
         }
 
-        $dType = \Pimcore\File::getFileExtension($download->getFilename());
+        $dType = File::getFileExtension($download->getFilename());
         $downloadTitle = $showFileNameIfTitleEmpty ? $download->getFilename() : $this->translator->trans('Download', [], 'admin');
         $dName = ($download->getMetadata('title')) ?: $downloadTitle;
         $dAltText = $download->getMetadata('alt') ?: '';
@@ -122,8 +113,8 @@ public function getDownloadInfo($download, $showPreviewImage = false, $fileSizeU
         $previewThumbName = $this->configManager->getImageThumbnailFromConfig('download_preview_thumbnail');
 
         if ($showPreviewImage) {
-            /** @var Asset|null $metaPreviewImage */
             $metaPreviewImage = $download->getMetadata('previewImage');
+            /** @phpstan-ignore-next-line */
             if ($metaPreviewImage instanceof Asset\Image) {
                 $dPreviewImage = $metaPreviewImage->getThumbnail($previewThumbName);
             } elseif ($download instanceof Asset\Image) {
@@ -157,15 +148,7 @@ public function getDownloadInfo($download, $showPreviewImage = false, $fileSizeU
         ];
     }
 
-    /**
-     * Get optimized file size.
-     *
-     * @param int $bytes
-     * @param int $precision
-     *
-     * @return string
-     */
-    public function getOptimizedFileSize($bytes, $precision)
+    public function getOptimizedFileSize(mixed $bytes, int $precision): string
     {
         if ($bytes >= 1073741824) {
             $bytes = number_format($bytes / 1073741824, 2);
@@ -184,6 +167,6 @@ public function getOptimizedFileSize($bytes, $precision)
             $format = 'bytes';
         }
 
-        return round((float)$bytes, $precision) . ' ' . $format;
+        return round((float) $bytes, $precision) . ' ' . $format;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`}`
`32`	`32`	`},`
`33`	`33`	`"require": {`
`34`		`- "pimcore/pimcore": "^10.1"`
	`34`	`+ "pimcore/pimcore": "^10.5"`
`35`	`35`	`},`
`36`	`36`	`"require-dev": {`
`37`	`37`	`"codeception/codeception": "^4.1",`
Original file line number	Diff line number	Diff line change
`@@ -2,17 +2,16 @@`
`2`	`2`
`3`	`3`	`namespace ToolboxBundle\Connector;`
`4`	`4`
`5`		`-use Pimcore\Extension\Bundle\PimcoreBundleManager;`
`6`	`5`	`use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;`
`7`	`6`
`8`	`7`	`class BundleConnector`
`9`	`8`	`{`
`10`		`- protected PimcoreBundleManager $bundleManager;`
	`9`	`+ protected array $activeBundles = [];`
`11`	`10`	`protected array $services = [];`
`12`	`11`
`13`		`- public function __construct(PimcoreBundleManager $bundleManager)`
	`12`	`+ public function addActiveBundle(string $bundleName): void`
`14`	`13`	`{`
`15`		`- $this->bundleManager = $bundleManager;`
	`14`	`+ $this->activeBundles[$bundleName] = true;`
`16`	`15`	`}`
`17`	`16`
`18`	`17`	`public function registerBundleService(string $serviceId, mixed $service): void`
`@@ -29,14 +28,8 @@ public function getBundleService(string $serviceId): mixed`
`29`	`28`	`return $this->services[$serviceId];`
`30`	`29`	`}`
`31`	`30`
`32`		`- public function hasBundle(string $bundleName = 'ExtensionBundle\ExtensionBundle'): bool`
	`31`	`+ public function hasBundle(string $bundleName): bool`
`33`	`32`	`{`
`34`		`- try {`
`35`		`- $hasExtension = $this->bundleManager->isEnabled($bundleName);`
`36`		`- } catch (\Exception $e) {`
`37`		`- $hasExtension = false;`
`38`		`- }`
`39`		`-`
`40`		`- return $hasExtension;`
	`33`	`+ return array_key_exists($bundleName, $this->activeBundles);`
`41`	`34`	`}`
`42`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace ToolboxBundle\Document\Areabrick\Download;`
`4`	`4`
	`5`	`+use Doctrine\DBAL\Query\QueryBuilder;`
`5`	`6`	`use Pimcore\Model\Document\Editable\Relations;`
`6`	`7`	`use Symfony\Component\HttpFoundation\Response;`
`7`	`8`	`use ToolboxBundle\Connector\BundleConnector;`
`@@ -11,11 +12,8 @@`
`11`	`12`
`12`	`13`	`class Download extends AbstractAreabrick`
`13`	`14`	`{`
`14`		`- protected BundleConnector $bundleConnector;`
`15`		`-`
`16`		`- public function __construct(BundleConnector $bundleConnector)`
	`15`	`+ public function __construct(protected BundleConnector $bundleConnector)`
`17`	`16`	`{`
`18`		`- $this->bundleConnector = $bundleConnector;`
`19`	`17`	`}`
`20`	`18`
`21`	`19`	`public function action(Info $info): ?Response`
`@@ -44,7 +42,7 @@ public function action(Info $info): ?Response`
`44`	`42`
`45`	`43`	`protected function getByFile(Asset $node): array`
`46`	`44`	`{`
`47`		`- if (!$this->hasMembersBundle()) {`
	`45`	`+ if (!$this->bundleConnector->hasBundle('MembersBundle')) {`
`48`	`46`	`return [$node];`
`49`	`47`	`}`
`50`	`48`
`@@ -64,9 +62,10 @@ protected function getByFolder(Asset\Folder $node): array`
`64`	`62`	`$assetListing->addConditionParam('path LIKE ?', $fullPath . '%');`
`65`	`63`	`$assetListing->addConditionParam('type != ?', 'folder');`
`66`	`64`
`67`		`- if ($this->hasMembersBundle()) {`
`68`		`- $assetListing->onCreateQueryBuilder(function (\Doctrine\DBAL\Query\QueryBuilder $query) use ($assetListing) {`
`69`		`- $this->bundleConnector->getBundleService(\MembersBundle\Security\RestrictionQuery::class)`
	`65`	`+ if ($this->bundleConnector->hasBundle('MembersBundle')) {`
	`66`	`+ $assetListing->onCreateQueryBuilder(function (QueryBuilder $query) use ($assetListing) {`
	`67`	`+ $this->bundleConnector`
	`68`	`+ ->getBundleService(\MembersBundle\Security\RestrictionQuery::class)`
`70`	`69`	`->addRestrictionInjection($query, $assetListing, 'id');`
`71`	`70`	`});`
`72`	`71`	`}`
`@@ -77,11 +76,6 @@ protected function getByFolder(Asset\Folder $node): array`
`77`	`76`	`return $assetListing->getAssets();`
`78`	`77`	`}`
`79`	`78`
`80`		`- protected function hasMembersBundle(): bool`
`81`		`- {`
`82`		`- return $this->bundleConnector->hasBundle('MembersBundle\MembersBundle');`
`83`		`- }`
`84`		`-`
`85`	`79`	`public function getName(): string`
`86`	`80`	`{`
`87`	`81`	`return 'Downloads';`