Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[!!!][FEATURE] Replace $GLOBALS['PAGES_TYPES'] with shared state object
This change introduces a new registry class to be used automatically instead of accessing $GLOBALS['PAGES_TYPES'] which is not evaluated anymore. Also, instead of ExtensionManagementUtility::allowTableOnStandardPages() the flag $TCA[$table][ctrl][security][ignorePageTypeRestriction] is introduced which allows to avoid this call. Resolves: #98487 Releases: main Change-Id: I91bdb321500d133e645ccc5b6c0d159f5dd3ad87 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/75188 Tested-by: core-ci <typo3@b13.com> Tested-by: Georg Ringer <georg.ringer@gmail.com> Tested-by: Oliver Hader <oliver.hader@typo3.org> Reviewed-by: Kevin Appelt <kevin.appelt@icloud.com> Reviewed-by: Georg Ringer <georg.ringer@gmail.com> Reviewed-by: Oliver Hader <oliver.hader@typo3.org>
- Loading branch information
Showing
62 changed files
with
450 additions
and
210 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
typo3/sysext/core/Classes/DataHandling/PageDoktypeRegistry.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /* | ||
| * 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! | ||
| */ | ||
|
|
||
| namespace TYPO3\CMS\Core\DataHandling; | ||
|
|
||
| use TYPO3\CMS\Core\Domain\Repository\PageRepository; | ||
| use TYPO3\CMS\Core\SingletonInterface; | ||
| use TYPO3\CMS\Core\Utility\GeneralUtility; | ||
|
|
||
| /** | ||
| * This object defines the various types of pages (field: doktype) the system | ||
| * can handle and what restrictions may apply to them when adding records. | ||
| * Here you can define which tables are allowed on a certain pagetype (doktype). | ||
| * | ||
| * NOTE: The 'default' entry array is the 'base' for all types, and for every type the | ||
| * entries simply overrides the entries in the 'default' type! | ||
| * | ||
| * You can fully use this once TCA is properly loaded (e.g. in ext_tables.php). Please be | ||
| * aware that this class might change until TYPO3 v12 LTS, for further optimizations. | ||
| */ | ||
| class PageDoktypeRegistry implements SingletonInterface | ||
| { | ||
| protected array $pageTypes = [ | ||
| PageRepository::DOKTYPE_BE_USER_SECTION => [ | ||
| 'allowedTables' => '*', | ||
| ], | ||
| // Doktype 254 is a 'Folder' - a general purpose storage folder for whatever you like. | ||
| // In CMS context it's NOT a viewable page. Can contain any element. | ||
| PageRepository::DOKTYPE_SYSFOLDER => [ | ||
| 'allowedTables' => '*', | ||
| ], | ||
| // Doktype 255 is a recycle-bin. | ||
| PageRepository::DOKTYPE_RECYCLER => [ | ||
| 'allowedTables' => 'sys_file', | ||
| ], | ||
| PageRepository::DOKTYPE_MOUNTPOINT => [ | ||
| ], | ||
| // Even though both options look contradictory, the "allowedTables" key is used for other $pageTypes | ||
| // that have no custom definitions. So "allowedTables" works as a fallback for additional page types | ||
| // Effectively working like "allowTableOnStandardPages()" as the default entry is a "standard page" | ||
| 'default' => [ | ||
| 'allowedTables' => 'pages,sys_category,sys_file_reference,sys_file_collection', | ||
| 'onlyAllowedTables' => false, | ||
| ], | ||
| ]; | ||
|
|
||
| /** | ||
| * Adds a specific configuration for a doktype. By default, it is NOT restricted to only allow tables that | ||
| * have been explicitly added via addAllowedRecordTypes(). | ||
| * | ||
| * @param int $dokType | ||
| * @param array $configuration | ||
| */ | ||
| public function add(int $dokType, array $configuration): void | ||
| { | ||
| $this->pageTypes[$dokType] = array_replace(['onlyAllowedTables' => false], $configuration); | ||
| } | ||
|
|
||
| public function addAllowedRecordTypes(array $recordTypes, ?int $doktype = null): void | ||
| { | ||
| if ($recordTypes === []) { | ||
| return; | ||
| } | ||
| $doktype ??= 'default'; | ||
| if (!isset($this->pageTypes[$doktype]['allowedTables'])) { | ||
| $this->pageTypes[$doktype]['allowedTables'] = ''; | ||
| } | ||
| $this->pageTypes[$doktype]['allowedTables'] .= ',' . implode(',', $recordTypes); | ||
| } | ||
|
|
||
| /** | ||
| * Check if a record can be added on a page with a given $doktype. | ||
| */ | ||
| public function isRecordTypeAllowedForDoktype(string $type, ?int $doktype): bool | ||
| { | ||
| $doktype ??= 'default'; | ||
| $allowedTableList = $this->pageTypes[$doktype]['allowedTables'] ?? $this->pageTypes['default']['allowedTables']; | ||
| return str_contains($allowedTableList, '*') || GeneralUtility::inList($allowedTableList, $type); | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| public function getRegisteredDoktypes(): array | ||
| { | ||
| $items = $this->pageTypes; | ||
| unset($items['default']); | ||
| return array_keys($items); | ||
| } | ||
|
|
||
| /** | ||
| * Used to find out if a specific doktype is restricted to only allow a certain list of tables. | ||
| * This list can be checked against via 'isRecordTypeAllowedForDoktype()' | ||
| */ | ||
| public function doesDoktypeOnlyAllowSpecifiedRecordTypes(int $doktype = null): bool | ||
| { | ||
| $doktype = $doktype ?? 'default'; | ||
| return $this->pageTypes[$doktype]['onlyAllowedTables'] ?? false; | ||
| } | ||
|
|
||
| /** | ||
| * @internal only to be used within TYPO3 Core | ||
| */ | ||
| public function getAllowedTypesForDoktype(int $doktype): array | ||
| { | ||
| $allowedTableList = $this->pageTypes[$doktype]['allowedTables'] ?? $this->pageTypes['default']['allowedTables']; | ||
| return explode(',', $allowedTableList); | ||
| } | ||
|
|
||
| /** | ||
| * @internal only to be used within TYPO3 Core | ||
| */ | ||
| public function exportConfiguration(): array | ||
| { | ||
| return $this->pageTypes; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
.../core/Documentation/Changelog/12.0/Breaking-98487-GLOBALSPAGES_TYPESRemoved.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| .. include:: /Includes.rst.txt | ||
|
|
||
| .. _breaking-98487-1664575125: | ||
|
|
||
| ================================================== | ||
| Breaking: #98487 - $GLOBALS['PAGES_TYPES'] removed | ||
| ================================================== | ||
|
|
||
| See :issue:`98487` | ||
|
|
||
| Description | ||
| =========== | ||
|
|
||
| The global array :php:`PAGES_TYPES` has been removed in favor of a new registry | ||
| class containing the shared state. | ||
|
|
||
|
|
||
| Impact | ||
| ====== | ||
|
|
||
| Accessing or modifying :php:`$GLOBALS['PAGES_TYPES']` will have no effect anymore. | ||
|
|
||
|
|
||
| Affected installations | ||
| ====================== | ||
|
|
||
| TYPO3 installations with custom extensions creating custom TCA records or custom | ||
| Page Doktypes. | ||
|
|
||
|
|
||
| Migration | ||
| ========= | ||
|
|
||
| Use the new PageTypeRegistry class to register custom page types with their | ||
| dependency what kind of records should be allowed for creation, or to read the | ||
| information what record types are allowed on a specific pages.doktype. | ||
|
|
||
| .. index:: PHP-API, FullyScanned, ext:core |
Oops, something went wrong.