[TASK] Mitigate PHP 8.4.0-RC1 breaking changes

sbuerk · sbuerk · commit 33c1185a9de1 · 2024-09-29T19:50:08.000+02:00
Note that this change addresses three different issues, which need to be done in one step, otherwise none of isolated patches would get a +1 CI verification: * Alignment for changed `$escape` parameter handling of CSV related methods, which must be avoided with PHP versions below 8.4.0-beta5, but is required as of PHP 8.4.0-RC1. * This `$escape` issue needs to be addressed directly in the `typo3/testing-framework` and thus needs a raised dependency directly. * PHP 8.4.0.0-RC1 also deprecated the `E_STRICT` constant, which needs to be addressed directly. With [1] the `$escape` parameter for the following method calls * `str_getcsv()` * `fputcsv()` * `fgetcsv()` must be provided as a 1 character long value. Omitting and using the default value will emit a PHP deprecation [2] warning as of PHP 8.4.0-RC1, for example: str_getcsv(): the $escape parameter must be provided as its default value will change To mitigate this, PHP recommends following: It must be passed explicitly either positionally or via named arguments. This change adjusts all occurences (function calls) and ensures that the `$escape` parameter is explicitly provided via specifying all parameters up to that position and not using a `named arguments` approach for easier backporting. The TYPO3 testing framework also needs to be aligned to mitigate `fgetcsv()` issues, and is raised in the same step - otherwise none of these changes would get a green CI pipeline run. The following testing-framework updates are adjusted: * main: simple update `main` pointer * 12.4: Raise to tag `8.2.2` * 11.5: Raise to tag `6.16.10` Used command(s): > composer require --dev "typo3/testing-framework":"^8.2.2" Additionally, PHP 8.4.0-RC1 deprecated the `E_STRICT` constant, which now emits a E_DEPRECATED which leads to failed CI tests. This change introduces a core internal constant with the same integer value, and replaces usages with this constant to mitigate the E_DEPRECATION. This constant can then be dropped with TYPO3 v14, preventing a breaking change at this time. [3][4] [1] php/php-src#15569 [2] https://github.com/php/php-src/blob/ebee8df27ed/UPGRADING#L617-L622 [3] https://github.com/php/php-src/blob/ebee8df27edf7/UPGRADING#L47-L49 [4] php/php-src#13053 Resolves: #105155 Releases: main, 12.4, 11.5 Change-Id: Ie8b7d46eeb75ba6e32c0e8f6e7e947775083cc15 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/86376 Tested-by: core-ci <typo3@b13.com> Tested-by: Stefan Bürk <stefan@buerk.tech> Reviewed-by: Garvin Hicking <gh@faktor-e.de> Reviewed-by: Stefan Bürk <stefan@buerk.tech> Tested-by: Garvin Hicking <gh@faktor-e.de>
diff --git a/Classes/Error/ErrorHandler.php b/Classes/Error/ErrorHandler.php
@@ -62,10 +62,11 @@ class ErrorHandler implements ErrorHandlerInterface, LoggerAwareInterface
         E_USER_ERROR => 'PHP User Error',
         E_USER_WARNING => 'PHP User Warning',
         E_USER_NOTICE => 'PHP User Notice',
-        E_STRICT => 'PHP Runtime Notice',
         E_RECOVERABLE_ERROR => 'PHP Catchable Fatal Error',
         E_USER_DEPRECATED => 'TYPO3 Deprecation Notice',
         E_DEPRECATED => 'PHP Runtime Deprecation Notice',
+        // @todo Remove intermediate constant E_STRICT_DEPRECATED with TYPO3 v14. E_STRICT (2048) constant deprecated since PHP 8.4.0 RC1.
+        E_STRICT_DEPRECATED => 'PHP Runtime Notice',
     ];
 
     /**
diff --git a/Classes/LinkHandling/TypoLinkCodecService.php b/Classes/LinkHandling/TypoLinkCodecService.php
@@ -80,7 +80,7 @@ public function decode($typoLink)
     {
         $typoLink = trim((string)$typoLink);
         if ($typoLink !== '') {
-            $parts = str_replace(['\\\\', '\\"'], ['\\', '"'], str_getcsv($typoLink, static::$partDelimiter));
+            $parts = str_replace(['\\\\', '\\"'], ['\\', '"'], str_getcsv($typoLink, static::$partDelimiter, '"', '\\'));
         } else {
             $parts = [];
         }
diff --git a/Classes/Resource/Index/FileIndexRepository.php b/Classes/Resource/Index/FileIndexRepository.php
@@ -242,7 +242,7 @@ public function findByFolders(array $folders, $includeMissing = true, $fileName
             );
 
         if (isset($fileName)) {
-            $nameParts = str_getcsv($fileName, ' ');
+            $nameParts = str_getcsv($fileName, ' ', '"', '\\');
             foreach ($nameParts as $part) {
                 $part = trim($part);
                 if ($part !== '') {
diff --git a/Classes/Resource/Search/QueryRestrictions/SearchTermRestriction.php b/Classes/Resource/Search/QueryRestrictions/SearchTermRestriction.php
@@ -69,7 +69,7 @@ private function makeQuerySearchByTable(string $tableName, string $tableAlias):
         $searchTerm = (string)$this->searchDemand->getSearchTerm();
         $constraints = [];
 
-        $searchTermParts = str_getcsv($searchTerm, ' ');
+        $searchTermParts = str_getcsv($searchTerm, ' ', '"', '\\');
         foreach ($searchTermParts as $searchTermPart) {
             $searchTermPart = trim($searchTermPart);
             if ($searchTermPart === '') {
diff --git a/Classes/Utility/ArrayUtility.php b/Classes/Utility/ArrayUtility.php
@@ -181,7 +181,7 @@ public static function getValueByPath(array $array, array|string $path, string $
                 // Programming error has to be sanitized before calling the method -> global exception
                 throw new \RuntimeException('Path must not be empty', 1341397767);
             }
-            $path = str_getcsv($path, $delimiter);
+            $path = str_getcsv($path, $delimiter, '"', '\\');
         }
         // Loop through each part and extract its value
         $value = $array;
@@ -265,7 +265,7 @@ public static function setValueByPath(array $array, string|array|\ArrayAccess $p
                 throw new \RuntimeException('Path must not be empty', 1341406194);
             }
             // Extract parts of the path
-            $path = str_getcsv($path, $delimiter);
+            $path = str_getcsv($path, $delimiter, '"', '\\');
         }
         // Point to the root of the array
         $pointer = &$array;
@@ -306,7 +306,7 @@ public static function removeByPath(array $array, string $path, string $delimite
             throw new \RuntimeException('Path must not be empty', 1371757718);
         }
         // Extract parts of the path
-        $pathSegments = str_getcsv($path, $delimiter);
+        $pathSegments = str_getcsv($path, $delimiter, '"', '\\');
         $pathDepth = count($pathSegments);
         $currentDepth = 0;
         $pointer = &$array;
diff --git a/Classes/Utility/CsvUtility.php b/Classes/Utility/CsvUtility.php
@@ -58,7 +58,7 @@ public static function csvToArray(string $input, string $fieldDelimiter = ',', s
         if (($handle = fopen('php://memory', 'r+')) !== false) {
             fwrite($handle, $input);
             rewind($handle);
-            while (($cells = fgetcsv($handle, 0, $fieldDelimiter, $fieldEnclosure)) !== false) {
+            while (($cells = fgetcsv($handle, 0, $fieldDelimiter, $fieldEnclosure, '\\')) !== false) {
                 $maximumCellCount = max(count($cells), $maximumCellCount);
                 $multiArray[] = preg_replace('|<br */?>|i', LF, $cells);
             }
@@ -110,7 +110,7 @@ public static function csvValues(array $row, string $delim = ',', string $quote
         } elseif ($type === self::TYPE_PREFIX_CONTROLS) {
             $row = array_map(self::prefixControlLiterals(...), $row);
         }
-        fputcsv($resource, $modifier($row), $delim, $quote);
+        fputcsv($resource, $modifier($row), $delim, $quote, '\\');
         fseek($resource, 0);
         return stream_get_contents($resource);
     }
diff --git a/Configuration/DefaultConfiguration.php b/Configuration/DefaultConfiguration.php
@@ -258,9 +258,13 @@
         'productionExceptionHandler' => \TYPO3\CMS\Core\Error\ProductionExceptionHandler::class,
         'debugExceptionHandler' => \TYPO3\CMS\Core\Error\DebugExceptionHandler::class,
         'errorHandler' => \TYPO3\CMS\Core\Error\ErrorHandler::class,
-        'errorHandlerErrors' => E_ALL & ~(E_STRICT | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR),
-        'exceptionalErrors' => E_ALL & ~(E_STRICT | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR | E_DEPRECATED | E_USER_DEPRECATED | E_WARNING | E_USER_ERROR | E_USER_NOTICE | E_USER_WARNING),
-        'belogErrorReporting' => E_ALL & ~(E_STRICT | E_NOTICE),
+        // @todo Remove intermediate constant E_STRICT_DEPRECATED with TYPO3 v14. E_STRICT (2048) constant deprecated since PHP 8.4.0 RC1.
+        'errorHandlerErrors' => E_ALL & ~(E_STRICT_DEPRECATED | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR),
+        // @todo Remove intermediate constant E_STRICT_DEPRECATED with TYPO3 v14. E_STRICT (2048) constant deprecated since PHP 8.4.0 RC1.
+        'exceptionalErrors' => E_ALL & ~(E_STRICT_DEPRECATED | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR | E_DEPRECATED | E_USER_DEPRECATED | E_WARNING | E_USER_ERROR | E_USER_NOTICE | E_USER_WARNING),
+        // @todo Remove intermediate constant E_STRICT_DEPRECATED with TYPO3 v14. E_STRICT (2048) constant deprecated since PHP 8.4.0 RC1.
+        'belogErrorReporting' => E_ALL & ~(E_STRICT_DEPRECATED | E_NOTICE),
+        'allowedPhpDisableFunctions' => [],
         'locallangXMLOverride' => [], // For extension/overriding of the arrays in 'locallang' files in frontend  and backend.
         'generateApacheHtaccess' => 1,
         'ipAnonymization' => 1,
diff --git a/Resources/PHP/DeprecatedConstants.php b/Resources/PHP/DeprecatedConstants.php
@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * @internal only for TYPO3 internal work and not part of public API. Remove usage in custom extension code to mitigate
+ *           PHP deprecated constant E_STRICT.
+ * @deprecated since v13, will be removed in v14. This constant is only for TYPO3 internal usage to replace the
+ *             deprecated `E_STRICT` constant of PHP since PHP 8.4.0 RC1 to avoid E_DEPRECATED messages within
+ *             automatic testing.
+ */
+define('E_STRICT_DEPRECATED', 2048);
diff --git a/Tests/Functional/Error/ErrorHandlerTest.php b/Tests/Functional/Error/ErrorHandlerTest.php
@@ -88,7 +88,8 @@ public function handleErrorOnlyHandlesRegisteredErrorLevels(): void
         $logger->expects(self::never())->method('log');
 
         $coreErrorHandler = new ErrorHandler(
-            E_ALL & ~(E_STRICT | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR)
+            // @todo Remove intermediate constant E_STRICT_DEPRECATED with TYPO3 v14. E_STRICT (2048) constant deprecated since PHP 8.4.0 RC1.
+            E_ALL & ~(E_STRICT_DEPRECATED | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR)
         );
         $coreErrorHandler->setLogger($logger);
 
diff --git a/Tests/Unit/Error/ErrorHandlerTest.php b/Tests/Unit/Error/ErrorHandlerTest.php
@@ -41,8 +41,10 @@ final class ErrorHandlerTest extends UnitTestCase
     protected LoggerInterface $trackingLogger;
 
     // These are borrowed from DefaultConfiguration.php.
-    protected const DEFAULT_ERROR_HANDLER_LEVELS = E_ALL & ~(E_STRICT | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR);
-    protected const DEFAULT_EXCEPTIONAL_ERROR_LEVELS = E_ALL & ~(E_STRICT | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR | E_DEPRECATED | E_USER_DEPRECATED | E_WARNING | E_USER_ERROR | E_USER_NOTICE | E_USER_WARNING);
+    // @todo Remove intermediate constant E_STRICT_DEPRECATED with TYPO3 v14. E_STRICT (2048) constant deprecated since PHP 8.4.0 RC1.
+    protected const DEFAULT_ERROR_HANDLER_LEVELS = E_ALL & ~(E_STRICT_DEPRECATED | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR);
+    // @todo Remove intermediate constant E_STRICT_DEPRECATED with TYPO3 v14. E_STRICT (2048) constant deprecated since PHP 8.4.0 RC1.
+    protected const DEFAULT_EXCEPTIONAL_ERROR_LEVELS = E_ALL & ~(E_STRICT_DEPRECATED | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR | E_DEPRECATED | E_USER_DEPRECATED | E_WARNING | E_USER_ERROR | E_USER_NOTICE | E_USER_WARNING);
 
     protected bool $resetSingletonInstances = true;
 
diff --git a/composer.json b/composer.json
@@ -116,6 +116,9 @@
 			"TYPO3\\CMS\\Core\\": "Classes/"
 		},
 		"classmap": ["Resources/PHP/"],
-		"files": ["Resources/PHP/GlobalDebugFunctions.php"]
+		"files": [
+			"Resources/PHP/DeprecatedConstants.php",
+			"Resources/PHP/GlobalDebugFunctions.php"
+		]
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ public function decode($typoLink)`
`80`	`80`	`{`
`81`	`81`	`$typoLink = trim((string)$typoLink);`
`82`	`82`	`if ($typoLink !== '') {`
`83`		`- $parts = str_replace(['\\\\', '\\"'], ['\\', '"'], str_getcsv($typoLink, static::$partDelimiter));`
	`83`	`+ $parts = str_replace(['\\\\', '\\"'], ['\\', '"'], str_getcsv($typoLink, static::$partDelimiter, '"', '\\'));`
`84`	`84`	`} else {`
`85`	`85`	`$parts = [];`
`86`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ public static function getValueByPath(array $array, array\|string $path, string $`
`181`	`181`	`// Programming error has to be sanitized before calling the method -> global exception`
`182`	`182`	`throw new \RuntimeException('Path must not be empty', 1341397767);`
`183`	`183`	`}`
`184`		`- $path = str_getcsv($path, $delimiter);`
	`184`	`+ $path = str_getcsv($path, $delimiter, '"', '\\');`
`185`	`185`	`}`
`186`	`186`	`// Loop through each part and extract its value`
`187`	`187`	`$value = $array;`
`@@ -265,7 +265,7 @@ public static function setValueByPath(array $array, string\|array\|\ArrayAccess $p`
`265`	`265`	`throw new \RuntimeException('Path must not be empty', 1341406194);`
`266`	`266`	`}`
`267`	`267`	`// Extract parts of the path`
`268`		`- $path = str_getcsv($path, $delimiter);`
	`268`	`+ $path = str_getcsv($path, $delimiter, '"', '\\');`
`269`	`269`	`}`
`270`	`270`	`// Point to the root of the array`
`271`	`271`	`$pointer = &$array;`
`@@ -306,7 +306,7 @@ public static function removeByPath(array $array, string $path, string $delimite`
`306`	`306`	`throw new \RuntimeException('Path must not be empty', 1371757718);`
`307`	`307`	`}`
`308`	`308`	`// Extract parts of the path`
`309`		`- $pathSegments = str_getcsv($path, $delimiter);`
	`309`	`+ $pathSegments = str_getcsv($path, $delimiter, '"', '\\');`
`310`	`310`	`$pathDepth = count($pathSegments);`
`311`	`311`	`$currentDepth = 0;`
`312`	`312`	`$pointer = &$array;`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public static function csvToArray(string $input, string $fieldDelimiter = ',', s`
`58`	`58`	`if (($handle = fopen('php://memory', 'r+')) !== false) {`
`59`	`59`	`fwrite($handle, $input);`
`60`	`60`	`rewind($handle);`
`61`		`- while (($cells = fgetcsv($handle, 0, $fieldDelimiter, $fieldEnclosure)) !== false) {`
	`61`	`+ while (($cells = fgetcsv($handle, 0, $fieldDelimiter, $fieldEnclosure, '\\')) !== false) {`
`62`	`62`	`$maximumCellCount = max(count($cells), $maximumCellCount);`
`63`	`63`	`$multiArray[] = preg_replace('\|<br */?>\|i', LF, $cells);`
`64`	`64`	`}`
`@@ -110,7 +110,7 @@ public static function csvValues(array $row, string $delim = ',', string $quote`
`110`	`110`	`} elseif ($type === self::TYPE_PREFIX_CONTROLS) {`
`111`	`111`	`$row = array_map(self::prefixControlLiterals(...), $row);`
`112`	`112`	`}`
`113`		`- fputcsv($resource, $modifier($row), $delim, $quote);`
	`113`	`+ fputcsv($resource, $modifier($row), $delim, $quote, '\\');`
`114`	`114`	`fseek($resource, 0);`
`115`	`115`	`return stream_get_contents($resource);`
`116`	`116`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,9 @@`
`116`	`116`	`"TYPO3\\CMS\\Core\\": "Classes/"`
`117`	`117`	`},`
`118`	`118`	`"classmap": ["Resources/PHP/"],`
`119`		`- "files": ["Resources/PHP/GlobalDebugFunctions.php"]`
	`119`	`+ "files": [`
	`120`	`+ "Resources/PHP/DeprecatedConstants.php",`
	`121`	`+ "Resources/PHP/GlobalDebugFunctions.php"`
	`122`	`+ ]`
`120`	`123`	`}`
`121`	`124`	`}`