[MAINTENANCE] Add support for Typo3 v12 (fixes #900) (#1337)

Co-authored-by: Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
kitodo · Oct 10, 2024 · 4e77a8f · 4e77a8f
1 parent 63041f8
commit 4e77a8f
Show file tree

Hide file tree

Showing 61 changed files with 455 additions and 419 deletions.
diff --git a/.github/phpstan.neon b/.github/phpstan.neon
@@ -23,7 +23,6 @@ parameters:
     - '#Constant LOG_SEVERITY_ERROR not found\.#'
     - '#Constant LOG_SEVERITY_NOTICE not found\.#'
     - '#Constant LOG_SEVERITY_WARNING not found\.#'
-    - '#Constant TYPO3_MODE not found\.#'
   level: 5
   paths:
     - ../Classes/

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -12,19 +12,19 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        typo3: [ 10.4, 11.5 ]
+        variants: [ {typo3: 11.5, php: 7.4}, {typo3: 12.4, php: 8.1} ]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
       - name: Install dependencies
-        run: Build/Test/runTests.sh -s composerInstall -t ${{ matrix.typo3 }}
+        run: Build/Test/runTests.sh -s composerInstall -t ${{ matrix.variants.typo3 }} -p ${{ matrix.variants.php }}
 
       - name: Run unit tests
-        run: Build/Test/runTests.sh -s unit
+        run: Build/Test/runTests.sh -s unit -p ${{ matrix.variants.php }}
 
       - name: Run functional tests
-        run: Build/Test/runTests.sh -s functional
+        run: Build/Test/runTests.sh -s functional -p ${{ matrix.variants.php }}
 
       - name: Upload coverage reports
         uses: codecov/codecov-action@v4

diff --git a/Build/Test/runTests.sh b/Build/Test/runTests.sh
@@ -74,12 +74,12 @@ Options:
             - functional: PHP functional tests
             - unit (default): PHP unit tests
 
-    -t <|10.4|11.5>
+    -t <|11.5|12.4>
         Only with -s composerInstall
         Specifies which TYPO3 version to install. When unset, installs either the packages from
         composer.lock, or the latest version otherwise (default behavior of "composer install").
-            - 10.4
             - 11.5
+            - 12.4
 
     -a <mysqli|pdo_mysql>
         Only with -s functional

diff --git a/Classes/Command/BaseCommand.php b/Classes/Command/BaseCommand.php
@@ -146,7 +146,7 @@ protected function initializeRepositories(int $storagePid): void
      *
      * @return int matching uid of Solr core
      */
-    protected function getSolrCoreUid(array $solrCores, $inputSolrId): int
+    protected function getSolrCoreUid(array $solrCores, $inputSolrId): ?int
     {
         if (MathUtility::canBeInterpretedAsInteger($inputSolrId)) {
             $solrCoreUid = MathUtility::forceIntegerInRange((int) $inputSolrId, 0);

diff --git a/Classes/Common/Helper.php b/Classes/Common/Helper.php
@@ -14,8 +14,10 @@
 
 use TYPO3\CMS\Core\Configuration\ConfigurationManager;
 use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
+use TYPO3\CMS\Core\Core\Environment;
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Http\Uri;
+use TYPO3\CMS\Core\Http\ApplicationType;
 use TYPO3\CMS\Core\Http\RequestFactory;
 use TYPO3\CMS\Core\Log\LogManager;
 use TYPO3\CMS\Core\Context\Context;
@@ -583,7 +585,7 @@ public static function processDatabaseAsAdmin(array $data = [], array $cmd = [],
         $context = GeneralUtility::makeInstance(Context::class);
 
         if (
-            \TYPO3_MODE === 'BE'
+            ApplicationType::fromRequest($GLOBALS['TYPO3_REQUEST'])->isBackend()
             && $context->getPropertyFromAspect('backend.user', 'isAdmin')
         ) {
             // Instantiate TYPO3 core engine.
@@ -783,8 +785,7 @@ public static function translate(string $indexName, string $table, string $pid):
      */
     public static function whereExpression(string $table, bool $showHidden = false): string
     {
-        // TODO: Check with applicationType; TYPO3_MODE is removed in v12
-        if (\TYPO3_MODE === 'FE') {
+        if (!Environment::isCli() && ApplicationType::fromRequest($GLOBALS['TYPO3_REQUEST'])->isFrontend()) {
             // Should we ignore the record's hidden flag?
             $ignoreHide = 0;
             if ($showHidden) {
@@ -799,14 +800,13 @@ public static function whereExpression(string $table, bool $showHidden = false):
             } else {
                 return '';
             }
-            // TODO: Check with applicationType; TYPO3_MODE is removed in v12
-        } elseif (\TYPO3_MODE === 'BE') {
+        } elseif (Environment::isCli() || ApplicationType::fromRequest($GLOBALS['TYPO3_REQUEST'])->isBackend()) {
             return GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable($table)
                 ->expr()
                 ->eq($table . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'], 0);
         } else {
-            self::log('Unexpected TYPO3_MODE', LOG_SEVERITY_ERROR);
+            self::log('Unexpected application type (neither frontend or backend)', LOG_SEVERITY_ERROR);
             return '1=-1';
         }
     }

diff --git a/Classes/Common/KitodoFlashMessageRenderer.php b/Classes/Common/KitodoFlashMessageRenderer.php
@@ -33,6 +33,7 @@ class KitodoFlashMessageRenderer implements FlashMessageRendererInterface
      * @var array The message severity class names
      */
     protected static array $classes = [
+        // Todo: FlashMessage constants deprecated in v12, remove when dropping v11 support
         FlashMessage::NOTICE => 'notice',
         FlashMessage::INFO => 'info',
         FlashMessage::OK => 'success',
@@ -44,6 +45,7 @@ class KitodoFlashMessageRenderer implements FlashMessageRendererInterface
      * @var array The message severity icon names
      */
     protected static array $icons = [
+        // Todo: FlashMessage constants deprecated in v12, remove when dropping v11 support
         FlashMessage::NOTICE => 'lightbulb-o',
         FlashMessage::INFO => 'info',
         FlashMessage::OK => 'check',
@@ -65,6 +67,27 @@ public function render(array $flashMessages): string
         return $this->getMessageAsMarkup($flashMessages);
     }
 
+    /**
+     * Gets the message severity as integer value for compatibility with Typo3 v12
+     *
+     * @access public
+     *
+     * @param FlashMessage $flashMessage
+     *
+     * @return int The message severity as integer
+     */
+    protected function getSeverityAsInt(FlashMessage $flashMessage): int
+    {
+        $severity = $flashMessage->getSeverity();
+        if (is_int($severity)) {
+            // $severity is integer constant from FlashMessage in Typo3 v11
+            return $severity;
+        }
+        // $severity is instance of ContextualFeedbackSeverity enum introduced in Typo3 v12
+        // TODO: migrate message severity to ContextualFeedbackSeverity when dropping support for Typo3 v11
+        return $severity->value;
+    }
+
     /**
      * Gets the message severity class name
      *
@@ -76,7 +99,7 @@ public function render(array $flashMessages): string
      */
     protected function getClass(FlashMessage $flashMessage): string
     {
-        return 'alert-' . self::$classes[$flashMessage->getSeverity()];
+        return 'alert-' . self::$classes[$this->getSeverityAsInt($flashMessage)];
     }
 
     /**
@@ -90,7 +113,7 @@ protected function getClass(FlashMessage $flashMessage): string
      */
     protected function getIconName(FlashMessage $flashMessage): string
     {
-        return self::$icons[$flashMessage->getSeverity()];
+        return self::$icons[$this->getSeverityAsInt($flashMessage)];
     }
 
     /**

diff --git a/Classes/Common/Solr/SolrSearch.php b/Classes/Common/Solr/SolrSearch.php
@@ -2,6 +2,7 @@
 
 namespace Kitodo\Dlf\Common\Solr;
 
+use Exception;
 use Kitodo\Dlf\Common\AbstractDocument;
 use Kitodo\Dlf\Common\Helper;
 use Kitodo\Dlf\Common\Indexer;
@@ -13,6 +14,7 @@
 use TYPO3\CMS\Core\Utility\MathUtility;
 use TYPO3\CMS\Extbase\Persistence\Generic\QueryResult;
 use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
+use TYPO3\CMS\Extbase\Persistence\QueryInterface;
 
 /**
  * Targeted towards being used in ``PaginateController`` (``<f:widget.paginate>``).
@@ -318,6 +320,22 @@ public function getQuery()
         return new SolrSearchQuery($this);
     }
 
+    /**
+     * Sets query.
+     *
+     * @access public
+     *
+     * @param QueryInterface $query the query
+     *
+     * @throws Exception not implemented
+     *
+     * @return void
+     */
+    public function setQuery(QueryInterface $query): void
+    {
+        throw new Exception("setQuery not supported on SolrSearch instance");
+    }
+
     /**
      * Gets first.
      *

diff --git a/Classes/Common/Solr/SolrSearchQuery.php b/Classes/Common/Solr/SolrSearchQuery.php
@@ -3,9 +3,7 @@
 namespace Kitodo\Dlf\Common\Solr;
 
 use TYPO3\CMS\Extbase\Persistence\QueryInterface;
-use TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface;
-use TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface;
-use TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface;
+use TYPO3\CMS\Extbase\Persistence\Generic\Query;
 
 /**
  * Targeted towards being used in ``PaginateController`` (``<f:widget.paginate>``).
@@ -18,7 +16,7 @@
  * @property int $limit
  * @property int $offset
  */
-class SolrSearchQuery implements QueryInterface
+class SolrSearchQuery extends Query
 {
     /**
      * @access private
@@ -27,18 +25,6 @@ class SolrSearchQuery implements QueryInterface
     private SolrSearch $solrSearch;
 
     /**
-     * @access private
-     * @var int
-     */
-    private int $limit;
-
-    /**
-     * @access private
-     * @var int
-     */
-    private int $offset;
-
-     /**
      * Constructs SolrSearchQuery instance.
      *
      * @access public
@@ -55,10 +41,6 @@ public function __construct($solrSearch)
         $this->limit = count($solrSearch);
     }
 
-    // this class contains a lot of methods which are inherited but not implemented
-    // @phpstan-ignore-next-line
-    public function getSource() {}
-
     /**
      * Executes SOLR search query.
      *
@@ -83,9 +65,6 @@ public function execute($returnRawQueryResult = false)
         return $result;
     }
 
-    // @phpstan-ignore-next-line
-    public function setOrderings(array $orderings) {}
-
     /**
      * Sets limit for SOLR search query.
      *
@@ -116,44 +95,6 @@ public function setOffset($offset): SolrSearchQuery
         return $this;
     }
 
-    // @phpstan-ignore-next-line
-    public function matching($constraint) {}
-    // @phpstan-ignore-next-line
-    public function logicalAnd($constraint1) {}
-    // @phpstan-ignore-next-line
-    public function logicalOr($constraint1) {}
-    // @phpstan-ignore-next-line
-    public function logicalNot(ConstraintInterface $constraint) {}
-    // @phpstan-ignore-next-line
-    public function equals($propertyName, $operand, $caseSensitive = true) {}
-    // @phpstan-ignore-next-line
-    public function like($propertyName, $operand) {}
-    // @phpstan-ignore-next-line
-    public function contains($propertyName, $operand) {}
-    // @phpstan-ignore-next-line
-    public function in($propertyName, $operand) {}
-    // @phpstan-ignore-next-line
-    public function lessThan($propertyName, $operand) {}
-    // @phpstan-ignore-next-line
-    public function lessThanOrEqual($propertyName, $operand) {}
-    // @phpstan-ignore-next-line
-    public function greaterThan($propertyName, $operand) {}
-    // @phpstan-ignore-next-line
-    public function greaterThanOrEqual($propertyName, $operand) {}
-    // @phpstan-ignore-next-line
-    public function getType() {}
-    public function setQuerySettings(QuerySettingsInterface $querySettings) {}
-    // @phpstan-ignore-next-line
-    public function getQuerySettings() {}
-
-    public function count()
-    {// @phpstan-ignore-next-line
-        // TODO?
-    }
-
-    // @phpstan-ignore-next-line
-    public function getOrderings() {}
-
     /**
      * Gets limit for SOLR search query.
      *
@@ -178,10 +119,4 @@ public function getOffset(): int
         return $this->offset;
     }
 
-    // @phpstan-ignore-next-line
-    public function getConstraint() {}
-    public function isEmpty($propertyName) {}
-    public function setSource(SourceInterface $source) {}
-    // @phpstan-ignore-next-line
-    public function getStatement() {}
 }
diff --git a/Classes/Controller/AbstractController.php b/Classes/Controller/AbstractController.php
@@ -15,16 +15,19 @@
 use Kitodo\Dlf\Common\Helper;
 use Kitodo\Dlf\Domain\Model\Document;
 use Kitodo\Dlf\Domain\Repository\DocumentRepository;
+use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
 use TYPO3\CMS\Core\Localization\LanguageService;
 use TYPO3\CMS\Core\Log\LogManager;
 use TYPO3\CMS\Core\Pagination\PaginationInterface;
+use TYPO3\CMS\Core\Utility\ArrayUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Utility\MathUtility;
 use TYPO3\CMS\Core\Pagination\PaginatorInterface;
 use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
+use TYPO3\CMS\Extbase\Mvc\RequestInterface;
 
 /**
  * Abstract controller class for most of the plugin controller.
@@ -99,10 +102,13 @@ public function injectDocumentRepository(DocumentRepository $documentRepository)
      *
      * @access protected
      *
+     * @param RequestInterface $request the HTTP request
+     *
      * @return void
      */
-    protected function initialize(): void
+    protected function initialize(RequestInterface $request): void
     {
+        // replace with $this->request->getQueryParams() when dropping support for Typo3 v11, see Deprecation-100596
         $this->requestData = GeneralUtility::_GPmerged('tx_dlf');
         $this->pageUid = (int) GeneralUtility::_GET('id');
 
@@ -386,15 +392,19 @@ protected function setDefaultPage(): void
     }
 
     /**
-     * This is the constructor
+     * Wrapper for ActionController::processRequest in order to initialize things
+     * without using a constructor.
      *
      * @access public
      *
-     * @return void
+     * @param RequestInterface $request the request
+     *
+     * @return ResponseInterface the response
      */
-    public function __construct()
+    public function processRequest(RequestInterface $request): ResponseInterface
     {
-        $this->initialize();
+        $this->initialize($request);
+        return parent::processRequest($request);
     }
 
     /**