[TASK] add TYPO3 12 compatibility

Author: hannesbochmann

Classes/Controller/CleanupController.php

@@ -10,8 +10,11 @@
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
 use TYPO3\CMS\Core\Imaging\Icon;
+use TYPO3\CMS\Core\Imaging\IconFactory;
+use TYPO3\CMS\Core\Information\Typo3Version;
 use TYPO3\CMS\Core\Localization\LanguageService;
 use TYPO3\CMS\Core\Messaging\FlashMessage;
+use TYPO3\CMS\Core\Messaging\FlashMessageQueue;
 use TYPO3\CMS\Core\Page\PageRenderer;
 use TYPO3\CMS\Core\Resource\Exception;
 use TYPO3\CMS\Core\Resource\Exception\ExistingTargetFolderException;
@@ -22,7 +25,7 @@
 use TYPO3\CMS\Core\Resource\ResourceStorage;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
-use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
+use TYPO3Fluid\Fluid\View\ViewInterface;
 use WebVision\WvFileCleanup\Domain\Repository\FileRepository;
 
 /**
@@ -42,14 +45,18 @@ class CleanupController extends ActionController
 
     protected FileRepository $fileRepository;
 
+    protected IconFactory $iconFactory;
+
     public function __construct(
         FileRepository $fileRepository,
         PageRenderer $pageRenderer,
-        ModuleTemplateFactory $moduleTemplateFactory
+        ModuleTemplateFactory $moduleTemplateFactory,
+        IconFactory $iconFactory
     ) {
         $this->fileRepository = $fileRepository;
         $this->pageRenderer = $pageRenderer;
         $this->moduleTemplateFactory = $moduleTemplateFactory;
+        $this->iconFactory = $iconFactory;
     }
 
     public function initializeAction(): void
@@ -219,7 +226,6 @@ protected function initializeIndexAction(): void
     protected function registerDocHeaderButtons(): void
     {
         $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
-        $iconFactory = $this->moduleTemplate->getIconFactory();
 
         // Refresh page
         $refreshLink = GeneralUtility::linkThisScript(
@@ -234,7 +240,7 @@ protected function registerDocHeaderButtons(): void
         $refreshButton = $buttonBar->makeLinkButton($buttonFactory)
             ->setHref($refreshLink)
             ->setTitle($buttonTitle)
-            ->setIcon($iconFactory->getIcon('actions-refresh', Icon::SIZE_SMALL));
+            ->setIcon($this->iconFactory->getIcon('actions-refresh', Icon::SIZE_SMALL));
 
         $buttonBar->addButton($refreshButton, ButtonBar::BUTTON_POSITION_RIGHT);
 
@@ -250,10 +256,6 @@ protected function registerDocHeaderButtons(): void
                 if (!$levelUpTitle) {
                     $levelUpTitle = 'Up one level';
                 }
-                $levelUpClick = 'top.document.getElementsByName("navigation")[0].';
-                $levelUpClick .= 'contentWindow.Tree.highlightActiveItem("file","folder';
-                $levelUpClick .= GeneralUtility::md5int($parentFolder->getCombinedIdentifier());
-                $levelUpClick .= '_"+top.fsMod.currentBank)';
                 $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
                 $levelUpButton = $buttonBar->makeLinkButton($buttonFactory)
                     ->setHref(
@@ -262,9 +264,15 @@ protected function registerDocHeaderButtons(): void
                             ['id' => $parentFolder->getCombinedIdentifier()]
                         )
                     )
-                    ->setOnClick($levelUpClick)
                     ->setTitle($levelUpTitle)
-                    ->setIcon($iconFactory->getIcon('actions-view-go-up', Icon::SIZE_SMALL));
+                    ->setIcon($this->iconFactory->getIcon('actions-view-go-up', Icon::SIZE_SMALL));
+                if ((new Typo3Version())->getMajorVersion() < 12) {
+                    $levelUpClick = 'top.document.getElementsByName("navigation")[0].';
+                    $levelUpClick .= 'contentWindow.Tree.highlightActiveItem("file","folder';
+                    $levelUpClick .= GeneralUtility::md5int($parentFolder->getCombinedIdentifier());
+                    $levelUpClick .= '_"+top.fsMod.currentBank)';
+                    $levelUpButton->setOnClick($levelUpClick);
+                }
                 $buttonBar->addButton($levelUpButton, ButtonBar::BUTTON_POSITION_LEFT, 1);
             }
         } catch (\Exception $e) {
@@ -273,7 +281,9 @@ protected function registerDocHeaderButtons(): void
 
         // Shortcut
         if ($this->getBackendUser()->mayMakeShortcut()) {
-            $shortCutButton = $buttonBar->makeShortcutButton()->setModuleName('file_WvFileCleanupCleanup');
+            $shortCutButton = $buttonBar->makeShortcutButton()
+                ->setRouteIdentifier('file_WvFileCleanupCleanup')
+                ->setDisplayName('File cleanup');
             $buttonBar->addButton($shortCutButton, ButtonBar::BUTTON_POSITION_RIGHT);
         }
     }
@@ -283,7 +293,7 @@ protected function registerDocHeaderButtons(): void
      */
     public function indexAction(): ResponseInterface
     {
-        $this->view->assign('files', $this->fileRepository->findUnusedFile($this->folder, $this->moduleSettings['recursive']));
+        $this->view->assign('files', $this->fileRepository->findUnusedFile($this->folder, $this->moduleSettings['recursive'] ?? false));
         $this->view->assign('folder', $this->folder);
         $backendUserTsconfig = $this->getBackendUserTsconfig();
         $this->view->assign('checkboxes', [
@@ -307,12 +317,12 @@ public function indexAction(): ResponseInterface
                 'html' => BackendUtility::getFuncCheck(
                     $this->folder ? $this->folder->getCombinedIdentifier() : '',
                     'SET[recursive]',
-                    $this->moduleSettings['recursive'],
+                    $this->moduleSettings['recursive'] ?? false,
                     '',
                     '',
                     'id="checkRecursive"'
                 ),
-                'checked' => $this->moduleSettings['recursive'],
+                'checked' => $this->moduleSettings['recursive'] ?? false,
             ],
         ]);
 
@@ -328,7 +338,7 @@ public function indexAction(): ResponseInterface
      * @throws InsufficientFolderAccessPermissionsException
      * @throws \TYPO3\CMS\Core\Exception
      */
-    public function cleanupAction(array $files): void
+    public function cleanupAction(array $files): ResponseInterface
     {
         /** @var $resourceFactory ResourceFactory **/
         $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
@@ -371,7 +381,7 @@ public function cleanupAction(array $files): void
             );
         }
 
-        $this->redirect('index');
+        return $this->redirect('index');
     }
 
     /**
@@ -405,7 +415,7 @@ public function addFlashMessage(
             $severity,
             $storeInSession
         );
-        $this->controllerContext->getFlashMessageQueue('core.template.flashMessages')->enqueue($flashMessage);
+        GeneralUtility::makeInstance(FlashMessageQueue::class, 'core.template.flashMessages')->enqueue($flashMessage);
     }
 
     protected function getLanguageService(): LanguageService

Classes/Domain/Repository/FileRepository.php

@@ -181,7 +181,7 @@ public function getReferenceCount(File $file): int
                 )
             )
             ->execute();
-        $refIndexCount = (int)$res1->fetchColumn(0);
+        $refIndexCount = (int)$res1->fetchOne();
 
         // sys_file_reference
         $queryBuilder2 = $this->connection->getQueryBuilderForTable('sys_file_reference');
@@ -199,7 +199,7 @@ public function getReferenceCount(File $file): int
                 ),
             )
             ->execute();
-        $fileReferenceCount = (int)$res2->fetchColumn(0);
+        $fileReferenceCount = (int)$res2->fetchOne();
 
         return max($refIndexCount, $fileReferenceCount);
     }

Classes/FileFacade.php

@@ -255,6 +255,7 @@ public function getLastReferenceTimestamp()
 
         if (!isset(self::$lastReferenceTimestamps[$uid])) {
             self::$lastReferenceTimestamps[$uid] = 0;
+            $row = null;
 
             if ($this->queryBuilder) {
                 $queryBuilder = $this->queryBuilder->getQueryBuilderForTable('sys_file_reference');

Configuration/Backend/Modules.php

@@ -0,0 +1,16 @@
+<?php
+
+return [
+    'file_WvFileCleanupCleanup' => [
+        'parent' => 'file',
+        'access' => 'user,group',
+        'workspaces' => 'online,custom',
+        'path' => '/file/wvfilecleanup',
+        'icon' => 'EXT:wv_file_cleanup/Resources/Public/Icons/module-cleanup.svg',
+        'labels' => 'LLL:EXT:wv_file_cleanup/Resources/Private/Language/locallang_mod_cleanup.xlf',
+        'extensionName' => 'wv_file_cleanup',
+        'controllerActions' => [
+            \WebVision\WvFileCleanup\Controller\CleanupController::class => ['index', 'cleanup'],
+        ],
+    ],
+];

Configuration/Services.yaml

@@ -24,3 +24,7 @@ services:
       - name: event.listener
         method: 'postFileMove'
         event:  TYPO3\CMS\Core\Resource\Event\AfterFileMovedEvent
+
+  WebVision\WvFileCleanup\Controller\CleanupController:
+    tags: [ 'backend.controller' ]
+

composer.json

@@ -6,10 +6,10 @@
     "license": ["GPL-3.0+"],
     "require": {
 		"php": ">=7.4 || >= 8.0",
-        "typo3/cms-core": "^11.5"
+        "typo3/cms-core": "^11.5 || ^12.4"
     },
     "require-dev": {
-        "typo3/testing-framework": "^6.16",
+        "typo3/testing-framework": "^6.16 || ^7.0",
         "saschaegerer/phpstan-typo3": "^1.8",
         "phpstan/phpstan": "^1.10",
         "friendsofphp/php-cs-fixer": "^v3.0"

ext_emconf.php

@@ -11,7 +11,7 @@
     'author_company' => 'beech.it, web-vision GmbH',
     'constraints' => [
         'depends' => [
-            'typo3' => '10.4.1-11.5.99',
+            'typo3' => '11.5.1-12.4.99',
         ],
     ],
 ];

ext_localconf.php

@@ -1,3 +1,3 @@
 <?php
 
-defined('TYPO3_MODE') || die();
+defined('TYPO3') || die();

ext_tables.php

@@ -1,19 +1,21 @@
 <?php
 
-defined('TYPO3_MODE') || die();
+defined('TYPO3') || die();
 
-\TYPO3\CMS\Extbase\Utility\ExtensionUtility::registerModule(
-    'WebVision.WvFileCleanup',
-    'file',
-    'cleanup',
-    '',
-    [
-        \WebVision\WvFileCleanup\Controller\CleanupController::class => 'index, cleanup',
-    ],
-    [
-        'access' => 'user,group',
-        'workspaces' => 'online,custom',
-        'icon' => 'EXT:wv_file_cleanup/Resources/Public/Icons/module-cleanup.svg',
-        'labels' => 'LLL:EXT:wv_file_cleanup/Resources/Private/Language/locallang_mod_cleanup.xlf',
-    ]
-);
+if ((new \TYPO3\CMS\Core\Information\Typo3Version())->getMajorVersion() < 12) {
+    \TYPO3\CMS\Extbase\Utility\ExtensionUtility::registerModule(
+        'WebVision.WvFileCleanup',
+        'file',
+        'cleanup',
+        '',
+        [
+            \WebVision\WvFileCleanup\Controller\CleanupController::class => 'index, cleanup',
+        ],
+        [
+            'access' => 'user,group',
+            'workspaces' => 'online,custom',
+            'icon' => 'EXT:wv_file_cleanup/Resources/Public/Icons/module-cleanup.svg',
+            'labels' => 'LLL:EXT:wv_file_cleanup/Resources/Private/Language/locallang_mod_cleanup.xlf',
+        ]
+    );
+}