9752 lines
508 KiB
PHP
9752 lines
508 KiB
PHP
<?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!
|
|
*/
|
|
|
|
namespace TYPO3\CMS\Core\DataHandling;
|
|
|
|
use Doctrine\DBAL\Exception as DBALException;
|
|
use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
|
|
use Doctrine\DBAL\Types\IntegerType;
|
|
use Doctrine\DBAL\Types\JsonType;
|
|
use Psr\Container\ContainerInterface;
|
|
use Psr\EventDispatcher\EventDispatcherInterface;
|
|
use Psr\Log\LoggerInterface;
|
|
use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
|
|
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
|
use Symfony\Component\Uid\Uuid;
|
|
use TYPO3\CMS\Backend\Domain\Repository\Localization\LocalizationRepository;
|
|
use TYPO3\CMS\Backend\Utility\BackendUtility;
|
|
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
|
|
use TYPO3\CMS\Core\Cache\CacheManager;
|
|
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
|
|
use TYPO3\CMS\Core\Configuration\FlexForm\Exception\AbstractInvalidDataStructureException;
|
|
use TYPO3\CMS\Core\Configuration\FlexForm\Exception\InvalidIdentifierException;
|
|
use TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools;
|
|
use TYPO3\CMS\Core\Configuration\Richtext;
|
|
use TYPO3\CMS\Core\Core\Environment;
|
|
use TYPO3\CMS\Core\Crypto\PasswordHashing\InvalidPasswordHashException;
|
|
use TYPO3\CMS\Core\Crypto\PasswordHashing\PasswordHashFactory;
|
|
use TYPO3\CMS\Core\Crypto\Random;
|
|
use TYPO3\CMS\Core\Database\Connection;
|
|
use TYPO3\CMS\Core\Database\ConnectionPool;
|
|
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
|
|
use TYPO3\CMS\Core\Database\Query\QueryHelper;
|
|
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
|
|
use TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
|
|
use TYPO3\CMS\Core\Database\RelationHandler;
|
|
use TYPO3\CMS\Core\DataHandling\Event\BeforeRemoveNonCopyableFieldsEvent;
|
|
use TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore;
|
|
use TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor;
|
|
use TYPO3\CMS\Core\DataHandling\Model\CorrelationId;
|
|
use TYPO3\CMS\Core\DataHandling\Model\RecordStateFactory;
|
|
use TYPO3\CMS\Core\Domain\DateTimeFactory;
|
|
use TYPO3\CMS\Core\Exception\SiteNotFoundException;
|
|
use TYPO3\CMS\Core\Html\RteHtmlParser;
|
|
use TYPO3\CMS\Core\LinkHandling\Exception\UnknownLinkHandlerException;
|
|
use TYPO3\CMS\Core\LinkHandling\LinkService;
|
|
use TYPO3\CMS\Core\LinkHandling\TypoLinkCodecService;
|
|
use TYPO3\CMS\Core\Localization\LanguageService;
|
|
use TYPO3\CMS\Core\Log\LogDataTrait;
|
|
use TYPO3\CMS\Core\Messaging\FlashMessage;
|
|
use TYPO3\CMS\Core\Messaging\FlashMessageService;
|
|
use TYPO3\CMS\Core\PasswordPolicy\Event\EnrichPasswordValidationContextDataEvent;
|
|
use TYPO3\CMS\Core\PasswordPolicy\PasswordPolicyAction;
|
|
use TYPO3\CMS\Core\PasswordPolicy\PasswordPolicyValidator;
|
|
use TYPO3\CMS\Core\PasswordPolicy\Validator\Dto\ContextData;
|
|
use TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter;
|
|
use TYPO3\CMS\Core\Schema\Capability\LanguageAwareSchemaCapability;
|
|
use TYPO3\CMS\Core\Schema\Capability\RootLevelCapability;
|
|
use TYPO3\CMS\Core\Schema\Capability\TcaSchemaCapability;
|
|
use TYPO3\CMS\Core\Schema\Field\FieldCollection;
|
|
use TYPO3\CMS\Core\Schema\Field\FieldTranslationBehaviour;
|
|
use TYPO3\CMS\Core\Schema\Field\FileFieldType;
|
|
use TYPO3\CMS\Core\Schema\Field\InlineFieldType;
|
|
use TYPO3\CMS\Core\Schema\Struct\SelectItemCollection;
|
|
use TYPO3\CMS\Core\Schema\TcaSchemaFactory;
|
|
use TYPO3\CMS\Core\Service\OpcodeCacheService;
|
|
use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
|
|
use TYPO3\CMS\Core\Site\SiteFinder;
|
|
use TYPO3\CMS\Core\SysLog\Action\Cache as SystemLogCacheAction;
|
|
use TYPO3\CMS\Core\SysLog\Action\Database as SystemLogDatabaseAction;
|
|
use TYPO3\CMS\Core\SysLog\Error as SystemLogErrorClassification;
|
|
use TYPO3\CMS\Core\SysLog\Repository\LogEntryRepository;
|
|
use TYPO3\CMS\Core\SysLog\Type as SystemLogType;
|
|
use TYPO3\CMS\Core\Type\Bitmask\Permission;
|
|
use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
|
|
use TYPO3\CMS\Core\Type\VirtualRecord;
|
|
use TYPO3\CMS\Core\Utility\ArrayUtility;
|
|
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Core\Utility\MathUtility;
|
|
use TYPO3\CMS\Core\Utility\StringUtility;
|
|
use TYPO3\CMS\Core\Versioning\VersionState;
|
|
|
|
/**
|
|
* The main data handler class which takes care of correctly updating and inserting records.
|
|
* This class was formerly known as TCEmain.
|
|
*
|
|
* This is the TYPO3 Core Engine class for manipulation of the database
|
|
* This class is used by eg. the tce_db BE route (SimpleDataHandlerController) which provides an interface for POST forms to this class.
|
|
*
|
|
* Dependencies:
|
|
* - $GLOBALS['TCA'] must exist
|
|
* - $GLOBALS['LANG'] must exist
|
|
*
|
|
* Also see document 'TYPO3 Core API' for details.
|
|
*/
|
|
#[Autoconfigure(public: true, shared: false)]
|
|
class DataHandler
|
|
{
|
|
use LogDataTrait;
|
|
|
|
/**
|
|
* Prefix for the cache entries of nested element calls since the runtimeCache has a global scope.
|
|
*/
|
|
protected const CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX = 'core-datahandler-nestedElementCalls-';
|
|
protected const CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED = 'core-datahandler-elementsToBeDeleted';
|
|
|
|
/**
|
|
* If TRUE, actions are logged to sys_log.
|
|
*/
|
|
public bool $enableLogging = true;
|
|
|
|
/**
|
|
* If TRUE, the datamap array is reversed in the order, which is a nice thing if you're creating a whole new
|
|
* bunch of records.
|
|
*/
|
|
public bool $reverseOrder = false;
|
|
|
|
/**
|
|
* If set, then the TCE class has been instantiated during an import action of a T3D
|
|
*/
|
|
public bool $isImporting = false;
|
|
|
|
/**
|
|
* If set, then transformations are NOT performed on the input.
|
|
*/
|
|
public bool $dontProcessTransformations = false;
|
|
|
|
/**
|
|
* Will distinguish between translations (with parent) and localizations (without parent) while still using the same methods to copy the records
|
|
* TRUE: translation of a record connected to the default language
|
|
* FALSE: localization of a record without connection to the default language
|
|
*/
|
|
protected bool $useTransOrigPointerField = true;
|
|
|
|
/**
|
|
* If TRUE, access check, check for deleted etc. for records is bypassed.
|
|
* YOU MUST KNOW what you are doing if you use this feature!
|
|
*/
|
|
public bool $bypassAccessCheckForRecords = false;
|
|
|
|
/**
|
|
* [table][fields]=value: New records are created with default values and you can set this array on the
|
|
* form $defaultValues[$table][$field] = $value to override the default values fetched from TCA.
|
|
* If ->setDefaultsFromUserTS is called UserTSconfig default values will overrule existing values in this array
|
|
* (thus UserTSconfig overrules externally set defaults which overrules TCA defaults)
|
|
*
|
|
* @internal should only be used from within DataHandler as permission checks do not apply to default values
|
|
*/
|
|
public array $defaultValues = [];
|
|
|
|
/**
|
|
* Use this array to validate suggested uids for tables by setting [table]:[uid]. This is a dangerous option
|
|
* since it will force the inserted record to have a certain UID. The value just have to be TRUE, but if you set
|
|
* it to "DELETE" it will make sure any record with that UID will be deleted first (raw delete).
|
|
* The option is used for import of T3D files when synchronizing between two mirrored servers.
|
|
* As a security measure this feature is available only for Admin Users (for now)
|
|
*/
|
|
public array $suggestedInsertUids = [];
|
|
|
|
/**
|
|
* A string which can be used as correlationId for RecordHistory entries.
|
|
* The string can later be used to rollback multiple changes at once.
|
|
*/
|
|
protected ?CorrelationId $correlationId = null;
|
|
|
|
// *********************
|
|
// Internal variables (mapping arrays) which can be used (read-only) from outside
|
|
// *********************
|
|
/**
|
|
* Contains mapping of auto-versioned records.
|
|
*
|
|
* @var array<string, array<int, string>>
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public array $autoVersionIdMap = [];
|
|
|
|
/**
|
|
* When new elements are created, this array contains a map between their "NEW..." string IDs
|
|
* and the final uid they got when stored in database. This public array is rather important
|
|
* since it is used by many DH consumers to further work with records after creation.
|
|
*/
|
|
public array $substNEWwithIDs = [];
|
|
|
|
/**
|
|
* Like $substNEWwithIDs, but where each old "NEW..." id is mapped to the table it was from.
|
|
*
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public array $substNEWwithIDs_table = [];
|
|
|
|
/**
|
|
* Holds the tables and there the ids of newly created child records from IRRE
|
|
*
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public array $newRelatedIDs = [];
|
|
|
|
/**
|
|
* This array is the sum of all copying operations in this class.
|
|
*
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public array $copyMappingArray_merged = [];
|
|
|
|
/**
|
|
* Errors are collected in this variable.
|
|
*
|
|
* @internal should only be used from within TYPO3 Core
|
|
*
|
|
* @var list<non-empty-string>
|
|
*/
|
|
public array $errorLog = [];
|
|
|
|
/**
|
|
* Fields from the pages-table for which changes will trigger a pagetree refresh
|
|
*/
|
|
public array $pagetreeRefreshFieldsFromPages = ['pid', 'sorting', 'deleted', 'hidden', 'title', 'doktype', 'is_siteroot', 'fe_group', 'nav_hide', 'nav_title', 'module', 'starttime', 'endtime', 'content_from_pid', 'extendToSubpages'];
|
|
|
|
/**
|
|
* Indicates whether the pagetree needs a refresh because of important changes
|
|
*
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public bool $pagetreeNeedsRefresh = false;
|
|
|
|
// *********************
|
|
// Internal Variables, do not touch.
|
|
// *********************
|
|
|
|
// Variables set in init() function:
|
|
|
|
/**
|
|
* The user-object the script uses. If not set from outside, this is set to the current global $BE_USER.
|
|
*/
|
|
public BackendUserAuthentication $BE_USER;
|
|
|
|
/**
|
|
* Data submitted from the form view, used to control behaviours,
|
|
* e.g. this is used to activate/deactivate fields and thus store NULL values
|
|
*/
|
|
protected array $control = [];
|
|
|
|
/**
|
|
* Set with incoming data array. The array shape is checked in start() before setting this property.
|
|
*
|
|
* @todo: This is public to allow manipulation by hooks (e.g. workspaces). Consider
|
|
* introduction of a public setter setCommandMap() that checks the array shape
|
|
* as done in start() already. Then have a getter as well and protect this property.
|
|
* @var array<string, array<int|string, array>>
|
|
*/
|
|
public array $datamap = [];
|
|
|
|
/**
|
|
* Incoming command array. The array shape is checked in start() before setting this property.
|
|
*
|
|
* @todo: This is public to allow manipulation by hooks (e.g. workspaces). Consider
|
|
* introduction of a public setter setCommandMap() that checks the array shape
|
|
* as done in start() already. Then have a getter as well and protect this property.
|
|
* @var array<string, array<int|string, array>>
|
|
*/
|
|
public array $cmdmap = [];
|
|
|
|
/**
|
|
* List of changed old record ids to new records ids
|
|
*/
|
|
protected array $mmHistoryRecords = [];
|
|
|
|
/**
|
|
* List of changed old record ids to new records ids
|
|
*/
|
|
protected array $historyRecords = [];
|
|
|
|
/**
|
|
* The interval between sorting numbers used with tables with a 'sorting' field defined.
|
|
*
|
|
* Min 1, should be power of 2
|
|
*
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public int $sortIntervals = 256;
|
|
|
|
/**
|
|
* For accumulation of MM relations that must be written after new records are created.
|
|
*
|
|
* @internal
|
|
*/
|
|
public array $dbAnalysisStore = [];
|
|
|
|
/**
|
|
* Used for tracking references that might need correction after operations
|
|
*
|
|
* @var array<string, array<int, array>>
|
|
* @internal
|
|
*/
|
|
public array $registerDBList = [];
|
|
|
|
/**
|
|
* Used for tracking references that might need correction in pid field after operations (e.g. IRRE)
|
|
*
|
|
* @internal
|
|
*/
|
|
public array $registerDBPids = [];
|
|
|
|
/**
|
|
* Used by the copy action to track the ids of new pages so subpages are correctly inserted!
|
|
* THIS is internally cleared for each executed copy operation! DO NOT USE THIS FROM OUTSIDE!
|
|
* Read from copyMappingArray_merged instead which is accumulating this information.
|
|
*
|
|
* NOTE: This is used by some outside scripts (e.g. hooks), as the results in $copyMappingArray_merged
|
|
* are only available after an action has been completed.
|
|
*
|
|
* @var array<string, array>
|
|
* @internal
|
|
*/
|
|
public array $copyMappingArray = [];
|
|
|
|
/**
|
|
* Array used for remapping uids and values at the end of process_datamap
|
|
*
|
|
* @internal
|
|
*/
|
|
public array $remapStack = [];
|
|
|
|
/**
|
|
* Array used for remapping uids and values at the end of process_datamap
|
|
* (e.g. $remapStackRecords[<table>][<uid>] = <index in $remapStack>)
|
|
*
|
|
* @internal
|
|
*/
|
|
public array $remapStackRecords = [];
|
|
|
|
/**
|
|
* Array used for executing addition actions after remapping happened (set processRemapStack())
|
|
*/
|
|
protected array $remapStackActions = [];
|
|
|
|
/**
|
|
* A list of fields which should not be processed. They are still written - just passed through no-questions-asked!
|
|
*/
|
|
protected array $nonFields = [
|
|
'uid',
|
|
'perms_userid',
|
|
'perms_groupid',
|
|
'perms_user',
|
|
'perms_group',
|
|
'perms_everybody',
|
|
't3ver_oid',
|
|
't3ver_wsid',
|
|
't3ver_state',
|
|
't3ver_stage',
|
|
];
|
|
|
|
/**
|
|
* Registry object to gather reference index update requests and perform updates after
|
|
* main processing has been done. It is created upon first start() call and hand over
|
|
* when dealing with internal sub instances. The final update() call is done at the end of
|
|
* process_cmdmap() or process_datamap() in the outermost instance.
|
|
*/
|
|
protected ReferenceIndexUpdater $referenceIndexUpdater;
|
|
|
|
// Various
|
|
|
|
/**
|
|
* Set to "currentRecord" during checking of values.
|
|
*
|
|
* @var array
|
|
* @internal
|
|
*/
|
|
public $checkValue_currentRecord = [];
|
|
|
|
/**
|
|
* The outermost instance of \TYPO3\CMS\Core\DataHandling\DataHandler:
|
|
* This object instantiates itself on versioning and localization ...
|
|
*/
|
|
protected ?self $outerMostInstance = null;
|
|
|
|
/**
|
|
* Internal cache for collecting records that should trigger cache clearing
|
|
*/
|
|
protected static array $recordsToClearCacheFor = [];
|
|
|
|
/**
|
|
* Internal cache for pids of records which were deleted. It's not possible
|
|
* to retrieve the parent folder/page at a later stage
|
|
*/
|
|
protected static array $recordPidsForDeletedRecords = [];
|
|
|
|
/**
|
|
* Remove fields that should not be processed during record copying.
|
|
*
|
|
* @param array $row Record row to filter
|
|
* @return array Filtered row without nonFields (uid, perms_*, t3ver_*)
|
|
*/
|
|
protected function removeNonCopyableFields(string $table, array $row, string $callingOperation): array
|
|
{
|
|
$beforeRemoveNonCopyableFieldsEvent = $this->eventDispatcher->dispatch(
|
|
new BeforeRemoveNonCopyableFieldsEvent($table, $row, $callingOperation, $this->nonFields),
|
|
);
|
|
return array_diff_key($row, array_flip($beforeRemoveNonCopyableFieldsEvent->getNonCopyableFields()));
|
|
}
|
|
|
|
public function __construct(
|
|
private readonly EventDispatcherInterface $eventDispatcher,
|
|
private readonly CacheManager $cacheManager,
|
|
#[Autowire(service: 'cache.runtime')]
|
|
private readonly FrontendInterface $runtimeCache,
|
|
private readonly ConnectionPool $connectionPool,
|
|
private readonly LoggerInterface $logger,
|
|
private readonly PagePermissionAssembler $pagePermissionAssembler,
|
|
private readonly TcaSchemaFactory $tcaSchemaFactory,
|
|
private readonly PageDoktypeRegistry $pageDoktypeRegistry,
|
|
private readonly FlexFormTools $flexFormTools,
|
|
private readonly Richtext $richtext,
|
|
private readonly PasswordHashFactory $passwordHashFactory,
|
|
private readonly Random $randomGenerator,
|
|
private readonly TypoLinkCodecService $typoLinkCodecService,
|
|
private readonly OpcodeCacheService $opcodeCacheService,
|
|
private readonly FlashMessageService $flashMessageService,
|
|
private readonly LogEntryRepository $logEntryRepository,
|
|
private readonly LocalizationRepository $localizationRepository,
|
|
private readonly SiteFinder $siteFinder,
|
|
private readonly DataMapProcessor $dataMapProcessor,
|
|
private readonly LinkService $linkService,
|
|
) {}
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
public function setControl(array $control): void
|
|
{
|
|
$this->control = $control;
|
|
}
|
|
|
|
/**
|
|
* Initializing.
|
|
* For details, see 'TYPO3 Core API' document.
|
|
* This method does not start the processing of data, but merely initializes the object.
|
|
*
|
|
* @param array $dataMap Data to be modified or inserted in the database
|
|
* @param array $commandMap Commands to copy, move, delete, localize, versionize records.
|
|
* @param BackendUserAuthentication|null $backendUser An alternative user, default is $GLOBALS['BE_USER']
|
|
* @param CorrelationId|null $correlationId Correlation id of the outer instance when this is a sub instance of a DataHandler chain run, default is a newly generated one
|
|
*/
|
|
public function start(
|
|
array $dataMap,
|
|
array $commandMap,
|
|
?BackendUserAuthentication $backendUser = null,
|
|
?ReferenceIndexUpdater $referenceIndexUpdater = null,
|
|
?CorrelationId $correlationId = null
|
|
): void {
|
|
// Initializing BE_USER
|
|
$this->BE_USER = $backendUser ?: $GLOBALS['BE_USER'];
|
|
// Sub instances should receive ReferenceIndexUpdater via start() and not from __construct() DI since
|
|
// it is a stateful object for *this* DH chain run. If this is the outermost instance, a new one is created.
|
|
$this->referenceIndexUpdater = $referenceIndexUpdater ?? GeneralUtility::makeInstance(ReferenceIndexUpdater::class);
|
|
|
|
// Sub instances receive the correlation id of the outer instance so all record history entries of one
|
|
// logical operation share the same scope. A new one is set for each new outermost set of data or commands.
|
|
$this->correlationId = $correlationId ?? CorrelationId::forScope(
|
|
$this->randomGenerator->generateRandomBase64String(32)
|
|
);
|
|
|
|
// Get default values from user TSconfig
|
|
$tcaDefaultOverride = $this->BE_USER->getTSConfig()['TCAdefaults.'] ?? null;
|
|
$this->setDefaultsFromUserTS($tcaDefaultOverride);
|
|
|
|
foreach ($dataMap as $tableName => $tableRecordArray) {
|
|
// @todo: Move this to a public setter and call it here. Then protect the property.
|
|
if (!is_string($tableName) || !is_array($tableRecordArray)) {
|
|
throw new \UnexpectedValueException('Data array must be shaped ["tableName" => [uid/"NEW.." => ["fieldName" => value]]]', 1709035799);
|
|
}
|
|
}
|
|
$this->datamap = $dataMap;
|
|
|
|
foreach ($commandMap as $idCommandArray) {
|
|
// @todo: Move this to a public setter and call it here. Then protect the property.
|
|
if (!is_array($idCommandArray)) {
|
|
throw new \UnexpectedValueException('Command array must be shaped ["table" => [uid => ["command" => value]]]', 1708586415);
|
|
}
|
|
foreach ($idCommandArray as $id => $commandValueArray) {
|
|
if (!MathUtility::canBeInterpretedAsInteger($id) || !is_array($commandValueArray)) {
|
|
throw new \UnexpectedValueException('Single record commands must be shaped [uid => ["command" => value]]', 1708586979);
|
|
}
|
|
}
|
|
}
|
|
$this->cmdmap = $commandMap;
|
|
}
|
|
|
|
/**
|
|
* Function that can mirror input values in datamap-array to other uid numbers.
|
|
* Example: $mirror[table][11] = '22,33' will look for content in $this->datamap[table][11] and copy it to $this->datamap[table][22] and $this->datamap[table][33]
|
|
*
|
|
* @param array|mixed $mirror This array has the syntax $mirror[table_name][uid] = [list of uids to copy data-value TO!]
|
|
* @internal
|
|
*/
|
|
public function setMirror($mirror): void
|
|
{
|
|
if (!is_array($mirror)) {
|
|
return;
|
|
}
|
|
foreach ($mirror as $table => $uid_array) {
|
|
if (!isset($this->datamap[$table])) {
|
|
continue;
|
|
}
|
|
foreach ($uid_array as $id => $uidList) {
|
|
if (!isset($this->datamap[$table][$id])) {
|
|
continue;
|
|
}
|
|
$theIdsInArray = GeneralUtility::trimExplode(',', $uidList, true);
|
|
foreach ($theIdsInArray as $copyToUid) {
|
|
$this->datamap[$table][$copyToUid] = $this->datamap[$table][$id];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Initializes default values coming from user TSconfig
|
|
* Supports both field-level defaults and type-specific defaults
|
|
* TCAdefaults.tt_content.header_layout = 1 (field-level)
|
|
* TCAdefaults.tt_content.header_layout.types.textmedia = 3 (type-specific)
|
|
*
|
|
* @param array|null $userTS User TSconfig array
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function setDefaultsFromUserTS($userTS): void
|
|
{
|
|
if (!is_array($userTS)) {
|
|
return;
|
|
}
|
|
foreach ($userTS as $k => $v) {
|
|
$k = mb_substr($k, 0, -1);
|
|
if (!$k || !is_array($v) || !$this->tcaSchemaFactory->has($k)) {
|
|
continue;
|
|
}
|
|
// Process type-specific TCA defaults, if schema supports subschema
|
|
if ($this->tcaSchemaFactory->get($k)->supportsSubSchema()) {
|
|
$v = $this->processTypeSpecificTcaDefaults($v);
|
|
}
|
|
if (is_array($this->defaultValues[$k] ?? false)) {
|
|
$this->defaultValues[$k] = array_merge($this->defaultValues[$k], $v);
|
|
} else {
|
|
$this->defaultValues[$k] = $v;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Process TCA defaults configuration, preserving type-specific
|
|
* structure for later processing when record type is known.
|
|
*
|
|
* @param array $tcaDefaults Raw TCA defaults configuration
|
|
* @return array Processed defaults ready for storage
|
|
*/
|
|
protected function processTypeSpecificTcaDefaults(array $tcaDefaults): array
|
|
{
|
|
$processedDefaults = [];
|
|
|
|
foreach ($tcaDefaults as $fieldKey => $fieldConfiguration) {
|
|
if (str_ends_with($fieldKey, '.')) {
|
|
// Field with potential sub-configuration (types)
|
|
$fieldName = rtrim($fieldKey, '.');
|
|
if (!is_array($fieldConfiguration)) {
|
|
continue;
|
|
}
|
|
|
|
// Store the full configuration including type-specific data
|
|
// This will be processed later in newFieldArray when we have record context
|
|
$processedDefaults['__typeSpecific'][$fieldName] = $fieldConfiguration;
|
|
|
|
// Also set field-level default if available
|
|
foreach ($fieldConfiguration as $key => $value) {
|
|
if (!str_ends_with($key, '.') && !is_array($value)) {
|
|
$processedDefaults[$fieldName] = $value;
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
// Simple field-level default
|
|
$processedDefaults[$fieldKey] = $fieldConfiguration;
|
|
}
|
|
}
|
|
|
|
return $processedDefaults;
|
|
}
|
|
|
|
/**
|
|
* When a new record is created, all values that haven't been set but are set via PageTSconfig / UserTSconfig
|
|
* get applied here.
|
|
*
|
|
* This is only executed for new records. The most important part is that the pageTS of the actual resolved $pid
|
|
* is taken, and a new field array with empty defaults is set again.
|
|
*/
|
|
protected function applyDefaultsForFieldArray(string $table, int $pageId, array $prepopulatedFieldArray, array $incomingFieldArray = []): array
|
|
{
|
|
// First set TCAdefaults respecting the given PageID
|
|
$tcaDefaults = BackendUtility::getPagesTSconfig($pageId)['TCAdefaults.'] ?? null;
|
|
// Re-apply $this->defaultValues settings
|
|
$this->setDefaultsFromUserTS($tcaDefaults);
|
|
// Merge incoming field array to have access to record type for type-specific defaults
|
|
$recordContext = array_merge($prepopulatedFieldArray, $incomingFieldArray);
|
|
$cleanFieldArray = $this->newFieldArray($table, $recordContext);
|
|
if (isset($prepopulatedFieldArray['pid'])) {
|
|
$cleanFieldArray['pid'] = $prepopulatedFieldArray['pid'];
|
|
}
|
|
if (!$this->tcaSchemaFactory->has($table)) {
|
|
return $cleanFieldArray;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if ($schema->hasCapability(TcaSchemaCapability::SortByField)) {
|
|
$sortByField = $schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName();
|
|
if (isset($prepopulatedFieldArray[$sortByField])) {
|
|
$cleanFieldArray[$sortByField] = $prepopulatedFieldArray[$sortByField];
|
|
}
|
|
}
|
|
return $cleanFieldArray;
|
|
}
|
|
|
|
/**
|
|
* Hook: processDatamap_afterDatabaseOperations
|
|
* (calls $hookObj->processDatamap_afterDatabaseOperations($status, $table, $id, $fieldArray, $this);)
|
|
*
|
|
* Note: When using the hook after INSERT operations, you will only get the temporary NEW... id passed to your hook as $id,
|
|
* but you can easily translate it to the real uid of the inserted record using the $this->substNEWwithIDs array.
|
|
*
|
|
* @param array $hookObjectsArr (reference) Array with hook objects
|
|
* @param string $status (reference) Status of the current operation, 'new' or 'update
|
|
* @param string $table (reference) The table currently processing data for
|
|
* @param string $id (reference) The record uid currently processing data for, [integer] or [string] (like 'NEW...')
|
|
* @param array $fieldArray (reference) The field array of a record
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function hook_processDatamap_afterDatabaseOperations($hookObjectsArr, $status, &$table, &$id, &$fieldArray): void
|
|
{
|
|
if (!isset($this->remapStackRecords[$table][$id])) {
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processDatamap_afterDatabaseOperations')) {
|
|
$hookObj->processDatamap_afterDatabaseOperations($status, $table, $id, $fieldArray, $this);
|
|
}
|
|
}
|
|
} else {
|
|
$this->remapStackRecords[$table][$id]['processDatamap_afterDatabaseOperations'] = [
|
|
'status' => $status,
|
|
'fieldArray' => $fieldArray,
|
|
'hookObjectsArr' => $hookObjectsArr,
|
|
];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Processing the data-array
|
|
* Call this function to process the data-array set by start()
|
|
*/
|
|
public function process_datamap(): void
|
|
{
|
|
$this->controlActiveElements();
|
|
$this->registerElementsToBeDeleted();
|
|
$this->datamap = $this->unsetElementsToBeDeleted($this->datamap);
|
|
|
|
$hookObjectsArr = [];
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass'] ?? [] as $className) {
|
|
// Instantiate hooks and call first hook method
|
|
$hookObject = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hookObject, 'processDatamap_beforeStart')) {
|
|
$hookObject->processDatamap_beforeStart($this);
|
|
}
|
|
$hookObjectsArr[] = $hookObject;
|
|
}
|
|
|
|
$this->datamap = $this->dataMapProcessor->process($this->datamap, $this->BE_USER, $this->referenceIndexUpdater, $this->correlationId);
|
|
$registerDBList = [];
|
|
$orderOfTables = [];
|
|
if (isset($this->datamap['pages'])) {
|
|
// Handling pages table is always the first task to make sure they are done if other records are added to them.
|
|
$orderOfTables[] = 'pages';
|
|
}
|
|
$orderOfTables = array_unique(array_merge($orderOfTables, array_keys($this->datamap)));
|
|
foreach ($orderOfTables as $table) {
|
|
if (!$this->checkModifyAccessList($table)) {
|
|
// User is not allowed to modify
|
|
$this->log($table, 0, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to modify table "{table}" without permission', null, ['table' => $table]);
|
|
continue;
|
|
}
|
|
if (!$this->tcaSchemaFactory->has($table)) {
|
|
// Table not set in TCA
|
|
continue;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if ($schema->hasCapability(TcaSchemaCapability::AccessReadOnly)) {
|
|
// Table is readonly
|
|
continue;
|
|
}
|
|
|
|
if ($this->reverseOrder) {
|
|
$this->datamap[$table] = array_reverse($this->datamap[$table], true);
|
|
}
|
|
|
|
foreach ($this->datamap[$table] as $id => $incomingFieldArray) {
|
|
if (!is_array($incomingFieldArray)) {
|
|
continue;
|
|
}
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processDatamap_preProcessFieldArray')) {
|
|
$hookObj->processDatamap_preProcessFieldArray($incomingFieldArray, $table, $id, $this);
|
|
// If a hook invalidated $incomingFieldArray, skip the record completely
|
|
if (!is_array($incomingFieldArray)) { // @phpstan-ignore function.alreadyNarrowedType (hook may modify variable type by reference)
|
|
continue 2;
|
|
}
|
|
}
|
|
}
|
|
|
|
$theRealPid = null;
|
|
$createNewVersion = false;
|
|
$old_pid_value = '';
|
|
if (!MathUtility::canBeInterpretedAsInteger($id)) {
|
|
// $id is not an integer. We're creating a new record.
|
|
// Get a fieldArray with tca default values
|
|
$fieldArray = $this->newFieldArray($table, $incomingFieldArray);
|
|
if (isset($incomingFieldArray['pid'])) {
|
|
// A pid must be set for new records.
|
|
$pid_value = $incomingFieldArray['pid'];
|
|
// Checking and finding numerical pid, it may be a string-reference to another value
|
|
$canProceed = true;
|
|
// If a NEW... id
|
|
if (str_contains($pid_value, 'NEW')) {
|
|
if ($pid_value[0] === '-') {
|
|
$negFlag = -1;
|
|
$pid_value = substr($pid_value, 1);
|
|
} else {
|
|
$negFlag = 1;
|
|
}
|
|
// Trying to find the correct numerical value as it should be mapped by earlier processing of another new record.
|
|
if (isset($this->substNEWwithIDs[$pid_value])) {
|
|
if ($negFlag === 1) {
|
|
$old_pid_value = $this->substNEWwithIDs[$pid_value];
|
|
}
|
|
$pid_value = (int)($negFlag * $this->substNEWwithIDs[$pid_value]);
|
|
} else {
|
|
$canProceed = false;
|
|
}
|
|
}
|
|
$pid_value = (int)$pid_value;
|
|
if ($canProceed) {
|
|
$fieldArray = $this->resolveSortingAndPidForNewRecord($table, $pid_value, $fieldArray);
|
|
}
|
|
}
|
|
$theRealPid = $fieldArray['pid'];
|
|
// Checks if records can be inserted on this $pid.
|
|
// If this is a page translation, the check needs to be done for the l10n_parent record
|
|
$languageField = null;
|
|
$transOrigPointerField = null;
|
|
if ($schema->isLanguageAware()) {
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$languageField = $languageCapability->getLanguageField()->getName();
|
|
$transOrigPointerField = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
}
|
|
if ($table === 'pages'
|
|
&& $languageField && isset($incomingFieldArray[$languageField]) && $incomingFieldArray[$languageField] > 0
|
|
&& $transOrigPointerField && isset($incomingFieldArray[$transOrigPointerField]) && $incomingFieldArray[$transOrigPointerField] > 0
|
|
) {
|
|
$pageRecord = BackendUtility::getRecord('pages', $incomingFieldArray[$transOrigPointerField]) ?? [];
|
|
if (!$this->hasPermissionToInsert($table, $incomingFieldArray[$transOrigPointerField], $pageRecord, (int)$incomingFieldArray[$languageField])) {
|
|
$this->log($table, $incomingFieldArray[$transOrigPointerField], SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to insert record on pages:{pid} where table "{table}" is not allowed', null, ['pid' => $incomingFieldArray[$transOrigPointerField], 'table' => $table], $incomingFieldArray[$transOrigPointerField]);
|
|
continue;
|
|
}
|
|
} else {
|
|
$pageRecord = BackendUtility::getRecord('pages', $theRealPid) ?? [];
|
|
if (!$this->hasPermissionToInsert($table, $theRealPid, $pageRecord)) {
|
|
$this->log($table, $theRealPid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to insert record on pages:{pid} where table "{table}" is not allowed', null, ['pid' => $theRealPid, 'table' => $table], $theRealPid);
|
|
continue;
|
|
}
|
|
}
|
|
$incomingFieldArray = $this->addDefaultPermittedLanguageIfNotSet($table, $incomingFieldArray, $theRealPid);
|
|
$accessResult = $this->BE_USER->checkRecordEditAccess($table, $incomingFieldArray, true);
|
|
if (!$accessResult->isAllowed) {
|
|
$this->log($table, 0, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'checkRecordEditAccess() check failed [{reason}]', null, ['reason' => $accessResult->errorMessage]);
|
|
continue;
|
|
}
|
|
if (!$this->BE_USER->workspaceAllowsLiveEditingInTable($table)) {
|
|
// If LIVE records cannot be created due to workspace restrictions, prepare creation of placeholder-record
|
|
// So, if no live records were allowed in the current workspace, we have to create a new version of this record
|
|
if ($schema->isWorkspaceAware()) {
|
|
$createNewVersion = true;
|
|
} else {
|
|
$this->log($table, 0, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to insert version record "{table}:{uid}" to this workspace failed. "Live" edit permissions of records from tables without versioning required', null, ['table' => $table, 'uid' => $id]);
|
|
continue;
|
|
}
|
|
}
|
|
// Here the "pid" is set IF NOT the old pid was a string pointing to a place in the subst-id array.
|
|
$tscPID = (int)BackendUtility::getRealPageId($table, $id, $old_pid_value ?: ($fieldArray['pid'] ?? 0));
|
|
// Apply TCA defaults from pageTS
|
|
$fieldArray = $this->applyDefaultsForFieldArray($table, $tscPID, $fieldArray, $incomingFieldArray);
|
|
// Apply page permissions as well
|
|
if ($table === 'pages') {
|
|
$fieldArray = $this->pagePermissionAssembler->applyDefaults(
|
|
$fieldArray,
|
|
$tscPID,
|
|
(int)$this->BE_USER->getUserId(),
|
|
(int)$this->BE_USER->firstMainGroup
|
|
);
|
|
}
|
|
// Ensure that the default values, that are stored in the $fieldArray (built from internal default values)
|
|
// Are also placed inside the incomingFieldArray, so this is checked in "fillInFieldArray" and
|
|
// all default values are also checked for validity
|
|
// This allows to set TCA defaults (for example) without having to use FormEngine to have the fields available first.
|
|
$incomingFieldArray = array_replace_recursive($fieldArray, $incomingFieldArray);
|
|
// Processing of all fields in incomingFieldArray and setting them in $fieldArray
|
|
$fieldArray = $this->fillInFieldArray($table, $id, $fieldArray, $incomingFieldArray, $theRealPid, 'new', $tscPID);
|
|
// Setting system fields
|
|
if ($schema->hasCapability(TcaSchemaCapability::CreatedAt)) {
|
|
$fieldArray[$schema->getCapability(TcaSchemaCapability::CreatedAt)->getFieldName()] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
// Set stage to "Editing" to make sure we restart the workflow
|
|
if ($schema->isWorkspaceAware()) {
|
|
$fieldArray['t3ver_stage'] = 0;
|
|
}
|
|
if ($schema->hasCapability(TcaSchemaCapability::UpdatedAt) && !empty($fieldArray)) {
|
|
$fieldArray[$schema->getCapability(TcaSchemaCapability::UpdatedAt)->getFieldName()] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processDatamap_postProcessFieldArray')) {
|
|
$hookObj->processDatamap_postProcessFieldArray('new', $table, $id, $fieldArray, $this);
|
|
}
|
|
}
|
|
// Performing insert/update. If fieldArray has been unset by some userfunction (see hook above), don't do anything
|
|
// Kasper: Unsetting the fieldArray is dangerous; MM relations might be saved already
|
|
if (is_array($fieldArray)) {
|
|
if ($table === 'pages') {
|
|
// for new pages always a refresh is needed
|
|
$this->pagetreeNeedsRefresh = true;
|
|
}
|
|
// This creates a version of the record, instead of adding it to the live workspace
|
|
if ($createNewVersion) {
|
|
// new record created in a workspace - so always refresh page tree to indicate there is a change in the workspace
|
|
$this->pagetreeNeedsRefresh = true;
|
|
$fieldArray['pid'] = $theRealPid;
|
|
$fieldArray['t3ver_oid'] = 0;
|
|
// Setting state for version (so it can know it is currently a new version...)
|
|
$fieldArray['t3ver_state'] = VersionState::NEW_PLACEHOLDER->value;
|
|
$fieldArray['t3ver_wsid'] = $this->BE_USER->workspace;
|
|
$this->insertDB($table, $id, $fieldArray, (int)($incomingFieldArray['uid'] ?? 0));
|
|
// Hold auto-versioned ids of placeholders
|
|
$this->autoVersionIdMap[$table][$this->substNEWwithIDs[$id]] = $this->substNEWwithIDs[$id];
|
|
} else {
|
|
$this->insertDB($table, $id, $fieldArray, (int)($incomingFieldArray['uid'] ?? 0));
|
|
}
|
|
}
|
|
// Note: When using the hook after INSERT operations, you will only get the temporary NEW... id passed to your hook as $id,
|
|
// but you can easily translate it to the real uid of the inserted record using the $this->substNEWwithIDs array.
|
|
$this->hook_processDatamap_afterDatabaseOperations($hookObjectsArr, 'new', $table, $id, $fieldArray);
|
|
} else {
|
|
// $id is an integer. We're updating an existing record or creating a workspace version.
|
|
$id = (int)$id;
|
|
$fieldArray = [];
|
|
$recordAccess = null;
|
|
$currentRecord = BackendUtility::getRecord($table, $id, '*', '', false);
|
|
if (empty($currentRecord) || ($currentRecord['pid'] ?? null) === null) {
|
|
// Skip if there is no record. Skip if record has no pid column indicating incomplete DB.
|
|
continue;
|
|
}
|
|
if ($table === 'pages') {
|
|
$pageRecord = $currentRecord;
|
|
} elseif ((int)$currentRecord['pid'] > 0) {
|
|
$pageRecord = BackendUtility::getRecord('pages', $currentRecord['pid']) ?? [];
|
|
} else {
|
|
$pageRecord = VirtualRecord::RootPage;
|
|
}
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'checkRecordUpdateAccess')) {
|
|
$recordAccess = $hookObj->checkRecordUpdateAccess($table, $id, $incomingFieldArray, $recordAccess, $this);
|
|
}
|
|
}
|
|
if ($recordAccess !== null) {
|
|
if (!$recordAccess) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to modify record {table}:{uid} denied by checkRecordUpdateAccess hook', null, ['table' => $table, 'uid' => $id], (int)$currentRecord['pid']);
|
|
continue;
|
|
}
|
|
} elseif (!$this->hasPermissionToUpdate($table, $pageRecord)) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to modify record {table}:{uid} without permission or non-existing page', null, ['table' => $table, 'uid' => $id], (int)$currentRecord['pid']);
|
|
continue;
|
|
}
|
|
$accessResult = $this->BE_USER->checkRecordEditAccess($table, $currentRecord);
|
|
if (!$accessResult->isAllowed) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to modify record {table}:{uid} failed with: {reason}', null, ['table' => $table, 'uid' => $id, 'reason' => $accessResult->errorMessage]);
|
|
continue;
|
|
}
|
|
// Use the new id of the versioned record we're trying to write to.
|
|
// This record is a child record of a parent and has already been versioned.
|
|
if (!empty($this->autoVersionIdMap[$table][$id])) {
|
|
// For the reason that creating a new version of this record, automatically
|
|
// created related child records (e.g. "IRRE"), update the accordant field:
|
|
$this->getVersionizedIncomingFieldArray($table, $id, $incomingFieldArray, $registerDBList);
|
|
// Use the new id of the copied/versioned record:
|
|
$id = $this->autoVersionIdMap[$table][$id];
|
|
} elseif (($errorCode = $this->workspaceCannotEditRecord($table, $currentRecord))) {
|
|
// Versioning is required and it must be offline version!
|
|
// Check if there already is a workspace version
|
|
$workspaceVersion = BackendUtility::getWorkspaceVersionOfRecord($this->BE_USER->workspace, $table, $id, 'uid,t3ver_oid');
|
|
if ($workspaceVersion) {
|
|
$id = $workspaceVersion['uid'];
|
|
} elseif ($this->workspaceAllowAutoCreation($table, $id, (int)$currentRecord['pid'])) {
|
|
// new version of a record created in a workspace - so always refresh page tree to indicate there is a change in the workspace
|
|
$this->pagetreeNeedsRefresh = true;
|
|
/** @var DataHandler $tce */
|
|
$tce = GeneralUtility::makeInstance(self::class);
|
|
$tce->enableLogging = $this->enableLogging;
|
|
// Setting up command for creating a new version of the record:
|
|
$cmd = [];
|
|
$cmd[$table][$id]['version'] = [
|
|
'action' => 'new',
|
|
// Default is to create a version of the individual records
|
|
'label' => 'Auto-created for WS #' . $this->BE_USER->workspace,
|
|
];
|
|
$tce->start([], $cmd, $this->BE_USER, $this->referenceIndexUpdater, $this->correlationId);
|
|
$tce->process_cmdmap();
|
|
$this->errorLog = array_merge($this->errorLog, $tce->errorLog);
|
|
// If copying was successful, share the new uids (also of related children):
|
|
if (empty($tce->copyMappingArray[$table][$id])) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to version record "{table}:{uid}" failed [{reason}]', null, ['reason' => $errorCode, 'table' => $table, 'uid' => $id]);
|
|
continue;
|
|
}
|
|
foreach ($tce->copyMappingArray as $origTable => $origIdArray) {
|
|
foreach ($origIdArray as $origId => $newId) {
|
|
$this->autoVersionIdMap[$origTable][$origId] = $newId;
|
|
}
|
|
}
|
|
// Update registerDBList, that holds the copied relations to child records:
|
|
$registerDBList = array_merge($registerDBList, $tce->registerDBList);
|
|
// For the reason that creating a new version of this record, automatically
|
|
// created related child records (e.g. "IRRE"), update the accordant field:
|
|
$this->getVersionizedIncomingFieldArray($table, $id, $incomingFieldArray, $registerDBList);
|
|
// Use the new id of the copied/versioned record:
|
|
$id = $this->autoVersionIdMap[$table][$id];
|
|
} else {
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to version record "{table}:{uid}" failed [{reason}]. "Live" edit permissions of records from tables without versioning required', null, ['reason' => $errorCode, 'table' => $table, 'uid' => $id]);
|
|
continue;
|
|
}
|
|
}
|
|
// Here the "pid" is set IF NOT the old pid was a string pointing to a place in the subst-id array.
|
|
$tscPID = (int)BackendUtility::getRealPageId($table, $id, 0);
|
|
// Processing of all fields in incomingFieldArray and setting them in $fieldArray
|
|
$fieldArray = $this->fillInFieldArray($table, $id, $fieldArray, $incomingFieldArray, (int)$currentRecord['pid'], 'update', $tscPID);
|
|
// Set stage to "Editing" to make sure we restart the workflow
|
|
if ($schema->isWorkspaceAware()) {
|
|
$fieldArray['t3ver_stage'] = 0;
|
|
}
|
|
// Removing fields which are equal to the current value:
|
|
$fieldArray = $this->compareFieldArrayWithCurrentAndUnset($table, $id, $fieldArray);
|
|
if ($schema->hasCapability(TcaSchemaCapability::UpdatedAt) && !empty($fieldArray)) {
|
|
$fieldArray[$schema->getCapability(TcaSchemaCapability::UpdatedAt)->getFieldName()] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processDatamap_postProcessFieldArray')) {
|
|
$hookObj->processDatamap_postProcessFieldArray('update', $table, $id, $fieldArray, $this);
|
|
}
|
|
}
|
|
// Performing insert/update. If fieldArray has been unset by some userfunction (see hook above), don't do anything
|
|
// Kasper: Unsetting the fieldArray is dangerous; MM relations might be saved already
|
|
if (!empty($fieldArray)) {
|
|
if ($table === 'pages') {
|
|
// Only a certain number of fields needs to be checked for updates,
|
|
// fields with unchanged values are already removed here.
|
|
$fieldsToCheck = array_intersect($this->pagetreeRefreshFieldsFromPages, array_keys($fieldArray));
|
|
if (!empty($fieldsToCheck)) {
|
|
$this->pagetreeNeedsRefresh = true;
|
|
}
|
|
}
|
|
$this->updateDB($table, $id, $fieldArray, (int)$currentRecord['pid']);
|
|
}
|
|
// Note: When using the hook after INSERT operations, you will only get the temporary NEW... id passed to your hook as $id,
|
|
// but you can easily translate it to the real uid of the inserted record using the $this->substNEWwithIDs array.
|
|
$this->hook_processDatamap_afterDatabaseOperations($hookObjectsArr, 'update', $table, $id, $fieldArray);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Process the stack of relations to remap/correct
|
|
$this->processRemapStack();
|
|
$this->dbAnalysisStoreExec();
|
|
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processDatamap_afterAllOperations')) {
|
|
// When this hook gets called, all operations on the submitted data have been finished.
|
|
$hookObj->processDatamap_afterAllOperations($this);
|
|
}
|
|
}
|
|
|
|
if ($this->isOuterMostInstance()) {
|
|
$this->referenceIndexUpdater->update();
|
|
$this->processClearCacheQueue();
|
|
$this->resetElementsToBeDeleted();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets the "sorting" DB field and the "pid" field of an incoming record that should be added (NEW1234)
|
|
* depending on the record that should be added or where it should be added.
|
|
*
|
|
* This method is called from process_datamap()
|
|
*
|
|
* @param string $table the table name of the record to insert
|
|
* @param int $pid the real PID (numeric) where the record should be
|
|
* @param array $fieldArray field+value pairs to add
|
|
* @return array the modified field array
|
|
*/
|
|
protected function resolveSortingAndPidForNewRecord(string $table, int $pid, array $fieldArray): array
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
// Points to a page on which to insert the element, possibly in the top of the page
|
|
if ($pid >= 0) {
|
|
// Ensure that the "pid" is not a translated page ID, but the default page ID
|
|
$pid = $this->getDefaultLanguagePageId($pid);
|
|
// The numerical pid is inserted in the data array
|
|
$fieldArray['pid'] = $pid;
|
|
// If this table is sorted we better find the top sorting number
|
|
if ($schema->hasCapability(TcaSchemaCapability::SortByField)) {
|
|
$fieldArray[$schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName()] = $this->getSortNumber($table, 0, $pid);
|
|
}
|
|
} elseif ($schema->hasCapability(TcaSchemaCapability::SortByField)) {
|
|
// Points to another record before itself
|
|
// If this table is sorted we better find the top sorting number
|
|
// Because $pid is < 0, getSortNumber() returns an array
|
|
$sortingInfo = $this->getSortNumber($table, 0, $pid);
|
|
$fieldArray['pid'] = $sortingInfo['pid'];
|
|
$fieldArray[$schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName()] = $sortingInfo['sortNumber'];
|
|
} else {
|
|
// Here we fetch the PID of the record that we point to
|
|
$record = BackendUtility::getRecord($table, abs($pid), '*', '', false);
|
|
// Ensure that the "pid" is not a translated page ID, but the default page ID
|
|
$fieldArray['pid'] = $this->getDefaultLanguagePageId($record['pid']);
|
|
}
|
|
return $fieldArray;
|
|
}
|
|
|
|
/**
|
|
* Filling in the field array
|
|
*
|
|
* @param int|string $id Record ID
|
|
* @param array $fieldArray Default values, Preset $fieldArray with 'pid' maybe (pid and uid will be not be overridden anyway)
|
|
* @param array $incomingFieldArray Is which fields/values you want to set. There are processed and put into $fieldArray if OK
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param string $status Is 'new' or 'update'
|
|
* @param int $tscPID TSconfig PID
|
|
*/
|
|
protected function fillInFieldArray(string $table, $id, array $fieldArray, array $incomingFieldArray, $realPid, $status, $tscPID): array
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$originalLanguageRecord = null;
|
|
$originalLanguage_diffStorage = null;
|
|
$diffStorageFlag = false;
|
|
$isNewRecord = str_contains((string)$id, 'NEW');
|
|
// Setting 'currentRecord' and 'checkValueRecord':
|
|
if ($isNewRecord) {
|
|
// Overlay default values with incoming values.
|
|
$checkValueRecord = $fieldArray;
|
|
ArrayUtility::mergeRecursiveWithOverrule($checkValueRecord, $incomingFieldArray);
|
|
$currentRecord = $checkValueRecord;
|
|
} else {
|
|
$id = (int)$id;
|
|
// We must use the current values as basis for this!
|
|
$currentRecord = ($checkValueRecord = BackendUtility::getRecord($table, $id, '*', '', false));
|
|
// However, we need to check if the record type is a different one, we need to adapt this one value
|
|
// in order to have columnsOverrides working
|
|
$testRecord = array_replace($checkValueRecord, $incomingFieldArray);
|
|
if ($schema->supportsSubSchema()
|
|
&& !$schema->getSubSchemaTypeInformation()->isPointerToForeignFieldInForeignSchema()
|
|
&& ($newTypeValue = BackendUtility::getTCAtypeValue($table, $testRecord)) !== BackendUtility::getTCAtypeValue($table, $checkValueRecord)
|
|
) {
|
|
$checkValueRecord[$schema->getSubSchemaTypeInformation()->getFieldName()] = $newTypeValue;
|
|
}
|
|
}
|
|
|
|
// Get original language record if available:
|
|
/** @var LanguageAwareSchemaCapability|null $languageCapability */
|
|
$languageCapability = null;
|
|
if ($schema->isLanguageAware() && is_array($currentRecord)) {
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
if ($languageCapability->hasDiffSourceField()) {
|
|
// Get original language record if available
|
|
if ((int)($currentRecord[$languageCapability->getLanguageField()->getName()] ?? 0) > 0
|
|
&& (int)($currentRecord[$languageCapability->getTranslationOriginPointerField()->getName()] ?? 0) > 0
|
|
) {
|
|
$originalLanguageRecord = BackendUtility::getRecord($table, $currentRecord[$languageCapability->getTranslationOriginPointerField()->getName()], '*', '', false);
|
|
BackendUtility::workspaceOL($table, $originalLanguageRecord, $this->BE_USER->workspace);
|
|
$originalLanguage_diffStorage = json_decode(
|
|
(string)($currentRecord[$languageCapability->getDiffSourceField()->getName()] ?? ''),
|
|
true
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->checkValue_currentRecord = $checkValueRecord;
|
|
// In the following all incoming value-fields are tested:
|
|
// - Are the user allowed to change the field?
|
|
// - Is the field uid/pid (which are already set)
|
|
// - perms-fields for pages-table, then do special things...
|
|
// - If the field is nothing of the above and the field is configured in TCA, the fieldvalues are evaluated by ->checkValue
|
|
// If everything is OK, the field is entered into $fieldArray[]
|
|
foreach ($incomingFieldArray as $field => $fieldValue) {
|
|
if ($this->BE_USER->isAdmin() === false && $schema->hasField($field) && $schema->getField($field)->getDisplayConditions() === 'HIDE_FOR_NON_ADMINS') {
|
|
continue;
|
|
}
|
|
if ($schema->hasField($field) && $schema->getField($field)->supportsAccessControl() && !$this->BE_USER->check('non_exclude_fields', $table . ':' . $field)) {
|
|
continue;
|
|
}
|
|
|
|
// The field must be editable.
|
|
// Checking if a value for language can be changed:
|
|
if ($languageCapability
|
|
&& $languageCapability->getLanguageField()->getName() === (string)$field
|
|
&& !$this->BE_USER->checkLanguageAccess($fieldValue)
|
|
) {
|
|
continue;
|
|
}
|
|
|
|
switch ($field) {
|
|
case 'uid':
|
|
case 'pid':
|
|
// Nothing happens, already set
|
|
break;
|
|
case 'perms_userid':
|
|
case 'perms_groupid':
|
|
case 'perms_user':
|
|
case 'perms_group':
|
|
case 'perms_everybody':
|
|
// Permissions can be edited by the owner or the administrator
|
|
if ($table === 'pages' && ($this->BE_USER->isAdmin() || $status === 'new' || (int)$currentRecord['perms_userid'] === (int)$this->BE_USER->getUserId())) {
|
|
$value = (int)$fieldValue;
|
|
switch ($field) {
|
|
case 'perms_userid':
|
|
case 'perms_groupid':
|
|
$fieldArray[$field] = $value;
|
|
break;
|
|
default:
|
|
if ($value >= 0 && $value < (2 ** 5)) {
|
|
$fieldArray[$field] = $value;
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
case 't3ver_oid':
|
|
case 't3ver_wsid':
|
|
case 't3ver_state':
|
|
case 't3ver_stage':
|
|
break;
|
|
case 'l10n_state':
|
|
$fieldArray[$field] = $fieldValue;
|
|
break;
|
|
default:
|
|
if ($schema->hasField($field)) {
|
|
// Evaluating the value
|
|
$res = $this->checkValue($table, $field, $fieldValue, $id, $status, $realPid, $tscPID, $incomingFieldArray);
|
|
if (array_key_exists('value', $res)) {
|
|
$fieldArray[$field] = $res['value'];
|
|
}
|
|
// Add the value of the original record to the diff-storage content:
|
|
if ($languageCapability && $languageCapability->hasDiffSourceField()
|
|
// not "sys_language_uid", this is 0 in default language record by definition
|
|
&& $languageCapability->getLanguageField()->getName() !== (string)$field
|
|
// not the "diffsource" field itself
|
|
&& $languageCapability->getDiffSourceField()->getName() !== (string)$field
|
|
// not "l10n_parent", this is 0 in default language record by definition
|
|
&& $languageCapability->getTranslationOriginPointerField()->getName() !== (string)$field
|
|
// not "l10n_source", this is 0 in default language record by definition
|
|
&& !($languageCapability->hasTranslationSourceField() && $languageCapability->getTranslationOriginPointerField()->getName() === (string)$field)
|
|
) {
|
|
if (!is_array($originalLanguage_diffStorage)) {
|
|
$originalLanguage_diffStorage = [];
|
|
}
|
|
$originalLanguage_diffStorage[$field] = (string)($originalLanguageRecord[$field] ?? '');
|
|
$diffStorageFlag = true;
|
|
}
|
|
} elseif ($schema->hasCapability(TcaSchemaCapability::AncestorReferenceField) && $schema->getCapability(TcaSchemaCapability::AncestorReferenceField)->getFieldName() === $field) {
|
|
// Allow value for original UID to pass by...
|
|
$fieldArray[$field] = $fieldValue;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Dealing with a page translation, setting "sorting", "pid", "perms_*" to the same values as the original record
|
|
if ($table === 'pages' && is_array($originalLanguageRecord)) {
|
|
$fieldArray['sorting'] = $originalLanguageRecord['sorting'];
|
|
$fieldArray['perms_userid'] = $originalLanguageRecord['perms_userid'];
|
|
$fieldArray['perms_groupid'] = $originalLanguageRecord['perms_groupid'];
|
|
$fieldArray['perms_user'] = $originalLanguageRecord['perms_user'];
|
|
$fieldArray['perms_group'] = $originalLanguageRecord['perms_group'];
|
|
$fieldArray['perms_everybody'] = $originalLanguageRecord['perms_everybody'];
|
|
}
|
|
|
|
// Add diff-storage information
|
|
if ($diffStorageFlag
|
|
&& (
|
|
!array_key_exists($languageCapability->getDiffSourceField()->getName(), $fieldArray)
|
|
|| ($isNewRecord && $originalLanguageRecord !== null)
|
|
)
|
|
) {
|
|
// If the field is set it would probably be because of an undo-operation - in which case we should not
|
|
// update the field of course. On the other hand, e.g. for record localization, we need to update the field.
|
|
ksort($originalLanguage_diffStorage);
|
|
$fieldArray[$languageCapability->getDiffSourceField()->getName()] = json_encode($originalLanguage_diffStorage);
|
|
}
|
|
return $fieldArray;
|
|
}
|
|
|
|
/**
|
|
* Evaluates a value according to $table/$field settings.
|
|
* This function is for real database fields - NOT FlexForm "pseudo" fields.
|
|
* NOTICE: Calling this function expects this: 1) That the data is saved!
|
|
*
|
|
* @param string $table Table name
|
|
* @param string $field Field name
|
|
* @param string $value Value to be evaluated. Notice, this is the INPUT value from the form. The original value (from any existing record) must be manually looked up inside the function if needed - or taken from $currentRecord array.
|
|
* @param int|string $id The record-uid, mainly - but not exclusively - used for logging
|
|
* @param string $status 'update' or 'new' flag
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param int $tscPID TSconfig PID
|
|
* @param array $incomingFieldArray the fields being explicitly set by the outside (unlike $fieldArray)
|
|
* @return array Returns the evaluated $value as key "value" in this array. Can be checked with isset($res['value']) ...
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValue($table, $field, $value, $id, $status, $realPid, $tscPID, $incomingFieldArray = []): array
|
|
{
|
|
$currentRecord = null;
|
|
$currentRecordValue = null;
|
|
if ((int)$id !== 0) {
|
|
// Int cast of $id can be 0 with NEW... records
|
|
// @todo: Hand over current record if there is some to avoid guesswork and DB call here
|
|
$currentRecord = BackendUtility::getRecord($table, (int)$id, '*', '', false);
|
|
// isset() won't work here, since values can be NULL
|
|
if ($currentRecord !== null && array_key_exists($field, $currentRecord)) {
|
|
$currentRecordValue = $currentRecord[$field];
|
|
}
|
|
}
|
|
|
|
if ($table === 'pages' && $field === 'doktype') {
|
|
// Processing special case of field pages.doktype
|
|
if (!($this->BE_USER->isAdmin() || GeneralUtility::inList($this->BE_USER->groupData['pagetypes_select'], $value))) {
|
|
// User is not allowed to use this specific doktype
|
|
$this->log($table, (int)$id, SystemLogDatabaseAction::CHECK, null, SystemLogErrorClassification::USER_ERROR, 'User lacks permissions to set pages:{uid} doktype to "{value}"', null, ['uid' => $id, 'value' => $value], $currentRecord['pid'] ?? 0);
|
|
return [];
|
|
}
|
|
if ($status === 'update') {
|
|
// Switching from one doktype to a different one. This is denied if the new doktype restricts the
|
|
// list of tables that can exist on them and if there are such records on the current page.
|
|
// Use the page uid of the default language
|
|
$recordId = $this->getDefaultLanguagePageId((int)$id);
|
|
$existingDisallowedTables = $this->doesPageHaveUnallowedTables($recordId, (int)$value);
|
|
if ($existingDisallowedTables !== []) {
|
|
$this->log($table, (int)$id, SystemLogDatabaseAction::CHECK, null, SystemLogErrorClassification::USER_ERROR, 'Can not set pages:{uid} doktype to "{value}". The page contains records from tables "{disallowedTables}" that are not allowed with new doktype.', null, ['uid' => (int)$id, 'value' => $value, 'disallowedTables' => implode(', ', $existingDisallowedTables)], $recordId);
|
|
return [];
|
|
}
|
|
}
|
|
}
|
|
|
|
// Getting config for the field
|
|
$tcaFieldConf = $this->resolveFieldConfigurationAndRespectColumnsOverrides($table, $field, $this->checkValue_currentRecord);
|
|
|
|
// Create $recFID only for those types that need it
|
|
if ($tcaFieldConf['type'] === 'flex') {
|
|
$recFID = $table . ':' . $id . ':' . $field;
|
|
} else {
|
|
$recFID = '';
|
|
}
|
|
|
|
return $this->checkValue_SW([], $value, $tcaFieldConf, $table, $id, $currentRecordValue, $status, $realPid, $recFID, $field, $tscPID, ['incomingFieldArray' => $incomingFieldArray]);
|
|
}
|
|
|
|
/**
|
|
* Get field configuration respecting columnsOverrides for a specific record.
|
|
*
|
|
* This method resolves the TCA field configuration while considering type-specific
|
|
* columnsOverrides. It determines the record type and returns the merged configuration
|
|
* from the appropriate sub-schema if available.
|
|
*
|
|
* Fetch the TCA ["config"] part for a specific field, including the columnsOverrides value.
|
|
* Used for checkValue purposes currently (as it takes the checkValue_currentRecord value) but also for
|
|
* all other places as well now.
|
|
*
|
|
* @param array $record The record array (must contain the type field if the table has types)
|
|
* @return array The field configuration array, or empty array if field doesn't exist
|
|
*/
|
|
protected function resolveFieldConfigurationAndRespectColumnsOverrides(string $table, string $field, array $record): array
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!$schema->hasField($field)) {
|
|
return [];
|
|
}
|
|
$recordType = BackendUtility::getTCAtypeValue($table, $record, true);
|
|
if ($recordType !== null && $schema->hasSubSchema($recordType) && $schema->getSubSchema($recordType)->hasField($field)) {
|
|
return $schema->getSubSchema($recordType)->getField($field)->getConfiguration();
|
|
}
|
|
return $schema->getField($field)->getConfiguration();
|
|
}
|
|
|
|
/**
|
|
* Branches out evaluation of a field value based on its type as configured in $GLOBALS['TCA']
|
|
* Can be called for FlexForm pseudo fields as well, BUT must not have $field set if so.
|
|
* And hey, there's a good thing about the method arguments: 13 is prime :-P
|
|
*
|
|
* @param array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
* @param string|null $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from $GLOBALS['TCA']
|
|
* @param string $table Table name
|
|
* @param int $id UID of record
|
|
* @param mixed $curValue Current value of the field
|
|
* @param string $status 'update' or 'new' flag
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param string $recFID Field identifier [table:uid:field] for flexforms
|
|
* @param string $field Field name. Must NOT be set if the call is for a flexform field (since flexforms are not allowed within flexforms).
|
|
* @param int $tscPID TSconfig PID
|
|
* @param array|null $additionalData Additional data to be forwarded to sub-processors
|
|
* @return array Returns the evaluated $value as key "value" in this array.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValue_SW($res, $value, $tcaFieldConf, $table, $id, $curValue, $status, $realPid, $recFID, $field, $tscPID, ?array $additionalData = null): array
|
|
{
|
|
// Convert to NULL value if defined in TCA
|
|
if ($value === null && ($tcaFieldConf['nullable'] ?? false)) {
|
|
return ['value' => null];
|
|
}
|
|
|
|
// This is either a normal field or a FlexForm field.
|
|
// Used to enrich the (potential) error log with contextual information.
|
|
$checkField = $recFID !== '' ? explode(':', $recFID)[2] : $field;
|
|
|
|
$res = (array)match ((string)$tcaFieldConf['type']) {
|
|
'category' => $this->checkValueForCategory($res, (string)$value, $tcaFieldConf, (string)$table, $id, (string)$status, (string)$field),
|
|
'check' => $this->checkValueForCheck($res, $value, $tcaFieldConf, $table, $id, $realPid, $field),
|
|
'color' => $this->checkValueForColor((string)$value, $tcaFieldConf),
|
|
'country' => $this->checkValueForCountry((string)$value, $tcaFieldConf),
|
|
'datetime' => $this->checkValueForDatetime($value, $tcaFieldConf),
|
|
'email' => $this->checkValueForEmail((string)$value, $tcaFieldConf, $table, $id, (int)$realPid, $checkField),
|
|
'flex' => $this->checkValueForFlex($res, $value, $tcaFieldConf, (string)$table, $id, (string)$curValue, (string)$status, (int)$realPid, (string)$recFID, (int)$tscPID, (string)$field),
|
|
'inline' => $this->checkValueForInline($res, (string)$value, $tcaFieldConf, $table, $id, $status, $field, $additionalData) ?: [],
|
|
'file' => $this->checkValueForFile($res, (string)$value, $tcaFieldConf, $table, $id, $field, $additionalData),
|
|
'input' => $this->checkValueForInput($value, $tcaFieldConf, $table, $id, $realPid, $field),
|
|
'language' => $this->checkValueForLanguage((int)$value, $table, $field),
|
|
'link' => $this->checkValueForLink((string)$value, $tcaFieldConf, $table, $id, $checkField),
|
|
'number' => $this->checkValueForNumber($value, $tcaFieldConf),
|
|
'password' => $this->checkValueForPassword((string)$value, $tcaFieldConf, $table, $id, (int)$realPid, $additionalData['incomingFieldArray'] ?? []),
|
|
'radio' => $this->checkValueForRadio($res, $value, $tcaFieldConf, $table, $id, $realPid, $field),
|
|
'slug' => $this->checkValueForSlug((string)$value, $tcaFieldConf, $table, $id, (int)$realPid, $field, $additionalData['incomingFieldArray'] ?? []),
|
|
'text' => $this->checkValueForText($value, $tcaFieldConf, $table, $realPid, $field),
|
|
'group', 'folder', 'select' => $this->checkValueForGroupFolderSelect($res, $value, $tcaFieldConf, $table, $id, $status, $field),
|
|
'json' => $this->checkValueForJson($value, $tcaFieldConf),
|
|
'uuid' => $this->checkValueForUuid((string)$value, $tcaFieldConf),
|
|
'passthrough', 'imageManipulation', 'user' => ['value' => $value],
|
|
default => [],
|
|
};
|
|
|
|
return $this->checkValueForInternalReferences($res, $value, $tcaFieldConf, $table, $id, $field);
|
|
}
|
|
|
|
/**
|
|
* Checks values that are used for internal references. If the provided $value
|
|
* is a NEW-identifier, the direct processing is stopped. Instead, the value is
|
|
* forwarded to the remap-stack to be post-processed and resolved into a proper
|
|
* UID after all data has been resolved.
|
|
*
|
|
* This method considers TCA types that cannot handle and resolve these internal
|
|
* values directly, like 'passthrough', 'none' or 'user'. Values are only modified
|
|
* here if the $field is used as 'transOrigPointerField' or 'translationSource'.
|
|
*
|
|
* @param array $res The result array. The processed value (if any!) is set in the 'value' key.
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int|string $id UID of record
|
|
* @param string $field The field name
|
|
* @return array The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForInternalReferences(array $res, $value, $tcaFieldConf, $table, $id, $field): array
|
|
{
|
|
$relevantFieldNames = [];
|
|
if ($this->tcaSchemaFactory->has($table)) {
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if ($schema->isLanguageAware()) {
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$relevantFieldNames[] = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
if ($languageCapability->hasTranslationSourceField()) {
|
|
$relevantFieldNames[] = $languageCapability->getTranslationSourceField()->getName();
|
|
}
|
|
}
|
|
}
|
|
|
|
if (
|
|
// in case field is empty
|
|
empty($field)
|
|
// in case the field is not relevant
|
|
|| !in_array($field, $relevantFieldNames)
|
|
// in case the 'value' index has been unset already
|
|
|| !array_key_exists('value', $res)
|
|
// in case it's not a NEW-identifier
|
|
|| !str_contains($value, 'NEW')
|
|
) {
|
|
return $res;
|
|
}
|
|
|
|
$valueArray = [$value];
|
|
$this->remapStackRecords[$table][$id] = ['remapStackIndex' => count($this->remapStack)];
|
|
$this->remapStack[] = [
|
|
'args' => [$valueArray, $tcaFieldConf, $id, $table, $field],
|
|
'pos' => ['valueArray' => 0, 'tcaFieldConf' => 1, 'id' => 2, 'table' => 3],
|
|
'field' => $field,
|
|
];
|
|
unset($res['value']);
|
|
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Evaluate "text" type values.
|
|
*
|
|
* @param string|null $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param string $field Field name
|
|
* @return array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForText($value, $tcaFieldConf, $table, $realPid, $field)
|
|
{
|
|
$richtextEnabled = (bool)($tcaFieldConf['enableRichtext'] ?? false);
|
|
|
|
// Reset value to empty string, if less than "min" characters.
|
|
$min = $tcaFieldConf['min'] ?? 0;
|
|
if (!$richtextEnabled && $min > 0 && mb_strlen((string)$value) < $min) {
|
|
$value = '';
|
|
}
|
|
|
|
if (!$this->validateValueForRequired($tcaFieldConf, $value)) {
|
|
$valueArray = [];
|
|
} elseif (isset($tcaFieldConf['eval']) && $tcaFieldConf['eval'] !== '') {
|
|
$evalCodesArray = GeneralUtility::trimExplode(',', $tcaFieldConf['eval'], true);
|
|
$valueArray = $this->checkValue_text_Eval($value, $evalCodesArray, $tcaFieldConf['is_in'] ?? '');
|
|
} else {
|
|
$valueArray = ['value' => $value];
|
|
}
|
|
|
|
// Handle richtext transformations
|
|
if ($this->dontProcessTransformations) {
|
|
return $valueArray;
|
|
}
|
|
// Keep null as value
|
|
if ($value === null) {
|
|
return $valueArray;
|
|
}
|
|
if ($richtextEnabled) {
|
|
$recordType = BackendUtility::getTCAtypeValue($table, $this->checkValue_currentRecord);
|
|
$richtextConfiguration = $this->richtext->getConfiguration($table, $field, $realPid, $recordType, $tcaFieldConf);
|
|
$rteParser = GeneralUtility::makeInstance(RteHtmlParser::class);
|
|
$valueArray['value'] = $rteParser->transformTextForPersistence((string)$value, $richtextConfiguration['proc.'] ?? []);
|
|
}
|
|
|
|
return $valueArray;
|
|
}
|
|
|
|
/**
|
|
* Evaluate "input" type values.
|
|
*
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int $id UID of record
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param string $field Field name
|
|
* @return array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForInput($value, $tcaFieldConf, $table, $id, $realPid, $field): array
|
|
{
|
|
// Secures the string-length to be less than max.
|
|
if (isset($tcaFieldConf['max']) && (int)$tcaFieldConf['max'] > 0) {
|
|
$value = mb_substr((string)$value, 0, (int)$tcaFieldConf['max'], 'utf-8');
|
|
}
|
|
|
|
// Reset value to empty string, if less than "min" characters.
|
|
$min = $tcaFieldConf['min'] ?? 0;
|
|
if ($min > 0 && mb_strlen((string)$value) < $min) {
|
|
$value = '';
|
|
}
|
|
|
|
if (!$this->validateValueForRequired($tcaFieldConf, (string)$value)) {
|
|
$res = [];
|
|
} elseif (empty($tcaFieldConf['eval'])) {
|
|
$res = ['value' => $value];
|
|
} else {
|
|
// Process evaluation settings:
|
|
$evalCodesArray = GeneralUtility::trimExplode(',', $tcaFieldConf['eval'], true);
|
|
$res = $this->checkValue_input_Eval((string)$value, $evalCodesArray, $tcaFieldConf['is_in'] ?? '', $table, $id);
|
|
// Process UNIQUE settings:
|
|
// Field is NOT set for flexForms - which also means that uniqueInPid and unique is NOT available for flexForm fields! Also getUnique should not be done for versioning
|
|
if ($field && !empty($res['value'])) {
|
|
if (in_array('uniqueInPid', $evalCodesArray, true)) {
|
|
$res['value'] = $this->getUnique($table, $field, $res['value'], $id, $realPid);
|
|
}
|
|
if ($res['value'] && in_array('unique', $evalCodesArray, true)) {
|
|
$res['value'] = $this->getUnique($table, $field, $res['value'], $id);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Evaluate 'number' type values
|
|
*
|
|
* @param mixed $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
*/
|
|
protected function checkValueForNumber(mixed $value, array $tcaFieldConf): array
|
|
{
|
|
$format = $tcaFieldConf['format'] ?? 'integer';
|
|
if ($format !== 'integer' && $format !== 'decimal') {
|
|
// Early return if format is not valid
|
|
return [];
|
|
}
|
|
|
|
if (!$this->validateValueForRequired($tcaFieldConf, (string)$value)) {
|
|
return [];
|
|
}
|
|
|
|
if ($format === 'decimal') {
|
|
// @todo Make precision configurable
|
|
$precision = 2;
|
|
$value = preg_replace('/[^0-9,\\.-]/', '', $value);
|
|
$negative = substr($value, 0, 1) === '-';
|
|
$value = strtr($value, [',' => '.', '-' => '']);
|
|
if (!str_contains($value, '.')) {
|
|
$value .= '.0';
|
|
}
|
|
$valueArray = explode('.', $value);
|
|
$dec = array_pop($valueArray);
|
|
$value = (float)(implode('', $valueArray) . '.' . $dec);
|
|
if ($negative) {
|
|
$value = $value * -1;
|
|
}
|
|
$result['value'] = number_format($value, $precision, '.', '');
|
|
} else {
|
|
$result['value'] = (int)$value;
|
|
}
|
|
|
|
// Checking range of value:
|
|
if (is_array($tcaFieldConf['range'] ?? false)) {
|
|
if ($format === 'decimal') {
|
|
if (isset($tcaFieldConf['range']['upper']) && ceil((float)$result['value']) > (float)$tcaFieldConf['range']['upper']) {
|
|
$result['value'] = (float)$tcaFieldConf['range']['upper'];
|
|
}
|
|
if (isset($tcaFieldConf['range']['lower']) && floor((float)$result['value']) < (float)$tcaFieldConf['range']['lower']) {
|
|
$result['value'] = (float)$tcaFieldConf['range']['lower'];
|
|
}
|
|
} else {
|
|
if (isset($tcaFieldConf['range']['upper']) && ceil($result['value']) > (int)$tcaFieldConf['range']['upper']) {
|
|
$result['value'] = (int)$tcaFieldConf['range']['upper'];
|
|
}
|
|
if (isset($tcaFieldConf['range']['lower']) && floor($result['value']) < (int)$tcaFieldConf['range']['lower']) {
|
|
$result['value'] = (int)$tcaFieldConf['range']['lower'];
|
|
}
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Evaluate "color" type values.
|
|
*
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @return array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForColor(string $value, array $tcaFieldConf): array
|
|
{
|
|
// Always trim the value
|
|
$value = trim($value);
|
|
// Secures the string-length to be <= 7 or <= 9 if opacity enabled.
|
|
$opacity = (bool)($tcaFieldConf['opacity'] ?? false);
|
|
$value = mb_substr($value, 0, $opacity ? 9 : 7, 'utf-8');
|
|
// Early return if required validation fails
|
|
if (!$this->validateValueForRequired($tcaFieldConf, $value)) {
|
|
return [];
|
|
}
|
|
return [
|
|
'value' => $value,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Evaluate "email" type values.
|
|
*
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int|string $id UID of record - might be a NEW.. string for new records
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param string $field Field name
|
|
* @return array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForEmail(
|
|
string $value,
|
|
array $tcaFieldConf,
|
|
string $table,
|
|
int|string $id,
|
|
int $realPid,
|
|
string $field
|
|
): array {
|
|
// Always trim the value
|
|
$value = trim($value);
|
|
|
|
// Early return if required validation fails
|
|
// Note: The "required" check is evaluated but does not yet lead to an error, see
|
|
// the comment in the DataHandler::validateValueForRequired() for more information.
|
|
if (!$this->validateValueForRequired($tcaFieldConf, $value)) {
|
|
return [];
|
|
}
|
|
|
|
if ($value !== '' && !GeneralUtility::validEmail($value)) {
|
|
// A non-empty value is given, which however is no valid email. Log this and unset the value afterwards.
|
|
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, '"{email}" is not a valid e-mail address for the field "{field}" of the table "{table}"', null, ['email' => $value, 'field' => $field, 'table' => $table]);
|
|
$value = '';
|
|
}
|
|
|
|
$res = [
|
|
'value' => $value,
|
|
];
|
|
|
|
// Early return if no evaluation is configured
|
|
if (!isset($tcaFieldConf['eval'])) {
|
|
return $res;
|
|
}
|
|
$evalCodesArray = GeneralUtility::trimExplode(',', $tcaFieldConf['eval'], true);
|
|
|
|
// Process UNIQUE settings:
|
|
// Field is NOT set for flexForms - which also means that uniqueInPid and unique is NOT available for flexForm fields! Also getUnique should not be done for versioning
|
|
if ($field && !empty($res['value'])) {
|
|
if (in_array('uniqueInPid', $evalCodesArray, true)) {
|
|
$res['value'] = $this->getUnique($table, $field, $res['value'], $id, $realPid);
|
|
}
|
|
if ($res['value'] && in_array('unique', $evalCodesArray, true)) {
|
|
$res['value'] = $this->getUnique($table, $field, $res['value'], $id);
|
|
}
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Evaluate "password" type values.
|
|
*
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int|string $id UID of record - might be a NEW.. string for new records
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param array $incomingFieldArray the fields being explicitly set by the outside (unlike $fieldArray) for the record
|
|
* @return array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForPassword(
|
|
string $value,
|
|
array $tcaFieldConf,
|
|
string $table,
|
|
int|string $id,
|
|
int $realPid,
|
|
array $incomingFieldArray = []
|
|
): array {
|
|
// Always trim the value
|
|
$value = trim($value);
|
|
|
|
// Early return if required validation fails
|
|
// Note: The "required" check is evaluated but does not yet lead to an error, see
|
|
// the comment in the DataHandler::validateValueForRequired() for more information.
|
|
if (!$this->validateValueForRequired($tcaFieldConf, $value)) {
|
|
return [];
|
|
}
|
|
|
|
// Early return, if password hashing is disabled and the table is not fe_users or be_users
|
|
if (!($tcaFieldConf['hashed'] ?? true) && !in_array($table, ['fe_users', 'be_users'], true)) {
|
|
return [
|
|
'value' => $value,
|
|
];
|
|
}
|
|
|
|
// An incoming value is either the salted password if the user did not change existing password
|
|
// when submitting the form, or a plaintext new password that needs to be turned into a salted password now.
|
|
// The strategy is to see if a salt instance can be created from the incoming value. If so,
|
|
// no new password was submitted and we keep the value. If no salting instance can be created,
|
|
// incoming value must be a new plain text value that needs to be hashed.
|
|
$mode = $table === 'fe_users' ? 'FE' : 'BE';
|
|
$isNewUser = str_contains((string)$id, 'NEW');
|
|
$newHashInstance = $this->passwordHashFactory->getDefaultHashInstance($mode);
|
|
|
|
try {
|
|
$this->passwordHashFactory->get($value, $mode);
|
|
} catch (InvalidPasswordHashException $e) {
|
|
// We got no salted password instance, incoming value must be a new plaintext password
|
|
// Validate new password against password policy for field
|
|
$passwordPolicy = $tcaFieldConf['passwordPolicy'] ?? '';
|
|
$passwordPolicyValidator = GeneralUtility::makeInstance(
|
|
PasswordPolicyValidator::class,
|
|
PasswordPolicyAction::NEW_USER_PASSWORD,
|
|
is_string($passwordPolicy) ? $passwordPolicy : ''
|
|
);
|
|
|
|
$contextData = new ContextData(
|
|
loginMode: $mode,
|
|
newUsername: $incomingFieldArray['username'] ?? '',
|
|
newUserFirstName: $incomingFieldArray['first_name'] ?? '',
|
|
newUserLastName: $incomingFieldArray['last_name'] ?? '',
|
|
newUserFullName: $incomingFieldArray['realName'] ?? '',
|
|
);
|
|
$event = $this->eventDispatcher->dispatch(
|
|
new EnrichPasswordValidationContextDataEvent(
|
|
$contextData,
|
|
$incomingFieldArray,
|
|
self::class
|
|
)
|
|
);
|
|
$contextData = $event->getContextData();
|
|
|
|
$isValidPassword = $passwordPolicyValidator->isValidPassword($value, $contextData);
|
|
if (!$isValidPassword) {
|
|
$message = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_password_policy.xlf:dataHandler.passwordNotSaved');
|
|
$this->log(
|
|
$table,
|
|
(int)$id,
|
|
SystemLogDatabaseAction::UPDATE,
|
|
null,
|
|
SystemLogErrorClassification::WARNING,
|
|
$message . implode('. ', $passwordPolicyValidator->getValidationErrors()),
|
|
null,
|
|
[
|
|
'table' => $table,
|
|
'uid' => (string)$id,
|
|
],
|
|
$realPid
|
|
);
|
|
|
|
// Password not valid for existing user. Stopping here, password won't be changed
|
|
if (!$isNewUser) {
|
|
return [];
|
|
}
|
|
// Password not valid for new user. To prevent empty passwords in the database, we set a random password.
|
|
$value = $this->randomGenerator->generateRandomHexString(96);
|
|
}
|
|
|
|
// Get an instance of the current configured salted password strategy and hash the value
|
|
$value = $newHashInstance->getHashedPassword($value);
|
|
}
|
|
|
|
if (!($tcaFieldConf['nullable'] ?? false) && $value === null) {
|
|
// type=password columns are by default NOT NULL-able.
|
|
// In this case, an invalid password needs to be an empty string to not throw an SQL error
|
|
// on a potential optional password.
|
|
$value = '';
|
|
}
|
|
|
|
return [
|
|
'value' => $value,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Evaluate "slug" type values.
|
|
*
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int $id UID of record
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param string $field Field name
|
|
* @param array $incomingFieldArray the fields being explicitly set by the outside (unlike $fieldArray) for the record
|
|
* @return array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
* @see SlugHelper
|
|
*/
|
|
protected function checkValueForSlug(string $value, array $tcaFieldConf, string $table, $id, int $realPid, string $field, array $incomingFieldArray = []): array
|
|
{
|
|
$workspaceId = $this->BE_USER->workspace;
|
|
$helper = GeneralUtility::makeInstance(SlugHelper::class, $table, $field, $tcaFieldConf, $workspaceId);
|
|
$fullRecord = array_replace_recursive($this->checkValue_currentRecord, $incomingFieldArray);
|
|
// Generate a value if there is none, otherwise ensure that all characters are cleaned up
|
|
if ($value === '') {
|
|
$value = $helper->generate($fullRecord, $realPid);
|
|
} else {
|
|
$value = $helper->sanitize($value);
|
|
}
|
|
|
|
// Return directly in case no evaluations are defined
|
|
if (empty($tcaFieldConf['eval'])) {
|
|
return ['value' => $value];
|
|
}
|
|
|
|
$state = RecordStateFactory::forName($table)
|
|
->fromArray($fullRecord, $realPid, $id);
|
|
$evalCodesArray = GeneralUtility::trimExplode(',', $tcaFieldConf['eval'], true);
|
|
if (in_array('unique', $evalCodesArray, true)) {
|
|
$value = $helper->buildSlugForUniqueInTable($value, $state);
|
|
}
|
|
if (in_array('uniqueInSite', $evalCodesArray, true)) {
|
|
$value = $helper->buildSlugForUniqueInSite($value, $state);
|
|
}
|
|
if (in_array('uniqueInPid', $evalCodesArray, true)) {
|
|
$value = $helper->buildSlugForUniqueInPid($value, $state);
|
|
}
|
|
|
|
return ['value' => $value];
|
|
}
|
|
|
|
/**
|
|
* Evaluate "language" type value.
|
|
*
|
|
* Checks whether the user is allowed to add such a value as language
|
|
*
|
|
* @param int $value The value to set.
|
|
* @param string $table Table name
|
|
* @param string $field Field name
|
|
* @return array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForLanguage(int $value, string $table, string $field): array
|
|
{
|
|
// If given table is localizable and the given field is the defined
|
|
// languageField, check if the selected language is allowed for the user.
|
|
// Note: Usually this method should never be reached, in case the language value is
|
|
// not valid, since "checkRecordEditAccess" checks for proper permission beforehand.
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if ($schema->isLanguageAware()
|
|
&& $schema->getCapability(TcaSchemaCapability::Language)->getLanguageField()->getName() === $field
|
|
&& !$this->BE_USER->checkLanguageAccess($value)
|
|
) {
|
|
return [];
|
|
}
|
|
// @todo Should we also check if the language is allowed for the current site - if record has site context?
|
|
return ['value' => $value];
|
|
}
|
|
|
|
/**
|
|
* Evaluate "link" type values.
|
|
*
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int|string $id UID of record - might be a NEW.. string for new records
|
|
* @param string $field The name of the current field
|
|
* @return array The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForLink(string $value, array $tcaFieldConf, string $table, int|string $id, string $field): array
|
|
{
|
|
// Always trim the value
|
|
$value = trim($value);
|
|
|
|
// Early return if required validation fails
|
|
// Note: The "required" check is evaluated but does not yet lead to an error, see
|
|
// the comment in the DataHandler::validateValueForRequired() for more information.
|
|
if (!$this->validateValueForRequired($tcaFieldConf, $value)) {
|
|
return [];
|
|
}
|
|
|
|
// Early return if an empty allow list is defined for the link types
|
|
if (is_array($tcaFieldConf['allowedTypes'] ?? false) && $tcaFieldConf['allowedTypes'] === []) {
|
|
return [];
|
|
}
|
|
|
|
if ($value !== '') {
|
|
// Extract the actual link from the link definition for further evaluation
|
|
$linkParameter = $this->typoLinkCodecService->decode($value)['url'];
|
|
if ($linkParameter === '') {
|
|
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, '"{link}" is not a valid link definition for the field "{field}" of the table "{table}"', null, ['link' => $value, 'field' => $field, 'table' => $table]);
|
|
$value = '';
|
|
} else {
|
|
// Try to resolve the actual link type and compare with the allow list
|
|
try {
|
|
$linkData = $this->linkService->resolve($linkParameter);
|
|
$linkType = $linkData['type'] ?? '';
|
|
$linkIdentifier = $linkData['identifier'] ?? '';
|
|
if (is_array($tcaFieldConf['allowedTypes'] ?? false)
|
|
&& ($tcaFieldConf['allowedTypes'][0] ?? '') !== '*'
|
|
&& !in_array($linkType, $tcaFieldConf['allowedTypes'], true)
|
|
&& ($linkType !== 'record' || !in_array($linkIdentifier, $tcaFieldConf['allowedTypes'], true))
|
|
) {
|
|
$message = $linkIdentifier !== ''
|
|
? 'Link type "record" with identifier "{type}" is not allowed for the field "{field}" of the table "{table}"'
|
|
: 'Link type "{type}" is not allowed for the field "{field}" of the table "{table}"';
|
|
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, $message, null, ['type' => $linkIdentifier ?: $linkType, 'field' => $field, 'table' => $table]);
|
|
$value = '';
|
|
}
|
|
} catch (UnknownLinkHandlerException $e) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, '"{link}" is not a valid link for the field "{field}" of the table "{table}"', null, ['link' => $value, 'field' => $field, 'table' => $table]);
|
|
$value = '';
|
|
}
|
|
}
|
|
}
|
|
|
|
return ['value' => $value];
|
|
}
|
|
|
|
/**
|
|
* Evaluate 'category' type values
|
|
*
|
|
* @param array $result The result array. The processed value (if any!) is set in the 'value' key.
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int|string $id uid of record
|
|
* @param string $status The status - 'update' or 'new' flag
|
|
* @param string $field Field name
|
|
*/
|
|
protected function checkValueForCategory(
|
|
array $result,
|
|
string $value,
|
|
array $tcaFieldConf,
|
|
string $table,
|
|
$id,
|
|
string $status,
|
|
string $field
|
|
): array {
|
|
// Exploded comma-separated values and remove duplicates
|
|
$valueArray = array_unique(GeneralUtility::trimExplode(',', $value, true));
|
|
// If an exclusive key is found, discard all others:
|
|
if ($tcaFieldConf['exclusiveKeys'] ?? false) {
|
|
$exclusiveKeys = GeneralUtility::trimExplode(',', $tcaFieldConf['exclusiveKeys']);
|
|
foreach ($valueArray as $index => $key) {
|
|
if (in_array($key, $exclusiveKeys, true)) {
|
|
$valueArray = [$index => $key];
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
$unsetResult = false;
|
|
if (str_contains($value, 'NEW')) {
|
|
$this->remapStackRecords[$table][$id] = ['remapStackIndex' => count($this->remapStack)];
|
|
$this->remapStack[] = [
|
|
'func' => 'checkValue_category_processDBdata',
|
|
'args' => [$valueArray, $tcaFieldConf, $id, $status, $table, $field],
|
|
'pos' => ['valueArray' => 0, 'tcaFieldConf' => 1, 'id' => 2, 'table' => 4],
|
|
'field' => $field,
|
|
];
|
|
$unsetResult = true;
|
|
} else {
|
|
$valueArray = $this->checkValue_category_processDBdata($valueArray, $tcaFieldConf, $id, $status, $table, $field);
|
|
}
|
|
if ($unsetResult) {
|
|
unset($result['value']);
|
|
} else {
|
|
$newVal = implode(',', $this->checkValue_checkMax($tcaFieldConf, $valueArray));
|
|
$result['value'] = $newVal !== '' ? $newVal : 0;
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Evaluate 'datetime' type values
|
|
*
|
|
* @param int|string|\DateTimeInterface $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
*/
|
|
protected function checkValueForDatetime(int|string|\DateTimeInterface|null $value, array $tcaFieldConf): array
|
|
{
|
|
$format = $tcaFieldConf['format'] ?? 'datetime';
|
|
if (!in_array($format, ['datetime', 'date', 'time', 'timesec', 'datetimesec'], true)) {
|
|
// Early return if format is not valid
|
|
return [];
|
|
}
|
|
|
|
// Handle native date/time fields
|
|
$isNullable = $tcaFieldConf['nullable'] ?? false;
|
|
$nativeDateTimeType = $tcaFieldConf['dbType'] ?? null;
|
|
if (in_array($nativeDateTimeType, QueryHelper::getDateTimeTypes(), true)) {
|
|
$isNullable = $tcaFieldConf['nullable'] ?? true;
|
|
$dateTimeFormats = QueryHelper::getDateTimeFormats();
|
|
$nativeDateTimeFieldEmptyValue = $dateTimeFormats[$nativeDateTimeType]['empty'];
|
|
if ($value === $nativeDateTimeFieldEmptyValue && $nativeDateTimeType !== 'time') {
|
|
$value = null;
|
|
}
|
|
} else {
|
|
$nativeDateTimeType = null;
|
|
}
|
|
|
|
if (!$this->validateValueForRequired($tcaFieldConf, $value instanceof \DateTimeInterface ? $value->format(\DateTimeInterface::ATOM) : (string)$value)) {
|
|
return [];
|
|
}
|
|
|
|
if ($value === '') {
|
|
$value = null;
|
|
}
|
|
if (MathUtility::canBeInterpretedAsInteger($value)) {
|
|
$value = (int)$value;
|
|
}
|
|
|
|
try {
|
|
$datetime = match (true) {
|
|
$value === null => null,
|
|
$value instanceof \DateTimeImmutable => $value,
|
|
$value instanceof \DateTimeInterface => \DateTimeImmutable::createFromInterface($value),
|
|
// Reprocessing of an existing database value (e.g. Unix timestamp for date/datetime or seconds for time fields)
|
|
is_int($value) => DateTimeFactory::createFromDatabaseValueAndTCAConfig($value, $tcaFieldConf),
|
|
// The value we receive from the backend form is an unqualified ISO 8601 date,
|
|
// for instance "1999-11-11T11:11:11".
|
|
// We can also accept an ISO8601 date with offsets,
|
|
// for instance "1999-11-11T12:11:11+01:00"
|
|
// And we accept database formatted strings,
|
|
// for instance "1999-11-11 12:11:11"
|
|
default => new \DateTimeImmutable($value),
|
|
};
|
|
} catch (\Exception) {
|
|
$datetime = null;
|
|
}
|
|
|
|
if ($datetime !== null) {
|
|
$upper = isset($tcaFieldConf['range']['upper']) ? DateTimeFactory::createFromTimestamp((int)$tcaFieldConf['range']['upper']) : null;
|
|
if ($upper !== null && $datetime > $upper) {
|
|
$datetime = $upper;
|
|
}
|
|
|
|
$lower = isset($tcaFieldConf['range']['lower']) ? DateTimeFactory::createFromTimestamp((int)$tcaFieldConf['range']['lower']) : null;
|
|
if ($lower !== null && $datetime < $lower) {
|
|
$datetime = $lower;
|
|
}
|
|
}
|
|
|
|
return ['value' => QueryHelper::transformDateTimeToDatabaseValue($datetime, $isNullable, $format, $nativeDateTimeType)];
|
|
}
|
|
|
|
/**
|
|
* Evaluates 'check' type values.
|
|
*
|
|
* @param array $res The result array. The processed value (if any!) is set in the 'value' key.
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int $id UID of record
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param string $field Field name
|
|
* @return array Modified $res array
|
|
*/
|
|
protected function checkValueForCheck($res, $value, $tcaFieldConf, $table, $id, $realPid, $field)
|
|
{
|
|
$items = $tcaFieldConf['items'] ?? null;
|
|
if (
|
|
($tcaFieldConf['itemsProcFunc'] ?? '') !== ''
|
|
|| ($tcaFieldConf['itemsProcessors'] ?? []) !== []
|
|
) {
|
|
$processingService = GeneralUtility::makeInstance(ItemProcessingService::class);
|
|
$itemsCollection = SelectItemCollection::createFromArray($tcaFieldConf['items'], $tcaFieldConf['type']);
|
|
$context = new ItemsProcessorContext(
|
|
table: $table,
|
|
field: $field,
|
|
row: $this->checkValue_currentRecord,
|
|
fieldConfiguration: $tcaFieldConf,
|
|
processorParameters: [],
|
|
realPid: $realPid,
|
|
site: $processingService->resolveSite($realPid)
|
|
);
|
|
$items = $processingService->processItems($itemsCollection, $context)->toArray();
|
|
}
|
|
|
|
$itemC = 0;
|
|
if ($items !== null) {
|
|
$itemC = count($items);
|
|
}
|
|
if (!$itemC) {
|
|
$itemC = 1;
|
|
}
|
|
$maxV = (2 ** $itemC) - 1;
|
|
if ($value < 0) {
|
|
// @todo: throw LogicException here? Negative values for checkbox items do not make sense and indicate a coding error.
|
|
$value = 0;
|
|
}
|
|
if ($value > $maxV) {
|
|
// @todo: This case is pretty ugly: If there is an itemsProcFunc registered, and if it returns a dynamic,
|
|
// changing list of items, then it may happen that a value is transformed and vanished checkboxes
|
|
// are permanently removed from the value.
|
|
// Suggestion: Throw an exception instead? Maybe a specific, catchable exception that generates a
|
|
// error message to the user - dynamic item sets via itemsProcFunc on check would be a bad idea anyway.
|
|
$value = (int)$value & $maxV;
|
|
}
|
|
if ($field && $value > 0 && !empty($tcaFieldConf['eval'])) {
|
|
$evalCodesArray = GeneralUtility::trimExplode(',', $tcaFieldConf['eval'], true);
|
|
$otherRecordsWithSameValue = [];
|
|
$maxCheckedRecords = 0;
|
|
// @todo These checks do not consider the language of the current record (if available).
|
|
if (in_array('maximumRecordsCheckedInPid', $evalCodesArray, true)) {
|
|
$otherRecordsWithSameValue = $this->getRecordsWithSameValue($table, $id, $field, $value, $realPid);
|
|
$maxCheckedRecords = (int)$tcaFieldConf['validation']['maximumRecordsCheckedInPid'];
|
|
}
|
|
if (in_array('maximumRecordsChecked', $evalCodesArray, true)) {
|
|
$otherRecordsWithSameValue = $this->getRecordsWithSameValue($table, $id, $field, $value);
|
|
$maxCheckedRecords = (int)$tcaFieldConf['validation']['maximumRecordsChecked'];
|
|
}
|
|
|
|
// there are more than enough records with value "1" in the DB
|
|
// if so, set this value to "0" again
|
|
if ($maxCheckedRecords && count($otherRecordsWithSameValue) >= $maxCheckedRecords) {
|
|
$value = 0;
|
|
$this->log(
|
|
$table,
|
|
$id,
|
|
SystemLogDatabaseAction::CHECK,
|
|
null,
|
|
SystemLogErrorClassification::USER_ERROR,
|
|
'Could not activate checkbox for field "{field}". A total of {max} record(s) can have this checkbox activated. Uncheck other records first in order to activate the checkbox of this record',
|
|
null,
|
|
['field' => $field, 'max' => $maxCheckedRecords]
|
|
);
|
|
}
|
|
}
|
|
$res['value'] = $value;
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Evaluates 'radio' type values.
|
|
*
|
|
* @param array $res The result array. The processed value (if any!) is set in the 'value' key.
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table The table of the record
|
|
* @param int $id The id of the record
|
|
* @param int $pid The pid of the record
|
|
* @param string $field The field to check
|
|
* @return array Modified $res array
|
|
*/
|
|
protected function checkValueForRadio(array $res, $value, $tcaFieldConf, $table, $id, $pid, $field): array
|
|
{
|
|
if (!is_array($tcaFieldConf['items'] ?? null)) {
|
|
$tcaFieldConf['items'] = [];
|
|
}
|
|
foreach ($tcaFieldConf['items'] as $set) {
|
|
if ((string)$set['value'] === (string)$value) {
|
|
$res['value'] = $value;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// if no value was found and an itemsProcFunc is defined, check that for the value
|
|
if (
|
|
empty($res['value'])
|
|
&& (($tcaFieldConf['itemsProcFunc'] ?? '') !== ''
|
|
|| ($tcaFieldConf['itemsProcessors'] ?? []) !== [])
|
|
) {
|
|
$processingService = GeneralUtility::makeInstance(ItemProcessingService::class);
|
|
$itemsCollection = SelectItemCollection::createFromArray($tcaFieldConf['items'], $tcaFieldConf['type']);
|
|
$context = new ItemsProcessorContext(
|
|
table: $table,
|
|
field: $field,
|
|
row: $this->checkValue_currentRecord,
|
|
fieldConfiguration: $tcaFieldConf,
|
|
processorParameters: [],
|
|
realPid: $pid,
|
|
site: $processingService->resolveSite($pid)
|
|
);
|
|
foreach ($processingService->processItems($itemsCollection, $context) as $set) {
|
|
if ((string)$set['value'] === (string)$value) {
|
|
$res['value'] = $value;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Evaluate "json" type values.
|
|
*
|
|
* @param array|string|null $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @return array The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForJson(array|string|null $value, array $tcaFieldConf): array
|
|
{
|
|
if ($value === null) {
|
|
$value = [];
|
|
} elseif (is_string($value)) {
|
|
if ($value === '') {
|
|
$value = [];
|
|
} else {
|
|
try {
|
|
$value = json_decode($value, true, 512, JSON_THROW_ON_ERROR);
|
|
if ($value === null) {
|
|
// Unset value as it could not be decoded
|
|
return [];
|
|
}
|
|
} catch (\JsonException) {
|
|
// Unset value as it is invalid
|
|
return [];
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!$this->validateValueForRequired($tcaFieldConf, $value)) {
|
|
// Unset value as it is required
|
|
return [];
|
|
}
|
|
|
|
return [
|
|
'value' => $value,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Evaluates 'group', 'folder' or 'select' type values.
|
|
*
|
|
* @param array $res The result array. The processed value (if any!) is set in the 'value' key.
|
|
* @param string|array $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int $id UID of record
|
|
* @param string $status 'update' or 'new' flag
|
|
* @param string $field Field name
|
|
* @return array Modified $res array
|
|
*/
|
|
protected function checkValueForGroupFolderSelect($res, $value, $tcaFieldConf, $table, $id, $status, $field)
|
|
{
|
|
// Detecting if value sent is an array and if so, implode it around a comma:
|
|
if (is_array($value)) {
|
|
$value = implode(',', $value);
|
|
} else {
|
|
$value = (string)$value;
|
|
}
|
|
|
|
// When values are sent as group or select they come as comma-separated values which are exploded by this function:
|
|
$valueArray = $this->checkValue_group_select_explodeSelectGroupValue($value);
|
|
// If multiple is not set, remove duplicates:
|
|
if (!($tcaFieldConf['multiple'] ?? false)) {
|
|
$valueArray = array_unique($valueArray);
|
|
}
|
|
// If an exclusive key is found, discard all others:
|
|
if ($tcaFieldConf['type'] === 'select' && ($tcaFieldConf['exclusiveKeys'] ?? false)) {
|
|
$exclusiveKeys = GeneralUtility::trimExplode(',', $tcaFieldConf['exclusiveKeys']);
|
|
foreach ($valueArray as $index => $key) {
|
|
if (in_array($key, $exclusiveKeys, true)) {
|
|
$valueArray = [$index => $key];
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
// This could be a good spot for parsing the array through a validation-function which checks if the values are correct (except that database references are not in their final form - but that is the point, isn't it?)
|
|
// NOTE!!! Must check max-items of files before the later check because that check would just leave out file names if there are too many!!
|
|
$valueArray = $this->applyFiltersToValues($tcaFieldConf, $valueArray);
|
|
// Checking for select / authMode, removing elements from $valueArray if any of them is not allowed!
|
|
if ($tcaFieldConf['type'] === 'select' && ($tcaFieldConf['authMode'] ?? false)) {
|
|
$preCount = count($valueArray);
|
|
foreach ($valueArray as $index => $key) {
|
|
if (!$this->BE_USER->checkAuthMode($table, $field, $key)) {
|
|
unset($valueArray[$index]);
|
|
}
|
|
}
|
|
// During the check it turns out that the value / all values were removed - we respond by simply returning an empty array so nothing is written to DB for this field.
|
|
if ($preCount && empty($valueArray)) {
|
|
return [];
|
|
}
|
|
}
|
|
// For select types which has a foreign table attached:
|
|
$unsetResult = false;
|
|
if ($tcaFieldConf['type'] === 'group' || ($tcaFieldConf['type'] === 'select' && ($tcaFieldConf['foreign_table'] ?? false))) {
|
|
// check, if there is a NEW... id in the value, that should be substituted later
|
|
if (str_contains($value, 'NEW')) {
|
|
$this->remapStackRecords[$table][$id] = ['remapStackIndex' => count($this->remapStack)];
|
|
$this->remapStack[] = [
|
|
'func' => 'checkValue_group_select_processDBdata',
|
|
'args' => [$valueArray, $tcaFieldConf, $id, $status, $tcaFieldConf['type'], $table, $field],
|
|
'pos' => ['valueArray' => 0, 'tcaFieldConf' => 1, 'id' => 2, 'table' => 5],
|
|
'field' => $field,
|
|
];
|
|
$unsetResult = true;
|
|
} else {
|
|
$valueArray = $this->checkValue_group_select_processDBdata($valueArray, $tcaFieldConf, $id, $status, $tcaFieldConf['type'], $table, $field);
|
|
}
|
|
}
|
|
if (!$unsetResult) {
|
|
$newVal = $this->checkValue_checkMax($tcaFieldConf, $valueArray);
|
|
$res['value'] = $this->castReferenceValue(implode(',', $newVal), $tcaFieldConf, str_contains($value, 'NEW'));
|
|
} else {
|
|
unset($res['value']);
|
|
}
|
|
return $res;
|
|
}
|
|
|
|
protected function checkValueForCountry(string $value, array $tcaFieldConf): array
|
|
{
|
|
// @todo For now, countries are only stored as a SINGLE value. MM handling may need implementation here.
|
|
$valueArray = $this->applyFiltersToValues($tcaFieldConf, [$value]);
|
|
return [
|
|
'value' => $valueArray[0] ?? '',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Evaluate "uuid" type values. Will create a new uuid in case
|
|
* an invalid uuid is provided and the field is marked as required.
|
|
*
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
*
|
|
* @return array $res The result array. The processed value (if any!) is set in the "value" key.
|
|
*/
|
|
protected function checkValueForUuid(string $value, array $tcaFieldConf): array
|
|
{
|
|
if (Uuid::isValid($value)) {
|
|
return ['value' => $value];
|
|
}
|
|
if ($tcaFieldConf['required'] ?? true) {
|
|
return ['value' => (string)match ((int)($tcaFieldConf['version'] ?? 0)) {
|
|
6 => Uuid::v6(),
|
|
7 => Uuid::v7(),
|
|
default => Uuid::v4()
|
|
}];
|
|
}
|
|
// Unset invalid uuid - in case a field value is not required
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Applies the filter methods from a column's TCA configuration to a value array.
|
|
*
|
|
* @return array|mixed
|
|
* @throws \RuntimeException
|
|
*/
|
|
protected function applyFiltersToValues(array $tcaFieldConfiguration, array $values)
|
|
{
|
|
if (!is_array($tcaFieldConfiguration['filter'] ?? null)) {
|
|
return $values;
|
|
}
|
|
foreach ($tcaFieldConfiguration['filter'] as $filter) {
|
|
if (empty($filter['userFunc'])) {
|
|
continue;
|
|
}
|
|
$parameters = $filter['parameters'] ?? [];
|
|
if (!is_array($parameters)) {
|
|
$parameters = [];
|
|
}
|
|
$parameters['values'] = $values;
|
|
$parameters['tcaFieldConfig'] = $tcaFieldConfiguration;
|
|
$values = GeneralUtility::callUserFunction($filter['userFunc'], $parameters, $this);
|
|
if (!is_array($values)) {
|
|
throw new \RuntimeException('Expected userFunc filter "' . $filter['userFunc'] . '" to return an array. Got ' . gettype($values) . '.', 1336051942);
|
|
}
|
|
}
|
|
return $values;
|
|
}
|
|
|
|
/**
|
|
* Evaluates 'flex' type values.
|
|
*
|
|
* @param array $res The result array. The processed value (if any!) is set in the 'value' key.
|
|
* @param mixed $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string|int $id UID of record
|
|
* @param string $curValue Current value of the field
|
|
* @param string $status 'update' or 'new' flag
|
|
* @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
|
|
* @param string $recFID Field identifier [table:uid:field] for flexforms
|
|
*/
|
|
protected function checkValueForFlex(array $res, mixed $value, array $tcaFieldConf, string $table, string|int $id, string $curValue, string $status, int $realPid, string $recFID, int $tscPID, string $field): array
|
|
{
|
|
// Called from within a FlexForm traversal (e.g. checkFlexFormData): a flex field
|
|
// cannot nest another flex field, so skip processing entirely.
|
|
if ($field === '') {
|
|
return [];
|
|
}
|
|
if (!is_array($value)) {
|
|
$res['value'] = $value;
|
|
return $res;
|
|
}
|
|
|
|
// This value is necessary for flex form processing to happen on flexform fields in page records when they are copied.
|
|
// Problem: when copying a page, flexform XML comes along in the array for the new record - but since $this->checkValue_currentRecord
|
|
// does not have a uid or pid for that sake, the FlexFormTools->getDataStructureIdentifier() function returns no good DS. For new
|
|
// records we do know the expected PID, so we send that with this special parameter. Only active when larger than zero.
|
|
$row = $this->checkValue_currentRecord;
|
|
if ($status === 'new') {
|
|
$row['pid'] = $realPid;
|
|
}
|
|
|
|
// Get data structure. The methods may throw various exceptions, with some of them being
|
|
// ok in certain scenarios, for instance on new record rows. Those are ok to "eat" here
|
|
// and substitute with a dummy DS.
|
|
try {
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$dataStructureIdentifier = $this->flexFormTools->getDataStructureIdentifier(
|
|
['config' => $tcaFieldConf],
|
|
$table,
|
|
$field,
|
|
$row,
|
|
$schema
|
|
);
|
|
$dataStructureArray = $this->flexFormTools->parseDataStructureByIdentifier($dataStructureIdentifier, $schema);
|
|
} catch (InvalidIdentifierException) {
|
|
$dataStructureArray = ['sheets' => ['sDEF' => []]];
|
|
}
|
|
|
|
// Get current value array:
|
|
$currentValueArray = $curValue !== '' ? GeneralUtility::xml2array($curValue) : [];
|
|
if (!is_array($currentValueArray)) {
|
|
$currentValueArray = [];
|
|
}
|
|
// Remove all old meta for languages...
|
|
// Evaluation of input values:
|
|
$value['data'] = $this->checkFlexFormData($value['data'] ?? [], $currentValueArray['data'] ?? [], $dataStructureArray, $table, $id, $status, $realPid, $recFID, $tscPID);
|
|
// Create XML from input value:
|
|
$xmlValue = $this->flexFormTools->flexArray2Xml($value);
|
|
|
|
// Here we convert the currently submitted values BACK to an array, then merge the two and then BACK to XML again. This is needed to ensure the charsets are the same
|
|
// (provided that the current value was already stored IN the charset that the new value is converted to).
|
|
$xmlAsArray = GeneralUtility::xml2array($xmlValue);
|
|
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['checkFlexFormValue'] ?? [] as $className) {
|
|
$hookObject = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hookObject, 'checkFlexFormValue_beforeMerge')) {
|
|
$hookObject->checkFlexFormValue_beforeMerge($this, $currentValueArray, $xmlAsArray);
|
|
}
|
|
}
|
|
|
|
ArrayUtility::mergeRecursiveWithOverrule($currentValueArray, $xmlAsArray);
|
|
$xmlValue = $this->flexFormTools->flexArray2Xml($currentValueArray);
|
|
|
|
$xmlAsArray = GeneralUtility::xml2array($xmlValue);
|
|
$xmlAsArray = $this->sortAndDeleteFlexSectionContainerElements($xmlAsArray, $dataStructureArray);
|
|
$xmlValue = $this->flexFormTools->flexArray2Xml($xmlAsArray);
|
|
|
|
$res['value'] = $xmlValue;
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Delete and resort section container elements.
|
|
*
|
|
* @todo: It would be better if the magic _ACTION key would be a 'command array', not part of 'data array'
|
|
*/
|
|
private function sortAndDeleteFlexSectionContainerElements(array $valueArray, array $dataStructure): array
|
|
{
|
|
foreach (($dataStructure['sheets'] ?? []) as $dataStructureSheetName => $dataStructureSheetDefinition) {
|
|
if (!isset($dataStructureSheetDefinition['ROOT']['el']) || !is_array($dataStructureSheetDefinition['ROOT']['el'])) {
|
|
continue;
|
|
}
|
|
$dataStructureFields = $dataStructureSheetDefinition['ROOT']['el'];
|
|
foreach ($dataStructureFields as $dataStructureFieldName => $dataStructureFieldDefinition) {
|
|
if (isset($dataStructureFieldDefinition['type']) && $dataStructureFieldDefinition['type'] === 'array'
|
|
&& isset($dataStructureFieldDefinition['section']) && (string)$dataStructureFieldDefinition['section'] === '1'
|
|
) {
|
|
// Found a possible section within flex form data structure definition
|
|
if (!is_array($valueArray['data'][$dataStructureSheetName]['lDEF'][$dataStructureFieldName]['el'] ?? false)) {
|
|
// No containers in data
|
|
continue;
|
|
}
|
|
$newElements = [];
|
|
$containerCounter = 0;
|
|
foreach ($valueArray['data'][$dataStructureSheetName]['lDEF'][$dataStructureFieldName]['el'] as $sectionKey => $sectionValues) {
|
|
// Remove to-delete containers
|
|
$action = $sectionValues['_ACTION'] ?? '';
|
|
if ($action === 'DELETE') {
|
|
continue;
|
|
}
|
|
if (($sectionValues['_ACTION'] ?? '') === '') {
|
|
$sectionValues['_ACTION'] = $containerCounter;
|
|
}
|
|
$newElements[$sectionKey] = $sectionValues;
|
|
$containerCounter++;
|
|
}
|
|
// Resort by action key
|
|
uasort($newElements, function ($a, $b) {
|
|
return (int)$a['_ACTION'] - (int)$b['_ACTION'];
|
|
});
|
|
foreach ($newElements as &$element) {
|
|
// Do not store action key
|
|
unset($element['_ACTION']);
|
|
}
|
|
$valueArray['data'][$dataStructureSheetName]['lDEF'][$dataStructureFieldName]['el'] = $newElements;
|
|
}
|
|
}
|
|
}
|
|
return $valueArray;
|
|
}
|
|
|
|
/**
|
|
* Evaluates 'inline' type values.
|
|
* (partly copied from the select_group function on this issue)
|
|
*
|
|
* @param array $res The result array. The processed value (if any!) is set in the 'value' key.
|
|
* @param string $value The value to set.
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param string $table Table name
|
|
* @param int|string $id UID of record
|
|
* @param string $status 'update' or 'new' flag
|
|
* @param string $field Field name
|
|
* @param array|null $additionalData Additional data to be forwarded to sub-processors
|
|
* @return array|false Modified $res array
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValueForInline($res, $value, $tcaFieldConf, $table, $id, $status, $field, ?array $additionalData = null)
|
|
{
|
|
if (!$tcaFieldConf['foreign_table']) {
|
|
// Fatal error, inline fields should always have a foreign_table defined
|
|
return false;
|
|
}
|
|
// When values are sent they come as comma-separated values which are exploded by this function:
|
|
$valueArray = GeneralUtility::trimExplode(',', $value);
|
|
// Remove duplicates: (should not be needed)
|
|
$valueArray = array_unique($valueArray);
|
|
// Example for received data:
|
|
// $value = 45,NEW4555fdf59d154,12,123
|
|
// We need to decide whether we use the stack or can save the relation directly.
|
|
if (!empty($value) && (str_contains($value, 'NEW') || !MathUtility::canBeInterpretedAsInteger($id))) {
|
|
$this->remapStackRecords[$table][$id] = ['remapStackIndex' => count($this->remapStack)];
|
|
$this->remapStack[] = [
|
|
'func' => 'checkValue_inline_processDBdata',
|
|
'args' => [$valueArray, $tcaFieldConf, $id, $status, $table, $field, $additionalData],
|
|
'pos' => ['valueArray' => 0, 'tcaFieldConf' => 1, 'id' => 2, 'table' => 4],
|
|
'additionalData' => $additionalData,
|
|
'field' => $field,
|
|
];
|
|
unset($res['value']);
|
|
} elseif ($value || MathUtility::canBeInterpretedAsInteger($id)) {
|
|
$res['value'] = $this->checkValue_inline_processDBdata($valueArray, $tcaFieldConf, $id, $status, $table, $field);
|
|
}
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Evaluates 'file' type values.
|
|
*/
|
|
public function checkValueForFile(
|
|
array $res,
|
|
string $value,
|
|
array $tcaFieldConf,
|
|
string $table,
|
|
int|string $id,
|
|
string $field,
|
|
?array $additionalData = null
|
|
): array {
|
|
$valueArray = array_unique(GeneralUtility::trimExplode(',', $value));
|
|
if ($value !== '' && (str_contains($value, 'NEW') || !MathUtility::canBeInterpretedAsInteger($id))) {
|
|
$this->remapStackRecords[$table][$id] = ['remapStackIndex' => count($this->remapStack)];
|
|
$this->remapStack[] = [
|
|
'func' => 'checkValue_file_processDBdata',
|
|
'args' => [$valueArray, $tcaFieldConf, $id, $table],
|
|
'pos' => ['valueArray' => 0, 'tcaFieldConf' => 1, 'id' => 2, 'table' => 3],
|
|
'additionalData' => $additionalData,
|
|
'field' => $field,
|
|
];
|
|
unset($res['value']);
|
|
} elseif ($value !== '' || MathUtility::canBeInterpretedAsInteger($id)) {
|
|
$res['value'] = $this->checkValue_file_processDBdata($valueArray, $tcaFieldConf, $id, $table);
|
|
}
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Checks if a fields has more items than defined via TCA in maxitems.
|
|
* If there are more items than allowed, the item list is truncated to the defined number.
|
|
*
|
|
* @param array $tcaFieldConf Field configuration from TCA
|
|
* @param array $valueArray Current value array of items
|
|
* @return array The truncated value array of items
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValue_checkMax($tcaFieldConf, $valueArray): array
|
|
{
|
|
// BTW, checking for min and max items here does NOT make any sense when MM is used because the above function
|
|
// calls will just return an array with a single item (the count) if MM is used... Why didn't I perform the check
|
|
// before? Probably because we could not evaluate the validity of record uids etc... Hmm...
|
|
// NOTE to the comment: It's not really possible to check for too few items, because you must then determine first,
|
|
// if the field is actually used regarding the CType.
|
|
$maxitems = isset($tcaFieldConf['maxitems']) ? (int)$tcaFieldConf['maxitems'] : 99999;
|
|
return array_slice($valueArray, 0, $maxitems);
|
|
}
|
|
|
|
/**
|
|
* Gets a unique value for $table/$id/$field based on $value
|
|
*
|
|
* @param string $table Table name
|
|
* @param string $field Field name for which $value must be unique
|
|
* @param string $value Value string.
|
|
* @param int $id UID to filter out in the lookup (the record itself...)
|
|
* @param int $newPid If set, the value will be unique for this PID
|
|
* @return string Modified value (if not-unique). Will be the value appended with a number (until 100, then the function just breaks).
|
|
* @todo: consider workspaces, especially when publishing a unique value which has a unique value already in live
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function getUnique($table, $field, $value, $id, $newPid = 0)
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table) || !$this->tcaSchemaFactory->get($table)->hasField($field)) {
|
|
// Field is not configured in TCA
|
|
return $value;
|
|
}
|
|
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$tcaField = $schema->getField($field);
|
|
if ($tcaField->getTranslationBehaviour() === FieldTranslationBehaviour::Excluded && $schema->isLanguageAware()) {
|
|
$transOrigPointerField = $schema->getCapability(TcaSchemaCapability::Language)->getTranslationOriginPointerField()->getName();
|
|
$l10nParent = (int)($this->checkValue_currentRecord[$transOrigPointerField] ?? 0);
|
|
if ($l10nParent > 0) {
|
|
// Current record is a translation and l10n_mode "exclude" just copies the value from source language
|
|
return $value;
|
|
}
|
|
}
|
|
|
|
$newValue = $originalValue = $value;
|
|
$queryBuilder = $this->getUniqueCountStatement($newValue, $table, $field, (int)$id, (int)$newPid);
|
|
// For as long as records with the test-value existing, try again (with incremented numbers appended)
|
|
$statement = $queryBuilder->prepare();
|
|
$result = $statement->executeQuery();
|
|
if ($result->fetchOne()) {
|
|
for ($counter = 0; $counter <= 100; $counter++) {
|
|
$result->free();
|
|
$newValue = $value . $counter;
|
|
$statement->bindValue(1, $newValue, Connection::PARAM_STR);
|
|
$result = $statement->executeQuery();
|
|
if (!$result->fetchOne()) {
|
|
break;
|
|
}
|
|
}
|
|
$result->free();
|
|
}
|
|
|
|
if ($originalValue !== $newValue) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::CHECK, null, SystemLogErrorClassification::WARNING, 'The value of the field "{field}" has been changed from "{originalValue}" to "{newValue}" as it is required to be unique', null, ['field' => $field, 'originalValue' => $originalValue, 'newValue' => $newValue], $newPid);
|
|
}
|
|
|
|
return $newValue;
|
|
}
|
|
|
|
/**
|
|
* Gets the count of records for a unique field
|
|
*
|
|
* @param string $value The string value which should be unique
|
|
* @param string $table Table name
|
|
* @param string $field Field name for which $value must be unique
|
|
* @param int $uid UID to filter out in the lookup (the record itself...)
|
|
* @param int $pid If set, the value will be unique for this PID
|
|
* @return QueryBuilder Return the prepared statement to check uniqueness
|
|
*/
|
|
protected function getUniqueCountStatement(
|
|
string $value,
|
|
string $table,
|
|
string $field,
|
|
int $uid,
|
|
int $pid
|
|
): QueryBuilder {
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$queryBuilder
|
|
->count('uid')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq($field, $queryBuilder->createPositionalParameter($value)),
|
|
$queryBuilder->expr()->neq('uid', $queryBuilder->createPositionalParameter($uid, Connection::PARAM_INT))
|
|
);
|
|
// ignore translations of current record if field is configured with l10n_mode = "exclude"
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$tcaField = $schema->getField($field);
|
|
if ($schema->isLanguageAware() && $tcaField->getTranslationBehaviour() === FieldTranslationBehaviour::Excluded) {
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$queryBuilder
|
|
->andWhere(
|
|
$queryBuilder->expr()->or(
|
|
// records without l10n_parent must be taken into account (in any language)
|
|
$queryBuilder->expr()->eq(
|
|
$languageCapability->getTranslationOriginPointerField()->getName(),
|
|
$queryBuilder->createPositionalParameter(0, Connection::PARAM_INT)
|
|
),
|
|
// translations of other records must be taken into account
|
|
$queryBuilder->expr()->neq(
|
|
$languageCapability->getTranslationOriginPointerField()->getName(),
|
|
$queryBuilder->createPositionalParameter($uid, Connection::PARAM_INT)
|
|
)
|
|
)
|
|
);
|
|
}
|
|
if ($pid !== 0) {
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->eq('pid', $queryBuilder->createPositionalParameter($pid, Connection::PARAM_INT))
|
|
);
|
|
} else {
|
|
// pid>=0 for versioning
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->gte('pid', $queryBuilder->createPositionalParameter(0, Connection::PARAM_INT))
|
|
);
|
|
}
|
|
return $queryBuilder;
|
|
}
|
|
|
|
/**
|
|
* gets all records that have the same value in a field
|
|
* excluding the given uid
|
|
*
|
|
* @param string $tableName Table name
|
|
* @param int $uid UID to filter out in the lookup (the record itself...)
|
|
* @param string $fieldName Field name for which $value must be unique
|
|
* @param string|int $value Value string.
|
|
* @param int $pageId If set, the value will be unique for this PID
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function getRecordsWithSameValue($tableName, $uid, $fieldName, $value, $pageId = 0): array
|
|
{
|
|
$result = [];
|
|
if (!$this->tcaSchemaFactory->has($tableName) || !$this->tcaSchemaFactory->get($tableName)->hasField($fieldName)) {
|
|
return $result;
|
|
}
|
|
|
|
$uid = (int)$uid;
|
|
$pageId = (int)$pageId;
|
|
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($tableName);
|
|
$queryBuilder->getRestrictions()->removeAll()
|
|
->add(GeneralUtility::makeInstance(DeletedRestriction::class))
|
|
->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, (int)$this->BE_USER->workspace));
|
|
|
|
$queryBuilder->select('*')
|
|
->from($tableName)
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
$fieldName,
|
|
$queryBuilder->createNamedParameter($value)
|
|
),
|
|
$queryBuilder->expr()->neq(
|
|
'uid',
|
|
$queryBuilder->createNamedParameter($uid, Connection::PARAM_INT)
|
|
)
|
|
);
|
|
|
|
if ($pageId) {
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter($pageId, Connection::PARAM_INT))
|
|
);
|
|
}
|
|
|
|
return $queryBuilder->executeQuery()->fetchAllAssociative();
|
|
}
|
|
|
|
/**
|
|
* @param string $value The field value to be evaluated
|
|
* @param array $evalArray Array of evaluations to traverse.
|
|
* @param string $is_in The "is_in" value of the field configuration from TCA
|
|
* @return array
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValue_text_Eval($value, $evalArray, $is_in)
|
|
{
|
|
$res = [];
|
|
/** @var true|false this is required as PHPstan doesn't know about evaluateFieldValue() $set */
|
|
$set = true;
|
|
foreach ($evalArray as $func) {
|
|
switch ($func) {
|
|
case 'trim':
|
|
$value = trim((string)$value);
|
|
break;
|
|
default:
|
|
if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tce']['formevals'][$func])) {
|
|
if (class_exists($func)) {
|
|
$evalObj = GeneralUtility::makeInstance($func);
|
|
if (method_exists($evalObj, 'evaluateFieldValue')) {
|
|
$value = $evalObj->evaluateFieldValue($value, $is_in, $set);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if ($set) {
|
|
$res['value'] = $value;
|
|
}
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Evaluation of 'input'-type values based on 'eval' list
|
|
*
|
|
* @param string $value Value to evaluate
|
|
* @param array $evalArray Array of evaluations to traverse.
|
|
* @param string $is_in Is-in string for 'is_in' evaluation
|
|
* @param string $table Table name the eval is evaluated on
|
|
* @param string|int $id Record ID the eval is evaluated on
|
|
* @return array Modified $value in key 'value' or empty array
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValue_input_Eval($value, $evalArray, $is_in, string $table = '', $id = ''): array
|
|
{
|
|
$res = [];
|
|
$set = true;
|
|
foreach ($evalArray as $func) {
|
|
switch ($func) {
|
|
case 'md5':
|
|
if (strlen($value) !== 32) {
|
|
$set = false;
|
|
}
|
|
break;
|
|
case 'trim':
|
|
$value = trim($value);
|
|
break;
|
|
case 'upper':
|
|
$value = mb_strtoupper($value, 'utf-8');
|
|
break;
|
|
case 'lower':
|
|
$value = mb_strtolower($value, 'utf-8');
|
|
break;
|
|
case 'is_in':
|
|
$c = mb_strlen($value);
|
|
if ($c) {
|
|
$newVal = '';
|
|
for ($a = 0; $a < $c; $a++) {
|
|
$char = mb_substr($value, $a, 1);
|
|
if (str_contains($is_in, $char)) {
|
|
$newVal .= $char;
|
|
}
|
|
}
|
|
$value = $newVal;
|
|
}
|
|
break;
|
|
case 'nospace':
|
|
$value = str_replace(' ', '', $value);
|
|
break;
|
|
case 'alpha':
|
|
$value = preg_replace('/[^a-zA-Z]/', '', $value);
|
|
break;
|
|
case 'num':
|
|
$value = preg_replace('/[^0-9]/', '', $value);
|
|
break;
|
|
case 'alphanum':
|
|
$value = preg_replace('/[^a-zA-Z0-9]/', '', $value);
|
|
break;
|
|
case 'alphanum_x':
|
|
$value = preg_replace('/[^a-zA-Z0-9_-]/', '', $value);
|
|
break;
|
|
case 'domainname':
|
|
if (!preg_match('/^[a-z0-9.\\-]*$/i', $value)) {
|
|
$value = (string)idn_to_ascii($value);
|
|
}
|
|
break;
|
|
default:
|
|
if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tce']['formevals'][$func])) {
|
|
if (class_exists($func)) {
|
|
$evalObj = GeneralUtility::makeInstance($func);
|
|
if (method_exists($evalObj, 'evaluateFieldValue')) {
|
|
$value = $evalObj->evaluateFieldValue($value, $is_in, $set);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if ($set) {
|
|
$res['value'] = $value;
|
|
}
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Checks if required=true is set:
|
|
* if set: checks if the value is not empty (or not "0").
|
|
* if not set: does not matter, always returns true:
|
|
*
|
|
* @todo: If this requirement is not fulfilled, DataHandler should not execute any write statements, which could be
|
|
* properly covered by tests then
|
|
*
|
|
* @return bool true if the required flag is set and the value is properly set, or if the required flag is not needed (and thus always valid).
|
|
*/
|
|
protected function validateValueForRequired(array $tcaFieldConfig, mixed $value): bool
|
|
{
|
|
if (!isset($tcaFieldConfig['required']) || !$tcaFieldConfig['required']) {
|
|
return true;
|
|
}
|
|
return !empty($value) || $value === '0';
|
|
}
|
|
|
|
/**
|
|
* Returns processed data for category fields
|
|
*
|
|
* @param array $valueArray Current value array
|
|
* @param array $tcaFieldConf TCA field config
|
|
* @param string|int $id Record id, used for look-up of MM relations (local_uid)
|
|
* @param string $status Status string ('update' or 'new')
|
|
* @param string $table Table name, needs to be passed to \TYPO3\CMS\Core\Database\RelationHandler
|
|
* @param string $field field name, needs to be set for writing to sys_history
|
|
* @return array Modified value array
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValue_category_processDBdata(
|
|
array $valueArray,
|
|
array $tcaFieldConf,
|
|
$id,
|
|
string $status,
|
|
string $table,
|
|
string $field
|
|
): array {
|
|
$newRelations = implode(',', $valueArray);
|
|
$relationHandler = $this->createRelationHandlerInstance();
|
|
$relationHandler->start($newRelations, $tcaFieldConf['foreign_table'], '', 0, $table, $tcaFieldConf);
|
|
if ($tcaFieldConf['MM'] ?? false) {
|
|
$relationHandler->convertItemArray();
|
|
if ($status === 'update') {
|
|
$relationHandleForOldRelations = $this->createRelationHandlerInstance();
|
|
$relationHandleForOldRelations->start('', $tcaFieldConf['foreign_table'], $tcaFieldConf['MM'], $id, $table, $tcaFieldConf);
|
|
$oldRelations = implode(',', $relationHandleForOldRelations->getValueArray());
|
|
$relationHandler->writeMM($tcaFieldConf['MM'], $id);
|
|
if ($oldRelations !== $newRelations) {
|
|
$this->mmHistoryRecords[$table . ':' . $id]['oldRecord'][$field] = $oldRelations;
|
|
$this->mmHistoryRecords[$table . ':' . $id]['newRecord'][$field] = $newRelations;
|
|
} else {
|
|
$this->mmHistoryRecords[$table . ':' . $id]['oldRecord'][$field] = '';
|
|
$this->mmHistoryRecords[$table . ':' . $id]['newRecord'][$field] = '';
|
|
}
|
|
} else {
|
|
$this->dbAnalysisStore[] = [$relationHandler, $tcaFieldConf['MM'], $id, '', $table];
|
|
}
|
|
$valueArray = $relationHandler->countItems();
|
|
} else {
|
|
$valueArray = $relationHandler->getValueArray();
|
|
}
|
|
return $valueArray;
|
|
}
|
|
|
|
/**
|
|
* Returns data for group/db and select fields
|
|
*
|
|
* @param array $valueArray Current value array
|
|
* @param array $tcaFieldConf TCA field config
|
|
* @param int $id Record id, used for look-up of MM relations (local_uid)
|
|
* @param string $status Status string ('update' or 'new')
|
|
* @param string $type The type, either 'select', 'group' or 'inline'
|
|
* @param string $currentTable Table name, needs to be passed to \TYPO3\CMS\Core\Database\RelationHandler
|
|
* @param string $currentField field name, needs to be set for writing to sys_history
|
|
* @return array Modified value array
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValue_group_select_processDBdata($valueArray, $tcaFieldConf, $id, $status, $type, $currentTable, $currentField)
|
|
{
|
|
$tables = $type === 'group' ? $tcaFieldConf['allowed'] : $tcaFieldConf['foreign_table'];
|
|
$prep = $type === 'group' ? ($tcaFieldConf['prepend_tname'] ?? '') : '';
|
|
$newRelations = implode(',', $valueArray);
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->registerNonTableValues = !empty($tcaFieldConf['allowNonIdValues']);
|
|
$dbAnalysis->start($newRelations, $tables, '', 0, $currentTable, $tcaFieldConf);
|
|
if ($tcaFieldConf['MM'] ?? false) {
|
|
// convert submitted items to use version ids instead of live ids
|
|
// (only required for MM relations in a workspace context)
|
|
$dbAnalysis->convertItemArray();
|
|
if ($status === 'update') {
|
|
$oldRelations_dbAnalysis = $this->createRelationHandlerInstance();
|
|
$oldRelations_dbAnalysis->registerNonTableValues = !empty($tcaFieldConf['allowNonIdValues']);
|
|
// Db analysis with $id will initialize with the existing relations
|
|
$oldRelations_dbAnalysis->start('', $tables, $tcaFieldConf['MM'], $id, $currentTable, $tcaFieldConf);
|
|
$oldRelations = implode(',', $oldRelations_dbAnalysis->getValueArray());
|
|
$dbAnalysis->writeMM($tcaFieldConf['MM'], $id, $prep);
|
|
if ($oldRelations != $newRelations) {
|
|
$this->mmHistoryRecords[$currentTable . ':' . $id]['oldRecord'][$currentField] = $oldRelations;
|
|
$this->mmHistoryRecords[$currentTable . ':' . $id]['newRecord'][$currentField] = $newRelations;
|
|
} else {
|
|
$this->mmHistoryRecords[$currentTable . ':' . $id]['oldRecord'][$currentField] = '';
|
|
$this->mmHistoryRecords[$currentTable . ':' . $id]['newRecord'][$currentField] = '';
|
|
}
|
|
} else {
|
|
$this->dbAnalysisStore[] = [$dbAnalysis, $tcaFieldConf['MM'], $id, $prep, $currentTable];
|
|
}
|
|
$valueArray = $dbAnalysis->countItems();
|
|
} else {
|
|
$valueArray = $dbAnalysis->getValueArray($prep);
|
|
}
|
|
// Here we should see if 1) the records exist anymore, 2) which are new and check if the BE_USER has read-access to the new ones.
|
|
return $valueArray;
|
|
}
|
|
|
|
/**
|
|
* Explodes the $value, which is a list of files/uids (group select)
|
|
*
|
|
* @param string $value Input string, comma separated values. For each part it will also be detected if a '|' is found and the first part will then be used if that is the case. Further the value will be rawurldecoded.
|
|
* @return array The value array.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function checkValue_group_select_explodeSelectGroupValue($value): array
|
|
{
|
|
$valueArray = GeneralUtility::trimExplode(',', $value, true);
|
|
foreach ($valueArray as &$newVal) {
|
|
$temp = explode('|', $newVal, 2);
|
|
$newVal = str_replace(['|', ','], '', rawurldecode($temp[0]));
|
|
}
|
|
unset($newVal);
|
|
return $valueArray;
|
|
}
|
|
|
|
/**
|
|
* Validate and coerce all leaf field values in a FlexForm data array against their
|
|
* Data Structure definitions by calling checkValue_SW() on each vDEF value.
|
|
* Structure-driven: only DS-declared sheets and elements are processed.
|
|
*/
|
|
private function checkFlexFormData(array $data, array $currentData, array $dataStructure, string $table, string|int $id, string $status, int $realPid, string $recFID, int $tscPID): array
|
|
{
|
|
foreach ($dataStructure['sheets'] as $sheetKey => $sheetData) {
|
|
foreach (($sheetData['ROOT']['el'] ?? []) as $sheetElementKey => $sheetElementTca) {
|
|
if (($sheetElementTca['type'] ?? '') === 'array') {
|
|
// Section element.
|
|
if (!is_array($sheetElementTca['el'] ?? false) || !is_array($data[$sheetKey]['lDEF'][$sheetElementKey]['el'] ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($data[$sheetKey]['lDEF'][$sheetElementKey]['el'] as $valueSectionContainerKey => $valueSectionContainers) {
|
|
if (!is_array($valueSectionContainers ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($valueSectionContainers as $valueContainerType => $valueContainerElements) {
|
|
if (!is_array($sheetElementTca['el'][$valueContainerType]['el'] ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($sheetElementTca['el'][$valueContainerType]['el'] as $containerElement => $containerElementTca) {
|
|
$fieldConfig = $containerElementTca['config'] ?? null;
|
|
if (!is_array($fieldConfig)) {
|
|
continue;
|
|
}
|
|
if (($fieldConfig['type'] ?? '') === 'passthrough') {
|
|
$currentVDef = $currentData[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'] ?? null;
|
|
if (!empty($currentVDef)) {
|
|
// If there is existing value, keep it.
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'] = $currentVDef;
|
|
} elseif (!empty($fieldConfig['default']) && !MathUtility::canBeInterpretedAsInteger($id)) {
|
|
// If is new record and a default is specified for field, use it.
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'] = $fieldConfig['default'];
|
|
}
|
|
}
|
|
if (!is_array($valueContainerElements['el'][$containerElement] ?? false)) {
|
|
continue;
|
|
}
|
|
$flexFormPath = $sheetKey . '/lDEF/' . $sheetElementKey . '/el/' . $valueSectionContainerKey . '/' . $valueContainerType . '/el/' . $containerElement . '/vDEF';
|
|
$res = $this->checkValue_SW(
|
|
[],
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'] ?? null,
|
|
$fieldConfig,
|
|
$table,
|
|
$id,
|
|
$currentData[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'] ?? null,
|
|
$status,
|
|
$realPid,
|
|
$recFID,
|
|
'',
|
|
$tscPID,
|
|
['flexFormId' => $recFID, 'flexFormPath' => $flexFormPath]
|
|
);
|
|
if (isset($res['value'])) {
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'] = $res['value'];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
// Simple field element.
|
|
$fieldConfig = $sheetElementTca['config'] ?? null;
|
|
if (!is_array($fieldConfig)) {
|
|
continue;
|
|
}
|
|
if (($fieldConfig['type'] ?? '') === 'passthrough') {
|
|
$currentVDef = $currentData[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'] ?? null;
|
|
if (!empty($currentVDef)) {
|
|
// If there is existing value, keep it.
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'] = $currentVDef;
|
|
} elseif (!empty($fieldConfig['default']) && !MathUtility::canBeInterpretedAsInteger($id)) {
|
|
// If is new record and a default is specified for field, use it.
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'] = $fieldConfig['default'];
|
|
}
|
|
}
|
|
if (!isset($data[$sheetKey]['lDEF'][$sheetElementKey]) || !is_array($data[$sheetKey]['lDEF'][$sheetElementKey])) {
|
|
continue;
|
|
}
|
|
$flexFormPath = $sheetKey . '/lDEF/' . $sheetElementKey . '/vDEF';
|
|
$res = $this->checkValue_SW(
|
|
[],
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'] ?? null,
|
|
$fieldConfig,
|
|
$table,
|
|
$id,
|
|
$currentData[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'] ?? null,
|
|
$status,
|
|
$realPid,
|
|
$recFID,
|
|
'',
|
|
$tscPID,
|
|
['flexFormId' => $recFID, 'flexFormPath' => $flexFormPath]
|
|
);
|
|
if (isset($res['value'])) {
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'] = $res['value'];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Returns data for inline fields.
|
|
*
|
|
* @param array $valueArray Current value array
|
|
* @param array $tcaFieldConf TCA field config
|
|
* @param int $id Record id
|
|
* @param string $status Status string ('update' or 'new')
|
|
* @param string $table Table name, needs to be passed to \TYPO3\CMS\Core\Database\RelationHandler
|
|
* @param string $field The current field the values are modified for
|
|
* @return string Modified values
|
|
*/
|
|
protected function checkValue_inline_processDBdata($valueArray, $tcaFieldConf, $id, $status, $table, $field)
|
|
{
|
|
$foreignTable = $tcaFieldConf['foreign_table'];
|
|
$valueArray = $this->applyFiltersToValues($tcaFieldConf, $valueArray);
|
|
// Fetch the related child records using \TYPO3\CMS\Core\Database\RelationHandler
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start(implode(',', $valueArray), $foreignTable, '', 0, $table, $tcaFieldConf);
|
|
// IRRE with a pointer field (database normalization):
|
|
if ($tcaFieldConf['foreign_field'] ?? false) {
|
|
// update record in intermediate table (sorting & pointer uid to parent record)
|
|
$dbAnalysis->writeForeignField($tcaFieldConf, $id);
|
|
$newValue = $dbAnalysis->countItems(false);
|
|
} elseif ($this->getRelationFieldType($tcaFieldConf) === 'mm') {
|
|
// In order to fully support all the MM stuff, directly call checkValue_group_select_processDBdata instead of repeating the needed code here
|
|
$valueArray = $this->checkValue_group_select_processDBdata($valueArray, $tcaFieldConf, $id, $status, 'select', $table, $field);
|
|
$newValue = $valueArray[0];
|
|
} else {
|
|
$valueArray = $dbAnalysis->getValueArray();
|
|
// Checking that the number of items is correct:
|
|
$valueArray = $this->checkValue_checkMax($tcaFieldConf, $valueArray);
|
|
$newValue = $this->castReferenceValue(implode(',', $valueArray), $tcaFieldConf, ($status === 'new'));
|
|
}
|
|
return $newValue;
|
|
}
|
|
|
|
/**
|
|
* Returns data for file fields.
|
|
*/
|
|
protected function checkValue_file_processDBdata($valueArray, $tcaFieldConf, $id, $table): mixed
|
|
{
|
|
$filteredValueArray = GeneralUtility::makeInstance(FileExtensionFilter::class)->filter(
|
|
$valueArray,
|
|
(string)($tcaFieldConf['allowed'] ?? ''),
|
|
(string)($tcaFieldConf['disallowed'] ?? ''),
|
|
);
|
|
$disallowedReferences = array_diff($valueArray, $filteredValueArray);
|
|
foreach ($disallowedReferences as $reference) {
|
|
// Remove not allowed sys_file_reference rows for this record
|
|
$parts = GeneralUtility::revExplode('_', (string)$reference, 2);
|
|
$fileReferenceUid = (int)$parts[count($parts) - 1];
|
|
if ($fileReferenceUid <= 0) {
|
|
continue;
|
|
}
|
|
$this->deleteAction('sys_file_reference', $fileReferenceUid);
|
|
}
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start(implode(',', $filteredValueArray), $tcaFieldConf['foreign_table'], '', 0, $table, $tcaFieldConf);
|
|
$dbAnalysis->writeForeignField($tcaFieldConf, $id);
|
|
return $dbAnalysis->countItems(false);
|
|
}
|
|
|
|
/**
|
|
* Processing the cmd-array
|
|
* See "TYPO3 Core API" for a description of the options.
|
|
*
|
|
* @return void|bool
|
|
*/
|
|
public function process_cmdmap()
|
|
{
|
|
// Hook initialization:
|
|
$hookObjectsArr = [];
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processCmdmapClass'] ?? [] as $className) {
|
|
$hookObj = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hookObj, 'processCmdmap_beforeStart')) {
|
|
$hookObj->processCmdmap_beforeStart($this);
|
|
}
|
|
$hookObjectsArr[] = $hookObj;
|
|
}
|
|
$pasteDatamap = [];
|
|
// Traverse command map:
|
|
foreach ($this->cmdmap as $table => $idCommandArray) {
|
|
$table = (string)$table;
|
|
if (!$this->checkModifyAccessList($table)) {
|
|
// Check if the table may be modified!
|
|
$this->log($table, 0, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to modify table "{table}" without permission', null, ['table' => $table]);
|
|
continue;
|
|
}
|
|
// Check basic permissions and circumstances:
|
|
if (!$this->tcaSchemaFactory->has($table) || $this->tcaSchemaFactory->get($table)->hasCapability(TcaSchemaCapability::AccessReadOnly)) {
|
|
continue;
|
|
}
|
|
|
|
// Traverse the command map:
|
|
foreach ($idCommandArray as $id => $incomingCmdArray) {
|
|
$id = (int)$id;
|
|
if (!is_array($incomingCmdArray)) {
|
|
continue;
|
|
}
|
|
|
|
if ($table === 'pages') {
|
|
// for commands on pages do a pagetree-refresh
|
|
$this->pagetreeNeedsRefresh = true;
|
|
}
|
|
|
|
foreach ($incomingCmdArray as $command => $value) {
|
|
$command = (string)$command;
|
|
$pasteUpdate = false;
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$languageField = $schema->isLanguageAware() ? $schema->getCapability(TcaSchemaCapability::Language)->getLanguageField()->getName() : null;
|
|
if (is_array($value) && isset($value['action']) && $value['action'] === 'paste') {
|
|
// Extended paste command: $command is set to "move" or "copy"
|
|
// $value['update'] holds field/value pairs which should be updated after copy/move operation
|
|
// $value['target'] holds original $value (target of move/copy)
|
|
if ($languageField) {
|
|
$row = BackendUtility::getRecord($table, $id);
|
|
$languageId = $value['update'][$languageField] ?? null;
|
|
// Update language field after copy/move only if language was changed
|
|
if ($languageId !== null && (int)$languageId === $row[$languageField]) {
|
|
unset($value['update'][$languageField]);
|
|
}
|
|
// Reset language for a -1 element from original record if copied or moved into language 0
|
|
if ($row[$languageField] === -1 && (int)$languageId === 0) {
|
|
$value['update'][$languageField] = $row[$languageField];
|
|
}
|
|
}
|
|
$pasteUpdate = $value['update'];
|
|
$value = $value['target'];
|
|
}
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processCmdmap_preProcess')) {
|
|
$hookObj->processCmdmap_preProcess($command, $table, $id, $value, $this, $pasteUpdate);
|
|
}
|
|
}
|
|
// Init copyMapping array:
|
|
// Must clear this array before call from here to those functions:
|
|
// Contains mapping information between new and old id numbers.
|
|
$this->copyMappingArray = [];
|
|
// process the command
|
|
$commandIsProcessed = false;
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processCmdmap')) {
|
|
/** @var bool $commandIsProcessed */
|
|
$hookObj->processCmdmap($command, $table, $id, $value, $commandIsProcessed, $this, $pasteUpdate);
|
|
}
|
|
}
|
|
// Only execute default commands if a hook hasn't been processed the command already
|
|
$pasteDatamap = [];
|
|
if (!$commandIsProcessed) {
|
|
$procId = $id;
|
|
// Branch, based on command
|
|
switch ($command) {
|
|
case 'move':
|
|
$this->moveRecord($table, $id, (int)$value);
|
|
if (is_array($pasteUpdate) && $procId > 0) {
|
|
// Update after copy/move operation
|
|
$pasteDatamap[$table][$procId] = $pasteUpdate;
|
|
}
|
|
break;
|
|
case 'copy':
|
|
$target = $value['target'] ?? $value;
|
|
$ignoreLocalization = (bool)($value['ignoreLocalization'] ?? false);
|
|
if ($table === 'pages') {
|
|
$this->copyPages($id, $target);
|
|
} else {
|
|
$this->copyRecord($table, $id, $target, true, [], $ignoreLocalization);
|
|
}
|
|
$procId = $this->copyMappingArray[$table][$id] ?? null;
|
|
if (is_array($pasteUpdate) && $procId > 0) {
|
|
// Update after copy/move operation
|
|
$pasteDatamap[$table][$procId] = $pasteUpdate;
|
|
// Update language field of relations after copy operation (record was copied to a different language)
|
|
// When 'copy' is called to copy/paste some record that has inline children to *some other language*,
|
|
// the copied children must have the same "sys_language_uid" (TCA ctrl languageField) value as their
|
|
// copied parent. The loop goes through the copied elements to set their "sys_language_uid"
|
|
// @todo: localize() in 'copyToLanguage' does this already, mainly by calling copyRecord() with a negative uid/pid,
|
|
// and by not calling copyRecord() with 0 for $language (7th argument), but with the target
|
|
// language id. Trying to implement this here however leads to different "sorting" values, but
|
|
// in general, this loop should not be needed and streamlined with details from 'copyToLanguage'.
|
|
// @todo: Make this work for move operation as well? May need additional test coverage.
|
|
foreach ($this->copyMappingArray as $procTable => $copyProcIds) {
|
|
foreach ($copyProcIds as $copyProcId) {
|
|
if ($copyProcId !== $procId) {
|
|
if ($languageField !== null && isset($pasteUpdate[$languageField])) {
|
|
$pasteDatamap[$procTable][$copyProcId][$languageField] = $pasteUpdate[$languageField];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
case 'localize':
|
|
// @todo: Hand this state change around as method argument to localize() instead.
|
|
$backupUseTransOrigPointerField = $this->useTransOrigPointerField;
|
|
$this->useTransOrigPointerField = true;
|
|
$this->localize($table, $id, $value);
|
|
$this->useTransOrigPointerField = $backupUseTransOrigPointerField;
|
|
break;
|
|
case 'copyToLanguage':
|
|
$backupUseTransOrigPointerField = $this->useTransOrigPointerField;
|
|
$this->useTransOrigPointerField = false;
|
|
$this->localize($table, $id, $value);
|
|
$this->useTransOrigPointerField = $backupUseTransOrigPointerField;
|
|
break;
|
|
case 'inlineLocalizeSynchronize':
|
|
$this->inlineLocalizeSynchronize($table, $id, $value);
|
|
break;
|
|
case 'delete':
|
|
$this->deleteAction($table, $id);
|
|
break;
|
|
case 'undelete':
|
|
$this->undeleteRecord($table, $id);
|
|
break;
|
|
case 'discard':
|
|
$this->discard((string)$table, (int)$id);
|
|
break;
|
|
case 'version':
|
|
$action = $value['action'] ?? null;
|
|
if ($action === 'new') {
|
|
$this->versionizeRecord($table, $id, $value['label'] ?? null);
|
|
} elseif ($value['action'] === 'clearWSID' || $value['action'] === 'flush') {
|
|
// @todo: This can be removed once testing framework is not using 'clearWSID' and 'flush' anymore
|
|
$this->discard($table, $id);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processCmdmap_postProcess')) {
|
|
$hookObj->processCmdmap_postProcess($command, $table, $id, $value, $this, $pasteUpdate, $pasteDatamap);
|
|
}
|
|
}
|
|
// Merging the copy-array info together for remapping purposes.
|
|
ArrayUtility::mergeRecursiveWithOverrule($this->copyMappingArray_merged, $this->copyMappingArray);
|
|
}
|
|
}
|
|
}
|
|
$copyTCE = $this->getLocalTCE();
|
|
$copyTCE->start($pasteDatamap, [], $this->BE_USER, $this->referenceIndexUpdater, $this->correlationId);
|
|
$copyTCE->process_datamap();
|
|
$this->errorLog = array_merge($this->errorLog, $copyTCE->errorLog);
|
|
unset($copyTCE);
|
|
|
|
// Finally, before exit, check if there are ID references to remap.
|
|
// This might be the case if versioning or copying has taken place!
|
|
$this->remapListedDBRecords();
|
|
$this->processRemapStack();
|
|
foreach ($hookObjectsArr as $hookObj) {
|
|
if (method_exists($hookObj, 'processCmdmap_afterFinish')) {
|
|
$hookObj->processCmdmap_afterFinish($this);
|
|
}
|
|
}
|
|
if ($this->isOuterMostInstance()) {
|
|
$this->referenceIndexUpdater->update();
|
|
$this->processClearCacheQueue();
|
|
$this->resetNestedElementCalls();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Copying a single record
|
|
*
|
|
* @param string $table Element table
|
|
* @param int $uid Element UID
|
|
* @param int $destPid >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if
|
|
* @param bool $first Is a flag set, if the record copied is NOT a 'slave' to another record copied. That is, if this record was asked to be copied in the cmd-array
|
|
* @param array $overrideValues Associative array with field/value pairs to override directly. Notice; Fields must exist in the table record and NOT be among excluded fields!
|
|
* @param bool $ignoreLocalization If TRUE, any localization routine is skipped
|
|
* @return int|null ID of new record, if any
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function copyRecord(string $table, int $uid, int $destPid, bool $first = false, array $overrideValues = [], bool $ignoreLocalization = false): ?int
|
|
{
|
|
$uid = ($origUid = $uid);
|
|
// Only copy if the table has a Schema, a uid is given and the record wasn't copied before:
|
|
if (!$this->tcaSchemaFactory->has($table) || $uid === 0) {
|
|
return null;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if ($this->isRecordCopied($table, $uid)) {
|
|
return null;
|
|
}
|
|
|
|
$row = BackendUtility::getRecord($table, $uid);
|
|
if (!is_array($row)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to copy record "{table}:{uid}" which does not exist', null, ['table' => $table, 'uid' => (int)$uid]);
|
|
return null;
|
|
}
|
|
BackendUtility::workspaceOL($table, $row, $this->BE_USER->workspace);
|
|
if ($table === 'pages') {
|
|
$pageContext = $row;
|
|
} elseif ((int)$row['pid'] > 0) {
|
|
$pageContext = BackendUtility::getRecord('pages', $row['pid']);
|
|
if (!is_array($pageContext)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to copy record "{table}:{uid}" which is not assigned to a valid page', null, ['table' => $table, 'uid' => (int)$uid]);
|
|
return null;
|
|
}
|
|
} else {
|
|
$pageContext = VirtualRecord::RootPage;
|
|
}
|
|
if (!$this->hasPageContextPermission($table, Permission::PAGE_SHOW, $pageContext)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to copy record "{table}:{uid}" without read permissions', null, ['table' => $table, 'uid' => (int)$uid]);
|
|
return null;
|
|
}
|
|
|
|
$pageRecord = is_array($pageContext) ? $pageContext : [];
|
|
$tscPID = (int)BackendUtility::getTSconfig_pidValue($table, $uid, $destPid);
|
|
|
|
// Check if table is allowed on destination page
|
|
if (!$this->isTableAllowedForThisPage($tscPID, $table, $pageRecord)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to insert record "{table}:{uid}" on a page ({pid}) that can\'t store record type', null, ['table' => $table, 'uid' => $uid, 'pid' => $tscPID]);
|
|
return null;
|
|
}
|
|
|
|
$fullLanguageCheckNeeded = $table !== 'pages';
|
|
// Used to check language and general editing rights
|
|
$accessResult = $this->BE_USER->checkRecordEditAccess($table, $row, false, $fullLanguageCheckNeeded);
|
|
if (!$ignoreLocalization && !$accessResult->isAllowed) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to copy record "{table}:{uid}" without having permissions to do so [{reason}]', null, ['table' => $table, 'uid' => $uid, 'reason' => $accessResult->errorMessage]);
|
|
return null;
|
|
}
|
|
|
|
BackendUtility::workspaceOL($table, $row, $this->BE_USER->workspace);
|
|
if ($schema->hasCapability(TcaSchemaCapability::Workspace)
|
|
&& $this->BE_USER->workspace > 0
|
|
&& VersionState::tryFrom($row['t3ver_state'] ?? 0) === VersionState::DELETE_PLACEHOLDER
|
|
) {
|
|
// The to-copy record turns out to be a delete placeholder. Those do not make sense to be copied and are skipped.
|
|
return null;
|
|
}
|
|
$row = BackendUtility::purgeComputedPropertiesFromRecord($row);
|
|
|
|
// Initializing:
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$theNewID = StringUtility::getUniqueId('NEW');
|
|
$disabledField = $schema->hasCapability(TcaSchemaCapability::RestrictionDisabledField) ? $schema->getCapability(TcaSchemaCapability::RestrictionDisabledField)->getField() : null;
|
|
$labelFieldName = $schema->getCapability(TcaSchemaCapability::Label)->getPrimaryFieldName() ?? '';
|
|
// Getting "copy-after" fields if applicable:
|
|
$copyAfterFields = $destPid < 0 ? $this->fixCopyAfterDuplFields((string)$table, (int)abs($destPid)) : [];
|
|
// Page TSconfig related:
|
|
$TSConfig = BackendUtility::getPagesTSconfig($tscPID)['TCEMAIN.'] ?? [];
|
|
$tE = $this->getTableEntries($table, $TSConfig);
|
|
// Determine the record's own language for field processing
|
|
$recordLanguage = 0;
|
|
if ($schema->isLanguageAware()) {
|
|
$recordLanguage = (int)($row[$schema->getCapability(TcaSchemaCapability::Language)->getLanguageField()->getName()] ?? 0);
|
|
}
|
|
|
|
$data = [];
|
|
$row = $this->removeNonCopyableFields($table, $row, 'copyRecord');
|
|
|
|
// Traverse ALL fields of the selected record:
|
|
foreach ($row as $field => $value) {
|
|
// Preparation/Processing of the value:
|
|
// "pid" is hardcoded of course:
|
|
// isset() won't work here, since values can be NULL in each of the arrays
|
|
// except setDefaultOnCopyArray, since we exploded that from a string
|
|
if ($field === 'pid') {
|
|
$value = $destPid;
|
|
} elseif (array_key_exists($field, $overrideValues)) {
|
|
// Override value...
|
|
$value = $overrideValues[$field];
|
|
} elseif (array_key_exists($field, $copyAfterFields)) {
|
|
// Copy-after value if available:
|
|
$value = $copyAfterFields[$field];
|
|
} else {
|
|
// Hide at copy may override:
|
|
if ($first && $field === $disabledField?->getName()
|
|
&& $schema->hasCapability(TcaSchemaCapability::HideRecordsAtCopy)
|
|
&& !($this->BE_USER->uc['neverHideAtCopy'] ?? false)
|
|
&& !($tE['disableHideAtCopy'] ?? false)
|
|
) {
|
|
$value = 1;
|
|
}
|
|
// Prepend label on copy:
|
|
if ($first && $field === $labelFieldName
|
|
&& $schema->hasCapability(TcaSchemaCapability::PrependLabelTextAtCopy)
|
|
&& !($tE['disablePrependAtCopy'] ?? false)
|
|
) {
|
|
$value = $this->getCopyHeader($table, $this->resolvePid($table, $destPid), $field, $this->clearPrefixFromValue($table, $value), 0);
|
|
}
|
|
// Get TCA configuration for the field (respecting columnsOverrides):
|
|
$conf = $this->resolveFieldConfigurationAndRespectColumnsOverrides($table, $field, $row);
|
|
// Processing based on the TCA config field type (files, references, flexforms...)
|
|
$value = $this->copyRecord_procBasedOnFieldType($table, $uid, $field, $value, $row, $conf, $tscPID, $recordLanguage);
|
|
}
|
|
// Add value to array.
|
|
$data[$table][$theNewID][$field] = $value;
|
|
}
|
|
// Overriding values:
|
|
if ($schema->hasCapability(TcaSchemaCapability::EditLock)) {
|
|
$data[$table][$theNewID][$schema->getCapability(TcaSchemaCapability::EditLock)->getFieldName()] = 0;
|
|
}
|
|
// Setting original UID:
|
|
if ($schema->hasCapability(TcaSchemaCapability::AncestorReferenceField)) {
|
|
$data[$table][$theNewID][$schema->getCapability(TcaSchemaCapability::AncestorReferenceField)->getFieldName()] = $uid;
|
|
}
|
|
// Do the copy by simply submitting the array through DataHandler:
|
|
$copyTCE = $this->getLocalTCE();
|
|
$copyTCE->start($data, [], $this->BE_USER, $this->referenceIndexUpdater, $this->correlationId);
|
|
$copyTCE->process_datamap();
|
|
// Getting the new UID:
|
|
$theNewSQLID = $copyTCE->substNEWwithIDs[$theNewID] ?? null;
|
|
if ($theNewSQLID) {
|
|
$this->copyMappingArray[$table][$origUid] = $theNewSQLID;
|
|
// Keep automatically versionized record information:
|
|
if (isset($copyTCE->autoVersionIdMap[$table][$theNewSQLID])) {
|
|
$this->autoVersionIdMap[$table][$theNewSQLID] = $copyTCE->autoVersionIdMap[$table][$theNewSQLID];
|
|
}
|
|
}
|
|
$this->errorLog = array_merge($this->errorLog, $copyTCE->errorLog);
|
|
if (!$ignoreLocalization && $recordLanguage === 0 && $schema->isLanguageAware()) {
|
|
// repointing the new translation records to the parent record we just created
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
// repointing the new translation records to the parent record we just created
|
|
$overrideValues[$languageCapability->getTranslationOriginPointerField()->getName()] = $theNewSQLID;
|
|
if ($languageCapability->hasTranslationSourceField()) {
|
|
$overrideValues[$languageCapability->getTranslationSourceField()->getName()] = 0;
|
|
}
|
|
$this->copyL10nOverlayRecords($table, $uid, $destPid, $first, $overrideValues);
|
|
}
|
|
|
|
return $theNewSQLID;
|
|
}
|
|
|
|
/**
|
|
* Copying pages
|
|
* Main function for copying pages.
|
|
*
|
|
* @param int $uid Page UID to copy
|
|
* @param int $destPid Destination PID: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function copyPages($uid, $destPid): void
|
|
{
|
|
// Initialize:
|
|
$uid = (int)$uid;
|
|
$destPid = (int)$destPid;
|
|
|
|
$copyTablesAlongWithPage = $this->BE_USER->isAdmin()
|
|
? $this->tcaSchemaFactory->all()->getNames()
|
|
: explode(',', $this->BE_USER->groupData['tables_modify']);
|
|
$copyTablesAlongWithPage = array_unique($copyTablesAlongWithPage);
|
|
|
|
// Begin to copy pages if we're allowed to:
|
|
if ($this->BE_USER->isAdmin() || in_array('pages', $copyTablesAlongWithPage, true)) {
|
|
// Copy this page we're on. And set first-flag (this will trigger that the record is hidden if that is configured)
|
|
// This method also copies the localizations of a page
|
|
$theNewRootID = $this->copySpecificPage($uid, $destPid, $copyTablesAlongWithPage, true);
|
|
// If we're going to copy recursively
|
|
if ($theNewRootID && MathUtility::forceIntegerInRange($this->BE_USER->uc['copyLevels'] ?? 0, 0, 100) > 0) {
|
|
// Get ALL subpages to copy (read-permissions are respected!):
|
|
$CPtable = $this->int_pageTreeInfo([], $uid, MathUtility::forceIntegerInRange($this->BE_USER->uc['copyLevels'] ?? 0, 0, 100), $theNewRootID);
|
|
// Now copying the subpages:
|
|
foreach ($CPtable as $thePageUid => $thePagePid) {
|
|
$newPid = $this->copyMappingArray['pages'][$thePagePid] ?? null;
|
|
if (isset($newPid)) {
|
|
$this->copySpecificPage($thePageUid, $newPid, $copyTablesAlongWithPage);
|
|
} else {
|
|
$this->log('pages', $uid, SystemLogDatabaseAction::CHECK, null, SystemLogErrorClassification::USER_ERROR, 'Something went wrong during copying branch');
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
$this->log('pages', $uid, SystemLogDatabaseAction::CHECK, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to copy page {uid} without permission to this table', null, ['uid' => $uid]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Copying a single page ($uid) to $destPid and all tables in the array copyTablesArray.
|
|
*
|
|
* @param int $uid Page uid
|
|
* @param int $destPid Destination PID: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if
|
|
* @param array $copyTablesArray Table on pages to copy along with the page.
|
|
* @param bool $first Is a flag set, if the record copied is NOT a 'slave' to another record copied. That is, if this record was asked to be copied in the cmd-array
|
|
* @return int|null The id of the new page, if applicable.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function copySpecificPage($uid, $destPid, $copyTablesArray, $first = false)
|
|
{
|
|
// Copy the page itself:
|
|
$theNewRootID = $this->copyRecord('pages', $uid, $destPid, $first);
|
|
if ($theNewRootID === null) {
|
|
return null;
|
|
}
|
|
$currentWorkspaceId = (int)$this->BE_USER->workspace;
|
|
foreach ($copyTablesArray as $table) {
|
|
// All records under the page is copied.
|
|
if ($table && $this->tcaSchemaFactory->has($table) && $table !== 'pages') {
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$fields = ['uid'];
|
|
$languageField = null;
|
|
$transOrigPointerField = null;
|
|
$translationSourceField = null;
|
|
if ($schema->isLanguageAware()) {
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$languageField = $languageCapability->getLanguageField()->getName();
|
|
$transOrigPointerField = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
$fields[] = $languageField;
|
|
$fields[] = $transOrigPointerField;
|
|
if ($languageCapability->hasTranslationSourceField()) {
|
|
$translationSourceField = $languageCapability->getTranslationSourceField()->getName();
|
|
$fields[] = $translationSourceField;
|
|
}
|
|
}
|
|
$isTableWorkspaceEnabled = $schema->isWorkspaceAware();
|
|
if ($isTableWorkspaceEnabled) {
|
|
$fields[] = 't3ver_oid';
|
|
$fields[] = 't3ver_state';
|
|
$fields[] = 't3ver_wsid';
|
|
}
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()
|
|
->add(GeneralUtility::makeInstance(DeletedRestriction::class))
|
|
->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $currentWorkspaceId));
|
|
$queryBuilder
|
|
->select(...$fields)
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
'pid',
|
|
$queryBuilder->createNamedParameter($uid, Connection::PARAM_INT)
|
|
)
|
|
);
|
|
if ($schema->hasCapability(TcaSchemaCapability::SortByField)) {
|
|
$queryBuilder->orderBy($schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName(), 'DESC');
|
|
}
|
|
$queryBuilder->addOrderBy('uid');
|
|
try {
|
|
$result = $queryBuilder->executeQuery();
|
|
$rows = [];
|
|
$movedLiveIds = [];
|
|
$movedLiveRecords = [];
|
|
while ($row = $result->fetchAssociative()) {
|
|
if ($isTableWorkspaceEnabled && VersionState::tryFrom($row['t3ver_state'] ?? 0) === VersionState::MOVE_POINTER) {
|
|
$movedLiveIds[(int)$row['t3ver_oid']] = (int)$row['uid'];
|
|
}
|
|
$rows[(int)$row['uid']] = $row;
|
|
}
|
|
// Resolve placeholders of workspace versions
|
|
if (!empty($rows) && $currentWorkspaceId > 0 && $isTableWorkspaceEnabled) {
|
|
// If a record was moved within the page, the PlainDataResolver needs the moved record
|
|
// but not the original live version, otherwise the moved record is not considered at all.
|
|
// For this reason, we find the live ids, where there was also a moved record in the SQL
|
|
// query above in $movedLiveIds and now we removed them before handing them over to PlainDataResolver.
|
|
// see changeContentSortingAndCopyDraftPage test
|
|
foreach ($movedLiveIds as $liveId => $movePlaceHolderId) {
|
|
if (isset($rows[$liveId])) {
|
|
$movedLiveRecords[$movePlaceHolderId] = $rows[$liveId];
|
|
unset($rows[$liveId]);
|
|
}
|
|
}
|
|
$rows = array_reverse(
|
|
$this->resolveVersionedRecords(
|
|
$table,
|
|
implode(',', $fields),
|
|
$schema->hasCapability(TcaSchemaCapability::SortByField) ? $schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName() : '',
|
|
array_keys($rows)
|
|
),
|
|
true
|
|
);
|
|
foreach ($movedLiveRecords as $movePlaceHolderId => $liveRecord) {
|
|
$rows[$movePlaceHolderId] = $liveRecord;
|
|
}
|
|
}
|
|
if ($rows !== []) {
|
|
$languageSourceMap = [];
|
|
$overrideValues = $translationSourceField ? [$translationSourceField => 0] : [];
|
|
$doRemap = false;
|
|
foreach ($rows as $row) {
|
|
// Skip localized records that will be processed in
|
|
// copyL10nOverlayRecords() on copying the default language record
|
|
$transOrigPointer = $row[$transOrigPointerField ?? ''] ?? 0;
|
|
if (!empty($languageField)
|
|
&& $row[$languageField] > 0
|
|
&& $transOrigPointer > 0
|
|
&& (isset($rows[$transOrigPointer]) || isset($movedLiveIds[$transOrigPointer]))
|
|
) {
|
|
continue;
|
|
}
|
|
// Copying each of the underlying records...
|
|
$newUid = $this->copyRecord($table, $row['uid'], $theNewRootID, false, $overrideValues);
|
|
if ($translationSourceField) {
|
|
$languageSourceMap[$row['uid']] = $newUid;
|
|
if ($row[$languageField] > 0) {
|
|
$doRemap = true;
|
|
}
|
|
}
|
|
}
|
|
if ($doRemap) {
|
|
//remap is needed for records in non-default language records in the "free mode"
|
|
$this->copy_remapTranslationSourceField($table, $rows, $languageSourceMap);
|
|
}
|
|
}
|
|
} catch (DBALException $e) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::CHECK, null, SystemLogErrorClassification::USER_ERROR, 'An SQL error occurred: {reason}', null, ['reason' => $e->getMessage()]);
|
|
}
|
|
}
|
|
}
|
|
$this->processRemapStack();
|
|
return $theNewRootID;
|
|
}
|
|
|
|
/**
|
|
* Copying records, but makes a "raw" copy of a record.
|
|
* Basically the only thing observed is field processing like the copying of files and correction of ids. All other fields are 1-1 copied.
|
|
* Technically the copy is made with THIS instance of the DataHandler class contrary to copyRecord() which creates a new instance and uses the processData() function.
|
|
* The copy is created by insertNewCopyVersion() which bypasses most of the regular input checking associated with processData() - maybe copyRecord() should even do this as well!?
|
|
* This function is used to create new versions of a record.
|
|
* NOTICE: DOES NOT CHECK PERMISSIONS to create! And since page permissions are just passed through and not changed to the user who executes the copy we cannot enforce permissions without getting an incomplete copy - unless we change permissions of course.
|
|
*
|
|
* @param string $table Element table
|
|
* @param int $uid Element UID
|
|
* @param int $pid Element PID (real PID, not checked)
|
|
* @param array $overrideArray Override array - must NOT contain any fields not in the table!
|
|
* @param array $workspaceOptions Options to be forwarded if actions happen on a workspace currently
|
|
* @return int|null Returns the new ID of the record (if applicable)
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function copyRecord_raw(string $table, $uid, $pid, array $overrideArray = [], array $workspaceOptions = []): ?int
|
|
{
|
|
$uid = (int)$uid;
|
|
// Stop any actions if the record is marked to be deleted:
|
|
// (this can occur if IRRE elements are versionized and child elements are removed)
|
|
if ($this->isElementToBeDeleted($table, $uid)) {
|
|
return null;
|
|
}
|
|
// Only copy if the table is defined in TCA, a uid is given and the record wasn't copied before:
|
|
if (!$this->tcaSchemaFactory->has($table) || !$uid || $this->isRecordCopied($table, $uid)) {
|
|
return null;
|
|
}
|
|
$row = BackendUtility::getRecord($table, $uid);
|
|
if (!is_array($row)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to create workspace version of a not existing record');
|
|
return null;
|
|
}
|
|
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
|
|
// Merge in override array (t3ver_* overrides from versionizeRecord, etc.)
|
|
$row = array_merge($row, $overrideArray);
|
|
|
|
// Preserve system field values (perms_*, t3ver_*) — they must reach insertNewCopyVersion
|
|
$preservedSystemFields = array_intersect_key($row, array_flip($this->nonFields));
|
|
unset($preservedSystemFields['uid']);
|
|
|
|
// Remove non-copyable fields for the processing loop
|
|
$row = $this->removeNonCopyableFields($table, $row, 'copyRecord_raw');
|
|
|
|
// Traverse ALL fields of the selected record:
|
|
foreach ($row as $field => $value) {
|
|
if ($field === 'pid') {
|
|
$value = $pid;
|
|
} else {
|
|
// Get TCA configuration for the field (respecting columnsOverrides):
|
|
$conf = $this->resolveFieldConfigurationAndRespectColumnsOverrides($table, $field, $row);
|
|
if ($conf !== []) {
|
|
// Processing based on the TCA config field type (files, references, flexforms...)
|
|
$value = $this->copyRecord_procBasedOnFieldType($table, $uid, $field, $value, $row, $conf, $pid, 0, $workspaceOptions);
|
|
}
|
|
}
|
|
// Add value to array.
|
|
$row[$field] = $value;
|
|
}
|
|
|
|
// Re-add preserved system fields for insertNewCopyVersion
|
|
$row = array_merge($row, $preservedSystemFields);
|
|
// Setting original UID:
|
|
if ($schema->hasCapability(TcaSchemaCapability::AncestorReferenceField)) {
|
|
$row[$schema->getCapability(TcaSchemaCapability::AncestorReferenceField)->getFieldName()] = $uid;
|
|
}
|
|
// Do the copy by internal function
|
|
$theNewSQLID = $this->insertNewCopyVersion($table, $row, $pid);
|
|
|
|
// When a record is copied in workspace (eg. to create a delete placeholder record for a live record), records
|
|
// pointing to that record need a reference index update. This is for instance the case in FAL, if a sys_file_reference
|
|
// that refers e.g. to a tt_content record is marked as deleted. The tt_content record then needs a reference index update.
|
|
// This scenario seems to currently only show up if in workspaces, so the refindex update is restricted to this for now.
|
|
if ($workspaceOptions !== []) {
|
|
$this->referenceIndexUpdater->registerUpdateForReferencesToItem($table, $uid, $this->BE_USER->workspace);
|
|
}
|
|
|
|
if ($theNewSQLID) {
|
|
$this->dbAnalysisStoreExec();
|
|
$this->dbAnalysisStore = [];
|
|
$this->copyMappingArray[$table][$uid] = $theNewSQLID;
|
|
return $theNewSQLID;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Inserts a record in the database, passing TCA configuration values through checkValue() but otherwise does NOTHING and checks nothing regarding permissions.
|
|
* Passes the "version" parameter to insertDB() so the copy will look like a new version in the log - should probably be changed or modified a bit for more broad usage...
|
|
*
|
|
* @param string $table Table name
|
|
* @param array $fieldArray Field array to insert as a record
|
|
* @param int $realPid The value of PID field.
|
|
* @return int|null Returns the new ID of the record (if applicable)
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function insertNewCopyVersion($table, $fieldArray, $realPid): ?int
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$id = StringUtility::getUniqueId('NEW');
|
|
// $fieldArray is set as current record.
|
|
// The point is that when new records are created as copies with flex type fields there might be a field containing information about which DataStructure to use and without that information the flexforms cannot be correctly processed.... This should be OK since the $checkValueRecord is used by the flexform evaluation only anyways...
|
|
$this->checkValue_currentRecord = $fieldArray;
|
|
// Makes sure that transformations aren't processed on the copy.
|
|
$backupDontProcessTransformations = $this->dontProcessTransformations;
|
|
$this->dontProcessTransformations = true;
|
|
// Traverse record and input-process each value:
|
|
foreach ($fieldArray as $field => $fieldValue) {
|
|
if ($schema->hasField($field)) {
|
|
// Evaluating the value.
|
|
$res = $this->checkValue($table, $field, $fieldValue, $id, 'new', $realPid, 0, $fieldArray);
|
|
if (isset($res['value'])) {
|
|
$fieldArray[$field] = $res['value'];
|
|
}
|
|
}
|
|
}
|
|
// System fields being set:
|
|
if ($schema->hasCapability(TcaSchemaCapability::CreatedAt)) {
|
|
$fieldArray[$schema->getCapability(TcaSchemaCapability::CreatedAt)->getFieldName()] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
if ($schema->hasCapability(TcaSchemaCapability::UpdatedAt)) {
|
|
$fieldArray[$schema->getCapability(TcaSchemaCapability::UpdatedAt)->getFieldName()] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
// Finally, insert record:
|
|
$this->insertDB($table, $id, $fieldArray);
|
|
// Resets dontProcessTransformations to the previous state.
|
|
$this->dontProcessTransformations = $backupDontProcessTransformations;
|
|
// Return new id:
|
|
return $this->substNEWwithIDs[$id] ?? null;
|
|
}
|
|
|
|
/**
|
|
* Processing/Preparing content for copyRecord() function
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $uid Record uid
|
|
* @param string $field Field name being processed
|
|
* @param string|null $value Input value to be processed.
|
|
* @param array $row Record array
|
|
* @param array $conf TCA field configuration
|
|
* @param int $realDestPid Real page id (pid) the record is copied to
|
|
* @param int $language Language ID used in the duplicated record
|
|
* @param array $workspaceOptions Options to be forwarded if actions happen on a workspace currently
|
|
* @return array|string|null
|
|
* @internal
|
|
* @see copyRecord()
|
|
*/
|
|
public function copyRecord_procBasedOnFieldType($table, $uid, $field, $value, $row, $conf, $realDestPid, $language = 0, array $workspaceOptions = [])
|
|
{
|
|
$relationFieldType = $this->getRelationFieldType($conf);
|
|
// Get the localization mode for the current (parent) record (keep|select):
|
|
// Register if there are references to take care of or MM is used on an inline field (no change to value):
|
|
if ($this->isReferenceField($conf) || $relationFieldType === 'mm') {
|
|
$value = $this->copyRecord_processManyToMany($table, $uid, $field, $value, $conf, $language);
|
|
} elseif ($relationFieldType !== false) {
|
|
$value = $this->copyRecord_processRelation($table, $uid, $field, $value, $row, $conf, $realDestPid, $language, $workspaceOptions);
|
|
}
|
|
// For "flex" fieldtypes we need to traverse the structure for two reasons: If there are file references they have to be prepended with absolute paths and if there are database reference they MIGHT need to be remapped (still done in remapListedDBRecords())
|
|
if (isset($conf['type']) && $conf['type'] === 'flex') {
|
|
// Get current value array:
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$dataStructureIdentifier = $this->flexFormTools->getDataStructureIdentifier(
|
|
['config' => $conf],
|
|
$table,
|
|
$field,
|
|
$row,
|
|
$schema
|
|
);
|
|
$dataStructureArray = $this->flexFormTools->parseDataStructureByIdentifier($dataStructureIdentifier, $schema);
|
|
$currentValue = is_string($value) ? GeneralUtility::xml2array($value) : null;
|
|
// Traversing the XML structure, processing relations in FlexForm such as inline records:
|
|
if (is_array($currentValue)) {
|
|
$currentValue['data'] = $this->copyFlexFormData($currentValue['data'] ?? [], $dataStructureArray, $table, $uid, $field, $realDestPid, $language, $workspaceOptions);
|
|
// Setting value as an array! -> which means the input will be processed according to the 'flex' type when the new copy is created.
|
|
$value = $currentValue;
|
|
}
|
|
}
|
|
if (($conf['type'] ?? '') === 'uuid' && $value !== '') {
|
|
// Uuid is unique by definition. On copying a record, this value must be regenerated
|
|
// if set. In case uuid is not set, it might be optional - or the base record is
|
|
// invalid. In this case the uuid will then be generated by checkValueForUuid().
|
|
$value = (string)match ((int)($conf['version'] ?? 0)) {
|
|
6 => Uuid::v6(),
|
|
7 => Uuid::v7(),
|
|
default => Uuid::v4()
|
|
};
|
|
}
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Processes the children of an MM relation field (select, group, inline) when the parent record is copied.
|
|
*
|
|
* @param string $table
|
|
* @param int $uid
|
|
* @param string $field
|
|
* @param string $value
|
|
* @param array $conf
|
|
* @param int $language
|
|
* @return string
|
|
*/
|
|
protected function copyRecord_processManyToMany($table, $uid, $field, $value, $conf, $language)
|
|
{
|
|
$allowedTables = $conf['type'] === 'group' ? $conf['allowed'] : $conf['foreign_table'];
|
|
$allowedTablesArray = GeneralUtility::trimExplode(',', $allowedTables, true);
|
|
$prependName = $conf['type'] === 'group' ? ($conf['prepend_tname'] ?? '') : '';
|
|
$mmTable = !empty($conf['MM']) ? $conf['MM'] : '';
|
|
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($value, $allowedTables, $mmTable, $uid, $table, $conf);
|
|
$purgeItems = false;
|
|
|
|
// Check if referenced records of select or group fields should also be localized in general.
|
|
// A further check is done in the loop below for each table name.
|
|
if ($language > 0 && $mmTable === '' && !empty($conf['localizeReferencesAtParentLocalization'])) {
|
|
// Check whether allowed tables can be localized.
|
|
$localizeTables = [];
|
|
foreach ($allowedTablesArray as $allowedTable) {
|
|
$localizeTables[$allowedTable] = (bool)$this->tcaSchemaFactory->get($allowedTable)->isLanguageAware();
|
|
}
|
|
|
|
foreach ($dbAnalysis->itemArray as $index => $item) {
|
|
// No action required, if referenced tables cannot be localized (current value will be used).
|
|
if (empty($localizeTables[$item['table']])) {
|
|
continue;
|
|
}
|
|
|
|
// Since select or group fields can reference many records, check whether there's already a localization.
|
|
$recordLocalization = $this->localizationRepository->getRecordTranslation($item['table'], (int)$item['id'], $language, $this->BE_USER->workspace);
|
|
if ($recordLocalization) {
|
|
$dbAnalysis->itemArray[$index]['id'] = $recordLocalization->getUid();
|
|
} elseif ($this->isNestedElementCallRegistered($item['table'], $item['id'], 'localize-' . $language) === false) {
|
|
$dbAnalysis->itemArray[$index]['id'] = $this->localize($item['table'], (int)$item['id'], (int)$language);
|
|
}
|
|
}
|
|
$purgeItems = true;
|
|
}
|
|
|
|
if ($purgeItems || $mmTable !== '') {
|
|
$dbAnalysis->purgeItemArray();
|
|
$value = implode(',', $dbAnalysis->getValueArray($prependName));
|
|
}
|
|
// Setting the value in this array will notify the remapListedDBRecords() function that this field MAY need references to be corrected.
|
|
if ($value) {
|
|
$this->registerDBList[$table][$uid][$field] = $value;
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Processes relations in an inline (IRRE) or file element when the parent record is copied.
|
|
*
|
|
* @param string $table
|
|
* @param int $uid
|
|
* @param string $field
|
|
* @param string $value
|
|
* @param array $row
|
|
* @param array $conf
|
|
* @param int $realDestPid
|
|
* @param int $language
|
|
* @return string
|
|
*/
|
|
protected function copyRecord_processRelation(
|
|
$table,
|
|
$uid,
|
|
$field,
|
|
$value,
|
|
$row,
|
|
$conf,
|
|
$realDestPid,
|
|
$language,
|
|
array $workspaceOptions
|
|
) {
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
// Fetch the related child records using \TYPO3\CMS\Core\Database\RelationHandler
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($value, $conf['foreign_table'], '', $uid, $table, $conf);
|
|
// Walk through the items, copy them and remember the new id:
|
|
foreach ($dbAnalysis->itemArray as $k => $v) {
|
|
$newId = null;
|
|
$childTableIsWorkspaceAware = $this->tcaSchemaFactory->has($v['table']) && $this->tcaSchemaFactory->get($v['table'])->isWorkspaceAware();
|
|
$childTableIsLanguageAware = $this->tcaSchemaFactory->has($v['table']) && $this->tcaSchemaFactory->get($v['table'])->isLanguageAware();
|
|
// If language is set and differs from original record, this isn't a copy action but a localization of our parent/ancestor:
|
|
if ($language > 0 && $schema->isLanguageAware() && $language != ($row[$schema->getCapability(TcaSchemaCapability::Language)->getLanguageField()->getName()] ?? 0)) {
|
|
// Skip localization of children whose table is not language-aware, as they cannot be localized (e.g. monoglot IRRE children).
|
|
// Remove from itemArray to prevent writeForeignField from reassigning the original child to the localized parent.
|
|
// @see DataScenarios\IrreForeignField\AbstractActionTestCase->localizeParentContentWithMonoglotHotelChild()
|
|
if (!$childTableIsLanguageAware) {
|
|
unset($dbAnalysis->itemArray[$k]);
|
|
continue;
|
|
}
|
|
// Children should be localized when the parent gets localized the first time, just do it:
|
|
$newId = $this->localize($v['table'], (int)$v['id'], (int)$language);
|
|
} else {
|
|
if (!MathUtility::canBeInterpretedAsInteger($realDestPid)) {
|
|
$newId = $this->copyRecord($v['table'], $v['id'], -(int)($v['id']));
|
|
// If the destination page id is a NEW string, keep it on the same page
|
|
} elseif ($this->BE_USER->workspace > 0 && $childTableIsWorkspaceAware) {
|
|
// A filled $workspaceOptions indicated that this call
|
|
// has it's origin in previous versionizeRecord() processing
|
|
if (!empty($workspaceOptions)) {
|
|
// Versions use live default id, thus the "new"
|
|
// id is the original live default child record
|
|
$newId = $v['id'];
|
|
$this->versionizeRecord(
|
|
$v['table'],
|
|
$v['id'],
|
|
$workspaceOptions['label'] ?? 'Auto-created for WS #' . $this->BE_USER->workspace,
|
|
$workspaceOptions['delete'] ?? false
|
|
);
|
|
// Otherwise just use plain copyRecord() to create placeholders etc.
|
|
} else {
|
|
// If a record has been copied already during this request,
|
|
// prevent superfluous duplication and use the existing copy
|
|
if (isset($this->copyMappingArray[$v['table']][$v['id']])) {
|
|
$newId = $this->copyMappingArray[$v['table']][$v['id']];
|
|
} else {
|
|
$newId = $this->copyRecord($v['table'], $v['id'], $realDestPid);
|
|
}
|
|
}
|
|
} elseif ($this->BE_USER->workspace > 0 && !$childTableIsWorkspaceAware) {
|
|
// We are in workspace context creating a new parent version and have a child table
|
|
// that is not workspace aware. We don't do anything with this child.
|
|
continue;
|
|
} else {
|
|
// If a record has been copied already during this request,
|
|
// prevent superfluous duplication and use the existing copy
|
|
if (isset($this->copyMappingArray[$v['table']][$v['id']])) {
|
|
$newId = $this->copyMappingArray[$v['table']][$v['id']];
|
|
} else {
|
|
$newId = $this->copyRecord_raw($v['table'], $v['id'], $realDestPid, [], $workspaceOptions);
|
|
}
|
|
}
|
|
}
|
|
// If the current field is set on a page record, update the pid of related child records:
|
|
if ($table === 'pages') {
|
|
$this->registerDBPids[$v['table']][$v['id']] = $uid;
|
|
} elseif (isset($this->registerDBPids[$table][$uid])) {
|
|
$this->registerDBPids[$v['table']][$v['id']] = $this->registerDBPids[$table][$uid];
|
|
}
|
|
$dbAnalysis->itemArray[$k]['id'] = $newId;
|
|
}
|
|
// Store the new values, we will set up the uids for the subtype later on (exception keep localization from original record):
|
|
$value = implode(',', $dbAnalysis->getValueArray());
|
|
$this->registerDBList[$table][$uid][$field] = $value;
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Process FlexForm relation and inline fields during a record copy, registering them
|
|
* for post-copy UID remapping via remapListedDBRecords().
|
|
*/
|
|
private function copyFlexFormData(array $data, array $dataStructure, string $table, int $uid, string $field, int $realDestPid, int $language, array $workspaceOptions): array
|
|
{
|
|
foreach ($dataStructure['sheets'] as $sheetKey => $sheetData) {
|
|
foreach (($sheetData['ROOT']['el'] ?? []) as $sheetElementKey => $sheetElementTca) {
|
|
if (($sheetElementTca['type'] ?? '') === 'array') {
|
|
// Section element.
|
|
if (!is_array($sheetElementTca['el'] ?? false) || !is_array($data[$sheetKey]['lDEF'][$sheetElementKey]['el'] ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($data[$sheetKey]['lDEF'][$sheetElementKey]['el'] as $valueSectionContainerKey => $valueSectionContainers) {
|
|
if (!is_array($valueSectionContainers ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($valueSectionContainers as $valueContainerType => $valueContainerElements) {
|
|
if (!is_array($sheetElementTca['el'][$valueContainerType]['el'] ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($sheetElementTca['el'][$valueContainerType]['el'] as $containerElement => $containerElementTca) {
|
|
if (!isset($data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'])) {
|
|
continue;
|
|
}
|
|
$fieldConfig = $containerElementTca['config'] ?? [];
|
|
$fieldValue = $data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'];
|
|
if (($this->isReferenceField($fieldConfig) || $this->getRelationFieldType($fieldConfig) !== false) && (string)$fieldValue !== '') {
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF']
|
|
= $this->copyRecord_procBasedOnFieldType($table, $uid, $field, $fieldValue, [], $fieldConfig, $realDestPid, $language, $workspaceOptions);
|
|
$this->registerDBList[$table][$uid][$field] = 'FlexForm_reference';
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif (isset($data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'])) {
|
|
// Simple field element.
|
|
$fieldConfig = $sheetElementTca['config'] ?? [];
|
|
$fieldValue = $data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'];
|
|
if (($this->isReferenceField($fieldConfig) || $this->getRelationFieldType($fieldConfig) !== false) && (string)$fieldValue !== '') {
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF']
|
|
= $this->copyRecord_procBasedOnFieldType($table, $uid, $field, $fieldValue, [], $fieldConfig, $realDestPid, $language, $workspaceOptions);
|
|
$this->registerDBList[$table][$uid][$field] = 'FlexForm_reference';
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Find l10n-overlay records and perform the requested copy action for these records.
|
|
*
|
|
* @param int $uid uid default language record
|
|
* @param int $destPid Position to copy to
|
|
*/
|
|
protected function copyL10nOverlayRecords(string $table, int $uid, int $destPid, bool $first = false, array $overrideValues = []): void
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table)) {
|
|
return;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!$schema->isLanguageAware()) {
|
|
return;
|
|
}
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$languageField = $languageCapability->getLanguageField()->getName();
|
|
$transOrigPointerField = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()
|
|
->add(GeneralUtility::makeInstance(DeletedRestriction::class))
|
|
->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->BE_USER->workspace));
|
|
$queryBuilder->select('*')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
$transOrigPointerField,
|
|
$queryBuilder->createNamedParameter($uid, Connection::PARAM_INT, ':pointer')
|
|
)
|
|
);
|
|
|
|
// Never copy the actual placeholders around, as the newly copied records are
|
|
// always created as new record / new placeholder pairs
|
|
if ($schema->isWorkspaceAware()) {
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->neq(
|
|
't3ver_state',
|
|
VersionState::DELETE_PLACEHOLDER->value
|
|
)
|
|
);
|
|
}
|
|
|
|
// If $destPid is < 0, get the pid of the record with uid equal to abs($destPid)
|
|
// @todo: getTSconfig_pidValue() may return -1 or -2, which is an ugly interface and not handled below properly.
|
|
$tscPID = BackendUtility::getTSconfig_pidValue($table, $uid, $destPid) ?? 0;
|
|
// Get the localized records to be copied
|
|
$l10nRecords = $queryBuilder->executeQuery()->fetchAllAssociative();
|
|
if (empty($l10nRecords)) {
|
|
return;
|
|
}
|
|
|
|
// Check whether the target site has configured the language to avoid orphaned records
|
|
$targetPageId = $destPid < 0 ? $tscPID : $destPid;
|
|
try {
|
|
$targetSite = $this->siteFinder->getSiteByPageId($targetPageId);
|
|
// Get all language IDs configured in the target site (including disabled ones, as they may be re-enabled)
|
|
$siteLanguageIds = array_keys($targetSite->getAllLanguages());
|
|
foreach ($l10nRecords as $key => $record) {
|
|
// Remove page translation when the language is not configured in the target site
|
|
if (!in_array($record[$languageField], $siteLanguageIds, true)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::WARNING, 'Attempt to copy translation of record {table}:{uid} into a site, but the site does not support the language {language}', null, ['table' => $table, 'uid' => $uid, 'language' => $record[$languageField]]);
|
|
unset($l10nRecords[$key]);
|
|
}
|
|
}
|
|
if (empty($l10nRecords)) {
|
|
return;
|
|
}
|
|
} catch (SiteNotFoundException) {
|
|
// Translations are not possible in a non-site context
|
|
return;
|
|
}
|
|
|
|
$localizedDestPids = [];
|
|
// If $destPid < 0, then it is the uid of the original language record we are inserting after
|
|
if ($destPid < 0) {
|
|
// Get the localized records of the record we are inserting after
|
|
$queryBuilder->setParameter('pointer', abs($destPid), Connection::PARAM_INT);
|
|
$destL10nRecords = $queryBuilder->executeQuery()->fetchAllAssociative();
|
|
// Index the localized record uids by language
|
|
foreach ($destL10nRecords as $record) {
|
|
$localizedDestPids[$record[$languageField]] = -$record['uid'];
|
|
}
|
|
}
|
|
$languageSourceMap = [
|
|
$uid => $overrideValues[$transOrigPointerField],
|
|
];
|
|
|
|
// For non-page records: Check if target page has translations in the respective language
|
|
if ($table !== 'pages') {
|
|
$pageTranslations = $this->localizationRepository->getPageTranslations($destPid < 0 ? $tscPID : $destPid, [], $this->BE_USER->workspace);
|
|
// Build array with language ids for comparison
|
|
$availableLanguages = array_keys($pageTranslations);
|
|
// Filter records
|
|
foreach ($l10nRecords as $key => $record) {
|
|
// Remove record when target page is not available in the corresponding language
|
|
if (!in_array($record[$languageField], $availableLanguages, true)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::WARNING, 'Attempt to copy translation of record {table}:{uid} into a page, but the page does not support the language {language}', null, ['table' => $table, 'uid' => $uid, 'language' => $record[$languageField]]);
|
|
unset($l10nRecords[$key]);
|
|
}
|
|
}
|
|
if (empty($l10nRecords)) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Copy the localized records after the corresponding localizations of the destination record
|
|
foreach ($l10nRecords as $record) {
|
|
$localizedDestPid = (int)($localizedDestPids[$record[$languageField]] ?? 0);
|
|
if ($localizedDestPid < 0) {
|
|
$newUid = $this->copyRecord($table, $record['uid'], $localizedDestPid, $first, $overrideValues);
|
|
} else {
|
|
$newUid = $this->copyRecord($table, $record['uid'], $destPid < 0 ? $tscPID : $destPid, $first, $overrideValues);
|
|
}
|
|
$languageSourceMap[$record['uid']] = $newUid;
|
|
}
|
|
$this->copy_remapTranslationSourceField($table, $l10nRecords, $languageSourceMap);
|
|
}
|
|
|
|
/**
|
|
* Remap languageSource field to uids of newly created records
|
|
*
|
|
* @param array $l10nRecords array of localized records from the page we're copying from (source records)
|
|
* @param array $languageSourceMap array mapping source records uids to newly copied uids
|
|
*/
|
|
protected function copy_remapTranslationSourceField(string $table, array $l10nRecords, array $languageSourceMap): void
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table)) {
|
|
return;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!$schema->isLanguageAware()) {
|
|
return;
|
|
}
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
if (!$languageCapability->hasTranslationSourceField()) {
|
|
return;
|
|
}
|
|
$translationSourceFieldName = $languageCapability->getTranslationSourceField()->getName();
|
|
$translationParentFieldName = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
|
|
// We can avoid running these update queries by sorting the $l10nRecords by languageSource dependency (in copyL10nOverlayRecords)
|
|
// and first copy records depending on default record (and map the field).
|
|
foreach ($l10nRecords as $record) {
|
|
$oldSourceUid = $record[$translationSourceFieldName];
|
|
if ($oldSourceUid <= 0 && $record[$translationParentFieldName] > 0) {
|
|
//BC fix - in connected mode 'translationSource' field should not be 0
|
|
$oldSourceUid = $record[$translationParentFieldName];
|
|
}
|
|
if ($oldSourceUid > 0) {
|
|
if (empty($languageSourceMap[$oldSourceUid])) {
|
|
// we don't have mapping information available e.g when copyRecord returned null
|
|
continue;
|
|
}
|
|
$newFieldValue = $languageSourceMap[$oldSourceUid];
|
|
$updateFields = [
|
|
$translationSourceFieldName => $newFieldValue,
|
|
];
|
|
if (isset($languageSourceMap[$record['uid']])) {
|
|
$this->connectionPool->getConnectionForTable($table)
|
|
->update($table, $updateFields, ['uid' => (int)$languageSourceMap[$record['uid']]]);
|
|
if ($this->BE_USER->workspace > 0) {
|
|
$this->connectionPool->getConnectionForTable($table)
|
|
->update($table, $updateFields, ['t3ver_oid' => (int)$languageSourceMap[$record['uid']], 't3ver_wsid' => $this->BE_USER->workspace]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Move a single record.
|
|
*
|
|
* @param int $destination Position to move to. If >=0, then it points to a page uid on which to insert the
|
|
* record as the first element. If <0, then it points to an uid from its own table
|
|
* after which the record should be moved to.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function moveRecord(string $table, int $uid, int $destination): void
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table) || $uid <= 0) {
|
|
return;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
|
|
$sortByFieldName = null;
|
|
if ($schema->hasCapability(TcaSchemaCapability::SortByField)) {
|
|
$sortByFieldName = $schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName();
|
|
} elseif ($destination < 0) {
|
|
// Trying to move a record *after* another one of the same table. Stop early if the table is not sorting-aware.
|
|
$this->log($table, $uid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move record {table}:{uid} after another record, but the table does not support sorting', null, ['table' => $table, 'uid' => $uid]);
|
|
return;
|
|
}
|
|
$pagesLocalizationParentFieldName = $this->tcaSchemaFactory->get('pages')->getCapability(TcaSchemaCapability::Language)->getTranslationOriginPointerField()->getName();
|
|
$tableLanguageFieldName = null;
|
|
if ($schema->hasCapability(TcaSchemaCapability::Language)) {
|
|
$tableLanguageFieldName = $schema->getCapability(TcaSchemaCapability::Language)->getLanguageField()->getName();
|
|
}
|
|
|
|
// Gather record facts
|
|
$plainRecord = BackendUtility::getRecord($table, $uid, '*', '', false);
|
|
if ($plainRecord === null) {
|
|
return;
|
|
}
|
|
$isTableWorkspaceAware = $schema->isWorkspaceAware();
|
|
$isMovingInWorkspaces = false;
|
|
if ($this->BE_USER->workspace > 0) {
|
|
$isMovingInWorkspaces = true;
|
|
}
|
|
if (!$isTableWorkspaceAware && (int)($plainRecord['t3ver_wsid'] ?? 0) > 0) {
|
|
// Moving record in a not workspace aware table, and the record is a workspace record. Broken record. Skip.
|
|
$this->log($table, $uid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::SYSTEM_ERROR, 'Attempt to move workspace record {table}:{uid} in not workspace aware table', null, ['table' => $table, 'uid' => $uid], $plainRecord['pid']);
|
|
return;
|
|
}
|
|
if (!$isMovingInWorkspaces && (int)($plainRecord['t3ver_wsid'] ?? 0) > 0) {
|
|
// Trying to move a workspace record while user is in live. For now, we'll log and skip.
|
|
// @todo: This seems to be fully unhandled right now: If a live workspace record is moved, we should
|
|
// consider existing workspace overlays somehow. For instance, it would *probably* be good to move
|
|
// an existing workspace overlay to a different page, when the live record is moved. There are various
|
|
// edge cases we need to think about when doing this: What should happen if a live record is just resorted
|
|
// on the same page? What if a live record is moved that has a workspace-moved overlay already? And what
|
|
// if that move-overlay is a combination of "has first been changed, then turned into a move placeholder"?
|
|
$this->log($table, $uid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::SYSTEM_ERROR, 'Attempt to move workspace record {table}:{uid} and user is not in this workspace', null, ['table' => $table, 'uid' => $uid], $plainRecord['pid']);
|
|
return;
|
|
}
|
|
if ((int)($plainRecord['t3ver_wsid'] ?? 0) === 0 && (int)($plainRecord['t3ver_oid'] ?? 0) > 0) {
|
|
// Inconsistent combination: We have a live record with t3ver_oid not 0. Should not happen. This may be no
|
|
// hard problem and may be a result of some incomplete publish. We ignore it for now but log a warning.
|
|
// @todo: We may want to set such records to t3ver_oid=0 (and potentially t3ver_state=0) since they *are* live.
|
|
// This is more a task of a general "repair" strategy (ext:dbdoctor), but details like this *may* be
|
|
// involved at a central DH place when performing change operations to existing records?
|
|
$this->log($table, $uid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::WARNING, 'Moving live record {table}:{uid} while it has non zero t3ver_oid="{t3verOid}"', null, ['table' => $table, 'uid' => $uid, 't3verOid' => $plainRecord['t3ver_oid']], $plainRecord['pid']);
|
|
}
|
|
$liveRecord = null;
|
|
$workspaceRecord = null;
|
|
if ($isMovingInWorkspaces && !$isTableWorkspaceAware) {
|
|
// Moving a live record when user is in a workspace. Odd, but may happen. Permission checked below.
|
|
$liveRecord = $plainRecord;
|
|
} elseif ($isMovingInWorkspaces && (int)($plainRecord['t3ver_wsid'] === 0)) {
|
|
// We are in a workspace but got a move request for a live record uid. There may be an existing workspace overlay
|
|
// that should be moved instead. This is checked using BackendUtility::getWorkspaceVersionOfRecord(), which respects
|
|
// current user workspace. But it also returns a workspace row if the record is a "new placeholder" that has no live
|
|
// version. In this case, $liveRecord is kept null, but $workspaceRecord is set. Otherwise, both are set.
|
|
$potentialWorkspaceOverlay = BackendUtility::getWorkspaceVersionOfRecord($this->BE_USER->workspace, $table, $uid);
|
|
if ($potentialWorkspaceOverlay) {
|
|
$workspaceRecord = $potentialWorkspaceOverlay;
|
|
if (VersionState::tryFrom($potentialWorkspaceOverlay['t3ver_state']) !== VersionState::NEW_PLACEHOLDER) {
|
|
// A live record is requested to be moved, and we have an overlay record as well.
|
|
$liveRecord = $plainRecord;
|
|
}
|
|
} else {
|
|
// We are in workspace requesting to move a live record that has no overlay yet.
|
|
// This will create "move placeholder" records down below.
|
|
$liveRecord = $plainRecord;
|
|
}
|
|
// Do not work on $potentialWorkspaceOverlay anymore
|
|
unset($potentialWorkspaceOverlay);
|
|
} elseif ((int)($plainRecord['t3ver_wsid'] ?? 0) > 0) {
|
|
// Moving workspace overlay record
|
|
$workspaceRecord = $plainRecord;
|
|
if ((int)$workspaceRecord['t3ver_oid'] > 0) {
|
|
// The record is an overlay of a live record, the live record needs to exist. New workspace
|
|
// placeholder records have no live record and t3ver_oid=0, leaving $liveRecord unset.
|
|
$liveRecord = BackendUtility::getRecord($table, $workspaceRecord['t3ver_oid'], '*', '', false);
|
|
if (empty($liveRecord)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::SYSTEM_ERROR, 'Attempt to move workspace overlay record {table}:{uid}, but live record {table}:{liveUid} not found', null, ['table' => $table, 'uid' => $uid, 'liveUid' => $workspaceRecord['t3ver_oid']], $workspaceRecord['pid']);
|
|
return;
|
|
}
|
|
}
|
|
} else {
|
|
// Moving a live record in live workspaces. There is no overlay.
|
|
$liveRecord = $plainRecord;
|
|
}
|
|
// Do not work on these variables anymore
|
|
unset($plainRecord);
|
|
if ($liveRecord === null && $workspaceRecord === null) {
|
|
// If both are still null, some sanity and determination checks above are broken
|
|
throw new \RuntimeException('Could not determine live nor workspace record when moving', 1739389473);
|
|
}
|
|
|
|
// At this point we have:
|
|
// * $liveRecord set and $workspaceRecord is null: We're moving a live record.
|
|
// * $liveRecord null and $workspaceRecord is set: We're moving a "new placeholder", turning it into
|
|
// a "move placeholder" if all goes well. The table is workspace aware.
|
|
// * $liveRecord set and $workspaceRecord set: We're moving an existing workspace overlay. The table
|
|
// is workspace aware.
|
|
|
|
// Moving a workspace aware record in workspaces
|
|
if ($isMovingInWorkspaces && $workspaceRecord === null && $isTableWorkspaceAware) {
|
|
// Create version of record first, if it does not exist
|
|
// @todo: This strategy is odd. A "dummy" record is created in correct workspace, but it is a
|
|
// DEFAULT_STATE one, not a MOVE_POINTER. This is then later updated to a move placeholder.
|
|
// This is complex and risky, we can for instance end up with a dangling record when a
|
|
// permission check fails down below. Next issue is that versionizeRecord() does
|
|
// a lot of stuff that we checked above already, but we can't change versionizeRecord()
|
|
// much since it is also used as entry method in process_cmdmap().
|
|
// In the end, we should refactor this to fully prepare the workspace record and insert it once.
|
|
$sourceUid = $this->versionizeRecord($table, $liveRecord['uid'], 'MovePointer');
|
|
if (!$sourceUid) {
|
|
// If versionizeRecord() could not create, it usually logs.
|
|
return;
|
|
}
|
|
$workspaceRecord = BackendUtility::getRecord($table, $sourceUid);
|
|
if ($workspaceRecord === null) {
|
|
throw new \RuntimeException('Table ' . $table . ' is workspace aware, but could not create workspace overlay', 1740217183);
|
|
}
|
|
}
|
|
|
|
$sourceUid = (int)($workspaceRecord['uid'] ?? $liveRecord['uid']);
|
|
$sourcePid = (int)($workspaceRecord['pid'] ?? $liveRecord['pid']);
|
|
$sourcePageRecord = $table === 'pages'
|
|
? (BackendUtility::getRecord('pages', $sourceUid) ?? [])
|
|
: (BackendUtility::getRecord('pages', $sourcePid) ?? []);
|
|
|
|
$updateFields = [];
|
|
$oldData = [
|
|
'pid' => $workspaceRecord['pid'] ?? $liveRecord['pid'],
|
|
];
|
|
if ($schema->hasCapability(TcaSchemaCapability::UpdatedAt)) {
|
|
$updatedAtFieldName = $schema->getCapability(TcaSchemaCapability::UpdatedAt)->getFieldName();
|
|
$updateFields[$updatedAtFieldName] = $GLOBALS['EXEC_TIME'];
|
|
$oldData[$updatedAtFieldName] = $workspaceRecord[$updatedAtFieldName] ?? $liveRecord[$updatedAtFieldName];
|
|
}
|
|
if ($sortByFieldName) {
|
|
$oldData[$sortByFieldName] = $workspaceRecord[$sortByFieldName] ?? $liveRecord[$sortByFieldName];
|
|
}
|
|
if ($table === 'pages' && (int)($workspaceRecord[$pagesLocalizationParentFieldName] ?? $liveRecord[$pagesLocalizationParentFieldName]) > 0) {
|
|
// If this is a translation of a page sorting and pid is kept in sync with default language record.
|
|
// Also in workspaces, the default language page may have been moved to a different pid than the
|
|
// default language page record of live workspace. In this case, localized pages need to be
|
|
// moved to the pid of the workspace move record, which is why we use getRecord() and workspaceOL() here.
|
|
$defaultLanguagePageRecord = BackendUtility::getRecord('pages', (int)($workspaceRecord[$pagesLocalizationParentFieldName] ?? $liveRecord[$pagesLocalizationParentFieldName]));
|
|
BackendUtility::workspaceOL('pages', $defaultLanguagePageRecord, $this->BE_USER->workspace);
|
|
|
|
if (is_array($defaultLanguagePageRecord)) {
|
|
$updateFields[$sortByFieldName] = $defaultLanguagePageRecord[$sortByFieldName];
|
|
$updateFields['pid'] = $defaultLanguagePageRecord['pid'];
|
|
}
|
|
} elseif ($sortByFieldName) {
|
|
// Calculate new "sort number" depending on weather the record is inserted as first record, or below another one.
|
|
$sortNumber = $this->getSortNumber($table, $sourceUid, $destination);
|
|
if ($sortNumber === false) {
|
|
// Unable to calculate sort number, logged in getSortNumber() already.
|
|
return;
|
|
}
|
|
if ($destination >= 0) {
|
|
$updateFields[$sortByFieldName] = $sortNumber;
|
|
$updateFields['pid'] = $destination;
|
|
} else {
|
|
$updateFields[$sortByFieldName] = $sortNumber['sortNumber'];
|
|
$updateFields['pid'] = $sortNumber['pid'];
|
|
}
|
|
} else {
|
|
$updateFields['pid'] = $destination;
|
|
}
|
|
|
|
$isMovingToDifferentPid = false;
|
|
$targetPageRecord = $sourcePageRecord;
|
|
if ($updateFields['pid'] !== $sourcePid) {
|
|
$isMovingToDifferentPid = true;
|
|
$targetPageRecord = BackendUtility::getRecord('pages', $updateFields['pid']) ?? [];
|
|
}
|
|
|
|
if ($table === 'pages') {
|
|
if ($isMovingToDifferentPid) {
|
|
if (!$this->destNotInsideSelf($updateFields['pid'], $sourceUid)) {
|
|
// When page is moved to a different pid, it must not be a child of itself
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move pages:{uid} to inside of its own rootline', null, ['uid' => $sourceUid]);
|
|
return;
|
|
}
|
|
if (!$this->hasPageContextPermission($table, Permission::PAGE_DELETE, $sourcePageRecord)) {
|
|
// When page is moved to a different parent page, delete permissions are needed for the source page
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move page {table}:{uid} without having permissions to do so', null, ['table' => $table, 'uid' => $sourceUid], $sourcePid);
|
|
return;
|
|
}
|
|
if (!$this->hasPermissionToInsert($table, $updateFields['pid'], $targetPageRecord)) {
|
|
// When page moved to different target, insert permissions are needed
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move record {table}:{uid} to pid "{targetPid}" without having permissions to insert', null, ['table' => $table, 'uid' => $sourceUid, 'targetPid' => $updateFields['pid']], $updateFields['pid']);
|
|
return;
|
|
}
|
|
} else {
|
|
if (!$this->hasPermissionToUpdate($table, $sourcePageRecord)) {
|
|
// When page is moved within same parent page, page edit records are needed
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move record {table}:{uid} without having permissions to update', null, ['table' => $table, 'uid' => $sourceUid], $sourcePid);
|
|
return;
|
|
}
|
|
}
|
|
} else {
|
|
if ($isMovingToDifferentPid) {
|
|
if (!$this->hasPermissionToUpdate($table, $sourcePageRecord)) {
|
|
// When record is moved to different target, update permissions on source page are needed
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move record {table}:{uid} to pid "{targetPid}" without having permissions to update the source page (uid={sourcePid})', null, ['table' => $table, 'uid' => $sourceUid, 'targetPid' => $updateFields['pid'], 'sourcePid' => $sourcePid], $sourcePid);
|
|
return;
|
|
}
|
|
if (!$this->hasPermissionToInsert($table, $updateFields['pid'], $targetPageRecord)) {
|
|
// When record is moved to different page, insert permissions on target are needed
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move record {table}:{uid} to pid "{targetPid}" without having permissions to insert', null, ['table' => $table, 'uid' => $sourceUid, 'targetPid' => $updateFields['pid']], $updateFields['pid']);
|
|
return;
|
|
}
|
|
} else {
|
|
if (!$this->hasPermissionToUpdate($table, $sourcePageRecord)) {
|
|
// When record is moved within same page, edit records are needed
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move record {table}:{uid} without having permissions to update', null, ['table' => $table, 'uid' => $sourceUid], $sourcePid);
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
$accessResult = $this->BE_USER->checkRecordEditAccess($table, $liveRecord ?? $workspaceRecord, false, $table !== 'pages');
|
|
if (!$accessResult->isAllowed) {
|
|
// Check if anything else disallows the move operation
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move record {table}:{uid} without having permissions to do so [{reason}]', null, ['table' => $table, 'uid' => $sourceUid, 'reason' => $accessResult->errorMessage], $sourcePid);
|
|
return;
|
|
}
|
|
|
|
if ($isMovingInWorkspaces && !$isTableWorkspaceAware && !$this->BE_USER->workspaceAllowsLiveEditingInTable($table)) {
|
|
// Moving a not workspace aware record while in workspaces, but user, table TCA or sys_workspace record do not allow live editing this table.
|
|
// Can happen when moving a workspace aware parent record with children not being workspace aware.
|
|
// @todo: See DataScenarios/IrreForeignFieldNonWs/WorkspacesModify/ActionTest.php for a rough overview on what is broken in this case.
|
|
// @todo: This means the parent record *is* moved (gets a move placeholder), while children are not.
|
|
// This is fine when only resorting parent on the same page. Its problematic when parent is moved
|
|
// to a different page since the child stays on the old page. It is also unclear what happens when
|
|
// the parent is later published (should children *then* be moved to recreate integrity?). At
|
|
// the moment, the workspace BE module crashes when doing this.
|
|
// @todo: If allowed, moving the live record ist still probably not a good idea since this may break live when
|
|
// inline children are moved to a different page while the live parent record is on the "old" page.
|
|
// It is not an issue with inline children when parent is only resorted on the same page.
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move {table}:{uid} in workspace but the table is not workspace aware and live editing is denied', null, ['table' => $table, 'uid' => (int)$liveRecord['uid']]);
|
|
return;
|
|
}
|
|
|
|
$recordWasMoved = false;
|
|
$moveRec = [
|
|
'header' => 'DATAHANDLER DUMMY',
|
|
'pid' => (int)($liveRecord['pid'] ?? $workspaceRecord['pid']),
|
|
'event_pid' => $table === 'pages'
|
|
? (int)(($liveRecord['t3ver_oid'] ?? null) ?: ($liveRecord['uid'] ?? $workspaceRecord['uid']))
|
|
: (int)($liveRecord['pid'] ?? $workspaceRecord['pid']),
|
|
't3ver_state' => ($liveRecord['t3ver_state'] ?? $workspaceRecord['t3ver_state'] ?? 0),
|
|
];
|
|
if (!empty($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['moveRecordClass'] ?? [])) {
|
|
// Extensive hook argument handling for b/w compatibility
|
|
$propArr = [
|
|
'header' => 'DATAHANDLER DUMMY',
|
|
'pid' => $sourcePid,
|
|
'event_pid' => $table === 'pages'
|
|
? ((int)($workspaceRecord['t3ver_oid'] ?? null) ?: $liveRecord['uid'] ?? $workspaceRecord['uid'])
|
|
: $sourcePid,
|
|
't3ver_state' => $workspaceRecord['t3ver_state'] ?? $liveRecord['t3ver_state'] ?? 0,
|
|
];
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['moveRecordClass'] ?? [] as $className) {
|
|
$hook = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hook, 'moveRecord')) {
|
|
$hook->moveRecord($table, $liveRecord['uid'] ?? $workspaceRecord['uid'], $destination, $propArr, $moveRec, $updateFields['pid'], $recordWasMoved, $this);
|
|
/** @var bool $recordWasMoved */
|
|
}
|
|
}
|
|
}
|
|
if ($recordWasMoved) {// @phpstan-ignore if.alwaysFalse (hook result is not taken into account)
|
|
// Return if a hook handled move
|
|
return;
|
|
}
|
|
|
|
if ($table !== 'pages' && $isMovingToDifferentPid) {
|
|
// When moving a record to a different pid, attached children have to be moved as well.
|
|
$recordForFieldConfig = $workspaceRecord ?? $liveRecord;
|
|
foreach ($recordForFieldConfig as $field => $value) {
|
|
$fieldConfig = $this->resolveFieldConfigurationAndRespectColumnsOverrides($table, $field, $recordForFieldConfig);
|
|
if (!($fieldConfig['behaviour']['disableMovingChildrenWithParent'] ?? false)
|
|
&& in_array($this->getRelationFieldType($fieldConfig), ['list', 'field'], true)
|
|
) {
|
|
// Move non-MM inline children
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($value, $fieldConfig['foreign_table'], '', $sourceUid, $table, $fieldConfig);
|
|
// Moving records to a positive destination will insert each record at the beginning, thus the order is reversed here
|
|
foreach (array_reverse($dbAnalysis->itemArray) as $item) {
|
|
$this->moveRecord($item['table'], (int)$item['id'], $table === 'pages' ? $sourceUid : $updateFields['pid']);
|
|
}
|
|
continue;
|
|
}
|
|
if (($fieldConfig['type'] ?? '') === 'flex' && !empty($value)) {
|
|
// Children attached to flex inline fields have to be moved to new pid along with their parent record
|
|
try {
|
|
$fieldConfig['config'] = $fieldConfig;
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$dataStructureIdentifier = $this->flexFormTools->getDataStructureIdentifier($fieldConfig, $table, $field, $workspaceRecord ?? $liveRecord, $schema);
|
|
$dataStructure = $this->flexFormTools->parseDataStructureByIdentifier($dataStructureIdentifier, $schema);
|
|
$flexFormValueParsed = GeneralUtility::xml2array($value);
|
|
} catch (AbstractInvalidDataStructureException) {
|
|
// Nothing to do if data structure could not be determined
|
|
continue;
|
|
}
|
|
foreach ($dataStructure['sheets'] as $sheetName => $sheet) {
|
|
foreach (($sheet['ROOT']['el'] ?? []) as $sheetFieldName => $sheetFieldConfig) {
|
|
if (!($sheetFieldConfig['config']['behaviour']['disableMovingChildrenWithParent'] ?? false)
|
|
&& in_array($this->getRelationFieldType($sheetFieldConfig['config']), ['list', 'field'], true)
|
|
) {
|
|
// Move existing non-MM inline flex children
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($flexFormValueParsed['data'][$sheetName]['lDEF'][$sheetFieldName]['vDEF'] ?? '', $sheetFieldConfig['config']['foreign_table'], '', $sourceUid, $table, $sheetFieldConfig['config']);
|
|
foreach (array_reverse($dbAnalysis->itemArray) as $item) {
|
|
$this->moveRecord($item['table'], (int)$item['id'], $table === 'pages' ? $sourceUid : $updateFields['pid']);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->registerRecordIdForPageCacheClearing($table, $sourceUid, $table === 'pages' ? $workspaceRecord['uid'] ?? $liveRecord['uid'] : $workspaceRecord['pid'] ?? $liveRecord['pid']);
|
|
$this->connectionPool->getConnectionForTable($table)->update($table, $updateFields, ['uid' => $sourceUid]);
|
|
if ($tableLanguageFieldName && (int)($workspaceRecord[$tableLanguageFieldName] ?? $liveRecord[$tableLanguageFieldName]) === 0) {
|
|
$this->moveL10nOverlayRecords($table, $sourceUid, $updateFields['pid'], $destination);
|
|
}
|
|
if ($destination >= 0) {
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['moveRecordClass'] ?? [] as $className) {
|
|
$hook = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hook, 'moveRecord_firstElementPostProcess')) {
|
|
$hook->moveRecord_firstElementPostProcess($table, $sourceUid, $destination, $moveRec, $updateFields, $this);
|
|
}
|
|
}
|
|
} else {
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['moveRecordClass'] ?? [] as $className) {
|
|
$hook = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hook, 'moveRecord_afterAnotherElementPostProcess')) {
|
|
$hook->moveRecord_afterAnotherElementPostProcess($table, $sourceUid, $updateFields['pid'], $destination, $moveRec, $updateFields, $this);
|
|
}
|
|
}
|
|
}
|
|
$this->getRecordHistoryStore()->moveRecord($table, $sourceUid, ['oldData' => $oldData, 'newData' => $updateFields], $this->correlationId);
|
|
if ($isMovingToDifferentPid) {
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::MESSAGE, 'Moved record {table}:{uid} to page {pid}', null, ['table' => $table, 'uid' => $sourceUid, 'pid' => $updateFields['pid']], $workspaceRecord['pid'] ?? $liveRecord['pid']);
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::MESSAGE, 'Moved record {table}:{uid} from page {pid}', null, ['table' => $table, 'uid' => $sourceUid, 'pid' => $workspaceRecord['pid'] ?? $liveRecord['pid']], $updateFields['pid']);
|
|
} else {
|
|
$this->log($table, $sourceUid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::MESSAGE, 'Moved record {table}:{uid} on page {pid}', null, ['table' => $table, 'uid' => $sourceUid, 'pid' => $updateFields['pid']], $updateFields['pid']);
|
|
}
|
|
$this->fixUniqueInPid($table, $workspaceRecord ?? $liveRecord);
|
|
$this->fixUniqueInSite($table, $workspaceRecord ?? $liveRecord);
|
|
if ($table === 'pages') {
|
|
$this->fixUniqueInSiteForSubpages($sourceUid);
|
|
}
|
|
|
|
if ($isMovingInWorkspaces && $isTableWorkspaceAware && VersionState::tryFrom((int)($workspaceRecord['t3ver_state'])) !== VersionState::NEW_PLACEHOLDER) {
|
|
// Late changes after moveRecord_raw() moved stuff in workspaces.
|
|
// This is a "changed", "deleted" or "already moved" record.
|
|
if (VersionState::tryFrom($workspaceRecord['t3ver_state']) !== VersionState::DELETE_PLACEHOLDER) {
|
|
// Update the state of this record to a move placeholder. This is allowed if the
|
|
// record is a 'changed' (t3ver_state=0) record: Changing a record and moving it
|
|
// around later, should switch it from 'changed' to 'moved'. Deleted placeholders
|
|
// however are an 'end-state', they should not be switched to a move placeholder.
|
|
// Scenario: For a live page that has a localization, the localization is first
|
|
// marked as to-delete in workspace, creating a delete placeholder for that
|
|
// localization. Later, the page is moved around, moving the localization along
|
|
// with the default language record. The localization should then NOT be switched
|
|
// from 'to-delete' to 'moved', this would lose the 'to-delete' information.
|
|
$this->connectionPool->getConnectionForTable($table)->update(
|
|
$table,
|
|
['t3ver_state' => VersionState::MOVE_POINTER->value],
|
|
['uid' => $sourceUid]
|
|
);
|
|
}
|
|
// Check for the localizations of that element and move them as well
|
|
// @todo: Why is this not done with "new"? Fishy. Called at different place or no test coverage?
|
|
$this->moveL10nOverlayRecords($table, $liveRecord['uid'] ?? $workspaceRecord['uid'], $destination, $destination);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find l10n-overlay records and perform the requested move action for these records.
|
|
*
|
|
* @param string $table Record Table
|
|
* @param int $uid Record UID
|
|
* @param int $destPid Position to move to
|
|
* @param int $originalRecordDestinationPid Position to move the original record to
|
|
*/
|
|
protected function moveL10nOverlayRecords(string $table, $uid, int $destPid, $originalRecordDestinationPid): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
// There's no need to perform this for non-localizable tables
|
|
if (!$schema->isLanguageAware()) {
|
|
return;
|
|
}
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$languageField = $languageCapability->getLanguageField()->getName();
|
|
$transOrigPointerFieldName = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()
|
|
->add(GeneralUtility::makeInstance(DeletedRestriction::class))
|
|
->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->BE_USER->workspace));
|
|
|
|
$l10nRecords = $queryBuilder->select('uid', $languageField)
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq($transOrigPointerFieldName, $queryBuilder->createNamedParameter($uid, Connection::PARAM_INT, ':pointer'))
|
|
)
|
|
->executeQuery()
|
|
->fetchAllAssociative();
|
|
|
|
$localizedDestPids = [];
|
|
if ($originalRecordDestinationPid < 0) {
|
|
// If $originalRecordDestinationPid < 0, then it is the uid of the original language record we are inserting after
|
|
// Get the localized records of the record we are inserting after
|
|
$queryBuilder->setParameter('pointer', abs($originalRecordDestinationPid), Connection::PARAM_INT);
|
|
$destL10nRecords = $queryBuilder->executeQuery()->fetchAllAssociative();
|
|
// Index the localized record uids by language
|
|
foreach ($destL10nRecords as $record) {
|
|
$localizedDestPids[$record[$languageField]] = -$record['uid'];
|
|
}
|
|
}
|
|
|
|
// Move the localized records after the corresponding localizations of the destination record
|
|
foreach ($l10nRecords as $record) {
|
|
$localizedDestPid = (int)($localizedDestPids[$record[$languageField]] ?? 0);
|
|
if ($localizedDestPid < 0) {
|
|
$this->moveRecord($table, (int)$record['uid'], $localizedDestPid);
|
|
} else {
|
|
$this->moveRecord($table, (int)$record['uid'], $destPid);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Localizes a record to another system language
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $uid Record uid (to be localized)
|
|
* @param int $language Language ID
|
|
* @return int|false The uid (int) of the new translated record or FALSE (bool) if something went wrong
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function localize(string $table, int $uid, int $language): int|false
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table) || !$uid || $this->isNestedElementCallRegistered($table, $uid, 'localize-' . $language) !== false) {
|
|
return false;
|
|
}
|
|
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$this->registerNestedElementCall($table, $uid, 'localize-' . $language);
|
|
if (!$schema->isLanguageAware()) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::LOCALIZE, null, SystemLogErrorClassification::USER_ERROR, 'Localization failed; "languageField" and "transOrigPointerField" must be defined for the table {table}', null, ['table' => $table]);
|
|
return false;
|
|
}
|
|
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$languageFieldName = $languageCapability->getLanguageField()->getName();
|
|
$translationOriginPointerFieldName = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
|
|
// Getting workspace overlay if possible - this will localize versions in workspace if any
|
|
$row = BackendUtility::getRecord($table, $uid);
|
|
BackendUtility::workspaceOL($table, $row, $this->BE_USER->workspace);
|
|
if (!is_array($row)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::LOCALIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to localize record {table}:{uid} that did not exist', null, ['table' => $table, 'uid' => (int)$uid]);
|
|
return false;
|
|
}
|
|
if ($table === 'pages') {
|
|
$pageRecord = $row;
|
|
} elseif ((int)$row['pid'] > 0) {
|
|
$pageRecord = BackendUtility::getRecord('pages', $row['pid']);
|
|
if (!is_array($pageRecord)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::LOCALIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to localize record "{table}:{uid}" which is not assigned to a valid page', null, ['table' => $table, 'uid' => (int)$uid]);
|
|
return false;
|
|
}
|
|
} else {
|
|
$pageRecord = VirtualRecord::RootPage;
|
|
}
|
|
if (!$this->hasPageContextPermission($table, Permission::PAGE_SHOW, $pageRecord)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::LOCALIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to localize record {table}:{uid} without permission', null, ['table' => $table, 'uid' => (int)$uid]);
|
|
return false;
|
|
}
|
|
|
|
$pageId = (int)BackendUtility::getRealPageId($table, $uid);
|
|
// Try to fetch the site language from the pages' associated site
|
|
$siteLanguage = $this->getSiteLanguageForPage($pageId, $language);
|
|
if ($siteLanguage === null) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::LOCALIZE, null, SystemLogErrorClassification::USER_ERROR, 'Language ID "{languageId}" not found for page {pageId}', null, ['languageId' => (int)$language, 'pageId' => $pageId]);
|
|
return false;
|
|
}
|
|
|
|
// Make sure that records which are translated from another language than the default language have a correct
|
|
// localization source set themselves, before translating them to another language.
|
|
if ((int)$row[$translationOriginPointerFieldName] !== 0 && $row[$languageFieldName] > 0) {
|
|
$localizationParentRecord = BackendUtility::getRecord($table, $row[$translationOriginPointerFieldName]);
|
|
if ((int)$localizationParentRecord[$languageFieldName] !== 0) {
|
|
$this->log($table, $localizationParentRecord['uid'], SystemLogDatabaseAction::LOCALIZE, null, SystemLogErrorClassification::USER_ERROR, 'Localization failed: Source record {table}:{originalRecordId} contained a reference to an original record that is not a default record (which is strange)', null, ['table' => $table, 'originalRecordId' => $localizationParentRecord['uid']]);
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Default language records must never have a localization parent as they are the origin of any translation.
|
|
if ((int)$row[$translationOriginPointerFieldName] !== 0 && (int)$row[$languageFieldName] === 0) {
|
|
$this->log($table, $row['uid'], SystemLogDatabaseAction::LOCALIZE, null, SystemLogErrorClassification::USER_ERROR, 'Localization failed: Source record {table}:{uid} contained a reference to an original default record but is a default record itself (which is strange)', null, ['table' => $table, 'uid' => (int)$row['uid']]);
|
|
return false;
|
|
}
|
|
|
|
$recordLocalization = $this->localizationRepository->getRecordTranslation($table, $row, $language, $this->BE_USER->workspace);
|
|
if ($recordLocalization) {
|
|
$this->log(
|
|
$table,
|
|
$uid,
|
|
SystemLogDatabaseAction::LOCALIZE,
|
|
null,
|
|
SystemLogErrorClassification::USER_ERROR,
|
|
'Localization failed: The record {uid} of type "{table}" has already been localized in language {language} (Localized UID: {localizedUid})',
|
|
null,
|
|
[
|
|
'localizedUid' => $recordLocalization->getUid(),
|
|
'language' => $language,
|
|
'table' => $table,
|
|
'uid' => $uid,
|
|
]
|
|
);
|
|
return false;
|
|
}
|
|
|
|
// Initialize:
|
|
$overrideValues = [
|
|
$languageFieldName => $language,
|
|
];
|
|
// Set override values:
|
|
// If the translated record is a default language record, set it's uid as localization parent of the new record.
|
|
// If translating from any other language, no override is needed; we just can copy the localization parent of
|
|
// the original record (which is pointing to the correspondent default language record) to the new record.
|
|
// In copy / free mode the TransOrigPointer field is always set to 0, as no connection to the localization parent is wanted in that case.
|
|
// For pages, there is no "copy/free mode".
|
|
if (($this->useTransOrigPointerField || $table === 'pages') && (int)$row[$languageFieldName] === 0) {
|
|
$overrideValues[$translationOriginPointerFieldName] = $uid;
|
|
} elseif (!$this->useTransOrigPointerField) {
|
|
$overrideValues[$translationOriginPointerFieldName] = 0;
|
|
}
|
|
if ($languageCapability->hasTranslationSourceField()) {
|
|
$overrideValues[$languageCapability->getTranslationSourceField()->getName()] = $uid;
|
|
}
|
|
// Copy the value of the type from the original record so that translation has same type as original record
|
|
if ($schema->supportsSubSchema()) {
|
|
// @todo: We always copy the local field name, even on foreign table types, such as "uid_local:type"
|
|
$subSchemaDivisorFieldName = $schema->getSubSchemaTypeInformation()->getFieldName();
|
|
$overrideValues[$subSchemaDivisorFieldName] = $row[$subSchemaDivisorFieldName] ?? null;
|
|
}
|
|
|
|
// Set exclude Fields:
|
|
foreach ($this->getTypeSpecificFields($table, $row) as $field) {
|
|
$translateToMsg = '';
|
|
// Check if we are just prefixing:
|
|
if ($field->getTranslationBehaviour() === FieldTranslationBehaviour::PrefixLanguageTitle
|
|
&& $field->isType(TableColumnType::TEXT, TableColumnType::INPUT, TableColumnType::EMAIL, TableColumnType::LINK)
|
|
&& (string)$row[$field->getName()] !== ''
|
|
) {
|
|
$TSConfig = BackendUtility::getPagesTSconfig($pageId)['TCEMAIN.'] ?? [];
|
|
$tableEntries = $this->getTableEntries($table, $TSConfig);
|
|
if (!empty($TSConfig['translateToMessage']) && !($tableEntries['disablePrependAtCopy'] ?? false)) {
|
|
$translateToMsg = $this->getLanguageService()->sL($TSConfig['translateToMessage']);
|
|
$translateToMsg = @sprintf($translateToMsg, $siteLanguage->getTitle());
|
|
}
|
|
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processTranslateToClass'] ?? [] as $className) {
|
|
$hookObj = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hookObj, 'processTranslateTo_copyAction')) {
|
|
// @todo Deprecate passing an array and pass the full SiteLanguage object instead
|
|
$hookObj->processTranslateTo_copyAction(
|
|
$row[$field->getName()],
|
|
['uid' => $siteLanguage->getLanguageId(), 'title' => $siteLanguage->getTitle()],
|
|
$this,
|
|
$field->getName()
|
|
);
|
|
}
|
|
}
|
|
if (!empty($translateToMsg)) {
|
|
$translateToMessage = '[' . $translateToMsg . '] ';
|
|
$fieldContent = $row[$field->getName()];
|
|
if ($field->isType(TableColumnType::TEXT) && str_starts_with($fieldContent, '<')) {
|
|
// If the field is a text field, we need to prepend the translation message to the content
|
|
// that means, it should be after the first opening HTML tag, if one exists.
|
|
// @todo: Ideally we can use TcaSchema and Subschema in the future, to resolve this issue properly
|
|
$overrideValues[$field->getName()] = preg_replace('/(<[^>]+>)/', '$1' . $translateToMessage, $fieldContent, 1);
|
|
} else {
|
|
$overrideValues[$field->getName()] = $translateToMessage . $fieldContent;
|
|
}
|
|
} else {
|
|
$overrideValues[$field->getName()] = $row[$field->getName()];
|
|
}
|
|
}
|
|
if (($field->getConfiguration()['MM'] ?? false)
|
|
// To determine the local side for fields with 'MM' config, we check if the field either
|
|
// has "MM_oppositeUsage" (foreign table names / field names) defined — e.g., sys_category with
|
|
// opposite usage to the table "pages" with the field "categories" — or if it does not have
|
|
// "MM_opposite_field" set. This field is set by the foreign side (e.g., an inline child)
|
|
// to allow editing the connection from both sides (bidirectional).
|
|
&& (!empty($field->getConfiguration()['MM_oppositeUsage']) || !isset($field->getConfiguration()['MM_opposite_field']))
|
|
) {
|
|
// We are localizing the 'local' side of an MM relation. (eg. localizing a category).
|
|
// In this case, MM relations connected to the default lang record should not be copied,
|
|
// so we set an override here to not trigger mm handling of 'items' field for this.
|
|
$overrideValues[$field->getName()] = 0;
|
|
}
|
|
}
|
|
|
|
if ($table === 'pages') {
|
|
$newId = $this->localizePage($uid, $row, $language, $overrideValues);
|
|
} else {
|
|
$newId = $this->localizeRecord($table, $uid, $row, $language, $overrideValues);
|
|
}
|
|
|
|
return $newId ?? false;
|
|
}
|
|
|
|
/**
|
|
* Creates a localized version of a record for the given target language.
|
|
*
|
|
* This method is called from localize() for non-page records. Unlike copyRecord(),
|
|
* it does not apply "copy-after" fields, "prepend label at copy", or copy l10n overlays.
|
|
* The $row is pre-fetched and workspace-overlaid by localize().
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $uid Record uid (source record to localize)
|
|
* @param array $row Pre-fetched and workspace-overlaid record
|
|
* @param int $language Target language ID (always > 0)
|
|
* @param array $overrideValues Override values prepared by localize() (language field, translation pointers, etc.)
|
|
* @return int|null UID of the new localized record, or null on failure
|
|
*/
|
|
protected function localizeRecord(string $table, int $uid, array $row, int $language, array $overrideValues): ?int
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
|
|
$row = BackendUtility::purgeComputedPropertiesFromRecord($row);
|
|
if ($schema->hasCapability(TcaSchemaCapability::Workspace)
|
|
&& $this->BE_USER->workspace > 0
|
|
&& VersionState::tryFrom($row['t3ver_state'] ?? 0) === VersionState::DELETE_PLACEHOLDER
|
|
) {
|
|
return null;
|
|
}
|
|
|
|
// Compute sorting: place after the previous localized record
|
|
$previousUid = $this->getPreviousLocalizedRecordUid($table, $uid, $row['pid'], $language);
|
|
$destPid = -$previousUid;
|
|
|
|
$tscPID = (int)BackendUtility::getTSconfig_pidValue($table, $uid, $destPid);
|
|
$TSConfig = BackendUtility::getPagesTSconfig($tscPID)['TCEMAIN.'] ?? [];
|
|
$tE = $this->getTableEntries($table, $TSConfig);
|
|
|
|
$theNewID = StringUtility::getUniqueId('NEW');
|
|
$disabledField = $schema->hasCapability(TcaSchemaCapability::RestrictionDisabledField)
|
|
? $schema->getCapability(TcaSchemaCapability::RestrictionDisabledField)->getField()
|
|
: null;
|
|
|
|
$row = $this->removeNonCopyableFields($table, $row, 'localizeRecord');
|
|
$data = [];
|
|
|
|
foreach ($row as $field => $value) {
|
|
if ($field === 'pid') {
|
|
$value = $destPid;
|
|
} elseif (array_key_exists($field, $overrideValues)) {
|
|
$value = $overrideValues[$field];
|
|
} else {
|
|
// Hide at copy may override — only apply if source record was visible
|
|
if ($field === $disabledField?->getName()
|
|
&& !$value
|
|
&& $schema->hasCapability(TcaSchemaCapability::HideRecordsAtCopy)
|
|
&& !($this->BE_USER->uc['neverHideAtCopy'] ?? false)
|
|
&& !($tE['disableHideAtCopy'] ?? false)
|
|
) {
|
|
$value = 1;
|
|
}
|
|
$conf = $this->resolveFieldConfigurationAndRespectColumnsOverrides($table, $field, $row);
|
|
$value = $this->copyRecord_procBasedOnFieldType($table, $uid, $field, $value, $row, $conf, $tscPID, $language);
|
|
}
|
|
$data[$table][$theNewID][$field] = $value;
|
|
}
|
|
|
|
if ($schema->hasCapability(TcaSchemaCapability::EditLock)) {
|
|
$data[$table][$theNewID][$schema->getCapability(TcaSchemaCapability::EditLock)->getFieldName()] = 0;
|
|
}
|
|
if ($schema->hasCapability(TcaSchemaCapability::AncestorReferenceField)) {
|
|
$data[$table][$theNewID][$schema->getCapability(TcaSchemaCapability::AncestorReferenceField)->getFieldName()] = $uid;
|
|
}
|
|
|
|
$copyTCE = $this->getLocalTCE();
|
|
$copyTCE->start($data, [], $this->BE_USER, $this->referenceIndexUpdater, $this->correlationId);
|
|
$copyTCE->process_datamap();
|
|
$theNewSQLID = $copyTCE->substNEWwithIDs[$theNewID] ?? null;
|
|
if ($theNewSQLID) {
|
|
$this->copyMappingArray[$table][$uid] = $theNewSQLID;
|
|
if (isset($copyTCE->autoVersionIdMap[$table][$theNewSQLID])) {
|
|
$this->autoVersionIdMap[$table][$theNewSQLID] = $copyTCE->autoVersionIdMap[$table][$theNewSQLID];
|
|
}
|
|
}
|
|
$this->errorLog = array_merge($this->errorLog, $copyTCE->errorLog);
|
|
|
|
return $theNewSQLID;
|
|
}
|
|
|
|
/**
|
|
* Creates a localized version of a record for the given target language.
|
|
* *
|
|
* @param int $uid Record uid (source record to localize)
|
|
* @param array $row Pre-fetched and workspace-overlaid record
|
|
* @param int $language Target language ID (always > 0)
|
|
* @param array $overrideValues Override values prepared by localize() (language field, translation pointers, etc.)
|
|
*/
|
|
protected function localizePage(int $uid, array $row, int $language, array $overrideValues): ?int
|
|
{
|
|
$table = 'pages';
|
|
$schema = $this->tcaSchemaFactory->get('pages');
|
|
// Create new page which needs to contain the same pid as the original page
|
|
$overrideValues['pid'] = $row['pid'];
|
|
// Take over the hidden state of the original language state, this is done due to legacy reasons where-as
|
|
// pages_language_overlay was set to "hidden -> default=0" but pages hidden -> default 1"
|
|
if ($schema->hasCapability(TcaSchemaCapability::RestrictionDisabledField)) {
|
|
$hiddenField = $schema->getCapability(TcaSchemaCapability::RestrictionDisabledField)->getField();
|
|
$hiddenFieldName = $hiddenField->getName();
|
|
$overrideValues[$hiddenFieldName] = $row[$hiddenFieldName] ?? $hiddenField->getDefaultValue();
|
|
// Override by TCA "hideAtCopy" or pageTS "disableHideAtCopy"
|
|
// Only for visible pages to get the same behavior as for copy
|
|
if (!$overrideValues[$hiddenFieldName]) {
|
|
$TSConfig = BackendUtility::getPagesTSconfig($uid)['TCEMAIN.'] ?? [];
|
|
$tableEntries = $this->getTableEntries('pages', $TSConfig);
|
|
if (
|
|
$schema->hasCapability(TcaSchemaCapability::HideRecordsAtCopy)
|
|
&& !($this->BE_USER->uc['neverHideAtCopy'] ?? false)
|
|
&& !($tableEntries['disableHideAtCopy'] ?? false)
|
|
) {
|
|
$overrideValues[$hiddenFieldName] = 1;
|
|
}
|
|
}
|
|
}
|
|
$temporaryId = StringUtility::getUniqueId('NEW');
|
|
$copyTCE = $this->getLocalTCE();
|
|
$copyTCE->start([$table => [$temporaryId => $overrideValues]], [], $this->BE_USER, $this->referenceIndexUpdater, $this->correlationId);
|
|
$copyTCE->process_datamap();
|
|
// Getting the new UID as if it had been copied:
|
|
$theNewSQLID = $copyTCE->substNEWwithIDs[$temporaryId] ?? null;
|
|
if ($theNewSQLID) {
|
|
$this->copyMappingArray[$table][$uid] = $theNewSQLID;
|
|
if (isset($copyTCE->autoVersionIdMap[$table][$theNewSQLID])) {
|
|
$this->autoVersionIdMap[$table][$theNewSQLID] = $copyTCE->autoVersionIdMap[$table][$theNewSQLID];
|
|
}
|
|
}
|
|
$this->errorLog = array_merge($this->errorLog, $copyTCE->errorLog);
|
|
return $theNewSQLID;
|
|
}
|
|
|
|
/**
|
|
* Performs localization or synchronization of child records.
|
|
* The $command argument expects an array, but supports a string for backward-compatibility.
|
|
*
|
|
* $command = array(
|
|
* 'field' => 'tx_myfieldname',
|
|
* 'language' => 2,
|
|
* // either the key 'action' or 'ids' must be set
|
|
* 'action' => 'synchronize', // or 'localize'
|
|
* 'ids' => array(1, 2, 3, 4) // child element ids
|
|
* );
|
|
*
|
|
* @param string $table The table of the localized parent record
|
|
* @param int $id The uid of the localized parent record
|
|
* @param array $command Defines the command to be performed (see example above)
|
|
*/
|
|
protected function inlineLocalizeSynchronize($table, $id, array $command): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$field = $command['field'] ?? '';
|
|
$language = (int)($command['language'] ?? 0);
|
|
$action = $command['action'] ?? '';
|
|
$ids = $command['ids'] ?? [];
|
|
if (!$field || !($action === 'localize' || $action === 'synchronize') && empty($ids) || !$schema->hasField($field)) {
|
|
return;
|
|
}
|
|
if ($language <= 0) {
|
|
return;
|
|
}
|
|
|
|
$parentRecord = BackendUtility::getRecord($table, $id);
|
|
BackendUtility::workspaceOL($table, $parentRecord, $this->BE_USER->workspace);
|
|
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
|
|
// In case the parent record is the default language record, fetch the localization
|
|
if (empty($parentRecord[$languageCapability->getLanguageField()->getName()])) {
|
|
// We need the live UID inside $id but we still process overlay for the current selected workspace
|
|
$parentRecordLocalization = $this->localizationRepository->getRecordTranslation($table, $parentRecord, $language, $this->BE_USER->workspace);
|
|
if (!$parentRecordLocalization) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::LOCALIZE, null, SystemLogErrorClassification::MESSAGE, 'Localization for parent record {table}:{uid} cannot be fetched', null, ['table' => $table, 'uid' => (int)$id], $table === 'pages' ? $id : $parentRecord['pid']);
|
|
return;
|
|
}
|
|
$parentRecord = $parentRecordLocalization->toArray(true);
|
|
$id = $parentRecord['uid'];
|
|
}
|
|
|
|
if (!$parentRecord) {
|
|
return;
|
|
}
|
|
|
|
$fieldDefinition = $schema->getField($field);
|
|
$config = $fieldDefinition->getConfiguration();
|
|
$foreignTable = $config['foreign_table'];
|
|
|
|
$foreignTableSchema = $this->tcaSchemaFactory->get($foreignTable);
|
|
$transOrigPointer = (int)$parentRecord[$languageCapability->getTranslationOriginPointerField()->getName()];
|
|
$childTransOrigPointerField = $foreignTableSchema->getCapability(TcaSchemaCapability::Language)->getTranslationOriginPointerField()->getName();
|
|
|
|
if (!$transOrigPointer) {
|
|
return;
|
|
}
|
|
|
|
$relationFieldType = $this->getRelationFieldType($config);
|
|
if ($relationFieldType === false) {
|
|
return;
|
|
}
|
|
|
|
$transOrigRecord = BackendUtility::getRecord($table, $transOrigPointer);
|
|
BackendUtility::workspaceOL($table, $transOrigRecord, $this->BE_USER->workspace);
|
|
|
|
$removeArray = [];
|
|
$mmTable = $relationFieldType === 'mm' && isset($config['MM']) && $config['MM'] ? $config['MM'] : '';
|
|
// Fetch children from original language parent:
|
|
$dbAnalysisOriginal = $this->createRelationHandlerInstance();
|
|
$dbAnalysisOriginal->start($transOrigRecord[$field], $foreignTable, $mmTable, $transOrigRecord['uid'], $table, $config);
|
|
$elementsOriginal = [];
|
|
foreach ($dbAnalysisOriginal->itemArray as $item) {
|
|
$elementsOriginal[$item['id']] = $item;
|
|
}
|
|
unset($dbAnalysisOriginal);
|
|
// Fetch children from current localized parent:
|
|
$dbAnalysisCurrent = $this->createRelationHandlerInstance();
|
|
$dbAnalysisCurrent->start($parentRecord[$field], $foreignTable, $mmTable, $id, $table, $config);
|
|
// Perform synchronization: Possibly removal of already localized records:
|
|
if ($action === 'synchronize') {
|
|
foreach ($dbAnalysisCurrent->itemArray as $index => $item) {
|
|
$childRecord = BackendUtility::getRecord($item['table'], $item['id']);
|
|
BackendUtility::workspaceOL($item['table'], $childRecord, $this->BE_USER->workspace);
|
|
if (isset($childRecord[$childTransOrigPointerField]) && $childRecord[$childTransOrigPointerField] > 0) {
|
|
$childTransOrigPointer = $childRecord[$childTransOrigPointerField];
|
|
// If synchronization is requested, child record was translated once, but original record does not exist anymore, remove it:
|
|
if (!isset($elementsOriginal[$childTransOrigPointer])) {
|
|
unset($dbAnalysisCurrent->itemArray[$index]);
|
|
$removeArray[$item['table']][$item['id']]['delete'] = 1;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// Perform synchronization/localization: Possibly add unlocalized records for original language:
|
|
if ($action === 'localize' || $action === 'synchronize') {
|
|
foreach ($elementsOriginal as $item) {
|
|
if ($this->isRecordLocalized((string)$item['table'], (int)$item['id'], $language)) {
|
|
continue;
|
|
}
|
|
$item['id'] = $this->localize($item['table'], (int)$item['id'], $language);
|
|
|
|
if (is_int($item['id'])) {
|
|
$item['id'] = $this->overlayAutoVersionId($item['table'], $item['id']);
|
|
}
|
|
$dbAnalysisCurrent->itemArray[] = $item;
|
|
}
|
|
} elseif (!empty($ids)) {
|
|
foreach ($ids as $childId) {
|
|
if (!MathUtility::canBeInterpretedAsInteger($childId) || !isset($elementsOriginal[$childId])) {
|
|
continue;
|
|
}
|
|
$item = $elementsOriginal[$childId];
|
|
if ($this->isRecordLocalized((string)$item['table'], (int)$item['id'], $language)) {
|
|
continue;
|
|
}
|
|
$item['id'] = $this->localize($item['table'], (int)$item['id'], $language);
|
|
if (is_int($item['id'])) {
|
|
$item['id'] = $this->overlayAutoVersionId($item['table'], $item['id']);
|
|
}
|
|
$dbAnalysisCurrent->itemArray[] = $item;
|
|
}
|
|
}
|
|
// Store the new values, we will set up the uids for the subtype later on (exception keep localization from original record):
|
|
$value = implode(',', $dbAnalysisCurrent->getValueArray());
|
|
$this->registerDBList[$table][$id][$field] = $value;
|
|
// Remove child records (if synchronization requested it):
|
|
if ($removeArray !== []) {
|
|
/** @var DataHandler $tce */
|
|
$tce = GeneralUtility::makeInstance(self::class);
|
|
$tce->enableLogging = $this->enableLogging;
|
|
$tce->start([], $removeArray, $this->BE_USER, $this->referenceIndexUpdater, $this->correlationId);
|
|
$tce->process_cmdmap();
|
|
unset($tce);
|
|
}
|
|
$updateFields = [];
|
|
// Handle, reorder and store relations:
|
|
if ($relationFieldType === 'list') {
|
|
$updateFields = [$field => $value];
|
|
} elseif ($relationFieldType === 'field') {
|
|
$dbAnalysisCurrent->writeForeignField($config, $id);
|
|
$updateFields = [$field => $dbAnalysisCurrent->countItems(false)];
|
|
} elseif ($relationFieldType === 'mm') {
|
|
$dbAnalysisCurrent->writeMM($config['MM'], $id);
|
|
$updateFields = [$field => $dbAnalysisCurrent->countItems(false)];
|
|
}
|
|
// Update field referencing to child records of localized parent record:
|
|
if (!empty($updateFields)) {
|
|
$this->updateDB($table, $id, $updateFields, (int)$parentRecord['pid']);
|
|
}
|
|
if (isset($parentRecord['_ORIG_uid']) && (int)$parentRecord['_ORIG_uid'] !== (int)$id) {
|
|
// If there is a workspace overlay of the record, then the relation has been attached to *this*
|
|
// record, even though the uids point to live. We still need to update refindex of the overlay
|
|
// to reflect this relation.
|
|
$this->updateRefIndex($table, (int)$parentRecord['_ORIG_uid']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns true if a localization of a record exists.
|
|
*/
|
|
protected function isRecordLocalized(string $table, int $uid, int $language): bool
|
|
{
|
|
$row = BackendUtility::getRecord($table, $uid);
|
|
BackendUtility::workspaceOL($table, $row, $this->BE_USER->workspace);
|
|
if (!$row) {
|
|
return false;
|
|
}
|
|
return $this->localizationRepository->getRecordTranslation($table, $row, $language, $this->BE_USER->workspace) !== null;
|
|
}
|
|
|
|
/**
|
|
* Delete a single record.
|
|
*
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function deleteAction(string $table, int|array $uidOrRow, bool $noRecordCheck = false, bool $forceHardDelete = false): void
|
|
{
|
|
if (is_int($uidOrRow) && $uidOrRow <= 0) {
|
|
$this->log($table, $uidOrRow, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::SYSTEM_ERROR, 'Can not delete "{table}:{uid}": uid must be a positive int larger than zero', null, ['table' => $table, 'uid' => $uidOrRow], 0);
|
|
return;
|
|
}
|
|
if (!is_array($uidOrRow)) {
|
|
$recordToDelete = BackendUtility::getRecord($table, $uidOrRow, '*', '', false);
|
|
if ($recordToDelete === null) {
|
|
// No record no cry.
|
|
return;
|
|
}
|
|
$uid = $uidOrRow;
|
|
} else {
|
|
$recordToDelete = $uidOrRow;
|
|
$uid = (int)$recordToDelete['uid'];
|
|
}
|
|
unset($uidOrRow);
|
|
|
|
// Exit if the current user does not have permission to modify the table and $noRecordCheck is set to false
|
|
if (!$noRecordCheck && !$this->checkModifyAccessList($table)) {
|
|
$this->log($table, 0, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Cannot delete "{table}:{uid}" without permission', null, ['table' => $table, 'uid' => $uid]);
|
|
return;
|
|
}
|
|
|
|
if ((int)($recordToDelete['t3ver_wsid'] ?? null) !== 0) {
|
|
// When uid to a workspace record is given, then discard always. This is coming from workspace BE
|
|
// module "waste bin" icon, which sends the workspace uid of the record with the intention to
|
|
// discard the overlay.
|
|
// @todo: It might be better to have an own cmdmap action for 'discard' directly to avoid
|
|
// live / workspace uid confusion with 'delete' and this dispatching.
|
|
$this->discard($table, null, $recordToDelete);
|
|
return;
|
|
}
|
|
|
|
$recordWasDeleted = false;
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processCmdmapClass'] ?? [] as $className) {
|
|
$hookObj = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hookObj, 'processCmdmap_deleteAction')) {
|
|
$hookObj->processCmdmap_deleteAction($table, $uid, $recordToDelete, $recordWasDeleted, $this);
|
|
/** @var bool $recordWasDeleted */
|
|
}
|
|
}
|
|
if ($recordWasDeleted) { // @phpstan-ignore if.alwaysFalse (hook result is not taken into account)
|
|
return;
|
|
}
|
|
|
|
$beUserCurrentWorkspace = $this->BE_USER->workspace;
|
|
if ($workspaceRecordOverlay = BackendUtility::getWorkspaceVersionOfRecord($beUserCurrentWorkspace, $table, $uid)) {
|
|
$workspaceRecordOverlayVersionState = VersionState::tryFrom($workspaceRecordOverlay['t3ver_state']);
|
|
if ($workspaceRecordOverlayVersionState === VersionState::DEFAULT_STATE) {
|
|
if (!$noRecordCheck && !$this->BE_USER->checkRecordEditAccess($table, $workspaceRecordOverlay)->isAllowed) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to delete record "{table:uid}" without delete-permissions', null, ['table' => $table, 'uid' => $workspaceRecordOverlay['uid']]);
|
|
return;
|
|
}
|
|
// If incoming uid references a live record (t3ver_wsid=0), and user is in workspace, and there is a "workspace modified"
|
|
// version of the record, then we'll turn the workspace record into a delete overlay if it isn't one already.
|
|
$this->connectionPool->getConnectionForTable($table)->update(
|
|
$table,
|
|
['t3ver_state' => VersionState::DELETE_PLACEHOLDER->value],
|
|
['uid' => (int)$workspaceRecordOverlay['uid']],
|
|
[Connection::PARAM_INT]
|
|
);
|
|
$this->updateRefIndex($table, (int)$workspaceRecordOverlay['uid']);
|
|
// @todo: Optimize to hand over record and skip early for sys_language_uid !== 0 ??
|
|
$this->deleteL10nOverlayRecords($table, $uid);
|
|
} else {
|
|
// * Discard "delete" placeholder, kinda obvious.
|
|
// * Discard "new" placeholder, which is a DB inconsistency at this point since "existing live" record
|
|
// plus "new" workspace placeholder shouldn't happen.
|
|
// * Discard "move" placeholder: When using "waste bin" in page module of a moved record, the move operation
|
|
// (and potentially additionally changed) record is discarded. The live version "re-appers" at the
|
|
// old position.
|
|
$this->discard($table, null, $workspaceRecordOverlay);
|
|
}
|
|
return;
|
|
}
|
|
if ($beUserCurrentWorkspace === 0) {
|
|
$this->deleteEl($table, $recordToDelete, $noRecordCheck, $forceHardDelete);
|
|
return;
|
|
}
|
|
if (!$this->tcaSchemaFactory->has($table) || !$this->tcaSchemaFactory->get($table)->hasCapability(TcaSchemaCapability::Workspace)) {
|
|
if (!$noRecordCheck && !$this->BE_USER->workspaceAllowsLiveEditingInTable($table)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to delete record "{table}:{uid}" from not workspace aware table without live editing permissions', null, ['table' => $table, 'uid' => $uid]);
|
|
return;
|
|
}
|
|
$this->deleteEl($table, $recordToDelete, $noRecordCheck, $forceHardDelete);
|
|
return;
|
|
}
|
|
// Create delete placeholder records in workspace
|
|
// @todo: Stop using versionizeRecord(), check permissions directly instead and use a lower level method.
|
|
$copyMappingArray = $this->copyMappingArray;
|
|
$this->versionizeRecord($table, $uid, 'DELETED!', true);
|
|
// Determine newly created versions to delete localization overlays:
|
|
// Remove placeholders are copied and modified, thus they appear in the copyMappingArray
|
|
$versionedElements = ArrayUtility::arrayDiffKeyRecursive($this->copyMappingArray, $copyMappingArray);
|
|
foreach ($versionedElements as $versionedTableName => $versionedOriginalIds) {
|
|
// Delete localization overlays
|
|
foreach ($versionedOriginalIds as $versionedOriginalId => $_) {
|
|
$this->deleteL10nOverlayRecords($versionedTableName, (int)$versionedOriginalId);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete element from any table
|
|
*
|
|
* @param array $recordToDelete Full record row
|
|
* @param bool $noRecordCheck If true, records are not checked for permissions
|
|
* @param bool $forceHardDelete If true, the "deleted" flag is ignored if applicable for record and the record is deleted COMPLETELY!
|
|
*/
|
|
protected function deleteEl(string $table, array $recordToDelete, bool $noRecordCheck = false, bool $forceHardDelete = false): void
|
|
{
|
|
$uid = (int)$recordToDelete['uid'];
|
|
if ($table === 'pages') {
|
|
$languageCapability = $this->tcaSchemaFactory->get('pages')->getCapability(TcaSchemaCapability::Language);
|
|
$localizationParentFieldName = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
$localizationParent = (int)($recordToDelete[$localizationParentFieldName] ?? 0);
|
|
$subPages = [];
|
|
if ($localizationParent === 0) {
|
|
// When deleting a default language page, subpages have to be deleted as well.
|
|
$subPages = $this->getSubPagesOfPage($uid, !$forceHardDelete);
|
|
}
|
|
$defaultLanguagePageRecord = $recordToDelete;
|
|
if ($localizationParent !== 0) {
|
|
$defaultLanguagePageRecord = BackendUtility::getRecord('pages', $localizationParent, '*', '', false);
|
|
if ($defaultLanguagePageRecord === null) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::SYSTEM_ERROR, 'Can not delete localized "pages:{uid}", default language page record "pages:{localizationParent}" not found', null, ['uid' => $uid, 'localizationParent' => $localizationParent], 0);
|
|
return;
|
|
}
|
|
}
|
|
if (!$noRecordCheck && is_string($pagesDeletePermissionError = $this->canDeletePage($recordToDelete, $defaultLanguagePageRecord, $subPages, !$forceHardDelete))) {
|
|
$this->log('pages', $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::SYSTEM_ERROR, $pagesDeletePermissionError);
|
|
return;
|
|
}
|
|
foreach ($subPages as $subPage) {
|
|
// Delete subpages. $subPages is a list of default language pages.
|
|
$this->deleteSpecificPage($subPage, $forceHardDelete);
|
|
}
|
|
$this->deleteSpecificPage($recordToDelete, $forceHardDelete);
|
|
} else {
|
|
$this->discardLocalizedWorkspaceVersionsOfRecord($table, $uid);
|
|
$this->discardWorkspaceVersionsOfRecord($table, $uid);
|
|
$this->deleteRecord($table, $recordToDelete, $noRecordCheck, $forceHardDelete);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* When deleting a live element with sys_language_uid = 0, there may be translated records that
|
|
* have been created in workspaces only (t3ver_state=1). Those have to be discarded explicitly
|
|
* since the other 'delete' related code does not consider this case, otherwise the 'new' workspace
|
|
* translation would be dangling when the live record is gone.
|
|
*/
|
|
protected function discardLocalizedWorkspaceVersionsOfRecord(string $table, int $uid): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!$schema->isLanguageAware() || !$schema->isWorkspaceAware()) {
|
|
return;
|
|
}
|
|
$liveRecord = BackendUtility::getRecord($table, $uid);
|
|
if ($liveRecord === null || !$this->BE_USER->checkRecordEditAccess($table, $liveRecord)->isAllowed) {
|
|
return;
|
|
}
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$languageField = $languageCapability->getLanguageField()->getName();
|
|
$localizationParentFieldName = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
if ((int)($liveRecord[$languageField] ?? 0) !== 0 || (int)($liveRecord['t3ver_wsid'] ?? 0) !== 0) {
|
|
// Don't do anything if we're not deleting a live record in default language
|
|
return;
|
|
}
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
$queryBuilder = $queryBuilder->select('*')->from($table)
|
|
->where(
|
|
// workspace elements
|
|
$queryBuilder->expr()->gt('t3ver_wsid', $queryBuilder->createNamedParameter(0, Connection::PARAM_INT)),
|
|
// with sys_language_uid > 0
|
|
$queryBuilder->expr()->gt($languageField, $queryBuilder->createNamedParameter(0, Connection::PARAM_INT)),
|
|
// in state 'new'
|
|
$queryBuilder->expr()->eq('t3ver_state', $queryBuilder->createNamedParameter(VersionState::NEW_PLACEHOLDER->value, Connection::PARAM_INT)),
|
|
// with "l10n_parent" set to uid of live record
|
|
$queryBuilder->expr()->eq($localizationParentFieldName, $queryBuilder->createNamedParameter($uid, Connection::PARAM_INT))
|
|
);
|
|
$result = $queryBuilder->executeQuery();
|
|
while ($row = $result->fetchAssociative()) {
|
|
// BE user must be put into this workspace temporarily so stuff like refindex updating
|
|
// is properly registered for this workspace when discarding records in there.
|
|
$currentUserWorkspace = $this->BE_USER->workspace;
|
|
$this->BE_USER->workspace = (int)$row['t3ver_wsid'];
|
|
$this->discard($table, null, $row);
|
|
// Switch user back to original workspace
|
|
$this->BE_USER->workspace = $currentUserWorkspace;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Discard workspace overlays of a live record: When a live row
|
|
* is deleted, all existing workspace overlays are discarded.
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $uid Record UID
|
|
*/
|
|
protected function discardWorkspaceVersionsOfRecord(string $table, int $uid): void
|
|
{
|
|
$versions = BackendUtility::selectVersionsOfRecord($table, $uid, '*', null);
|
|
if ($versions === null) {
|
|
// Null is returned by selectVersionsOfRecord() when table is not workspace aware.
|
|
return;
|
|
}
|
|
foreach ($versions as $record) {
|
|
if ($record['_CURRENT_VERSION'] ?? false) {
|
|
// The live record is included in the result from selectVersionsOfRecord()
|
|
// and marked as '_CURRENT_VERSION'. Skip this one.
|
|
continue;
|
|
}
|
|
// BE user must be put into this workspace temporarily so stuff like refindex updating
|
|
// is properly registered for this workspace when discarding records in there.
|
|
$currentUserWorkspace = $this->BE_USER->workspace;
|
|
$this->BE_USER->workspace = (int)$record['t3ver_wsid'];
|
|
$this->discard($table, null, $record);
|
|
// Switch user back to original workspace
|
|
$this->BE_USER->workspace = $currentUserWorkspace;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Deleting a record
|
|
* This function may not be used to delete pages-records unless the underlying records are already deleted
|
|
* Deletes a record regardless of versioning state (live or offline, doesn't matter, the uid decides)
|
|
* If both $noRecordCheck and $forceHardDelete are set it could even delete a "deleted"-flagged record!
|
|
*
|
|
* @param string $table Table name
|
|
* @param array $recordToDelete Full record row
|
|
* @param bool $noRecordCheck Flag: If $noRecordCheck is set, then the function does not check permission to delete record
|
|
* @param bool $forceHardDelete If TRUE, the "deleted" flag is ignored if applicable for record and the record is deleted COMPLETELY!
|
|
*/
|
|
protected function deleteRecord(string $table, array $recordToDelete, bool $noRecordCheck = false, bool $forceHardDelete = false): void
|
|
{
|
|
$currentUserWorkspace = $this->BE_USER->workspace;
|
|
$uid = (int)$recordToDelete['uid'];
|
|
|
|
if (!$this->tcaSchemaFactory->has($table) || $uid <= 0) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to delete record without delete-permissions [Invalid table or UID]');
|
|
return;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$accessResult = $this->BE_USER->checkRecordEditAccess($table, $recordToDelete, false, true);
|
|
if (!$accessResult->isAllowed) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to delete record without delete-permissions [{reason}]', null, ['reason' => $accessResult->errorMessage]);
|
|
return;
|
|
}
|
|
if ($table === 'sys_file_reference' && array_key_exists('pages', $this->datamap)) {
|
|
// @todo: find a more generic way to handle content relations of a page (without needing content editing access to that page)
|
|
$perms = Permission::PAGE_EDIT;
|
|
} else {
|
|
$perms = Permission::CONTENT_EDIT;
|
|
}
|
|
|
|
$recordWorkspaceId = (int)($recordToDelete['t3ver_wsid'] ?? 0);
|
|
if ($recordWorkspaceId > 0) {
|
|
// @todo: Verify this can not happen anymore and this case is dispatched to discard() more early.
|
|
return;
|
|
}
|
|
|
|
if (!$noRecordCheck) {
|
|
if ((int)$recordToDelete['pid'] > 0) {
|
|
$pageRecord = BackendUtility::getRecord('pages', $recordToDelete['pid'], '*', '', false);
|
|
if (!is_array($pageRecord)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to delete record "{table}:{uid}" which is not assigned to a valid page', null, ['table' => $table, 'uid' => $uid]);
|
|
return;
|
|
}
|
|
} else {
|
|
$pageRecord = VirtualRecord::RootPage;
|
|
}
|
|
if (!$this->hasPageContextPermission($table, $perms, $pageRecord)) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to delete record "{table}:{uid}" without permission', null, ['table' => $table, 'uid' => $uid]);
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Clear cache before deleting the record, else the correct page cannot be identified by clear_cache
|
|
$parentUid = (int)BackendUtility::getRealPageId($table, $uid);
|
|
$this->registerRecordIdForPageCacheClearing($table, $uid, $parentUid);
|
|
if ($schema->hasCapability(TcaSchemaCapability::SoftDelete) && !$forceHardDelete) {
|
|
$updateFields = [
|
|
$schema->getCapability(TcaSchemaCapability::SoftDelete)->getFieldName() => 1,
|
|
];
|
|
if ($schema->hasCapability(TcaSchemaCapability::UpdatedAt)) {
|
|
$updateFields[$schema->getCapability(TcaSchemaCapability::UpdatedAt)->getFieldName()] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
// before deleting this record, check for child records or references
|
|
$this->deleteRecord_procFields($table, $recordToDelete);
|
|
// Delete all l10n records as well
|
|
$this->deleteL10nOverlayRecords($table, $uid);
|
|
$this->connectionPool->getConnectionForTable($table)->update($table, $updateFields, ['uid' => $uid]);
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::MESSAGE, 'Record {table}:{uid} was deleted from pages:{pid}', null, ['table' => $table, 'uid' => $uid, 'pid' => (int)($recordToDelete['pid'] ?? 0)], (int)($recordToDelete['pid'] ?? 0));
|
|
} else {
|
|
// Delete child records. If the parent table is NOT soft-delete aware, it will get
|
|
// hard deleted. Attached children have to be hard-deleted aware as well, they'd be
|
|
// "orphaned" otherwise. We thus $forceHardDelete=true to deleteRecord_procFields().
|
|
$this->deleteRecord_procFields($table, $recordToDelete, true);
|
|
$this->hardDeleteSingleRecord($table, $uid);
|
|
$this->deleteL10nOverlayRecords($table, $uid);
|
|
$this->log($table, $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::MESSAGE, 'Record {table}:{uid} was deleted unrecoverable from pages:{pid}', null, ['table' => $table, 'uid' => $uid, 'pid' => (int)($recordToDelete['pid'] ?? 0)], (int)($recordToDelete['pid'] ?? 0));
|
|
}
|
|
|
|
// Add history entry
|
|
$this->getRecordHistoryStore()->deleteRecord($table, $uid, $this->correlationId);
|
|
// Update reference index with table/uid on left side (recuid)
|
|
$this->updateRefIndex($table, $uid);
|
|
// Update reference index with table/uid on right side (ref_uid). Important if children of a relation are deleted.
|
|
$this->referenceIndexUpdater->registerUpdateForReferencesToItem($table, $uid, $currentUserWorkspace);
|
|
}
|
|
|
|
/**
|
|
* Delete a page (or set deleted field to 1) and all records on it.
|
|
*
|
|
* @param bool $forceHardDelete If TRUE, the "deleted" flag is ignored if applicable for record and the record is deleted COMPLETELY!
|
|
*/
|
|
protected function deleteSpecificPage(array $recordToDelete, bool $forceHardDelete): void
|
|
{
|
|
$pagesSchema = $this->tcaSchemaFactory->get('pages');
|
|
$languageCapability = $pagesSchema->getCapability(TcaSchemaCapability::Language);
|
|
|
|
$currentUserWorkspace = $this->BE_USER->workspace;
|
|
$uid = (int)$recordToDelete['uid'];
|
|
|
|
// Delete either a default language page or a translated page
|
|
$pageIdInDefaultLanguage = $uid;
|
|
$isPageTranslation = false;
|
|
$localizationParent = (int)($recordToDelete[$languageCapability->getTranslationOriginPointerField()->getName()] ?? 0);
|
|
$pageLanguageId = 0;
|
|
if ($localizationParent > 0) {
|
|
// For translated pages, translated records in other tables (eg. tt_content) for the
|
|
// to-delete translated page have their pid field set to the uid of the default language record,
|
|
// NOT the uid of the translated page record.
|
|
// If a translated page is deleted, only translations of records in other tables of this language
|
|
// should be deleted. The code checks if the to-delete page is a translated page and
|
|
// adapts the query for other tables to use the uid of the default language page as pid together
|
|
// with the language id of the translated page.
|
|
// If a default language page is deleted, the access checks below behave subtly different.
|
|
$pageIdInDefaultLanguage = $localizationParent;
|
|
$isPageTranslation = true;
|
|
$pagesLanguageFieldName = $languageCapability->getLanguageField()->getName();
|
|
$pageLanguageId = $recordToDelete[$pagesLanguageFieldName] ?? 0;
|
|
}
|
|
$otherLocalizationExists = false;
|
|
if ($isPageTranslation && $forceHardDelete) {
|
|
// Restriction when hard deleting localized pages: Usually, localized records are hard deleted as well
|
|
// when hard deleting a localized page (via recycler). However, when a soft-deleted localized page is
|
|
// hard-deleted while another NOT soft-deleted localization of the page exists in the same
|
|
// sys_language_uid (created after the other translation has been soft-deleted), then records do not
|
|
// "know" if they belong to the soft-deleted, or the active localized page. In this case, we only
|
|
// hard delete the soft-deleted page, but no records, to keep existing records that belong to the
|
|
// active localization.
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable('pages');
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
$queryBuilder->getRestrictions()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$otherLocalizationExists = (bool)$queryBuilder->count('uid')->from('pages')
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
$languageCapability->getTranslationOriginPointerField()->getName(),
|
|
$queryBuilder->createNamedParameter($pageIdInDefaultLanguage, Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->eq(
|
|
$languageCapability->getLanguageField()->getName(),
|
|
$queryBuilder->createNamedParameter($pageLanguageId, Connection::PARAM_INT)
|
|
)
|
|
)
|
|
->executeQuery()
|
|
->fetchOne();
|
|
}
|
|
|
|
if (!$otherLocalizationExists) {
|
|
foreach ($this->tcaSchemaFactory->all() as $subSchema) {
|
|
$table = $subSchema->getName();
|
|
if ($table === 'pages' || ($isPageTranslation && !$subSchema->isLanguageAware())) {
|
|
// Skip pages table. And skip table if not translatable, but a translated page is deleted
|
|
continue;
|
|
}
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
if (!$forceHardDelete) {
|
|
$queryBuilder->getRestrictions()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
}
|
|
$queryBuilder
|
|
->select('*')
|
|
->from($table)
|
|
// order by uid is needed here to process possible live records first - overlays always
|
|
// have a higher uid. Otherwise dbms like postgres may return rows in arbitrary order,
|
|
// leading to hard to debug issues. This is especially relevant for the
|
|
// discardWorkspaceVersionsOfRecord() call below.
|
|
->addOrderBy('uid');
|
|
if ($isPageTranslation) {
|
|
// Only delete records in the specified language
|
|
$queryBuilder->where(
|
|
$queryBuilder->expr()->eq(
|
|
'pid',
|
|
$queryBuilder->createNamedParameter($pageIdInDefaultLanguage, Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->eq(
|
|
$subSchema->getCapability(TcaSchemaCapability::Language)->getLanguageField()->getName(),
|
|
$queryBuilder->createNamedParameter($pageLanguageId, Connection::PARAM_INT)
|
|
)
|
|
);
|
|
} else {
|
|
// Delete all records on this page
|
|
$queryBuilder->where(
|
|
$queryBuilder->expr()->eq(
|
|
'pid',
|
|
$queryBuilder->createNamedParameter($uid, Connection::PARAM_INT)
|
|
)
|
|
);
|
|
}
|
|
if ($currentUserWorkspace !== 0 && $subSchema->isWorkspaceAware()) {
|
|
// If we are in a workspace, make sure only records of this workspace are deleted.
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->eq(
|
|
't3ver_wsid',
|
|
$queryBuilder->createNamedParameter($currentUserWorkspace, Connection::PARAM_INT)
|
|
)
|
|
);
|
|
}
|
|
$statement = $queryBuilder->executeQuery();
|
|
while ($row = $statement->fetchAssociative()) {
|
|
// Delete any further workspace overlays of the record in question, then delete the record.
|
|
$this->discardWorkspaceVersionsOfRecord($table, (int)$row['uid']);
|
|
$this->deleteRecord($table, $row, true, $forceHardDelete);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Delete any further workspace overlays of the record in question, then delete the record.
|
|
$this->discardWorkspaceVersionsOfRecord('pages', $uid);
|
|
|
|
if (!$this->BE_USER->checkRecordEditAccess('pages', $recordToDelete, false, !$isPageTranslation)->isAllowed) {
|
|
$this->log('pages', $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to delete record "pages:{uid}" without delete-permissions', null, ['uid' => $uid]);
|
|
return;
|
|
}
|
|
|
|
$recordWorkspaceId = (int)($recordToDelete['t3ver_wsid'] ?? 0);
|
|
|
|
// Clear cache before deleting the record, else the correct page cannot be identified by clear_cache
|
|
$parentUid = (int)BackendUtility::getRealPageId('pages', $uid);
|
|
$this->registerRecordIdForPageCacheClearing('pages', $uid, $parentUid);
|
|
if ($recordWorkspaceId > 0) {
|
|
// @todo: This should be relocated elsewhere, dispatching to discard() here should happen at a different position:
|
|
// This is called by "delete page" code, especially canDeletePage() and doesBranchExist() which fetch *all*
|
|
// sub page uid's including their workspace overlays. It would be better if the "delete sub pages" code would
|
|
// not fetch overlays, but if "delete single live page" code would take care of discarding overlays directly.
|
|
// If this is a workspace record, use discard
|
|
$this->BE_USER->workspace = $recordWorkspaceId;
|
|
$this->discard('pages', null, $recordToDelete);
|
|
// Switch user back to original workspace
|
|
$this->BE_USER->workspace = $currentUserWorkspace;
|
|
} elseif ($pagesSchema->hasCapability(TcaSchemaCapability::SoftDelete) && !$forceHardDelete) {
|
|
$updateFields = [
|
|
$pagesSchema->getCapability(TcaSchemaCapability::SoftDelete)->getFieldName() => 1,
|
|
];
|
|
if ($pagesSchema->hasCapability(TcaSchemaCapability::UpdatedAt)) {
|
|
$updateFields[$pagesSchema->getCapability(TcaSchemaCapability::UpdatedAt)->getFieldName()] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
// before deleting this record, check for child records or references
|
|
$this->deleteRecord_procFields('pages', $recordToDelete);
|
|
// Delete all l10n records as well
|
|
$this->deleteL10nOverlayRecords('pages', $uid);
|
|
$this->connectionPool->getConnectionForTable('pages')->update('pages', $updateFields, ['uid' => $uid]);
|
|
$this->log('pages', $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::MESSAGE, 'Record pages:{uid} was deleted', null, ['uid' => $uid], (int)($recordToDelete['pid'] ?? 0));
|
|
} else {
|
|
// Delete the hard way...:
|
|
$this->deleteL10nOverlayRecords('pages', $uid, $forceHardDelete);
|
|
$this->hardDeleteSingleRecord('pages', $uid);
|
|
$this->log('pages', $uid, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::MESSAGE, 'Record pages:{uid} was deleted unrecoverable', null, ['uid' => $uid], (int)($recordToDelete['pid'] ?? 0));
|
|
}
|
|
|
|
// Add history entry
|
|
$this->getRecordHistoryStore()->deleteRecord('pages', $uid, $this->correlationId);
|
|
// Update reference index with table/uid on left side (recuid)
|
|
$this->updateRefIndex('pages', $uid);
|
|
// Update reference index with table/uid on right side (ref_uid). Important if children of a relation are deleted.
|
|
$this->referenceIndexUpdater->registerUpdateForReferencesToItem('pages', $uid, $currentUserWorkspace);
|
|
}
|
|
|
|
/**
|
|
* Evaluate if a page can be deleted. Checks access to page and sub pages, and access to records on them.
|
|
*
|
|
* @param array $pageRecord The page record to delete
|
|
* @param array $defaultLanguagePageRecord The default language page record if $pageRecord is a localization. Identical to
|
|
* $pageRecord if $pageRecord *is* a default language record
|
|
* @param array $subPages List of subpages. Only set if a default language page record should be deleted.
|
|
* @param bool $useDeleteClause Use the delete clause to check if the page is deleted
|
|
*/
|
|
protected function canDeletePage(array $pageRecord, array $defaultLanguagePageRecord, array $subPages, bool $useDeleteClause = true): ?string
|
|
{
|
|
$languageCapability = $this->tcaSchemaFactory->get('pages')->getCapability(TcaSchemaCapability::Language);
|
|
$localizationParentFieldName = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
$localizationParent = (int)($pageRecord[$localizationParentFieldName] ?? 0);
|
|
$pageRecordToCheck = $pageRecord;
|
|
if ($localizationParent > 0) {
|
|
$pageRecordToCheck = $defaultLanguagePageRecord;
|
|
}
|
|
if (!$this->hasPageContextPermission('pages', Permission::PAGE_DELETE, $pageRecordToCheck, $useDeleteClause)) {
|
|
return 'Attempt to delete page without permissions';
|
|
}
|
|
if (!$this->BE_USER->checkRecordEditAccess('pages', $pageRecord, false, $localizationParent === $pageRecord['uid'])->isAllowed) {
|
|
return 'Attempt to delete page which has prohibited localizations';
|
|
}
|
|
foreach ($subPages as $subPage) {
|
|
if (!$this->BE_USER->isAdmin() && !$this->BE_USER->doesUserHaveAccess($subPage, Permission::PAGE_DELETE, $useDeleteClause)) {
|
|
return 'Attempt to delete pages in branch without permissions';
|
|
}
|
|
if (!$this->BE_USER->checkRecordEditAccess('pages', $subPage, false, true)->isAllowed) {
|
|
return 'Attempt to delete page which has prohibited localizations';
|
|
}
|
|
}
|
|
if (!$this->BE_USER->isAdmin()) {
|
|
// Check if there are records from tables on the pages to be deleted which the current user is not allowed to touch.
|
|
foreach ($this->tcaSchemaFactory->all() as $schema) {
|
|
// @todo: Shouldn't we skip 'pages' here?
|
|
$table = $schema->getName();
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$count = $queryBuilder->count('uid')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->in(
|
|
'pid',
|
|
$queryBuilder->createNamedParameter(array_merge([$pageRecord['uid']], array_column($subPages, 'uid')), Connection::PARAM_INT_ARRAY)
|
|
)
|
|
)
|
|
->executeQuery()
|
|
->fetchOne();
|
|
if ($count && ($schema->hasCapability(TcaSchemaCapability::AccessReadOnly) || !$this->checkModifyAccessList($table))) {
|
|
return 'Attempt to delete records from disallowed table "' . $table . '"';
|
|
}
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Before a record is deleted, check if it has references such as inline type or MM references.
|
|
* If so, set these child records also to be deleted.
|
|
*/
|
|
protected function deleteRecord_procFields(string $table, array $recordToDelete, bool $forceHardDelete = false): void
|
|
{
|
|
$uid = (int)$recordToDelete['uid'];
|
|
foreach ($recordToDelete as $fieldName => $value) {
|
|
// Get TCA configuration for the field (respecting columnsOverrides)
|
|
$configuration = $this->resolveFieldConfigurationAndRespectColumnsOverrides($table, $fieldName, $recordToDelete);
|
|
if ($configuration === [] || !isset($configuration['type'])) {
|
|
continue;
|
|
}
|
|
if ($configuration['type'] === 'inline' || $configuration['type'] === 'file') {
|
|
if (in_array($this->getRelationFieldType($configuration), ['list', 'field'], true)) {
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
if ($forceHardDelete) {
|
|
// @todo: This should be called "disableDeleteClause" or similar.
|
|
$dbAnalysis->undeleteRecord = true;
|
|
}
|
|
$dbAnalysis->start($value, $configuration['foreign_table'], '', $uid, $table, $configuration);
|
|
// Non type save comparison is intended!
|
|
if (!isset($configuration['behaviour']['enableCascadingDelete']) || $configuration['behaviour']['enableCascadingDelete'] != false) {
|
|
// Walk through the items and remove them
|
|
foreach ($dbAnalysis->itemArray as $v) {
|
|
// @todo: It would be so much better when RelationHandler could return full rows ...
|
|
$this->deleteAction($v['table'], (int)$v['id'], false, $forceHardDelete);
|
|
}
|
|
}
|
|
}
|
|
} elseif ($this->isReferenceField($configuration)) {
|
|
$allowedTables = $configuration['type'] === 'group' ? $configuration['allowed'] : $configuration['foreign_table'];
|
|
if ($forceHardDelete && ($configuration['MM'] ?? false)) {
|
|
// When hard deleting an MM record, MM rows must be removed. Note they are kept when
|
|
// soft-deleting a local or foreign side record to allow undeleting the record and getting
|
|
// connected MM relations back.
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start('', $allowedTables, $configuration['MM'], $uid, $table, $configuration);
|
|
$previousItemArray = $dbAnalysis->itemArray;
|
|
$dbAnalysis->itemArray = [];
|
|
$dbAnalysis->writeMM($configuration['MM'], $uid);
|
|
} else {
|
|
$allowedTables = $configuration['type'] === 'group' ? $configuration['allowed'] : $configuration['foreign_table'];
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($value, $allowedTables, $configuration['MM'] ?? '', $uid, $table, $configuration);
|
|
$previousItemArray = $dbAnalysis->itemArray;
|
|
}
|
|
foreach ($previousItemArray as $v) {
|
|
$this->updateRefIndex($v['table'], $v['id']);
|
|
}
|
|
} elseif ($configuration['type'] === 'flex' && (string)$value !== '') {
|
|
try {
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$dataStructureIdentifier = $this->flexFormTools->getDataStructureIdentifier(
|
|
['config' => $configuration],
|
|
$table,
|
|
$fieldName,
|
|
$recordToDelete,
|
|
$schema
|
|
);
|
|
$dataStructureArray = $this->flexFormTools->parseDataStructureByIdentifier($dataStructureIdentifier, $schema);
|
|
} catch (AbstractInvalidDataStructureException) {
|
|
// Nothing to do if data structure could not be determined
|
|
continue;
|
|
}
|
|
if ($dataStructureArray !== []) {
|
|
$flexForm = GeneralUtility::xml2array($value);
|
|
foreach (($dataStructureArray['sheets'] ?? []) as $sheetName => $sheet) {
|
|
foreach ($sheet['ROOT']['el'] as $sheetFieldName => $flexField) {
|
|
$flexFormValue = $flexForm['data'][$sheetName]['lDEF'][$sheetFieldName]['vDEF'] ?? null;
|
|
$flexFieldConfig = $flexField['config'] ?? [];
|
|
if (!isset($flexFieldConfig['type'])) {
|
|
continue;
|
|
}
|
|
if ($flexFieldConfig['type'] === 'inline' || $flexFieldConfig['type'] === 'file') {
|
|
if (in_array($this->getRelationFieldType($flexFieldConfig), ['list', 'field'], true)) {
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
if ($forceHardDelete) {
|
|
// @todo: This should be called "disableDeleteClause" or similar.
|
|
$dbAnalysis->undeleteRecord = true;
|
|
}
|
|
$dbAnalysis->start($flexFormValue, $flexFieldConfig['foreign_table'], '', $uid, $table, $flexFieldConfig);
|
|
// Non type save comparison is intended!
|
|
if (!isset($flexFieldConfig['behaviour']['enableCascadingDelete']) || $flexFieldConfig['behaviour']['enableCascadingDelete'] != false) {
|
|
// Walk through the items and remove them
|
|
foreach ($dbAnalysis->itemArray as $v) {
|
|
$this->deleteAction($v['table'], (int)$v['id'], false, $forceHardDelete);
|
|
}
|
|
}
|
|
}
|
|
} elseif ($this->isReferenceField($flexFieldConfig)) {
|
|
$allowedTables = $flexFieldConfig['type'] === 'group' ? $flexFieldConfig['allowed'] : $flexFieldConfig['foreign_table'];
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($value, $allowedTables, $flexFieldConfig['MM'] ?? '', $uid, $table, $flexFieldConfig);
|
|
foreach ($dbAnalysis->itemArray as $v) {
|
|
$this->updateRefIndex($v['table'], $v['id']);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find l10n-overlay records and perform the requested delete action for these records.
|
|
*
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function deleteL10nOverlayRecords(string $table, int $uid, bool $forceHardDelete = false): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
// Check whether table can be localized
|
|
if (!$schema->isLanguageAware()) {
|
|
return;
|
|
}
|
|
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$restrictions = $queryBuilder->getRestrictions()->removeAll()
|
|
->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->BE_USER->workspace));
|
|
if (!$forceHardDelete) {
|
|
$restrictions->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
}
|
|
$queryBuilder->select('*')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
$languageCapability->getTranslationOriginPointerField()->getName(),
|
|
$queryBuilder->createNamedParameter($uid, Connection::PARAM_INT)
|
|
)
|
|
);
|
|
|
|
$result = $queryBuilder->executeQuery();
|
|
while ($record = $result->fetchAssociative()) {
|
|
// Ignore workspace delete placeholders. Those records have been marked for
|
|
// deletion before - deleting them again in a workspace would revert that state.
|
|
if ($this->BE_USER->workspace > 0 && $schema->isWorkspaceAware()) {
|
|
BackendUtility::workspaceOL($table, $record, $this->BE_USER->workspace);
|
|
if (VersionState::tryFrom($record['t3ver_state'] ?? 0) === VersionState::DELETE_PLACEHOLDER) {
|
|
continue;
|
|
}
|
|
}
|
|
$this->deleteAction($table, (int)($record['t3ver_oid'] ?? 0) > 0 ? (int)$record['t3ver_oid'] : (int)$record['uid'], false, $forceHardDelete);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Restore live records by setting soft-delete flag to 0.
|
|
*
|
|
* Usually only used by ext:recycler.
|
|
* Connected relations (eg. inline) are restored, too.
|
|
* Additional existing localizations are not restored.
|
|
*
|
|
* @param string $table Record table name
|
|
* @param int $uid Record uid
|
|
*/
|
|
protected function undeleteRecord(string $table, int $uid): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$record = BackendUtility::getRecord($table, $uid, '*', '', false);
|
|
$deleteField = $schema->hasCapability(TcaSchemaCapability::SoftDelete) ? $schema->getCapability(TcaSchemaCapability::SoftDelete)->getFieldName() : '';
|
|
$timestampField = $schema->hasCapability(TcaSchemaCapability::UpdatedAt) ? $schema->getCapability(TcaSchemaCapability::UpdatedAt)->getFieldName() : '';
|
|
|
|
// Exit if the current user does not have permission to modify the table
|
|
if (!$this->checkModifyAccessList($table)) {
|
|
$this->log($table, 0, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::USER_ERROR, 'Cannot restore "{table}:{uid}" without permission', null, ['table' => $table, 'uid' => $uid]);
|
|
return;
|
|
}
|
|
|
|
if ($record === null
|
|
|| $deleteField === ''
|
|
|| !isset($record[$deleteField])
|
|
|| (bool)$record[$deleteField] === false
|
|
|| ($timestampField !== '' && !isset($record[$timestampField]))
|
|
|| (int)$this->BE_USER->workspace > 0
|
|
|| ($schema->isWorkspaceAware() && (int)($record['t3ver_wsid'] ?? 0) > 0)
|
|
) {
|
|
// Return early and silently, if:
|
|
// * Record not found
|
|
// * Table is not soft-delete aware
|
|
// * Record does not have deleted field - db analyzer not up-to-date?
|
|
// * Record is not deleted - may eventually happen via recursion with self referencing records?
|
|
// * Table is tstamp aware, but field does not exist - db analyzer not up-to-date?
|
|
// * User is in a workspace - does not make sense
|
|
// * Record is in a workspace - workspace records are not soft-delete aware
|
|
return;
|
|
}
|
|
|
|
$recordPid = (int)($record['pid'] ?? 0);
|
|
if ($recordPid > 0) {
|
|
// Record is not on root level. Parent page record must exist and must not be deleted itself.
|
|
$page = BackendUtility::getRecord('pages', $recordPid, '*', '', false);
|
|
if ($page === null || !isset($page['deleted']) || (bool)$page['deleted'] === true) {
|
|
$this->log(
|
|
$table,
|
|
$uid,
|
|
SystemLogDatabaseAction::DELETE,
|
|
null,
|
|
SystemLogErrorClassification::USER_ERROR,
|
|
'Record "{table}:{uid}" can\'t be restored: The page "{pid}" containing it does not exist or is soft-deleted',
|
|
null,
|
|
[
|
|
'table' => $table,
|
|
'uid' => $uid,
|
|
'pid' => $recordPid,
|
|
],
|
|
$recordPid
|
|
);
|
|
return;
|
|
}
|
|
|
|
if (!$this->hasPermissionToInsert($table, $recordPid, $page)) {
|
|
$this->log(
|
|
'pages',
|
|
$recordPid,
|
|
SystemLogDatabaseAction::DELETE,
|
|
null,
|
|
SystemLogErrorClassification::USER_ERROR,
|
|
'Record "{table}:{uid}" can\'t be restored: Insufficient user permissions to target page {pid}',
|
|
null,
|
|
[
|
|
'table' => $table,
|
|
'uid' => $uid,
|
|
'pid' => $recordPid,
|
|
],
|
|
$recordPid
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
// @todo: When restoring a not-default language record, it should be verified the default language
|
|
// @todo: record is *not* set to deleted. Maybe even verify a possible l10n_source chain is not deleted?
|
|
|
|
if (!$this->BE_USER->checkRecordEditAccess($table, $record)->isAllowed) {
|
|
// User misses access permissions to record
|
|
$this->log(
|
|
$table,
|
|
$uid,
|
|
SystemLogDatabaseAction::DELETE,
|
|
null,
|
|
SystemLogErrorClassification::USER_ERROR,
|
|
'Record "{table}:{uid}" can\'t be restored: Insufficient user permissions',
|
|
null,
|
|
[
|
|
'table' => $table,
|
|
'uid' => $uid,
|
|
],
|
|
$recordPid
|
|
);
|
|
return;
|
|
}
|
|
|
|
// Restore referenced child records
|
|
$this->undeleteRecordRelations($table, $uid, $record);
|
|
|
|
// Restore record
|
|
$updateFields[$deleteField] = 0;
|
|
if ($timestampField !== '') {
|
|
$updateFields[$timestampField] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
$this->connectionPool->getConnectionForTable($table)
|
|
->update(
|
|
$table,
|
|
$updateFields,
|
|
['uid' => $uid]
|
|
);
|
|
$this->log(
|
|
$table,
|
|
$uid,
|
|
SystemLogDatabaseAction::INSERT,
|
|
null,
|
|
SystemLogErrorClassification::MESSAGE,
|
|
'Record "{table}:{uid}" was restored on page {pid}',
|
|
null,
|
|
[
|
|
'table' => $table,
|
|
'uid' => $uid,
|
|
'pid' => $recordPid,
|
|
],
|
|
$recordPid
|
|
);
|
|
|
|
// Register cache clearing of page, or parent page if a page is restored.
|
|
$this->registerRecordIdForPageCacheClearing($table, $uid, $recordPid);
|
|
// Add history entry
|
|
$this->getRecordHistoryStore()->undeleteRecord($table, $uid, $this->correlationId);
|
|
// Update reference index with table/uid on left side (recuid)
|
|
$this->updateRefIndex($table, $uid);
|
|
// Update reference index with table/uid on right side (ref_uid). Important if children of a relation were restored.
|
|
$this->referenceIndexUpdater->registerUpdateForReferencesToItem($table, $uid, 0);
|
|
}
|
|
|
|
/**
|
|
* Check if a to-restore record has inline references and restore them.
|
|
*
|
|
* @param string $table Record table name
|
|
* @param int $uid Record uid
|
|
* @param array $record Record row
|
|
*/
|
|
protected function undeleteRecordRelations(string $table, int $uid, array $record): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
foreach ($record as $fieldName => $value) {
|
|
if (!$schema->hasField($fieldName)) {
|
|
continue;
|
|
}
|
|
$fieldInformation = $schema->getField($fieldName);
|
|
$fieldConfig = $fieldInformation->getConfiguration();
|
|
$fieldType = $fieldInformation->getType();
|
|
$foreignTable = (string)($fieldInformation->getConfiguration()['foreign_table'] ?? '');
|
|
if ($fieldType === 'inline' || $fieldType === 'file') {
|
|
// @todo: Inline MM not handled here, and what about group / select?
|
|
if (!in_array($this->getRelationFieldType($fieldConfig), ['list', 'field'], true)) {
|
|
continue;
|
|
}
|
|
$relationHandler = $this->createRelationHandlerInstance();
|
|
// Must be set before start(): readForeignField() evaluates this flag
|
|
// to decide whether a DeletedRestriction is applied to the SELECT.
|
|
$relationHandler->undeleteRecord = true;
|
|
$relationHandler->start($value, $foreignTable, '', $uid, $table, $fieldConfig);
|
|
foreach ($relationHandler->itemArray as $reference) {
|
|
$this->undeleteRecord($reference['table'], (int)$reference['id']);
|
|
}
|
|
} elseif ($this->isReferenceField($fieldConfig)) {
|
|
$allowedTables = $fieldType === 'group' ? ($fieldConfig['allowed'] ?? '') : $foreignTable;
|
|
$relationHandler = $this->createRelationHandlerInstance();
|
|
$relationHandler->start($value, $allowedTables, $fieldConfig['MM'] ?? '', $uid, $table, $fieldConfig);
|
|
foreach ($relationHandler->itemArray as $reference) {
|
|
// @todo: Unsure if this is ok / enough. Needs coverage.
|
|
$this->updateRefIndex($reference['table'], $reference['id']);
|
|
}
|
|
} elseif ($fieldType === 'flex') {
|
|
// @todo: Implement undelete of relations within a FlexForm
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Discard a versioned record from this workspace. This deletes records from the database - no soft delete.
|
|
* This main entry method is called recursive for sub pages, localizations, relations and records on a page.
|
|
* The method checks user access and gathers facts about this record to hand the deletion over to detail methods.
|
|
*
|
|
* The incoming $uid or $row can be anything: The workspace of current user is respected and only records
|
|
* of current user workspace are discarded. If giving a live record uid, the versioned overly will be fetched.
|
|
*
|
|
* @param string $table Database table name
|
|
* @param int|null $uid Uid of live or versioned record to be discarded, or null if $record is given
|
|
* @param array|null $record Record row that should be discarded. Used instead of $uid within recursion.
|
|
*/
|
|
protected function discard(string $table, ?int $uid, ?array $record = null): void
|
|
{
|
|
if ($uid === null && $record === null) {
|
|
throw new \RuntimeException('Either record $uid or $record row must be given', 1600373491);
|
|
}
|
|
|
|
// Fetch record we are dealing with if not given
|
|
if ($record === null) {
|
|
$record = BackendUtility::getRecord($table, (int)$uid);
|
|
}
|
|
if (!is_array($record)) {
|
|
return;
|
|
}
|
|
$uid = (int)$record['uid'];
|
|
|
|
// Call hook and return if hook took care of the element
|
|
$recordWasDiscarded = false;
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processCmdmapClass'] ?? [] as $className) {
|
|
$hookObj = GeneralUtility::makeInstance($className);
|
|
if (method_exists($hookObj, 'processCmdmap_discardAction')) {
|
|
/** @var bool $recordWasDiscarded */
|
|
$hookObj->processCmdmap_discardAction($table, $uid, $record, $recordWasDiscarded);
|
|
}
|
|
}
|
|
|
|
$userWorkspace = $this->BE_USER->workspace;
|
|
if ($recordWasDiscarded // @phpstan-ignore booleanOr.leftAlwaysFalse (hook result is not taken into account)
|
|
|| $userWorkspace === 0
|
|
|| !$this->tcaSchemaFactory->has($table)
|
|
|| !$this->tcaSchemaFactory->get($table)->hasCapability(TcaSchemaCapability::Workspace)
|
|
) {
|
|
return;
|
|
}
|
|
|
|
// Gather versioned record
|
|
if ((int)$record['t3ver_wsid'] === 0) {
|
|
$record = BackendUtility::getWorkspaceVersionOfRecord($userWorkspace, $table, $uid);
|
|
}
|
|
if (!is_array($record)) {
|
|
return;
|
|
}
|
|
$versionRecord = $record;
|
|
|
|
if ($table === 'pages') {
|
|
$pageRecord = $versionRecord;
|
|
} elseif ((int)$versionRecord['pid'] > 0) {
|
|
$pageRecord = BackendUtility::getRecord('pages', $versionRecord['pid']) ?? [];
|
|
} else {
|
|
$pageRecord = VirtualRecord::RootPage;
|
|
}
|
|
|
|
// User access checks
|
|
if ($userWorkspace !== (int)$versionRecord['t3ver_wsid']) {
|
|
$this->log($table, $versionRecord['uid'], SystemLogDatabaseAction::DISCARD, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to discard workspace record {table}:{uid} failed: Different workspace', null, ['table' => $table, 'uid' => (int)$versionRecord['uid']]);
|
|
return;
|
|
}
|
|
if ($errorCode = $this->workspaceCannotEditOfflineVersion($table, $versionRecord)) {
|
|
$this->log($table, $versionRecord['uid'], SystemLogDatabaseAction::DISCARD, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to discard workspace record {table}:{uid} failed: {reason}', null, ['table' => $table, 'uid' => (int)$versionRecord['uid'], 'reason' => $errorCode]);
|
|
return;
|
|
}
|
|
if (!$this->hasPermissionToUpdate($table, $pageRecord)) {
|
|
$this->log($table, $versionRecord['uid'], SystemLogDatabaseAction::DISCARD, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to discard workspace record {table}:{uid} failed: User has no edit access', null, ['table' => $table, 'uid' => (int)$versionRecord['uid']]);
|
|
return;
|
|
}
|
|
$fullLanguageAccessCheck = !($table === 'pages' && (int)$versionRecord[$this->tcaSchemaFactory->get('pages')->getCapability(TcaSchemaCapability::Language)->getTranslationOriginPointerField()->getName()] !== 0);
|
|
if (!$this->BE_USER->checkRecordEditAccess($table, $versionRecord, false, $fullLanguageAccessCheck)->isAllowed) {
|
|
$this->log($table, $versionRecord['uid'], SystemLogDatabaseAction::DISCARD, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to discard workspace record {table}:{uid} failed: User has no delete access', null, ['table' => $table, 'uid' => (int)$versionRecord['uid']]);
|
|
return;
|
|
}
|
|
|
|
// Perform discard operations
|
|
$versionState = VersionState::tryFrom($versionRecord['t3ver_state'] ?? 0);
|
|
if ($table === 'pages' && $versionState === VersionState::NEW_PLACEHOLDER) {
|
|
// When discarding a new page, there can be new sub pages and new records.
|
|
// Those need to be discarded, otherwise they'd end up as records without parent page.
|
|
$this->discardSubPagesAndRecordsOnPage($versionRecord);
|
|
}
|
|
|
|
$this->discardLocalizationOverlayRecords($table, $versionRecord);
|
|
$this->discardRecordRelations($table, $versionRecord);
|
|
$this->discardCsvReferencesToRecord($table, $versionRecord);
|
|
$this->hardDeleteSingleRecord($table, (int)$versionRecord['uid']);
|
|
$this->registerReferenceIndexRowsForDrop($table, (int)$versionRecord['uid'], $userWorkspace);
|
|
$this->getRecordHistoryStore()->deleteRecord($table, (int)$versionRecord['uid'], $this->correlationId);
|
|
$this->log(
|
|
$table,
|
|
(int)$versionRecord['uid'],
|
|
SystemLogDatabaseAction::DELETE,
|
|
null,
|
|
SystemLogErrorClassification::MESSAGE,
|
|
'Record {table}:{uid} was deleted unrecoverable from page {pid}',
|
|
null,
|
|
['table' => $table, 'uid' => $versionRecord['uid'], 'pid' => $versionRecord['pid']],
|
|
(int)$versionRecord['pid']
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Also discard any sub pages and records of a new parent page if this page is discarded.
|
|
* Discarding only in specific localization, if needed.
|
|
*
|
|
* @param array $page Page record row
|
|
*/
|
|
protected function discardSubPagesAndRecordsOnPage(array $page): void
|
|
{
|
|
$isLocalizedPage = false;
|
|
$pageSchema = $this->tcaSchemaFactory->get('pages');
|
|
$languageFieldName = $pageSchema->getCapability(TcaSchemaCapability::Language)->getLanguageField()->getName();
|
|
$sysLanguageId = (int)$page[$languageFieldName];
|
|
$versionState = VersionState::tryFrom($page['t3ver_state'] ?? 0);
|
|
if ($sysLanguageId > 0) {
|
|
// New or moved localized page.
|
|
// Discard records on this page localization, but no sub pages.
|
|
// Records of a translated page have the pid set to the default language page uid. Found in l10n_parent.
|
|
// @todo: Discard other page translations that inherit from this?! (l10n_source field)
|
|
$isLocalizedPage = true;
|
|
$pid = (int)$page[$pageSchema->getCapability(TcaSchemaCapability::Language)->getTranslationOriginPointerField()->getName()];
|
|
} elseif ($versionState === VersionState::NEW_PLACEHOLDER) {
|
|
// New default language page.
|
|
// Discard any sub pages and all other records of this page, including any page localizations.
|
|
// The t3ver_state=1 record is incoming here. Records on this page have their pid field set to the uid
|
|
// of this record. So, since t3ver_state=1 does not have an online counter-part, the actual UID is used here.
|
|
$pid = (int)$page['uid'];
|
|
} else {
|
|
// Moved default language page.
|
|
// Discard any sub pages and all other records of this page, including any page localizations.
|
|
$pid = (int)$page['t3ver_oid'];
|
|
}
|
|
foreach ($this->tcaSchemaFactory->all() as $schema) {
|
|
$table = $schema->getName();
|
|
if (($isLocalizedPage && $table === 'pages')
|
|
|| ($isLocalizedPage && !$schema->isLanguageAware())
|
|
|| !$schema->isWorkspaceAware()
|
|
) {
|
|
continue;
|
|
}
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
$queryBuilder->select('*')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
'pid',
|
|
$queryBuilder->createNamedParameter($pid, Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->eq(
|
|
't3ver_wsid',
|
|
$queryBuilder->createNamedParameter((int)$this->BE_USER->workspace, Connection::PARAM_INT)
|
|
)
|
|
);
|
|
if ($isLocalizedPage && $schema->isLanguageAware()) {
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
// Add sys_language_uid = x restriction if discarding a localized page
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->eq(
|
|
$languageCapability->getLanguageField()->getName(),
|
|
$queryBuilder->createNamedParameter($sysLanguageId, Connection::PARAM_INT)
|
|
)
|
|
);
|
|
}
|
|
$statement = $queryBuilder->executeQuery();
|
|
while ($row = $statement->fetchAssociative()) {
|
|
$this->discard($table, null, $row);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Discard record relations like inline and MM of a record.
|
|
*
|
|
* @param string $table Table name of this record
|
|
* @param array $record The record row to handle
|
|
*/
|
|
protected function discardRecordRelations(string $table, array $record): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
foreach ($record as $fieldName => $value) {
|
|
if (!$schema->hasField($fieldName)) {
|
|
continue;
|
|
}
|
|
/** @var InlineFieldType|FileFieldType $fieldType */
|
|
$fieldType = $schema->getField($fieldName);
|
|
$fieldConfig = $fieldType->getConfiguration();
|
|
|
|
if ($fieldType->isType(TableColumnType::INLINE, TableColumnType::FILE)) {
|
|
$foreignTable = (string)($fieldConfig['foreign_table'] ?? '');
|
|
if ($foreignTable === ''
|
|
|| (isset($fieldConfig['behaviour']['enableCascadingDelete'])
|
|
&& (bool)$fieldConfig['behaviour']['enableCascadingDelete'] === false)
|
|
) {
|
|
continue;
|
|
}
|
|
if ($fieldType->getRelationshipType()->isSingularRelationship()) {
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($value, $fieldConfig['foreign_table'], '', (int)$record['uid'], $table, $fieldConfig);
|
|
$dbAnalysis->undeleteRecord = true;
|
|
foreach ($dbAnalysis->itemArray as $relationRecord) {
|
|
$this->discard($relationRecord['table'], (int)$relationRecord['id']);
|
|
}
|
|
}
|
|
} elseif ($this->isReferenceField($fieldConfig) && !empty($fieldConfig['MM'])) {
|
|
$this->discardMmRelations($table, $fieldConfig, $record);
|
|
} elseif ($fieldType->isType(TableColumnType::FLEX) && (string)$value !== '') {
|
|
try {
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$dataStructureIdentifier = $this->flexFormTools->getDataStructureIdentifier(['config' => $fieldConfig], $table, $fieldName, $record, $schema);
|
|
$dataStructureArray = $this->flexFormTools->parseDataStructureByIdentifier($dataStructureIdentifier, $schema);
|
|
} catch (AbstractInvalidDataStructureException) {
|
|
// Nothing to do if data structure could not be determined
|
|
continue;
|
|
}
|
|
if ($dataStructureArray !== []) {
|
|
$flexForm = GeneralUtility::xml2array($value);
|
|
foreach (($dataStructureArray['sheets'] ?? []) as $sheetName => $sheet) {
|
|
foreach ($sheet['ROOT']['el'] as $sheetFieldName => $flexField) {
|
|
$flexFormValue = $flexForm['data'][$sheetName]['lDEF'][$sheetFieldName]['vDEF'] ?? null;
|
|
$flexFieldConfig = $flexField['config'] ?? [];
|
|
if (!isset($flexFieldConfig['type'])) {
|
|
continue;
|
|
}
|
|
if ($flexFieldConfig['type'] === 'inline' || $flexFieldConfig['type'] === 'file') {
|
|
if (in_array($this->getRelationFieldType($flexFieldConfig), ['list', 'field'], true)) {
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($flexFormValue, $flexFieldConfig['foreign_table'], '', (int)$record['uid'], $table, $flexFieldConfig);
|
|
foreach ($dbAnalysis->itemArray as $relationRecord) {
|
|
$this->discard($relationRecord['table'], (int)$relationRecord['id']);
|
|
}
|
|
}
|
|
} elseif ($this->isReferenceField($flexFieldConfig) && !empty($flexFieldConfig['MM'])) {
|
|
$this->discardMmRelations($table, $flexFieldConfig, $record);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* When the to-discard record is the target of a CSV group field of another table record,
|
|
* these records need to be updated to no longer point to the discarded record.
|
|
*
|
|
* Those referencing records are not very easy to find with only the to-discard record being available.
|
|
* The solution used here looks up records referencing the to-discard record by fetching a list of
|
|
* references from sys_refindex, where the to-discard record is on the right side (ref_* fields)
|
|
* and in the workspace the to-discard record lives in. The referencing record fields are then updated
|
|
* to drop the to-discard record from the CSV list.
|
|
*
|
|
* Using sys_refindex for this task is a bit risky: This would fail if a DataHandler call
|
|
* adds a reference to the record and requests discarding the record in one call - the refindex
|
|
* is always only updated at the very end of a DataHandler call, the logic below wouldn't catch
|
|
* this since it would be based on an outdated sys_refindex. The scenario however is of little use and
|
|
* not used in core, so it should be fine.
|
|
*
|
|
* @param string $table Table name of this record
|
|
* @param array $record The record row to handle
|
|
*/
|
|
protected function discardCsvReferencesToRecord(string $table, array $record): void
|
|
{
|
|
// @see test workspaces Group Discard createContentAndCreateElementRelationAndDiscardElement
|
|
// Records referencing the to-discard record.
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable('sys_refindex');
|
|
$statement = $queryBuilder->select('tablename', 'recuid', 'field')
|
|
->from('sys_refindex')
|
|
->where(
|
|
$queryBuilder->expr()->eq('workspace', $queryBuilder->createNamedParameter($record['t3ver_wsid'], Connection::PARAM_INT)),
|
|
$queryBuilder->expr()->eq('ref_table', $queryBuilder->createNamedParameter($table)),
|
|
$queryBuilder->expr()->eq('ref_uid', $queryBuilder->createNamedParameter($record['uid'], Connection::PARAM_INT))
|
|
)
|
|
->executeQuery();
|
|
while ($row = $statement->fetchAssociative()) {
|
|
// For each record referencing the to-discard record, see if it is a CSV group field definition.
|
|
// If so, update that record to drop both the possible "uid" and "table_name_uid" variants from the list.
|
|
if (!$this->tcaSchemaFactory->has($row['tablename']) || !$this->tcaSchemaFactory->get($row['tablename'])->hasField($row['field'])) {
|
|
continue;
|
|
}
|
|
$fieldType = $this->tcaSchemaFactory->get($row['tablename'])->getField($row['field']);
|
|
$fieldTca = $fieldType->getConfiguration();
|
|
$groupAllowed = GeneralUtility::trimExplode(',', $fieldTca['allowed'] ?? '', true);
|
|
// @todo: "select" may be affected too, but it has no coverage to show this, yet?
|
|
if ($fieldType->isType(TableColumnType::GROUP)
|
|
&& empty($fieldTca['MM'])
|
|
&& (in_array('*', $groupAllowed, true) || in_array($table, $groupAllowed, true))
|
|
) {
|
|
// Note it would be possible to a) update multiple records with only one DB call, and b) combine the
|
|
// select and update to a single update query by doing the CSV manipulation as string function in sql.
|
|
// That's harder to get right though and probably not *that* beneficial performance-wise since we're
|
|
// most likely dealing with a very small number of records here anyways. Still, an optimization should
|
|
// be considered after we drop TCA 'prepend_tname' handling and always rely only on "table_name_uid"
|
|
// variant for CSV storage.
|
|
|
|
// Get that record
|
|
$recordReferencingDiscardedRecord = BackendUtility::getRecord($row['tablename'], $row['recuid'], $row['field']);
|
|
if (!$recordReferencingDiscardedRecord) {
|
|
continue;
|
|
}
|
|
// Drop "uid" and "table_name_uid" from list
|
|
$listOfRelatedRecords = GeneralUtility::trimExplode(',', $recordReferencingDiscardedRecord[$row['field']], true);
|
|
$listOfRelatedRecordsWithoutDiscardedRecord = array_diff($listOfRelatedRecords, [$record['uid'], $table . '_' . $record['uid']]);
|
|
if ($listOfRelatedRecords !== $listOfRelatedRecordsWithoutDiscardedRecord) {
|
|
// Update record if list changed
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($row['tablename']);
|
|
$queryBuilder->update($row['tablename'])
|
|
->set($row['field'], implode(',', $listOfRelatedRecordsWithoutDiscardedRecord))
|
|
->where($queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($row['recuid'], Connection::PARAM_INT)))
|
|
->executeStatement();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* When a workspace record row is discarded that has mm relations, existing mm table rows need
|
|
* to be deleted. The method performs the delete operation depending on TCA field configuration.
|
|
*
|
|
* @param string $table Table name of this record
|
|
* @param array $fieldConfig TCA configuration of this field
|
|
* @param array $record The full record of a left- or ride-side relation
|
|
*/
|
|
protected function discardMmRelations(string $table, array $fieldConfig, array $record): void
|
|
{
|
|
$recordUid = (int)$record['uid'];
|
|
$mmTableName = $fieldConfig['MM'];
|
|
// left - non foreign - uid_local vs. right - foreign - uid_foreign decision
|
|
$relationUidFieldName = isset($fieldConfig['MM_opposite_field']) ? 'uid_foreign' : 'uid_local';
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($mmTableName);
|
|
$queryBuilder->delete($mmTableName)->where(
|
|
// uid_local = given uid OR uid_foreign = given uid
|
|
$queryBuilder->expr()->eq($relationUidFieldName, $queryBuilder->createNamedParameter($recordUid, Connection::PARAM_INT))
|
|
);
|
|
if (!empty($fieldConfig['MM_table_where']) && is_string($fieldConfig['MM_table_where'])) {
|
|
$queryBuilder->andWhere(
|
|
QueryHelper::stripLogicalOperatorPrefix(str_replace('###THIS_UID###', (string)$recordUid, QueryHelper::quoteDatabaseIdentifiers($queryBuilder->getConnection(), $fieldConfig['MM_table_where'])))
|
|
);
|
|
}
|
|
$mmMatchFields = $fieldConfig['MM_match_fields'] ?? [];
|
|
foreach ($mmMatchFields as $fieldName => $fieldValue) {
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->eq($fieldName, $queryBuilder->createNamedParameter($fieldValue))
|
|
);
|
|
}
|
|
$queryBuilder->executeStatement();
|
|
|
|
// refindex treatment for mm relation handling: If the to discard record is foreign side of an mm relation,
|
|
// there may be other refindex rows that become obsolete when that record is discarded. See Modify
|
|
// addCategoryRelation sys_category-29->tt_content-298. We thus register an update for references
|
|
// to this item (right side - ref_table, ref_uid) in reference index updater to catch these.
|
|
if ($relationUidFieldName === 'uid_foreign') {
|
|
$this->referenceIndexUpdater->registerUpdateForReferencesToItem($table, $recordUid, (int)$record['t3ver_wsid']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find localization overlays of a record and discard them.
|
|
*
|
|
* @param string $table Table of this record
|
|
* @param array $record Record row
|
|
*/
|
|
protected function discardLocalizationOverlayRecords(string $table, array $record): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!$schema->isLanguageAware()) {
|
|
return;
|
|
}
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$uid = (int)$record['uid'];
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
$statement = $queryBuilder->select('*')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
$languageCapability->getTranslationOriginPointerField()->getName(),
|
|
$queryBuilder->createNamedParameter($uid, Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->eq(
|
|
't3ver_wsid',
|
|
$queryBuilder->createNamedParameter((int)$this->BE_USER->workspace, Connection::PARAM_INT)
|
|
)
|
|
)
|
|
->executeQuery();
|
|
while ($record = $statement->fetchAssociative()) {
|
|
$this->discard($table, null, $record);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a new version of a record if the table is workspace aware.
|
|
*
|
|
* @param int $id Live record uid to create a versioned record from
|
|
* @param string $label Version label
|
|
* @param bool $delete If TRUE, the version is created to delete the record.
|
|
* @return int|null Returns the id of the new version (if any)
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
protected function versionizeRecord($table, $id, $label, $delete = false): ?int
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$id = (int)$id;
|
|
if ($this->isElementToBeDeleted($table, $id)) {
|
|
// Stop if the record is marked to be deleted. Can happen when IRRE elements are versioned and children are removed
|
|
return null;
|
|
}
|
|
if (!$schema->isWorkspaceAware() || $id <= 0) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Versioning is not supported for this table {table}:{uid}', null, ['table' => $table, 'uid' => (int)$id]);
|
|
return null;
|
|
}
|
|
|
|
$row = BackendUtility::getRecord($table, $id);
|
|
if (!is_array($row)) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to create workspace version of "{table}:{uid}" which does not exist', null, ['table' => $table, 'uid' => (int)$id]);
|
|
return null;
|
|
}
|
|
if (((int)($row['t3ver_oid'] ?? 0)) > 0) {
|
|
// Reject "version of a version" before workspaceOL(): a current-workspace overlay
|
|
// legitimately has t3ver_oid > 0 and is handled by the early return further down.
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Record "{table}:{uid}" you wanted to versionize was already a version in archive (record has an online ID)', null, ['table' => $table, 'uid' => (int)$id]);
|
|
return null;
|
|
}
|
|
BackendUtility::workspaceOL($table, $row, $this->BE_USER->workspace);
|
|
if ($table === 'pages') {
|
|
$pageRecord = $row;
|
|
} elseif ((int)$row['pid'] > 0) {
|
|
$pageRecord = BackendUtility::getRecord('pages', $row['pid']);
|
|
if (!is_array($pageRecord)) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to create workspace version of "{table}:{uid}" which is not assigned to a valid page', null, ['table' => $table, 'uid' => (int)$id]);
|
|
return null;
|
|
}
|
|
} else {
|
|
$pageRecord = VirtualRecord::RootPage;
|
|
}
|
|
if (!$this->hasPageContextPermission($table, Permission::PAGE_SHOW, $pageRecord)) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to create workspace version of "{table}:{uid}" without read permissions', null, ['table' => $table, 'uid' => (int)$id]);
|
|
return null;
|
|
}
|
|
if ($delete) {
|
|
if ($table === 'pages') {
|
|
$pagesLanguageCapability = $this->tcaSchemaFactory->get('pages')->getCapability(TcaSchemaCapability::Language);
|
|
$pagesLocalizationParentFieldName = $pagesLanguageCapability->getTranslationOriginPointerField()->getName();
|
|
$pagesLocalizationParent = (int)($pageRecord[$pagesLocalizationParentFieldName] ?? 0);
|
|
$defaultLanguagePage = $pageRecord;
|
|
$subPages = [];
|
|
if ($pagesLocalizationParent === 0) {
|
|
// When deleting a default language page, user has to have delete permission on subpages as well.
|
|
$subPages = $this->getSubPagesOfPage($id);
|
|
} else {
|
|
$defaultLanguagePage = BackendUtility::getRecord('pages', $pagesLocalizationParent, '*', '', false);
|
|
if ($defaultLanguagePage === null) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::DELETE, null, SystemLogErrorClassification::SYSTEM_ERROR, 'Can not delete localized "pages:{uid}" in workspaces, default language page record "pages:{localizationParent}" not found', null, ['uid' => $id, 'localizationParent' => $pagesLocalizationParent], 0);
|
|
return null;
|
|
}
|
|
}
|
|
if (is_string($pageDeletePermissionError = $this->canDeletePage($pageRecord, $defaultLanguagePage, $subPages))) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Record {table}:{uid} cannot be deleted: {reason}', null, ['table' => $table, 'uid' => (int)$id, 'reason' => $pageDeletePermissionError]);
|
|
return null;
|
|
}
|
|
} else {
|
|
$perms = Permission::CONTENT_EDIT;
|
|
if ($table === 'sys_file_reference' && array_key_exists('pages', $this->datamap)) {
|
|
// @todo: find a more generic way to handle content relations of a page (without needing content editing access to that page)
|
|
$perms = Permission::PAGE_EDIT;
|
|
}
|
|
if (!$this->hasPageContextPermission($table, $perms, $pageRecord)) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::VERSIONIZE, null, SystemLogErrorClassification::USER_ERROR, 'Record {table}:{uid} cannot be deleted due to missing edit permissions', null, ['table' => $table, 'uid' => (int)$id]);
|
|
return null;
|
|
}
|
|
}
|
|
}
|
|
if ($this->BE_USER->workspace <= 0) {
|
|
// User must be in workspace at this point, we may otherwise end up with workspace related records in live.
|
|
// @todo: Maybe raise this to an exception?
|
|
return null;
|
|
}
|
|
|
|
// Check if the record already has a version in the current workspace of the backend user
|
|
$versionRecord = BackendUtility::getWorkspaceVersionOfRecord($this->BE_USER->workspace, $table, $id, 'uid');
|
|
if ($versionRecord) {
|
|
return (int)$versionRecord['uid'];
|
|
}
|
|
|
|
// Create new version of the record and return the new uid
|
|
// The information of the label to be used for the workspace record
|
|
// as well as the information whether the record shall be removed
|
|
// must be forwarded (creating delete placeholders on a workspace are
|
|
// done by copying the record and override several fields).
|
|
$overrideArray = [
|
|
't3ver_oid' => $id,
|
|
't3ver_wsid' => $this->BE_USER->workspace,
|
|
't3ver_state' => $delete ? VersionState::DELETE_PLACEHOLDER->value : VersionState::DEFAULT_STATE->value,
|
|
't3ver_stage' => 0,
|
|
];
|
|
if ($schema->hasCapability(TcaSchemaCapability::EditLock)) {
|
|
$overrideArray[$schema->getCapability(TcaSchemaCapability::EditLock)->getFieldName()] = 0;
|
|
}
|
|
$workspaceOptions = [
|
|
'delete' => $delete,
|
|
'label' => $label,
|
|
];
|
|
return $this->copyRecord_raw($table, $id, (int)$row['pid'], $overrideArray, $workspaceOptions);
|
|
}
|
|
|
|
/**
|
|
* Handle MM relations attached to a record when publishing a workspace record.
|
|
*
|
|
* Strategy:
|
|
* * Find all MM tables the record can be attached to by scanning TCA. Handle
|
|
* flex form "first level" fields too, but skip scanning for MM relations in
|
|
* container sections, since core does not support that since v7 - FormEngine
|
|
* throws an exception in this case.
|
|
* * For each found MM table: Delete current MM rows of the live record, and
|
|
* update MM rows of the workspace record to now point to the live record.
|
|
*
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function versionPublishManyToManyRelations(string $table, array $liveRecord, array $workspaceRecord, int $fromWorkspace): void
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table)) {
|
|
return;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$toDeleteRegistry = [];
|
|
$toUpdateRegistry = [];
|
|
foreach ($schema->getFields() as $fieldType) {
|
|
$dbFieldConfig = $fieldType->getConfiguration();
|
|
if (!empty($dbFieldConfig['MM']) && $this->isReferenceField($dbFieldConfig)) {
|
|
$toDeleteRegistry[] = $dbFieldConfig;
|
|
$toUpdateRegistry[] = $dbFieldConfig;
|
|
}
|
|
if ($fieldType->isType(TableColumnType::FLEX)) {
|
|
// Find possible mm tables attached to live record flex from data structures, mark as to delete
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$dataStructureIdentifier = $this->flexFormTools->getDataStructureIdentifier(['config' => $dbFieldConfig], $table, $fieldType->getName(), $liveRecord, $schema);
|
|
$dataStructureArray = $this->flexFormTools->parseDataStructureByIdentifier($dataStructureIdentifier, $schema);
|
|
foreach (($dataStructureArray['sheets'] ?? []) as $flexSheetDefinition) {
|
|
foreach (($flexSheetDefinition['ROOT']['el'] ?? []) as $flexFieldDefinition) {
|
|
if (is_array($flexFieldDefinition) && $this->flexFieldDefinitionIsMmRelation($flexFieldDefinition)) {
|
|
$toDeleteRegistry[] = $flexFieldDefinition['config'];
|
|
}
|
|
}
|
|
}
|
|
// Find possible mm tables attached to workspace record flex from data structures, mark as to update uid
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$dataStructureIdentifier = $this->flexFormTools->getDataStructureIdentifier(['config' => $dbFieldConfig], $table, $fieldType->getName(), $workspaceRecord, $schema);
|
|
$dataStructureArray = $this->flexFormTools->parseDataStructureByIdentifier($dataStructureIdentifier, $schema);
|
|
foreach (($dataStructureArray['sheets'] ?? []) as $flexSheetDefinition) {
|
|
foreach (($flexSheetDefinition['ROOT']['el'] ?? []) as $flexFieldDefinition) {
|
|
if (is_array($flexFieldDefinition) && $this->flexFieldDefinitionIsMmRelation($flexFieldDefinition)) {
|
|
$toUpdateRegistry[] = $flexFieldDefinition['config'];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Delete mm table relations of live record
|
|
foreach ($toDeleteRegistry as $config) {
|
|
$uidFieldName = $this->mmRelationIsLocalSide($config) ? 'uid_local' : 'uid_foreign';
|
|
$mmTableName = $config['MM'];
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($mmTableName);
|
|
$queryBuilder->delete($mmTableName);
|
|
$queryBuilder->where($queryBuilder->expr()->eq(
|
|
$uidFieldName,
|
|
$queryBuilder->createNamedParameter((int)$liveRecord['uid'], Connection::PARAM_INT)
|
|
));
|
|
if ($this->mmQueryShouldUseTablenamesColumn($config)) {
|
|
$queryBuilder->andWhere($queryBuilder->expr()->eq(
|
|
'tablenames',
|
|
$queryBuilder->createNamedParameter($table)
|
|
));
|
|
}
|
|
$queryBuilder->executeStatement();
|
|
}
|
|
|
|
// Update mm table relations of workspace record to uid of live record
|
|
foreach ($toUpdateRegistry as $config) {
|
|
$mmRelationIsLocalSide = $this->mmRelationIsLocalSide($config);
|
|
$uidFieldName = $mmRelationIsLocalSide ? 'uid_local' : 'uid_foreign';
|
|
$mmTableName = $config['MM'];
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($mmTableName);
|
|
$queryBuilder->update($mmTableName);
|
|
$queryBuilder->set($uidFieldName, (int)$liveRecord['uid'], true, Connection::PARAM_INT);
|
|
$queryBuilder->where($queryBuilder->expr()->eq(
|
|
$uidFieldName,
|
|
$queryBuilder->createNamedParameter((int)$workspaceRecord['uid'], Connection::PARAM_INT)
|
|
));
|
|
if ($this->mmQueryShouldUseTablenamesColumn($config)) {
|
|
$queryBuilder->andWhere($queryBuilder->expr()->eq(
|
|
'tablenames',
|
|
$queryBuilder->createNamedParameter($table)
|
|
));
|
|
}
|
|
$queryBuilder->executeStatement();
|
|
|
|
if (!$mmRelationIsLocalSide) {
|
|
// refindex treatment for mm relation handling: If the to publish record is foreign side of an mm relation, we need
|
|
// to instruct refindex updater to update all local side references for the live record the current workspace record
|
|
// has on foreign side. See ManyToMany Publish addCategoryRelation, this will create the sys_category-31->tt_content-297 entry.
|
|
$this->referenceIndexUpdater->registerUpdateForReferencesToItem($table, (int)$workspaceRecord['uid'], $fromWorkspace, 0);
|
|
// Similar, when in mm foreign side and relations are deleted in live during publish, other relations pointing to the
|
|
// same local side record may need updates due to different sorting, and the former refindex entry of the live record
|
|
// needs updates. See ManyToMany Publish deleteCategoryRelation scenario.
|
|
$this->referenceIndexUpdater->registerUpdateForReferencesToItem($table, (int)$liveRecord['uid'], 0);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find out if a given flex field definition is a relation with an MM relation.
|
|
* Helper of versionPublishManyToManyRelations().
|
|
*/
|
|
private function flexFieldDefinitionIsMmRelation(array $flexFieldDefinition): bool
|
|
{
|
|
return ($flexFieldDefinition['type'] ?? '') !== 'array' // is a field, not a section
|
|
&& is_array($flexFieldDefinition['config'] ?? false) // config array exists
|
|
&& $this->isReferenceField($flexFieldDefinition['config']) // select, group, category
|
|
&& !empty($flexFieldDefinition['config']['MM']); // MM exists
|
|
}
|
|
|
|
/**
|
|
* Find out if a query to an MM table should have a "tablenames=myTable" where. This
|
|
* is the case if we're looking at it from the foreign side and if the table must have
|
|
* "tablenames" column due to various TCA combinations.
|
|
* Helper of versionPublishManyToManyRelations().
|
|
*/
|
|
private function mmQueryShouldUseTablenamesColumn(array $config): bool
|
|
{
|
|
if ($this->mmRelationIsLocalSide($config)) {
|
|
return false;
|
|
}
|
|
|
|
if ($config['type'] === 'group' && !empty($config['prepend_tname'])) {
|
|
// prepend_tname in MM on foreign side forces 'tablenames' column
|
|
// @todo: See if we can get rid of prepend_tname in MM altogether?
|
|
return true;
|
|
}
|
|
if ($config['type'] === 'group' && is_string($config['allowed'] ?? false)
|
|
&& (str_contains($config['allowed'], ',') || $config['allowed'] === '*')
|
|
) {
|
|
// 'allowed' with *, or more than one table
|
|
// @todo: Neither '*' nor 'multiple tables' make sense for MM on foreign side.
|
|
// There is a hint in the docs about this, too. Sanitize in TCA bootstrap?!
|
|
return true;
|
|
}
|
|
$localSideTableName = $config['type'] === 'group' ? $config['allowed'] ?? '' : $config['foreign_table'] ?? '';
|
|
$localSideFieldName = $config['MM_opposite_field'] ?? '';
|
|
if (!$this->tcaSchemaFactory->has($localSideTableName) || !$this->tcaSchemaFactory->get($localSideTableName)->hasField($localSideFieldName)) {
|
|
return false;
|
|
}
|
|
$localSideField = $this->tcaSchemaFactory->get($localSideTableName)->getField($localSideFieldName);
|
|
$localSideAllowed = $localSideField->getConfiguration()['allowed'] ?? '';
|
|
// Local side with 'allowed' = '*' or multiple tables forces 'tablenames' column
|
|
return $localSideAllowed === '*' || str_contains($localSideAllowed, ',');
|
|
}
|
|
|
|
/**
|
|
* Find out if we're looking at an MM relation from local or foreign side.
|
|
* Helper of versionPublishManyToManyRelations().
|
|
*/
|
|
private function mmRelationIsLocalSide(array $config): bool
|
|
{
|
|
return empty($config['MM_opposite_field']);
|
|
}
|
|
|
|
/**
|
|
* Returns an instance of DataHandler for handling local datamaps/cmdmaps
|
|
*/
|
|
protected function getLocalTCE(): DataHandler
|
|
{
|
|
$copyTCE = GeneralUtility::makeInstance(DataHandler::class);
|
|
$copyTCE->enableLogging = $this->enableLogging;
|
|
// Transformations should NOT be carried out during copy
|
|
$copyTCE->dontProcessTransformations = true;
|
|
// make sure the isImporting flag is transferred, so all hooks know if
|
|
// the current process is an import process
|
|
$copyTCE->isImporting = $this->isImporting;
|
|
$copyTCE->bypassAccessCheckForRecords = $this->bypassAccessCheckForRecords;
|
|
return $copyTCE;
|
|
}
|
|
|
|
/**
|
|
* Processes the fields with references as registered during the copy process. This includes all FlexForm fields which had references.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function remapListedDBRecords(): void
|
|
{
|
|
if (!empty($this->registerDBList)) {
|
|
foreach ($this->registerDBList as $table => $records) {
|
|
foreach ($records as $uid => $fields) {
|
|
$newData = [];
|
|
$theUidToUpdate = $this->copyMappingArray_merged[$table][$uid] ?? null;
|
|
$theUidToUpdate_saveTo = BackendUtility::wsMapId($table, $theUidToUpdate);
|
|
foreach ($fields as $fieldName => $value) {
|
|
$fieldType = $this->tcaSchemaFactory->get($table)->getField($fieldName);
|
|
switch ($fieldType->getType()) {
|
|
case 'group':
|
|
case 'select':
|
|
case 'category':
|
|
$vArray = $this->remapListedDBRecords_procDBRefs($fieldType->getConfiguration(), $value, $theUidToUpdate, $table);
|
|
if (is_array($vArray)) {
|
|
$newData[$fieldName] = implode(',', $vArray);
|
|
}
|
|
break;
|
|
case 'flex':
|
|
if ($value === 'FlexForm_reference') {
|
|
// This will fetch the new row for the element
|
|
$origRecordRow = BackendUtility::getRecord($table, $theUidToUpdate, '*', '', false);
|
|
if (is_array($origRecordRow)) {
|
|
BackendUtility::workspaceOL($table, $origRecordRow, $this->BE_USER->workspace);
|
|
// Get current data structure and value array:
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$dataStructureIdentifier = $this->flexFormTools->getDataStructureIdentifier(
|
|
['config' => $fieldType->getConfiguration()],
|
|
$table,
|
|
$fieldName,
|
|
$origRecordRow,
|
|
$schema
|
|
);
|
|
$dataStructureArray = $this->flexFormTools->parseDataStructureByIdentifier($dataStructureIdentifier, $schema);
|
|
$currentValueArray = GeneralUtility::xml2array($origRecordRow[$fieldName]);
|
|
// Do recursive processing of the XML data:
|
|
$currentValueArray['data'] = $this->remapFlexFormDBRelations($currentValueArray['data'], $dataStructureArray, $table, $theUidToUpdate);
|
|
// The return value should be compiled back into XML, ready to insert directly in the field (as we call updateDB() directly later):
|
|
if (is_array($currentValueArray['data'])) {
|
|
$newData[$fieldName] = $this->flexFormTools->flexArray2Xml($currentValueArray);
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
case 'inline':
|
|
$this->remapListedDBRecords_procInline($fieldType->getConfiguration(), $value, $uid, $table);
|
|
break;
|
|
case 'file':
|
|
$this->remapListedDBRecords_procFile($fieldType->getConfiguration(), $value, $uid, $table);
|
|
break;
|
|
default:
|
|
$this->logger->debug('Field type should not appear here: {type}', ['type' => $fieldType->getType()]);
|
|
}
|
|
}
|
|
// If any fields were changed, those fields are updated!
|
|
if (!empty($newData)) {
|
|
// @todo: It would be better to have the current record at hand here already, at least its pid.
|
|
// This will require changing structure of $this->registerDBList.
|
|
$currentRecord = BackendUtility::getRecord($table, $theUidToUpdate_saveTo, 'pid', '', false);
|
|
if (!empty($currentRecord)) {
|
|
// @todo: For some reason, $this->registerDBList may contain records that do not exist in database
|
|
// anymore, so BU::getRecord() above may return null. Find out why/how this happens.
|
|
$this->updateDB($table, $theUidToUpdate_saveTo, $newData, (int)$currentRecord['pid']);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Remap old copied UIDs to new UIDs for DB reference fields inside a FlexForm data array.
|
|
*/
|
|
private function remapFlexFormDBRelations(array $data, array $dataStructure, string $table, mixed $uid): array
|
|
{
|
|
foreach ($dataStructure['sheets'] as $sheetKey => $sheetData) {
|
|
foreach (($sheetData['ROOT']['el'] ?? []) as $sheetElementKey => $sheetElementTca) {
|
|
if (($sheetElementTca['type'] ?? '') === 'array') {
|
|
// Section element.
|
|
if (!is_array($sheetElementTca['el'] ?? false) || !is_array($data[$sheetKey]['lDEF'][$sheetElementKey]['el'] ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($data[$sheetKey]['lDEF'][$sheetElementKey]['el'] as $valueSectionContainerKey => $valueSectionContainers) {
|
|
if (!is_array($valueSectionContainers ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($valueSectionContainers as $valueContainerType => $valueContainerElements) {
|
|
if (!is_array($sheetElementTca['el'][$valueContainerType]['el'] ?? false)) {
|
|
continue;
|
|
}
|
|
foreach ($sheetElementTca['el'][$valueContainerType]['el'] as $containerElement => $containerElementTca) {
|
|
if (!isset($data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'])) {
|
|
continue;
|
|
}
|
|
$fieldConfig = $containerElementTca['config'] ?? [];
|
|
$fieldValue = $data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF'];
|
|
if ($this->isReferenceField($fieldConfig) && (string)$fieldValue !== '') {
|
|
$vArray = $this->remapListedDBRecords_procDBRefs($fieldConfig, $fieldValue, $uid, $table);
|
|
if (is_array($vArray)) {
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['el'][$valueSectionContainerKey][$valueContainerType]['el'][$containerElement]['vDEF']
|
|
= implode(',', $vArray);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif (isset($data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'])) {
|
|
// Simple field element.
|
|
$fieldConfig = $sheetElementTca['config'] ?? [];
|
|
$fieldValue = $data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'];
|
|
if ($this->isReferenceField($fieldConfig) && (string)$fieldValue !== '') {
|
|
$vArray = $this->remapListedDBRecords_procDBRefs($fieldConfig, $fieldValue, $uid, $table);
|
|
if (is_array($vArray)) {
|
|
$data[$sheetKey]['lDEF'][$sheetElementKey]['vDEF'] = implode(',', $vArray);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Performs remapping of old UID values to NEW uid values for a DB reference field.
|
|
*
|
|
* @param array $conf TCA field config
|
|
* @param string $value Field value
|
|
* @param int $MM_localUid UID of local record (for MM relations - might need to change if support for FlexForms should be done!)
|
|
* @param string $table Table name
|
|
* @return array|null Returns array of items ready to implode for field content.
|
|
* @see remapListedDBRecords()
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function remapListedDBRecords_procDBRefs($conf, $value, $MM_localUid, $table)
|
|
{
|
|
// Initialize variables
|
|
// Will be set TRUE if an upgrade should be done...
|
|
$set = false;
|
|
// Allowed tables for references.
|
|
$allowedTables = $conf['type'] === 'group' ? $conf['allowed'] : $conf['foreign_table'];
|
|
// Table name to prepend the UID
|
|
$prependName = $conf['type'] === 'group' ? ($conf['prepend_tname'] ?? '') : '';
|
|
// Which tables that should possibly not be remapped
|
|
$dontRemapTables = GeneralUtility::trimExplode(',', $conf['dontRemapTablesOnCopy'] ?? '', true);
|
|
// Convert value to list of references:
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->registerNonTableValues = $conf['type'] === 'select' && ($conf['allowNonIdValues'] ?? false);
|
|
$dbAnalysis->start($value, $allowedTables, $conf['MM'] ?? '', $MM_localUid, $table, $conf);
|
|
// Traverse those references and map IDs:
|
|
foreach ($dbAnalysis->itemArray as $k => $v) {
|
|
$mapID = $this->copyMappingArray_merged[$v['table']][$v['id']] ?? 0;
|
|
if ($mapID && !in_array($v['table'], $dontRemapTables, true)) {
|
|
$dbAnalysis->itemArray[$k]['id'] = $mapID;
|
|
$set = true;
|
|
}
|
|
}
|
|
if (!empty($conf['MM'])) {
|
|
// Purge invalid items (live/version)
|
|
$dbAnalysis->purgeItemArray();
|
|
if ($dbAnalysis->isPurged()) {
|
|
$set = true;
|
|
}
|
|
// If record has been versioned/copied in this process, handle invalid relations of the live record
|
|
$liveId = BackendUtility::getLiveVersionIdOfRecord($table, $MM_localUid);
|
|
$originalId = 0;
|
|
if (!empty($this->copyMappingArray_merged[$table])) {
|
|
$originalId = array_search($MM_localUid, $this->copyMappingArray_merged[$table]);
|
|
}
|
|
if (!empty($liveId) && !empty($originalId) && (int)$liveId === (int)$originalId) {
|
|
$liveRelations = $this->createRelationHandlerInstance();
|
|
$liveRelations->setWorkspaceId(0);
|
|
$liveRelations->start('', $allowedTables, $conf['MM'], $liveId, $table, $conf);
|
|
// Purge invalid relations in the live workspace ("0")
|
|
$liveRelations->purgeItemArray(0);
|
|
if ($liveRelations->isPurged()) {
|
|
$liveRelations->writeMM($conf['MM'], $liveId, $prependName);
|
|
}
|
|
}
|
|
}
|
|
// If a change has been done, set the new value(s)
|
|
if ($set) {
|
|
if ($conf['MM'] ?? false) {
|
|
$dbAnalysis->writeMM($conf['MM'], $MM_localUid, $prependName);
|
|
} else {
|
|
return $dbAnalysis->getValueArray($prependName);
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Performs remapping of old UID values to NEW uid values for an inline field.
|
|
*
|
|
* @param array $conf TCA field config
|
|
* @param string $value Field value
|
|
* @param int $uid The uid of the ORIGINAL record
|
|
* @param string $table Table name
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function remapListedDBRecords_procInline($conf, $value, $uid, $table): void
|
|
{
|
|
$theUidToUpdate = $this->copyMappingArray_merged[$table][$uid] ?? null;
|
|
if ($conf['foreign_table']) {
|
|
$relationFieldType = $this->getRelationFieldType($conf);
|
|
if ($relationFieldType === 'mm') {
|
|
$this->remapListedDBRecords_procDBRefs($conf, $value, $theUidToUpdate, $table);
|
|
} elseif ($relationFieldType !== false) {
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($value, $conf['foreign_table'], '', 0, $table, $conf);
|
|
|
|
$updatePidForRecords = [];
|
|
// Update values for specific versioned records
|
|
foreach ($dbAnalysis->itemArray as &$item) {
|
|
$updatePidForRecords[$item['table']][] = $item['id'];
|
|
$versionedId = $this->getAutoVersionId($item['table'], $item['id']);
|
|
if ($versionedId !== null) {
|
|
$updatePidForRecords[$item['table']][] = $versionedId;
|
|
$item['id'] = $versionedId;
|
|
}
|
|
}
|
|
|
|
// Update child records if using pointer fields ('foreign_field'):
|
|
if ($relationFieldType === 'field') {
|
|
$dbAnalysis->writeForeignField($conf, $uid, $theUidToUpdate);
|
|
}
|
|
$thePidToUpdate = null;
|
|
// If the current field is set on a page record, update the pid of related child records:
|
|
if ($table === 'pages') {
|
|
$thePidToUpdate = $theUidToUpdate;
|
|
} elseif (isset($this->registerDBPids[$table][$uid])) {
|
|
$thePidToUpdate = $this->registerDBPids[$table][$uid];
|
|
$thePidToUpdate = $this->copyMappingArray_merged['pages'][$thePidToUpdate] ?? null;
|
|
}
|
|
|
|
// Update child records if change to pid is required
|
|
if ($thePidToUpdate && !empty($updatePidForRecords)) {
|
|
// Ensure that only the default language page is used as PID
|
|
$thePidToUpdate = $this->getDefaultLanguagePageId($thePidToUpdate);
|
|
// @todo: this can probably go away
|
|
// ensure, only live page ids are used as 'pid' values
|
|
$liveId = BackendUtility::getLiveVersionIdOfRecord('pages', $theUidToUpdate);
|
|
if ($liveId !== null) {
|
|
$thePidToUpdate = $liveId;
|
|
}
|
|
$updateValues = ['pid' => $thePidToUpdate];
|
|
foreach ($updatePidForRecords as $tableName => $uids) {
|
|
if (empty($tableName)) {
|
|
continue;
|
|
}
|
|
$conn = $this->connectionPool->getConnectionForTable($tableName);
|
|
foreach ($uids as $updateUid) {
|
|
$conn->update($tableName, $updateValues, ['uid' => $updateUid]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Performs remapping of old UID values to NEW uid values for an file field.
|
|
*
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function remapListedDBRecords_procFile($conf, $value, $uid, $table): void
|
|
{
|
|
$thePidToUpdate = null;
|
|
$updatePidForRecords = [];
|
|
$theUidToUpdate = $this->copyMappingArray_merged[$table][$uid] ?? null;
|
|
|
|
$dbAnalysis = $this->createRelationHandlerInstance();
|
|
$dbAnalysis->start($value, $conf['foreign_table'], '', 0, $table, $conf);
|
|
|
|
foreach ($dbAnalysis->itemArray as &$item) {
|
|
$updatePidForRecords[$item['table']][] = $item['id'];
|
|
$versionedId = $this->getAutoVersionId($item['table'], $item['id']);
|
|
if ($versionedId !== null) {
|
|
$updatePidForRecords[$item['table']][] = $versionedId;
|
|
$item['id'] = $versionedId;
|
|
}
|
|
}
|
|
unset($item);
|
|
|
|
$dbAnalysis->writeForeignField($conf, $uid, $theUidToUpdate);
|
|
|
|
if ($table === 'pages') {
|
|
$thePidToUpdate = $theUidToUpdate;
|
|
} elseif (isset($this->registerDBPids[$table][$uid])) {
|
|
$thePidToUpdate = $this->registerDBPids[$table][$uid];
|
|
$thePidToUpdate = $this->copyMappingArray_merged['pages'][$thePidToUpdate] ?? null;
|
|
}
|
|
|
|
if ($thePidToUpdate && $updatePidForRecords !== []) {
|
|
$thePidToUpdate = $this->getDefaultLanguagePageId($thePidToUpdate);
|
|
$liveId = BackendUtility::getLiveVersionIdOfRecord('pages', $theUidToUpdate);
|
|
if ($liveId !== null) {
|
|
$thePidToUpdate = $liveId;
|
|
}
|
|
$updateValues = ['pid' => $thePidToUpdate];
|
|
foreach ($updatePidForRecords as $tableName => $uids) {
|
|
if (empty($tableName)) {
|
|
continue;
|
|
}
|
|
$conn = $this->connectionPool->getConnectionForTable($tableName);
|
|
foreach ($uids as $updateUid) {
|
|
$conn->update($tableName, $updateValues, ['uid' => $updateUid]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Processes the $this->remapStack at the end of copying, inserting, etc. actions.
|
|
* The remapStack takes care about the correct mapping of new and old uids in case of relational data.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function processRemapStack(): void
|
|
{
|
|
// Processes the remap stack:
|
|
$remapFlexForms = [];
|
|
$hookPayload = [];
|
|
|
|
$newValue = null;
|
|
foreach ($this->remapStack as $remapAction) {
|
|
// If no position index for the arguments was set, skip this remap action:
|
|
if (!is_array($remapAction['pos'])) {
|
|
continue;
|
|
}
|
|
// Load values from the argument array in remapAction:
|
|
$isNew = false;
|
|
$field = $remapAction['field'];
|
|
$id = $remapAction['args'][$remapAction['pos']['id']];
|
|
$rawId = $id;
|
|
$table = $remapAction['args'][$remapAction['pos']['table']];
|
|
$valueArray = $remapAction['args'][$remapAction['pos']['valueArray']];
|
|
$tcaFieldConf = $remapAction['args'][$remapAction['pos']['tcaFieldConf']];
|
|
$additionalData = $remapAction['additionalData'] ?? [];
|
|
// The record is new and has one or more new ids (in case of versioning/workspaces):
|
|
if (str_contains($id, 'NEW')) {
|
|
$isNew = true;
|
|
// Replace NEW...-ID with real uid:
|
|
$id = $this->substNEWwithIDs[$id] ?? '';
|
|
// If the new parent record is on a non-live workspace or versionized, it has another new id:
|
|
if (isset($this->autoVersionIdMap[$table][$id])) {
|
|
$id = $this->autoVersionIdMap[$table][$id];
|
|
}
|
|
$remapAction['args'][$remapAction['pos']['id']] = $id;
|
|
}
|
|
// Replace relations to NEW...-IDs in field value (uids of child records):
|
|
if (is_array($valueArray)) {
|
|
foreach ($valueArray as $key => $value) {
|
|
if (str_contains($value, 'NEW')) {
|
|
if (!str_contains($value, '_')) {
|
|
$affectedTable = $tcaFieldConf['foreign_table'] ?? '';
|
|
$prependTable = false;
|
|
} else {
|
|
$parts = explode('_', $value);
|
|
$value = array_pop($parts);
|
|
$affectedTable = implode('_', $parts);
|
|
$prependTable = true;
|
|
}
|
|
$value = $this->substNEWwithIDs[$value] ?? '';
|
|
// The record is new, but was also auto-versionized and has another new id:
|
|
if (isset($this->autoVersionIdMap[$affectedTable][$value])) {
|
|
$value = $this->autoVersionIdMap[$affectedTable][$value];
|
|
}
|
|
if ($prependTable) {
|
|
$value = $affectedTable . '_' . $value;
|
|
}
|
|
// Set a hint that this was a new child record:
|
|
$this->newRelatedIDs[$affectedTable][] = $value;
|
|
$valueArray[$key] = $value;
|
|
}
|
|
}
|
|
$remapAction['args'][$remapAction['pos']['valueArray']] = $valueArray;
|
|
}
|
|
// Process the arguments with the defined function:
|
|
if (!empty($remapAction['func'])) {
|
|
$callable = [$this, $remapAction['func']];
|
|
if (is_callable($callable)) {
|
|
$newValue = $callable(...$remapAction['args']);
|
|
}
|
|
}
|
|
// If array is returned, check for maxitems condition, if string is returned this was already done:
|
|
if (is_array($newValue)) {
|
|
$newValue = implode(',', $this->checkValue_checkMax($tcaFieldConf, $newValue));
|
|
// The reference casting is only required if
|
|
// checkValue_group_select_processDBdata() returns an array
|
|
$newValue = $this->castReferenceValue($newValue, $tcaFieldConf, $isNew);
|
|
}
|
|
// Update in database (list of children (csv) or number of relations (foreign_field)):
|
|
if (!empty($field)) {
|
|
$fieldArray = [$field => $newValue];
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if ($schema->hasCapability(TcaSchemaCapability::UpdatedAt)) {
|
|
$fieldArray[$schema->getCapability(TcaSchemaCapability::UpdatedAt)->getFieldName()] = $GLOBALS['EXEC_TIME'];
|
|
}
|
|
// @todo: It would be better if we'd receive at least the pid somehow here without fetching
|
|
// the record again. OTOH, we could also reduce this overhead by getting rid of the
|
|
// "parent count" fields altogether, but that's a much more intrusive change.
|
|
// For now, we BU::getRecord() the current record explicitly to determine the current
|
|
// pid, which is needed at least for proper log records, plus it could make cache
|
|
// clearing in updateDB() more effective if used systematically.
|
|
$currentRecord = BackendUtility::getRecord($table, $id, '*', '', false);
|
|
if (!empty($currentRecord)) {
|
|
$this->updateDB($table, $id, $fieldArray, (int)$currentRecord['pid']);
|
|
}
|
|
} elseif (!empty($additionalData['flexFormId']) && !empty($additionalData['flexFormPath'])) {
|
|
// Collect data to update FlexForms
|
|
$flexFormId = $additionalData['flexFormId'];
|
|
$flexFormPath = $additionalData['flexFormPath'];
|
|
|
|
if (!isset($remapFlexForms[$flexFormId])) {
|
|
$remapFlexForms[$flexFormId] = [];
|
|
}
|
|
|
|
$remapFlexForms[$flexFormId][$flexFormPath] = $newValue;
|
|
}
|
|
|
|
// Collect elements that shall trigger processDatamap_afterDatabaseOperations
|
|
if (isset($this->remapStackRecords[$table][$rawId]['processDatamap_afterDatabaseOperations'])) {
|
|
$hookArgs = $this->remapStackRecords[$table][$rawId]['processDatamap_afterDatabaseOperations'];
|
|
if (!isset($hookPayload[$table][$rawId])) {
|
|
$hookPayload[$table][$rawId] = [
|
|
'status' => $hookArgs['status'],
|
|
'fieldArray' => $hookArgs['fieldArray'],
|
|
'hookObjects' => $hookArgs['hookObjectsArr'],
|
|
];
|
|
}
|
|
$hookPayload[$table][$rawId]['fieldArray'][$field] = $newValue;
|
|
}
|
|
}
|
|
|
|
if ($remapFlexForms) {
|
|
foreach ($remapFlexForms as $flexFormId => $modifications) {
|
|
$this->updateFlexFormData((string)$flexFormId, $modifications);
|
|
}
|
|
}
|
|
|
|
foreach ($hookPayload as $tableName => $rawIdPayload) {
|
|
foreach ($rawIdPayload as $rawId => $payload) {
|
|
foreach ($payload['hookObjects'] as $hookObject) {
|
|
if (!method_exists($hookObject, 'processDatamap_afterDatabaseOperations')) {
|
|
continue;
|
|
}
|
|
$hookObject->processDatamap_afterDatabaseOperations(
|
|
$payload['status'],
|
|
$tableName,
|
|
$rawId,
|
|
$payload['fieldArray'],
|
|
$this
|
|
);
|
|
}
|
|
}
|
|
}
|
|
// Processes the remap stack actions:
|
|
foreach ($this->remapStackActions as $action) {
|
|
if (isset($action['callback'], $action['arguments'])) {
|
|
$action['callback'](...$action['arguments']);
|
|
}
|
|
}
|
|
// Reset:
|
|
$this->remapStack = [];
|
|
$this->remapStackRecords = [];
|
|
$this->remapStackActions = [];
|
|
}
|
|
|
|
/**
|
|
* Updates FlexForm data.
|
|
*
|
|
* @param string $flexFormId e.g. <table>:<uid>:<field>
|
|
* @param array $modifications Modifications with paths and values (e.g. 'sDEF/lDEV/field/vDEF' => 'TYPO3')
|
|
*/
|
|
protected function updateFlexFormData($flexFormId, array $modifications): void
|
|
{
|
|
[$table, $uid, $field] = explode(':', $flexFormId, 3);
|
|
if (!MathUtility::canBeInterpretedAsInteger($uid) && !empty($this->substNEWwithIDs[$uid])) {
|
|
$uid = $this->substNEWwithIDs[$uid];
|
|
}
|
|
$record = BackendUtility::getRecord($table, $uid, '*', '', false);
|
|
if (!$table || !$uid || !$field || !is_array($record)) {
|
|
return;
|
|
}
|
|
BackendUtility::workspaceOL($table, $record, $this->BE_USER->workspace);
|
|
// Get current data structure and value array:
|
|
$valueStructure = GeneralUtility::xml2array($record[$field]);
|
|
// Do recursive processing of the XML data:
|
|
foreach ($modifications as $path => $value) {
|
|
$valueStructure['data'] = ArrayUtility::setValueByPath(
|
|
$valueStructure['data'],
|
|
$path,
|
|
$value
|
|
);
|
|
}
|
|
if (is_array($valueStructure['data'])) {
|
|
// The return value should be compiled back into XML
|
|
$values = [
|
|
$field => $this->flexFormTools->flexArray2Xml($valueStructure),
|
|
];
|
|
$this->updateDB($table, $uid, $values, (int)$record['pid']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds an instruction to the remap action stack (used with IRRE).
|
|
*
|
|
* @param string $table The affected table
|
|
* @param int|string $id The affected ID
|
|
* @param callable $callback The callback information (object and method)
|
|
* @param array $arguments The arguments to be used with the callback
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function addRemapAction($table, $id, callable $callback, array $arguments): void
|
|
{
|
|
$this->remapStackActions[] = [
|
|
'affects' => [
|
|
'table' => $table,
|
|
'id' => $id,
|
|
],
|
|
'callback' => $callback,
|
|
'arguments' => $arguments,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* If a parent record was versionized on a workspace in $this->process_datamap,
|
|
* it might be possible, that child records (e.g. on using IRRE) were affected.
|
|
* This function finds these relations and updates their uids in the $incomingFieldArray.
|
|
* The $incomingFieldArray is updated by reference!
|
|
*
|
|
* @param string $table Table name of the parent record
|
|
* @param int $id Uid of the parent record
|
|
* @param array $incomingFieldArray Reference to the incomingFieldArray of process_datamap
|
|
* @param array $registerDBList Reference to the $registerDBList array that was created/updated by versionizing calls to DataHandler in process_datamap.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function getVersionizedIncomingFieldArray($table, $id, &$incomingFieldArray, &$registerDBList): void
|
|
{
|
|
if (!isset($registerDBList[$table][$id]) || !is_array($registerDBList[$table][$id])) {
|
|
return;
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
foreach ($incomingFieldArray as $field => $value) {
|
|
$foreignTable = $schema->hasField($field) ? $schema->getField($field)->getConfiguration()['foreign_table'] ?? '' : '';
|
|
if (($registerDBList[$table][$id][$field] ?? false)
|
|
&& !empty($foreignTable)
|
|
) {
|
|
$newValueArray = [];
|
|
$origValueArray = is_array($value) ? $value : explode(',', $value);
|
|
// Update the uids of the copied records, but also take care about new records:
|
|
foreach ($origValueArray as $childId) {
|
|
$newValueArray[] = $this->autoVersionIdMap[$foreignTable][$childId] ?? $childId;
|
|
}
|
|
// Set the changed value to the $incomingFieldArray
|
|
$incomingFieldArray[$field] = implode(',', $newValueArray);
|
|
}
|
|
}
|
|
// Clean up the $registerDBList array:
|
|
unset($registerDBList[$table][$id]);
|
|
if (empty($registerDBList[$table])) {
|
|
unset($registerDBList[$table]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Straight db based record deletion:
|
|
* Either set deleted = 1 for soft-delete enabled tables, or remove row from table.
|
|
*/
|
|
protected function softOrHardDeleteSingleRecord(string $table, int $uid): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if ($schema->hasCapability(TcaSchemaCapability::SoftDelete)) {
|
|
$this->connectionPool->getConnectionForTable($table)->update(
|
|
$table,
|
|
[$schema->getCapability(TcaSchemaCapability::SoftDelete)->getFieldName() => 1],
|
|
['uid' => $uid],
|
|
[Connection::PARAM_INT]
|
|
);
|
|
} else {
|
|
$this->hardDeleteSingleRecord($table, $uid);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Simple helper method to hard delete one row from table ignoring delete TCA field
|
|
*
|
|
* @param string $table A row from this table should be deleted
|
|
* @param int $uid Uid of row to be deleted
|
|
*/
|
|
protected function hardDeleteSingleRecord(string $table, int $uid): void
|
|
{
|
|
$this->connectionPool->getConnectionForTable($table)
|
|
->delete($table, ['uid' => $uid], [Connection::PARAM_INT]);
|
|
}
|
|
|
|
/**
|
|
* Check user/group for modify table permission of a given table.
|
|
*/
|
|
protected function checkModifyAccessList(string $table): bool
|
|
{
|
|
$isTableAdminOnly = $this->tcaSchemaFactory->has($table) && $this->tcaSchemaFactory->get($table)->hasCapability(TcaSchemaCapability::AccessAdminOnly);
|
|
$isAccessAllowed = $this->BE_USER->isAdmin() || (!$isTableAdminOnly && isset($this->BE_USER->groupData['tables_modify']) && GeneralUtility::inList($this->BE_USER->groupData['tables_modify'], $table));
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['checkModifyAccessList'] ?? [] as $className) {
|
|
$hookObject = GeneralUtility::makeInstance($className);
|
|
if (!$hookObject instanceof DataHandlerCheckModifyAccessListHookInterface) {
|
|
throw new \UnexpectedValueException($className . ' must implement interface ' . DataHandlerCheckModifyAccessListHookInterface::class, 1251892472);
|
|
}
|
|
$hookObject->checkModifyAccessList($isAccessAllowed, $table, $this);
|
|
}
|
|
return $isAccessAllowed;
|
|
}
|
|
|
|
/**
|
|
* Checks if user may update a record $table on given page record
|
|
*
|
|
* @internal Strictly internal. May change or vanish any time.
|
|
*/
|
|
public function hasPermissionToUpdate(string $table, array|VirtualRecord $pageRecord): bool
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table)) {
|
|
return false;
|
|
}
|
|
if ($table === 'pages' || ($table === 'sys_file_reference' && array_key_exists('pages', $this->datamap))) {
|
|
// @todo: find a more generic way to handle content relations of a page (without needing content editing access to that page)
|
|
$perms = Permission::PAGE_EDIT;
|
|
} else {
|
|
$perms = Permission::CONTENT_EDIT;
|
|
}
|
|
if (!$this->hasPageContextPermission($table, $perms, $pageRecord)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Checks if user may insert a record from $table on $pid
|
|
*
|
|
* @param int $pid Integer PID
|
|
*/
|
|
protected function hasPermissionToInsert($table, $pid, array $pageRecord, int $language = 0): bool
|
|
{
|
|
$pid = (int)$pid;
|
|
if ($table === 'pages' && $language > 0) {
|
|
// Localizing a page is treated as "PAGE_EDIT": This is not about creating a new sub-page which
|
|
// needs "PAGE_NEW". We want to be able to allow editors to create page localization of existing
|
|
// pages, while at the same time disallow creating new sub-pages.
|
|
$perms = Permission::PAGE_EDIT;
|
|
} elseif ($table === 'pages') {
|
|
$perms = Permission::PAGE_NEW;
|
|
} elseif (($table === 'sys_file_reference') && array_key_exists('pages', $this->datamap)) {
|
|
// @todo: find a more generic way to handle content relations of a page (without needing content editing access to that page)
|
|
$perms = Permission::PAGE_EDIT;
|
|
} else {
|
|
$perms = Permission::CONTENT_EDIT;
|
|
}
|
|
if (!$this->hasPageContextPermission($table, $perms, $pid !== 0 ? $pageRecord : VirtualRecord::RootPage)) {
|
|
// If page does not exist, it can still be an attempt to add to pid 0. Check this case
|
|
// and deny record insert by looking at admin flag and TCA root level restriction as well.
|
|
return false;
|
|
}
|
|
if (!$this->isTableAllowedForThisPage($pid, $table, $pageRecord)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Checks if a table is allowed on a certain page id according to allowed tables set for the page "doktype" and its [ctrl][rootLevel]-settings if any.
|
|
*
|
|
* @param int $pageUid Page id for which to check, including 0 (zero) if checking for page tree root.
|
|
* @param string $table Table name to check
|
|
* @return bool TRUE if OK
|
|
*/
|
|
protected function isTableAllowedForThisPage(int $pageUid, string $table, array $pageRecord): bool
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
/** @var RootLevelCapability $rootLevelCapability */
|
|
$rootLevelCapability = $schema->getCapability(TcaSchemaCapability::RestrictionRootLevel);
|
|
// Check if rootLevel flag is set, and we're trying to insert on rootLevel - and reversed - and
|
|
// that the table is not "pages" which are allowed anywhere.
|
|
if ($table !== 'pages'
|
|
&& $rootLevelCapability->getRootLevelType() !== RootLevelCapability::TYPE_BOTH
|
|
&& ($rootLevelCapability->getRootLevelType() xor !$pageUid)
|
|
) {
|
|
return false;
|
|
}
|
|
// Check root-level
|
|
if ($pageUid === 0) {
|
|
return $this->BE_USER->isAdmin() || $rootLevelCapability->shallIgnoreRootLevelRestriction();
|
|
}
|
|
// Check non-root-level
|
|
return $this->pageDoktypeRegistry->isRecordTypeAllowedForDoktype($table, (int)$pageRecord['doktype']);
|
|
}
|
|
|
|
/**
|
|
* Checks if a whole branch of pages exists.
|
|
*
|
|
* Tests the branch under $pid. It doesn't test the page with $pid as uid.
|
|
*
|
|
* @param int $defaultLanguagePid uid of a default language page record
|
|
* @return array<array<string,mixed>> List of subpage records in branch, empty array if there are none
|
|
*/
|
|
protected function getSubPagesOfPage(int $defaultLanguagePid, bool $useDeletedRestriction = true): array
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get('pages');
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable('pages');
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
if ($useDeletedRestriction) {
|
|
$queryBuilder->getRestrictions()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
}
|
|
$result = $queryBuilder
|
|
->select('*')
|
|
->from('pages')
|
|
->where(
|
|
// Sub pages of given pid
|
|
$queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter($defaultLanguagePid, Connection::PARAM_INT)),
|
|
// Only default language pages
|
|
$queryBuilder->expr()->eq($schema->getCapability(TcaSchemaCapability::Language)->getLanguageField()->getName(), 0),
|
|
// We do want to handle "workspace new" and "workspace moved" subpages
|
|
$queryBuilder->expr()->or(
|
|
$queryBuilder->expr()->eq('t3ver_wsid', 0),
|
|
// @todo: Verify / add test to see if a workspace-new page is properly discarded if parent page is deleted
|
|
// @todo: Add test that moves a page in workspace below some other page, then delete that other page in
|
|
// live and workspaces to see what happens ...
|
|
$queryBuilder->expr()->and(
|
|
$queryBuilder->expr()->gt('t3ver_wsid', 0),
|
|
$queryBuilder->expr()->eq('t3ver_state', VersionState::NEW_PLACEHOLDER->value)
|
|
)
|
|
)
|
|
)
|
|
->orderBy('sorting')
|
|
->executeQuery();
|
|
$pages = [];
|
|
while ($row = $result->fetchAssociative()) {
|
|
// Follow subpages recursive, add before self so deeper pages are handled first
|
|
$pages = array_merge($pages, $this->getSubPagesOfPage((int)$row['uid'], $useDeletedRestriction), [$row]);
|
|
}
|
|
return $pages;
|
|
}
|
|
|
|
/**
|
|
* Checks if page $id is a uid in the rootline of page id $destinationId
|
|
* Used when moving a page
|
|
*
|
|
* @param int $destinationId Destination Page ID to test
|
|
* @param int $id Page ID to test for presence inside Destination
|
|
* @return bool Returns FALSE if ID is inside destination (including equal to)
|
|
*/
|
|
protected function destNotInsideSelf($destinationId, $id): bool
|
|
{
|
|
$loopCheck = 100;
|
|
$destinationId = (int)$destinationId;
|
|
$id = (int)$id;
|
|
if ($destinationId === $id) {
|
|
return false;
|
|
}
|
|
while ($destinationId !== 0 && $loopCheck > 0) {
|
|
$loopCheck--;
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable('pages');
|
|
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$result = $queryBuilder
|
|
->select('pid', 'uid', 't3ver_oid', 't3ver_wsid')
|
|
->from('pages')
|
|
->where($queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($destinationId, Connection::PARAM_INT)))
|
|
->executeQuery();
|
|
if ($row = $result->fetchAssociative()) {
|
|
// Ensure that the moved location is used as the PID value
|
|
BackendUtility::workspaceOL('pages', $row, $this->BE_USER->workspace);
|
|
if ($row['pid'] == $id) {
|
|
return false;
|
|
}
|
|
$destinationId = (int)$row['pid'];
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Checks if there are records on a page from tables that are not allowed
|
|
*
|
|
* @param int $page_uid Page ID
|
|
* @param int $doktype Page doktype
|
|
* @return array Returns a list of the tables that are 'present' on the page but not allowed with the page_uid/doktype
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
protected function doesPageHaveUnallowedTables(int $page_uid, int $doktype): array
|
|
{
|
|
if ($page_uid === 0) {
|
|
return [];
|
|
}
|
|
$allowedTables = $this->pageDoktypeRegistry->getAllowedTypesForDoktype($doktype);
|
|
// If all tables are allowed, return early
|
|
if (in_array('*', $allowedTables, true)) {
|
|
return [];
|
|
}
|
|
$tableList = [];
|
|
foreach ($this->tcaSchemaFactory->all() as $schema) {
|
|
$table = $schema->getName();
|
|
// If the table is not in the allowed list, check if there are records...
|
|
if (in_array($table, $allowedTables, true)) {
|
|
continue;
|
|
}
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
$count = $queryBuilder
|
|
->count('uid')
|
|
->from($table)
|
|
->where($queryBuilder->expr()->eq(
|
|
'pid',
|
|
$queryBuilder->createNamedParameter($page_uid, Connection::PARAM_INT)
|
|
))
|
|
->executeQuery()
|
|
->fetchOne();
|
|
if ($count) {
|
|
$tableList[] = $table;
|
|
}
|
|
}
|
|
return $tableList;
|
|
}
|
|
|
|
/**
|
|
* @deprecated will be removed in TYPO3 v15.0 (it was always internal -> no deprecation logging)
|
|
* @internal Strictly internal. May change or vanish any time.
|
|
*/
|
|
public function hasPagePermission(int $perms, array $page, bool $useDeleteClause = true): bool
|
|
{
|
|
return $this->hasPageContextPermission('pages', $perms, $page, $useDeleteClause);
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current backend user holds the requested permissions
|
|
* for a record of $table in the context of the given page.
|
|
*
|
|
* When $page is a VirtualRecord the standard page-permission bitmask check
|
|
* is bypassed. For VirtualRecord::RootPage the table's root-level restriction
|
|
* capability (security.ignoreRootLevelRestriction) is consulted instead; if
|
|
* the table opts out of the restriction, access is granted unconditionally.
|
|
*
|
|
* @param string $table Table name of the record on the particular page to be checked
|
|
* @param int $perms Permission restrictions to observe. An integer bitmask of Permission constants
|
|
* @param array $page Full page record
|
|
* @param bool $useDeleteClause Use the delete clause to check if the page is deleted
|
|
* @internal Strictly internal. May change or vanish any time.
|
|
*/
|
|
public function hasPageContextPermission(string $table, int $perms, array|VirtualRecord $page, bool $useDeleteClause = true): bool
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table)) {
|
|
return false;
|
|
}
|
|
if (!$perms) {
|
|
throw new \RuntimeException('Invalid $perms bitset: "' . $perms . '"', 1270853920);
|
|
}
|
|
$beUserUid = $this->BE_USER->getUserId();
|
|
if (!$beUserUid) {
|
|
return false;
|
|
}
|
|
if ($this->bypassAccessCheckForRecords || $this->BE_USER->isAdmin()) {
|
|
return true;
|
|
}
|
|
if ($page === VirtualRecord::RootPage) {
|
|
$tableSchema = $this->tcaSchemaFactory->get($table);
|
|
return $tableSchema->getCapability(TcaSchemaCapability::RestrictionRootLevel)->shallIgnoreRootLevelRestriction();
|
|
}
|
|
$pagesSchema = $this->tcaSchemaFactory->get('pages');
|
|
if (!$pagesSchema->hasCapability(TcaSchemaCapability::RestrictionWebMount) && !$this->BE_USER->isInWebMount($page, '', $useDeleteClause)) {
|
|
return false;
|
|
}
|
|
$permission = new Permission($perms);
|
|
|
|
$editLockFieldName = null;
|
|
$editLockCheck = false;
|
|
if ($pagesSchema->hasCapability(TcaSchemaCapability::EditLock)) {
|
|
$editLockFieldName = $pagesSchema->getCapability(TcaSchemaCapability::EditLock)->getFieldName();
|
|
if ($permission->editPagePermissionIsGranted() || $permission->deletePagePermissionIsGranted() || $permission->editContentPermissionIsGranted()) {
|
|
$editLockCheck = true;
|
|
}
|
|
}
|
|
$groupUids = [];
|
|
$groupCheck = false;
|
|
if (!empty($this->BE_USER->userGroupsUID)) {
|
|
$groupUids = $this->BE_USER->userGroupsUID;
|
|
$groupCheck = true;
|
|
}
|
|
if ((!$editLockCheck || (int)$page[$editLockFieldName] === 0)
|
|
&& (
|
|
((int)$page['perms_everybody'] & $perms) === $perms
|
|
|| ((int)$page['perms_userid'] === $beUserUid && ((int)$page['perms_user'] & $perms) === $perms)
|
|
|| ($groupCheck && in_array((int)$page['perms_groupid'], $groupUids, true) && ((int)$page['perms_group'] & $perms) === $perms)
|
|
)
|
|
) {
|
|
// A PHP implementation of BackendUserAuthentication->getPagePermsClause() plus the "editlock" check.
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Update database record
|
|
* Does not check permissions but expects them to be verified on beforehand
|
|
*
|
|
* @param string $table Record table name
|
|
* @param int $uid Record uid
|
|
* @param array $fieldArray Array of field=>value pairs to insert. FIELDS MUST MATCH the database FIELDS. No check is done.
|
|
*/
|
|
protected function updateDB($table, $uid, $fieldArray, int $recordPid): void
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table) || !(int)$uid) {
|
|
return;
|
|
}
|
|
// Never update the uid field
|
|
unset($fieldArray['uid']);
|
|
if (empty($fieldArray)) {
|
|
return;
|
|
}
|
|
$fieldArray = $this->insertUpdateDB_preprocessBasedOnFieldType($table, $fieldArray);
|
|
$connection = $this->connectionPool->getConnectionForTable($table);
|
|
try {
|
|
$connection->update($table, $fieldArray, ['uid' => (int)$uid]);
|
|
} catch (DBALException $e) {
|
|
$this->log($table, $uid, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::SYSTEM_ERROR, 'SQL error: "{reason}" ({table}:{uid})', null, ['reason' => $e->getMessage(), 'table' => $table, 'uid' => $uid]);
|
|
return;
|
|
}
|
|
$this->updateRefIndex($table, $uid);
|
|
// Set History data
|
|
$historyEntryId = 0;
|
|
if (isset($this->historyRecords[$table . ':' . $uid])) {
|
|
$historyEntryId = $this->getRecordHistoryStore()->modifyRecord($table, $uid, $this->historyRecords[$table . ':' . $uid], $this->correlationId);
|
|
}
|
|
$this->log($table, $uid, SystemLogDatabaseAction::UPDATE, null, SystemLogErrorClassification::MESSAGE, 'Record {table}:{uid} was updated', null, ['table' => $table, 'uid' => $uid, 'history' => $historyEntryId], $recordPid);
|
|
// Clear cache for relevant pages:
|
|
$this->registerRecordIdForPageCacheClearing($table, $uid);
|
|
}
|
|
|
|
/**
|
|
* Insert into database
|
|
* Does not check permissions but expects them to be verified on beforehand
|
|
*
|
|
* @param string $table Record table name
|
|
* @param string $id "NEW...." uid string
|
|
* @param array $fieldArray Array of field=>value pairs to insert. FIELDS MUST MATCH the database FIELDS. No check is done. "pid" must point to the destination of the record!
|
|
* @param int $suggestedUid Suggested UID value for the inserted record. See the array $this->suggestedInsertUids; Admin-only feature
|
|
* @return int|null Returns ID on success.
|
|
*/
|
|
protected function insertDB($table, $id, $fieldArray, $suggestedUid = 0): ?int
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table) || !isset($fieldArray['pid'])) {
|
|
return null;
|
|
}
|
|
// Do NOT insert the UID field, ever!
|
|
unset($fieldArray['uid']);
|
|
// Check for "suggestedUid".
|
|
// This feature is used by the import functionality to force a new record to have a certain UID value.
|
|
// This is only recommended for use when the destination server is a passive mirror of another server.
|
|
// As a security measure this feature is available only for Admin Users (for now)
|
|
// The value of $this->suggestedInsertUids["table":"uid"] is either string 'DELETE' (ext:impexp) to trigger
|
|
// a blind delete of any possibly existing row before insert with forced uid, or boolean true (testing-framework)
|
|
// to only force the uid insert and skipping deletion of an existing row.
|
|
$suggestedUid = (int)$suggestedUid;
|
|
if ($this->BE_USER->isAdmin() && $suggestedUid && ($this->suggestedInsertUids[$table . ':' . $suggestedUid] ?? false)) {
|
|
// When the value of ->suggestedInsertUids[...] is "DELETE" it will try to remove the previous record
|
|
if ($this->suggestedInsertUids[$table . ':' . $suggestedUid] === 'DELETE') {
|
|
$this->hardDeleteSingleRecord($table, (int)$suggestedUid);
|
|
}
|
|
$fieldArray['uid'] = $suggestedUid;
|
|
}
|
|
$fieldArray = $this->insertUpdateDB_preprocessBasedOnFieldType($table, $fieldArray);
|
|
$connection = $this->connectionPool->getConnectionForTable($table);
|
|
try {
|
|
// Execute the INSERT query:
|
|
$connection->insert($table, $fieldArray);
|
|
} catch (DBALException $e) {
|
|
$this->log($table, 0, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::SYSTEM_ERROR, 'SQL error: "{reason}" ({table}:{uid})', null, ['reason' => $e->getMessage(), 'table' => $table, 'uid' => $id]);
|
|
return null;
|
|
}
|
|
// Set mapping for NEW... -> real uid:
|
|
// the NEW_id now holds the 'NEW....' -id
|
|
$NEW_id = $id;
|
|
$id = $this->postProcessDatabaseInsert($connection, $table, $suggestedUid);
|
|
$this->substNEWwithIDs[$NEW_id] = $id;
|
|
$this->substNEWwithIDs_table[$NEW_id] = $table;
|
|
$newRow = $fieldArray;
|
|
$newRow['uid'] = $id;
|
|
// Update reference index:
|
|
$this->updateRefIndex($table, $id);
|
|
// Store in history
|
|
$this->getRecordHistoryStore()->addRecord($table, $id, $newRow, $this->correlationId);
|
|
if ($this->tcaSchemaFactory->get($table)->isWorkspaceAware() && (int)($newRow['t3ver_wsid'] ?? 0) > 0) {
|
|
$this->log($table, $id, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::MESSAGE, 'New version created "{table}:{uid}". UID of new version is "{offlineUid}"', null, ['table' => $table, 'uid' => $newRow['uid'], 'offlineUid' => $id], $table === 'pages' ? $newRow['uid'] : $newRow['pid']);
|
|
} else {
|
|
$this->log($table, $id, SystemLogDatabaseAction::INSERT, null, SystemLogErrorClassification::MESSAGE, 'Record {table}:{uid} was inserted on page {pid}', null, ['table' => $table, 'uid' => $id, 'pid' => $newRow['pid']], $newRow['pid']);
|
|
// Clear cache of relevant pages
|
|
$this->registerRecordIdForPageCacheClearing($table, $id);
|
|
}
|
|
return $id;
|
|
}
|
|
|
|
/**
|
|
* Setting sys_history record, based on content previously set in $this->historyRecords[$table . ':' . $id] (by compareFieldArrayWithCurrentAndUnset())
|
|
*
|
|
* This functionality is now moved into the RecordHistoryStore and can be used instead.
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $id Record ID
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function setHistory($table, $id): void
|
|
{
|
|
if (isset($this->historyRecords[$table . ':' . $id])) {
|
|
$this->getRecordHistoryStore()->modifyRecord(
|
|
$table,
|
|
$id,
|
|
$this->historyRecords[$table . ':' . $id],
|
|
$this->correlationId
|
|
);
|
|
}
|
|
}
|
|
|
|
protected function getRecordHistoryStore(): RecordHistoryStore
|
|
{
|
|
return GeneralUtility::makeInstance(
|
|
RecordHistoryStore::class,
|
|
RecordHistoryStore::USER_BACKEND,
|
|
(int)$this->BE_USER->user['uid'],
|
|
(int)$this->BE_USER->getOriginalUserIdWhenInSwitchUserMode(),
|
|
$GLOBALS['EXEC_TIME'],
|
|
$this->BE_USER->workspace
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Register a table/uid combination in current user workspace for reference updating.
|
|
* Should be called on almost any update to a record which could affect references inside the record.
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $uid Record UID
|
|
* @param int|null $workspace Workspace the record lives in
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function updateRefIndex($table, $uid, ?int $workspace = null): void
|
|
{
|
|
if ($workspace === null) {
|
|
$workspace = (int)$this->BE_USER->workspace;
|
|
}
|
|
$this->referenceIndexUpdater->registerForUpdate((string)$table, (int)$uid, $workspace);
|
|
}
|
|
|
|
/**
|
|
* Delete rows from sys_refindex a table / uid combination is involved in:
|
|
* Either on left side (tablename + recuid) OR right side (ref_table + ref_uid).
|
|
* Useful in scenarios like workspace-discard where parents or children are hard deleted: The
|
|
* expensive updateRefIndex() does not need to be called since we can just drop straight ahead.
|
|
*
|
|
* @param string $table Table name, used as tablename and ref_table
|
|
* @param int $uid Record uid, used as recuid and ref_uid
|
|
* @param int $workspace Workspace the record lives in
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function registerReferenceIndexRowsForDrop(string $table, int $uid, int $workspace): void
|
|
{
|
|
$this->referenceIndexUpdater->registerForDrop($table, $uid, $workspace);
|
|
}
|
|
|
|
/**
|
|
* Helper method to access referenceIndexUpdater->registerUpdateForReferencesToItem()
|
|
* from within workspace DataHandlerHook.
|
|
*
|
|
* @internal Exists only for workspace DataHandlerHook. May vanish any time.
|
|
*/
|
|
public function registerReferenceIndexUpdateForReferencesToItem(string $table, int $uid, int $workspace, ?int $targetWorkspace = null): void
|
|
{
|
|
$this->referenceIndexUpdater->registerUpdateForReferencesToItem($table, $uid, $workspace, $targetWorkspace);
|
|
}
|
|
|
|
/**
|
|
* Returning sorting number for tables with a "sortby" column
|
|
* Using when new records are created and existing records are moved around.
|
|
*
|
|
* The strategy is:
|
|
* - if no record exists: set interval as sorting number
|
|
* - if inserted before an element: put in the middle of the existing elements
|
|
* - if inserted behind the last element: add interval to last sorting number
|
|
* - if collision: move all subsequent records by 2 * interval, insert new record with collision + interval
|
|
*
|
|
* How to calculate the maximum possible inserts for the worst case of adding all records to the top,
|
|
* such that the sorting number stays within INT_MAX
|
|
*
|
|
* i = interval (currently 256)
|
|
* c = number of inserts until collision
|
|
* s = max sorting number to reach (INT_MAX - 32bit)
|
|
* n = number of records (~83 million)
|
|
*
|
|
* c = 2 * g
|
|
* g = log2(i) / 2 + 1
|
|
* n = g * s / i - g + 1
|
|
*
|
|
* The algorithm can be tuned by adjusting the interval value.
|
|
* Higher value means less collisions, but also less inserts are possible to stay within INT_MAX.
|
|
*
|
|
* @param int $uid Uid of record to find sorting number for. May be zero in case of new.
|
|
* @param int $pid Positioning PID, either >=0 (pointing to page in which case we find sorting number for first record in page) or <0 (pointing to record in which case to find next sorting number after this record)
|
|
* @return int|array|false Returns integer if PID is >=0, otherwise an array with PID and sorting number. Possibly FALSE in case of error.
|
|
*/
|
|
protected function getSortNumber(string $table, $uid, $pid): int|array|false
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!$schema->hasCapability(TcaSchemaCapability::SortByField)) {
|
|
return false;
|
|
}
|
|
$sortColumn = $schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName();
|
|
|
|
$considerWorkspaces = $schema->isWorkspaceAware();
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$queryBuilder
|
|
->select($sortColumn, 'pid', 'uid')
|
|
->from($table);
|
|
if ($considerWorkspaces) {
|
|
$queryBuilder->addSelect('t3ver_state');
|
|
}
|
|
|
|
// find and return the sorting value for the first record on that pid
|
|
if ($pid >= 0) {
|
|
// Fetches the first record (lowest sorting) under this pid
|
|
$queryBuilder
|
|
->where($queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter($pid, Connection::PARAM_INT)));
|
|
|
|
if ($considerWorkspaces) {
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->or(
|
|
$queryBuilder->expr()->eq('t3ver_oid', 0),
|
|
$queryBuilder->expr()->eq('t3ver_state', VersionState::MOVE_POINTER->value)
|
|
)
|
|
);
|
|
}
|
|
$row = $queryBuilder
|
|
->orderBy($sortColumn, 'ASC')
|
|
->addOrderBy('uid', 'ASC')
|
|
->setMaxResults(1)
|
|
->executeQuery()
|
|
->fetchAssociative();
|
|
|
|
if (!empty($row)) {
|
|
// The top record was the record itself, so we return its current sorting value
|
|
if ($row['uid'] == $uid) {
|
|
return $row[$sortColumn];
|
|
}
|
|
// If the record sorting value < 1 we must resort all the records under this pid
|
|
if ($row[$sortColumn] < 1) {
|
|
$this->increaseSortingOfFollowingRecords($table, (int)$pid);
|
|
// Lowest sorting value after full resorting is $sortIntervals
|
|
return $this->sortIntervals;
|
|
}
|
|
// Sorting number between current top element and zero
|
|
return (int)floor($row[$sortColumn] / 2);
|
|
}
|
|
// No records, so we choose the default value as sorting-number
|
|
return $this->sortIntervals;
|
|
}
|
|
|
|
// Find and return first possible sorting value AFTER record with given uid ($pid)
|
|
// Fetches the record which is supposed to be the prev record
|
|
$row = $queryBuilder
|
|
->where($queryBuilder->expr()->eq(
|
|
'uid',
|
|
$queryBuilder->createNamedParameter(abs($pid), Connection::PARAM_INT)
|
|
))
|
|
->executeQuery()
|
|
->fetchAssociative();
|
|
|
|
// There is a previous record
|
|
if (!empty($row)) {
|
|
// Look if the record UID happens to be a versioned record. If so, find its live version.
|
|
// If this is already a moved record in workspace, this is not needed
|
|
if (VersionState::tryFrom((int)($row['t3ver_state'] ?? 0)) !== VersionState::MOVE_POINTER && $lookForLiveVersion = BackendUtility::getLiveVersionOfRecord($table, $row['uid'], [$sortColumn, 'pid', 'uid'])) {
|
|
$row = $lookForLiveVersion;
|
|
} elseif ($considerWorkspaces && $this->BE_USER->workspace > 0) {
|
|
// In case the previous record is moved in the workspace, we need to fetch the information from this specific record
|
|
$versionedRecord = BackendUtility::getWorkspaceVersionOfRecord($this->BE_USER->workspace, $table, $row['uid'], [$sortColumn, 'pid', 'uid', 't3ver_state']);
|
|
if (is_array($versionedRecord) && VersionState::tryFrom($versionedRecord['t3ver_state'] ?? 0) === VersionState::MOVE_POINTER) {
|
|
$row = $versionedRecord;
|
|
}
|
|
}
|
|
// If the record should be inserted after itself, keep the current sorting information:
|
|
if ((int)$row['uid'] === (int)$uid) {
|
|
$sortNumber = $row[$sortColumn];
|
|
} else {
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$queryBuilder
|
|
->select($sortColumn, 'pid', 'uid')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
'pid',
|
|
$queryBuilder->createNamedParameter($row['pid'], Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->gte(
|
|
$sortColumn,
|
|
$queryBuilder->createNamedParameter($row[$sortColumn], Connection::PARAM_INT)
|
|
)
|
|
)
|
|
->orderBy($sortColumn, 'ASC')
|
|
->addOrderBy('uid', 'DESC')
|
|
->setMaxResults(2);
|
|
|
|
if ($considerWorkspaces) {
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->or(
|
|
$queryBuilder->expr()->eq('t3ver_oid', 0),
|
|
$queryBuilder->expr()->eq('t3ver_state', VersionState::MOVE_POINTER->value)
|
|
)
|
|
);
|
|
}
|
|
|
|
$subResults = $queryBuilder->executeQuery()->fetchAllAssociative();
|
|
// Fetches the next record in order to calculate the in-between sortNumber
|
|
if (count($subResults) === 2) {
|
|
// There was a record afterward, fetch that
|
|
$subrow = array_pop($subResults);
|
|
// The sortNumber is found in between these values
|
|
$sortNumber = $row[$sortColumn] + floor(($subrow[$sortColumn] - $row[$sortColumn]) / 2);
|
|
// The sortNumber happened NOT to be between the two surrounding numbers, so we'll have to resort the list
|
|
if ($sortNumber <= $row[$sortColumn] || $sortNumber >= $subrow[$sortColumn]) {
|
|
$this->increaseSortingOfFollowingRecords($table, (int)$row['pid'], (int)$row[$sortColumn]);
|
|
$sortNumber = $row[$sortColumn] + $this->sortIntervals;
|
|
}
|
|
} else {
|
|
// If after the last record in the list, we just add the sortInterval to the last sortvalue
|
|
$sortNumber = $row[$sortColumn] + $this->sortIntervals;
|
|
}
|
|
}
|
|
return ['pid' => $row['pid'], 'sortNumber' => $sortNumber];
|
|
}
|
|
// There must be a previous record or else this cannot work
|
|
$this->log($table, $uid, SystemLogDatabaseAction::MOVE, null, SystemLogErrorClassification::USER_ERROR, 'Attempt to move record {table}:{uid} after a non-existing record ({target})', null, ['table' => $table, 'uid' => $uid, 'target' => abs($pid)], $pid);
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Increases sorting field value of all records with sorting higher than $sortingValue
|
|
*
|
|
* Used internally by getSortNumber() to "make space" in sorting values when inserting new record
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $pid Page Uid in which to resort records
|
|
* @param int|null $sortingValue All sorting numbers larger than this number will be shifted
|
|
*/
|
|
protected function increaseSortingOfFollowingRecords(string $table, int $pid, ?int $sortingValue = null): void
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if ($schema->hasCapability(TcaSchemaCapability::SortByField)) {
|
|
$sortBy = $schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName();
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder
|
|
->update($table)
|
|
->where($queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter($pid, Connection::PARAM_INT)))
|
|
->set($sortBy, $queryBuilder->quoteIdentifier($sortBy) . ' + ' . $this->sortIntervals . ' + ' . $this->sortIntervals, false);
|
|
if ($sortingValue !== null) {
|
|
$queryBuilder->andWhere($queryBuilder->expr()->gt($sortBy, $sortingValue));
|
|
}
|
|
if ($schema->isWorkspaceAware()) {
|
|
$queryBuilder
|
|
->andWhere(
|
|
$queryBuilder->expr()->eq('t3ver_oid', 0)
|
|
);
|
|
}
|
|
|
|
if ($schema->hasCapability(TcaSchemaCapability::SoftDelete)) {
|
|
$queryBuilder->andWhere($queryBuilder->expr()->eq($schema->getCapability(TcaSchemaCapability::SoftDelete)->getFieldName(), 0));
|
|
}
|
|
|
|
$queryBuilder->executeStatement();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returning uid of "previous" localized record, if any, for tables with a "sortby" column.
|
|
* Used when records are localized, so that localized records are sorted in the
|
|
* same order as the source language records.
|
|
*
|
|
* The uid of the returned record is later used to create the localized record "after"
|
|
* (higher sorting value) than the one the uid is returned of.
|
|
*
|
|
* There are basically two scenarios:
|
|
* * The localized record is to be placed as the first record of the target pid/language
|
|
* combination. In this case, there is no "before" record in this language. The method
|
|
* returns input $uid, saying "insert the localized record with a higher sorting value
|
|
* than the record the localization is created from".
|
|
* * There is a localized record "before" (lower sorting value) in the target pid/language
|
|
* combination. For instance because source language element 2 is being translated and
|
|
* source language element 1 has already been translated. In this case, the uid of the
|
|
* 'element 1' is returned, saying "insert the localized record with a higher sorting
|
|
* value than the "before" record in this language.
|
|
*
|
|
* The algorithm first fetches the record of given input uid. It then looks if there is a
|
|
* record with a lower sorting value for this pid/language combination. If no, input uid
|
|
* is returned ("place with higher sorting than source language record"). If yes, it looks
|
|
* if there is a localization of that source record in the target language and return the
|
|
* uid of that target language record ("place with higher sorting that this traget language
|
|
* record"). When dealing with table tt_content, colpos is also taken into account.
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $uid Uid of source language record
|
|
* @param int $pid Pid of source language record
|
|
* @param int $targetLanguage Target language id
|
|
* @return int uid of record after which the localized record should be inserted
|
|
*/
|
|
protected function getPreviousLocalizedRecordUid($table, $uid, $pid, $targetLanguage)
|
|
{
|
|
$previousLocalizedRecordUid = $uid;
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!$schema->hasCapability(TcaSchemaCapability::SortByField)) {
|
|
return $previousLocalizedRecordUid;
|
|
}
|
|
$sortColumn = $schema->getCapability(TcaSchemaCapability::SortByField)->getFieldName();
|
|
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
|
|
// Typically l10n_parent
|
|
$transOrigPointerField = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
// Typically sys_language_uid
|
|
$languageField = $languageCapability->getLanguageField()->getName();
|
|
|
|
$select = [$sortColumn, $languageField, $transOrigPointerField, 'pid', 'uid'];
|
|
// For content elements, we also need the colPos
|
|
if ($table === 'tt_content') {
|
|
$select[] = 'colPos';
|
|
}
|
|
|
|
// Get the sort value and some other details of the source language record
|
|
$row = BackendUtility::getRecord($table, $uid, $select);
|
|
if (!is_array($row)) {
|
|
// This if may be obsolete ... didn't the callee already check if the source record exists?
|
|
return $previousLocalizedRecordUid;
|
|
}
|
|
|
|
// Try to find a "before" record in source language
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$queryBuilder
|
|
->select(...$select)
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
'pid',
|
|
$queryBuilder->createNamedParameter($pid, Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->eq(
|
|
$languageField,
|
|
$queryBuilder->createNamedParameter($row[$languageField], Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->lt(
|
|
$sortColumn,
|
|
$queryBuilder->createNamedParameter($row[$sortColumn], Connection::PARAM_INT)
|
|
)
|
|
)
|
|
->orderBy($sortColumn, 'DESC')
|
|
->addOrderBy('uid', 'DESC')
|
|
->setMaxResults(1);
|
|
if ($table === 'tt_content') {
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->eq(
|
|
'colPos',
|
|
$queryBuilder->createNamedParameter($row['colPos'], Connection::PARAM_INT)
|
|
)
|
|
);
|
|
}
|
|
// If there is a "before" record in source language, see if it is localized to target language.
|
|
// If so, return uid of target language record.
|
|
if ($previousRow = $queryBuilder->executeQuery()->fetchAssociative()) {
|
|
$previousLocalizedRecord = $this->localizationRepository->getRecordTranslation($table, ['uid' => $previousRow['uid'], 'pid' => $pid], $targetLanguage, $this->BE_USER->workspace);
|
|
if ($previousLocalizedRecord) {
|
|
$previousLocalizedRecordUid = $previousLocalizedRecord->getUid();
|
|
}
|
|
}
|
|
|
|
return $previousLocalizedRecordUid;
|
|
}
|
|
|
|
/**
|
|
* Returns a fieldArray with default values. Values will be picked up from the TCA array
|
|
* looking at the config key "default" for each column. If values are set in ->defaultValues
|
|
* they will overrule though. Used for new records and during copy operations for defaults.
|
|
*
|
|
* @param string $table Table name for which to set default values.
|
|
* @param array $recordContext Record context to determine type
|
|
* @return array Array with default values.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function newFieldArray($table, array $recordContext = []): array
|
|
{
|
|
$fieldArray = [];
|
|
foreach ($this->getTypeSpecificFields($table, $recordContext) as $field) {
|
|
$fieldName = $field->getName();
|
|
// PageTSconfig type-specific defaults take highest precedence
|
|
if (($typeSpecificValue = $this->getTypeSpecificDefault($table, $fieldName, $recordContext)) !== null) {
|
|
$fieldArray[$fieldName] = $typeSpecificValue;
|
|
} elseif (isset($this->defaultValues[$table][$fieldName])) {
|
|
$fieldArray[$fieldName] = $this->defaultValues[$table][$fieldName];
|
|
} elseif ($field->hasDefaultValue() && ($field->getDefaultValue() !== null || $field->isNullable())) {
|
|
// This now uses sub-schema field if available, respecting columnsOverrides defaults
|
|
$fieldArray[$fieldName] = $field->getDefaultValue();
|
|
}
|
|
}
|
|
return $fieldArray;
|
|
}
|
|
|
|
/**
|
|
* Use type-specific sub-schema fields if available, otherwise main schema fields
|
|
*/
|
|
protected function getTypeSpecificFields(string $table, array $row): FieldCollection
|
|
{
|
|
if (!$this->tcaSchemaFactory->has($table)) {
|
|
return new FieldCollection([]);
|
|
}
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
$recordType = BackendUtility::getTCAtypeValue($schema->getName(), $row, true);
|
|
return ($recordType !== null && $schema->hasSubSchema($recordType))
|
|
? $schema->getSubSchema($recordType)->getFields()
|
|
: $schema->getFields();
|
|
}
|
|
|
|
/**
|
|
* Get type-specific default value for a field if available
|
|
|
|
* @param array $recordContext Record context to determine type
|
|
* @return mixed|null Type-specific default value or null if not found
|
|
*/
|
|
protected function getTypeSpecificDefault(string $table, string $fieldName, array $recordContext): mixed
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
|
|
// Check if we have type-specific configuration for this table and field
|
|
if (!isset($this->defaultValues[$table]['__typeSpecific'][$fieldName])) {
|
|
return null;
|
|
}
|
|
|
|
// Determine record type from record context using Schema API
|
|
$recordType = '';
|
|
if ($schema->supportsSubSchema()) {
|
|
$typeFieldName = $schema->getSubSchemaTypeInformation()->getFieldName();
|
|
if (isset($recordContext[$typeFieldName])) {
|
|
$recordType = (string)$recordContext[$typeFieldName];
|
|
}
|
|
}
|
|
|
|
if ($recordType === '') {
|
|
return null;
|
|
}
|
|
|
|
// Get type-specific configuration for this field
|
|
$fieldTypeConfig = $this->defaultValues[$table]['__typeSpecific'][$fieldName];
|
|
|
|
// Check if there's a type-specific override
|
|
return $fieldTypeConfig['types.'][$recordType] ?? null;
|
|
}
|
|
|
|
/**
|
|
* If a "languageField" is specified for $table this function will add a
|
|
* possible value to the incoming array if none is found in there already.
|
|
*/
|
|
protected function addDefaultPermittedLanguageIfNotSet(string $table, array $incomingFieldArray, int $pageId): array
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!$schema->isLanguageAware()) {
|
|
return $incomingFieldArray;
|
|
}
|
|
/** @var LanguageAwareSchemaCapability $languageCapability */
|
|
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
|
|
$languageFieldName = $languageCapability->getLanguageField()->getName();
|
|
if (isset($incomingFieldArray[$languageFieldName])) {
|
|
return $incomingFieldArray;
|
|
}
|
|
try {
|
|
$site = $this->siteFinder->getSiteByPageId($pageId);
|
|
foreach ($site->getAvailableLanguages($this->BE_USER, false, $pageId) as $languageId => $language) {
|
|
$incomingFieldArray[$languageFieldName] = $languageId;
|
|
break;
|
|
}
|
|
} catch (SiteNotFoundException) {
|
|
// No site found, do not set a default language if nothing was set explicitly
|
|
}
|
|
return $incomingFieldArray;
|
|
}
|
|
|
|
/**
|
|
* Find a site language by the given language ID for a specific page, and check for all available sites
|
|
* if the page ID is "0".
|
|
*
|
|
* Note: Currently, the first language matching the given id is used, while
|
|
* there might be more languages with the same id in additional sites.
|
|
*
|
|
* @param int $pageId
|
|
* @param int $languageId
|
|
*/
|
|
protected function getSiteLanguageForPage(int $pageId, int $languageId): ?SiteLanguage
|
|
{
|
|
try {
|
|
// Try to fetch the site language from the pages' associated site
|
|
$site = $this->siteFinder->getSiteByPageId($pageId);
|
|
return $site->getLanguageById($languageId);
|
|
} catch (SiteNotFoundException|\InvalidArgumentException $e) {
|
|
// In case no site language could be found, we might deal with the root node,
|
|
// we therefore try to fetch the site language from all available sites.
|
|
// NOTE: This has side effects, in case the SAME ID is used for different languages in different sites!
|
|
$sites = $this->siteFinder->getAllSites();
|
|
foreach ($sites as $site) {
|
|
try {
|
|
return $site->getLanguageById($languageId);
|
|
} catch (\InvalidArgumentException $e) {
|
|
// language not found in site, continue
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Compares the incoming field array with the current record and unsets all fields which are the same.
|
|
* Used for existing records being updated
|
|
*
|
|
* @param string $table Record table name
|
|
* @param int $id Record uid
|
|
* @param array $fieldArray Array of field=>value pairs intended to be inserted into the database. All keys with values matching exactly the current value will be unset!
|
|
* @return array Returns $fieldArray. If the returned array is empty, then the record should not be updated!
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function compareFieldArrayWithCurrentAndUnset($table, $id, $fieldArray): array
|
|
{
|
|
$connection = $this->connectionPool->getConnectionForTable($table);
|
|
$queryBuilder = $connection->createQueryBuilder();
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
$currentRecord = $queryBuilder->select('*')
|
|
->from($table)
|
|
->where($queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($id, Connection::PARAM_INT)))
|
|
->executeQuery()
|
|
->fetchAssociative();
|
|
if (!is_array($currentRecord)) {
|
|
return [];
|
|
}
|
|
// If the current record exists (which it should...), begin comparison:
|
|
$currentRecord = BackendUtility::convertDatabaseRowValuesToPhp($table, $currentRecord);
|
|
$tableInfo = $connection->getSchemaInformation()->getTableInfo($table);
|
|
$columnRecordTypes = [];
|
|
foreach ($currentRecord as $columnName => $_) {
|
|
$columnRecordTypes[$columnName] = '';
|
|
$type = $tableInfo->getColumnInfo($columnName)?->getType();
|
|
if ($type instanceof IntegerType) {
|
|
$columnRecordTypes[$columnName] = 'int';
|
|
} elseif ($type instanceof JsonType) {
|
|
$columnRecordTypes[$columnName] = 'json';
|
|
}
|
|
}
|
|
// Unset the fields which are similar:
|
|
foreach ($fieldArray as $col => $val) {
|
|
$fieldConfiguration = [];
|
|
$isNullField = false;
|
|
|
|
if ($this->tcaSchemaFactory->get($table)->hasField($col)) {
|
|
$fieldType = $this->tcaSchemaFactory->get($table)->getField($col);
|
|
$fieldConfiguration = $fieldType->getConfiguration();
|
|
$isNullField = $fieldType->isNullable();
|
|
}
|
|
|
|
// Unset fields if stored and submitted values are equal - except the current field holds MM relations.
|
|
// In general this avoids to store superfluous data which also will be visualized in the editing history.
|
|
if (empty($fieldConfiguration['MM']) && $this->isSubmittedValueEqualToStoredValue($val, $currentRecord[$col], $columnRecordTypes[$col], $isNullField)) {
|
|
unset($fieldArray[$col]);
|
|
} else {
|
|
if (!isset($this->mmHistoryRecords[$table . ':' . $id]['oldRecord'][$col])) {
|
|
$this->historyRecords[$table . ':' . $id]['oldRecord'][$col] = $currentRecord[$col];
|
|
} elseif ($this->mmHistoryRecords[$table . ':' . $id]['oldRecord'][$col] != $this->mmHistoryRecords[$table . ':' . $id]['newRecord'][$col]) {
|
|
$this->historyRecords[$table . ':' . $id]['oldRecord'][$col] = $this->mmHistoryRecords[$table . ':' . $id]['oldRecord'][$col];
|
|
}
|
|
if (!isset($this->mmHistoryRecords[$table . ':' . $id]['newRecord'][$col])) {
|
|
$this->historyRecords[$table . ':' . $id]['newRecord'][$col] = $fieldArray[$col];
|
|
} elseif ($this->mmHistoryRecords[$table . ':' . $id]['newRecord'][$col] != $this->mmHistoryRecords[$table . ':' . $id]['oldRecord'][$col]) {
|
|
$this->historyRecords[$table . ':' . $id]['newRecord'][$col] = $this->mmHistoryRecords[$table . ':' . $id]['newRecord'][$col];
|
|
}
|
|
}
|
|
}
|
|
return $fieldArray;
|
|
}
|
|
|
|
/**
|
|
* Determines whether submitted values and stored values are equal.
|
|
* This prevents from adding superfluous field changes which would be shown in the record history as well.
|
|
* For NULL fields (see accordant TCA definition 'nullable'), a special handling is required since
|
|
* (!strcmp(NULL, '')) would be a false-positive.
|
|
*
|
|
* @param mixed $submittedValue Value that has submitted (e.g. from a backend form)
|
|
* @param mixed $storedValue Value that is currently stored in the database
|
|
* @param string $storedType SQL type of the stored value column (see mysql_field_type(), e.g 'int', 'string', ...)
|
|
* @param bool $allowNull Whether NULL values are allowed by accordant TCA definition ('nullable')
|
|
* @return bool Whether both values are considered to be equal
|
|
*/
|
|
protected function isSubmittedValueEqualToStoredValue($submittedValue, $storedValue, $storedType, $allowNull = false)
|
|
{
|
|
// No NULL values are allowed, this is the regular behaviour.
|
|
// Thus, check whether strings are the same or whether integer values are empty ("0" or "").
|
|
if (!$allowNull) {
|
|
switch ($storedType) {
|
|
case 'json':
|
|
$result = $submittedValue === $storedValue;
|
|
break;
|
|
case 'int':
|
|
$result = (int)$storedValue === (int)$submittedValue;
|
|
break;
|
|
default:
|
|
$result = (string)$submittedValue === (string)$storedValue;
|
|
}
|
|
// Null values are allowed, but currently there's a real (not NULL) value.
|
|
// Thus, ensure no NULL value was submitted and fallback to the regular behaviour.
|
|
} elseif ($storedValue !== null) {
|
|
$result = (
|
|
$submittedValue !== null
|
|
&& $this->isSubmittedValueEqualToStoredValue($submittedValue, $storedValue, $storedType, false)
|
|
);
|
|
// Null values are allowed, and currently there's a NULL value.
|
|
// Thus, check whether a NULL value was submitted.
|
|
} else {
|
|
$result = ($submittedValue === null);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Gets UID of parent record. If record is deleted it will be looked up in
|
|
* an array built before the record was deleted
|
|
*
|
|
* @param string $table Table where record lives/lived
|
|
* @param int $uid Record UID
|
|
* @return int[] Parent UIDs
|
|
*/
|
|
protected function getOriginalParentOfRecord($table, $uid)
|
|
{
|
|
if (isset(self::$recordPidsForDeletedRecords[$table][$uid])) {
|
|
return self::$recordPidsForDeletedRecords[$table][$uid];
|
|
}
|
|
$parentUid = (int)BackendUtility::getRealPageId($table, $uid);
|
|
return [$parentUid];
|
|
}
|
|
|
|
/**
|
|
* Extract entries from TSconfig for a specific table. This will merge specific and default configuration together.
|
|
*
|
|
* @param string $table Table name
|
|
* @param array $TSconfig TSconfig for page
|
|
* @return array TSconfig merged
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function getTableEntries($table, $TSconfig): array
|
|
{
|
|
$tA = is_array($TSconfig['table.'][$table . '.'] ?? false) ? $TSconfig['table.'][$table . '.'] : [];
|
|
$dA = is_array($TSconfig['default.'] ?? false) ? $TSconfig['default.'] : [];
|
|
ArrayUtility::mergeRecursiveWithOverrule($dA, $tA);
|
|
return $dA;
|
|
}
|
|
|
|
/**
|
|
* Executing dbAnalysisStore
|
|
* This will save MM relations for new records but is executed after records are created because we need to know the ID of them
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function dbAnalysisStoreExec(): void
|
|
{
|
|
foreach ($this->dbAnalysisStore as $action) {
|
|
$idIsInteger = MathUtility::canBeInterpretedAsInteger($action[2]);
|
|
// If NEW id is not found in substitution array (due to errors), continue.
|
|
if (!$idIsInteger && !isset($this->substNEWwithIDs[$action[2]])) {
|
|
continue;
|
|
}
|
|
$id = BackendUtility::wsMapId($action[4], $idIsInteger ? $action[2] : $this->substNEWwithIDs[$action[2]]);
|
|
if ($id) {
|
|
$action[0]->writeMM($action[1], $id, $action[3]);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns array, $CPtable, of pages under the $pid going down to $counter levels.
|
|
* Selecting ONLY pages which the user has read-access to!
|
|
*
|
|
* @param array $CPtable Accumulation of page uid=>pid pairs in branch of $pid
|
|
* @param int $pid Page ID for which to find subpages
|
|
* @param int $counter Number of levels to go down.
|
|
* @param int $rootID ID of root point for new copied branch: The idea seems to be that a copy is not made of the already new page!
|
|
* @return array Return array.
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function int_pageTreeInfo($CPtable, $pid, $counter, $rootID)
|
|
{
|
|
if ($counter) {
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable('pages');
|
|
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$queryBuilder
|
|
->select('uid')
|
|
->from('pages')
|
|
->where(
|
|
$queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter($pid, Connection::PARAM_INT)),
|
|
$queryBuilder->expr()->or(
|
|
$queryBuilder->expr()->eq('language_tag', $queryBuilder->createNamedParameter(\Local\Multilanguage\Service\DefaultLanguageTagService::getTag())),
|
|
$queryBuilder->expr()->eq('language_tag', $queryBuilder->createNamedParameter('')),
|
|
),
|
|
)
|
|
->orderBy('sorting', 'DESC');
|
|
if (!$this->BE_USER->isAdmin()) {
|
|
$queryBuilder->andWhere($this->BE_USER->getPagePermsClause(Permission::PAGE_SHOW));
|
|
}
|
|
if ($this->BE_USER->workspace === 0) {
|
|
$queryBuilder->andWhere(
|
|
$queryBuilder->expr()->eq('t3ver_wsid', $queryBuilder->createNamedParameter(0, Connection::PARAM_INT))
|
|
);
|
|
} else {
|
|
$queryBuilder->andWhere($queryBuilder->expr()->in(
|
|
't3ver_wsid',
|
|
$queryBuilder->createNamedParameter([0, $this->BE_USER->workspace], Connection::PARAM_INT_ARRAY)
|
|
));
|
|
}
|
|
$result = $queryBuilder->executeQuery();
|
|
|
|
$pages = [];
|
|
while ($row = $result->fetchAssociative()) {
|
|
$pages[$row['uid']] = $row;
|
|
}
|
|
|
|
// Resolve placeholders of workspace versions
|
|
if (!empty($pages) && $this->BE_USER->workspace !== 0) {
|
|
$pages = array_reverse(
|
|
$this->resolveVersionedRecords(
|
|
'pages',
|
|
'uid',
|
|
'sorting',
|
|
array_keys($pages)
|
|
),
|
|
true
|
|
);
|
|
}
|
|
|
|
foreach ($pages as $page) {
|
|
if ($page['uid'] != $rootID) {
|
|
$CPtable[$page['uid']] = $pid;
|
|
// If the uid is NOT the rootID of the copyaction and if we are supposed to walk further down
|
|
if ($counter - 1) {
|
|
$CPtable = $this->int_pageTreeInfo($CPtable, $page['uid'], $counter - 1, $rootID);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $CPtable;
|
|
}
|
|
|
|
/**
|
|
* Checks if any uniqueInPid eval input fields are in the record and if so, they are re-written to be correct.
|
|
*/
|
|
protected function fixUniqueInPid(string $table, array $row): void
|
|
{
|
|
$newData = [];
|
|
// Use type-specific sub-schema fields if available, otherwise main schema fields
|
|
foreach ($this->getTypeSpecificFields($table, $row) as $field) {
|
|
if ($field->isType(TableColumnType::INPUT, TableColumnType::EMAIL) && (string)($row[$field->getName()] ?? '') !== '') {
|
|
$evalCodesArray = GeneralUtility::trimExplode(',', $field->getConfiguration()['eval'] ?? '', true);
|
|
if (in_array('uniqueInPid', $evalCodesArray, true)) {
|
|
$newValue = $this->getUnique($table, $field->getName(), $row[$field->getName()], (int)$row['uid'], (int)$row['pid']);
|
|
if ((string)$newValue !== (string)$row[$field->getName()]) {
|
|
$newData[$field->getName()] = $newValue;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if (!empty($newData)) {
|
|
$this->updateDB($table, (int)$row['uid'], $newData, (int)$row['pid']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks if any uniqueInSite eval fields are in the record and if so, they are re-written to be correct.
|
|
*
|
|
* @return bool whether the record had to be fixed or not
|
|
*/
|
|
protected function fixUniqueInSite(string $table, int|array $uidOrRow): bool
|
|
{
|
|
// Load record first to determine record type for columnsOverrides support
|
|
if (is_array($uidOrRow)) {
|
|
$row = $uidOrRow;
|
|
} else {
|
|
$row = BackendUtility::getRecord($table, $uidOrRow, '*', '', false);
|
|
}
|
|
if (!is_array($row)) {
|
|
return false;
|
|
}
|
|
$newData = [];
|
|
foreach ($this->getTypeSpecificFields($table, $row) as $field) {
|
|
if (!$field->isType(TableColumnType::SLUG)) {
|
|
continue;
|
|
}
|
|
$conf = $field->getConfiguration();
|
|
$evalCodesArray = GeneralUtility::trimExplode(',', $conf['eval'] ?? '', true);
|
|
if (!in_array('uniqueInSite', $evalCodesArray, true)) {
|
|
continue;
|
|
}
|
|
if ((string)($row[$field->getName()] ?? '') === '') {
|
|
continue;
|
|
}
|
|
$helper = GeneralUtility::makeInstance(SlugHelper::class, $table, $field->getName(), $conf, $this->BE_USER->workspace);
|
|
$state = RecordStateFactory::forName($table)->fromArray($row);
|
|
$newValue = $helper->buildSlugForUniqueInSite($row[$field->getName()], $state);
|
|
if ((string)$newValue !== (string)$row[$field->getName()]) {
|
|
$newData[$field->getName()] = $newValue;
|
|
}
|
|
}
|
|
if (!empty($newData)) {
|
|
$this->updateDB($table, (int)$row['uid'], $newData, (int)$row['pid']);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check if there are subpages that need an adoption as well
|
|
*/
|
|
protected function fixUniqueInSiteForSubpages(int $pageId): void
|
|
{
|
|
// Get ALL subpages to update - read-permissions are respected
|
|
$subPages = $this->int_pageTreeInfo([], $pageId, 99, $pageId);
|
|
// Now fix uniqueInSite for subpages
|
|
foreach ($subPages as $thePageUid => $thePagePid) {
|
|
$recordWasModified = $this->fixUniqueInSite('pages', $thePageUid);
|
|
if ($recordWasModified) {
|
|
// @todo: Add logging and history - but how? we don't know the data that was in the system before
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* When a record is copied you can specify fields from the previous record which should be copied into the new one
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $prevUid UID of previous record
|
|
*
|
|
* @return array Output array (For when the copying operation needs to get the information instead of updating the info)
|
|
*/
|
|
protected function fixCopyAfterDuplFields(string $table, int $prevUid): array
|
|
{
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
if (!isset($schema->getRawConfiguration()['copyAfterDuplFields'])) {
|
|
return [];
|
|
}
|
|
if (($prevData = BackendUtility::getRecord($table, $prevUid, '*', '', false)) === null) {
|
|
return [];
|
|
}
|
|
|
|
$fieldNames = GeneralUtility::trimExplode(',', $schema->getRawConfiguration()['copyAfterDuplFields'], true);
|
|
$newData = [];
|
|
foreach ($fieldNames as $fieldName) {
|
|
if ($schema->hasField($fieldName)) {
|
|
$fieldType = $schema->getField($fieldName);
|
|
$fieldName = $fieldType->getName();
|
|
if (!isset($newData[$fieldName])) {
|
|
$newData[$fieldName] = $prevData[$fieldName];
|
|
}
|
|
}
|
|
}
|
|
return $newData;
|
|
}
|
|
|
|
/**
|
|
* Casts a reference value. In case MM relations or foreign_field
|
|
* references are used. All other configurations, as well as
|
|
* foreign_table(!) could be stored as comma-separated-values
|
|
* as well. Since the system is not able to determine the default
|
|
* value automatically then, the TCA default value is used if
|
|
* it has been defined.
|
|
*
|
|
* @param int|string $value The value to be casted (e.g. '', '0', '1,2,3')
|
|
* @param array $configuration The TCA configuration of the accordant field
|
|
* @param bool $isNew is the record new or not
|
|
* @return int|string
|
|
*/
|
|
protected function castReferenceValue($value, array $configuration, bool $isNew)
|
|
{
|
|
if ((string)$value !== '') {
|
|
return $value;
|
|
}
|
|
|
|
if (!empty($configuration['MM']) || !empty($configuration['foreign_field'])) {
|
|
return 0;
|
|
}
|
|
|
|
if (!$isNew && isset($configuration['renderType']) && $configuration['renderType'] === 'selectCheckBox') {
|
|
return '';
|
|
}
|
|
|
|
foreach (($configuration['items'] ?? []) as $item) {
|
|
if ($item['value'] === $value) {
|
|
return $value;
|
|
}
|
|
}
|
|
|
|
if (array_key_exists('default', $configuration)) {
|
|
return $configuration['default'];
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Returns TRUE if the TCA/columns field type is a DB reference field
|
|
*
|
|
* @param array $conf Config array for TCA/columns field
|
|
* @return bool TRUE if DB reference field (group/db or select with foreign-table)
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function isReferenceField($conf): bool
|
|
{
|
|
if (!isset($conf['type'])) {
|
|
return false;
|
|
}
|
|
return ($conf['type'] === 'group') || (($conf['type'] === 'select' || $conf['type'] === 'category') && !empty($conf['foreign_table']));
|
|
}
|
|
|
|
/**
|
|
* Returns the subtype as a string of a relation (inline / file) field.
|
|
* If it's not a relation field at all, it returns FALSE.
|
|
*
|
|
* @param array $conf Config array for TCA/columns field
|
|
* @return string|bool string Inline subtype (field|mm|list), boolean: FALSE
|
|
*/
|
|
protected function getRelationFieldType($conf): bool|string
|
|
{
|
|
if (
|
|
empty($conf['foreign_table'])
|
|
|| !in_array($conf['type'] ?? '', ['inline', 'file'], true)
|
|
|| ($conf['type'] === 'file' && !($conf['foreign_field'] ?? false))
|
|
) {
|
|
return false;
|
|
}
|
|
if ($conf['foreign_field'] ?? false) {
|
|
// The reference to the parent is stored in a pointer field in the child record
|
|
return 'field';
|
|
}
|
|
if ($conf['MM'] ?? false) {
|
|
// Regular MM intermediate table is used to store data
|
|
return 'mm';
|
|
}
|
|
// An item list (separated by comma) is stored (like select type is doing)
|
|
return 'list';
|
|
}
|
|
|
|
/**
|
|
* Get modified header for a copied record
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $pid PID value in which other records to test might be
|
|
* @param string $field Field name to get header value for.
|
|
* @param string $value Current field value
|
|
* @param int $count Counter (number of recursions)
|
|
* @param string $prevTitle Previous title we checked for (in previous recursion)
|
|
* @return string The field value, possibly appended with a "copy label
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function getCopyHeader($table, $pid, $field, $value, $count, $prevTitle = '')
|
|
{
|
|
// Set title value to check for:
|
|
$checkTitle = $value;
|
|
$labelToAppend = $this->prependLabel($table);
|
|
if ($count > 0) {
|
|
$checkTitle = $value . rtrim(' ' . sprintf($labelToAppend, $count));
|
|
}
|
|
// Do check:
|
|
if ($prevTitle != $checkTitle || $count < 100) {
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$rowCount = $queryBuilder
|
|
->count('uid')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter($pid, Connection::PARAM_INT)),
|
|
$queryBuilder->expr()->eq($field, $queryBuilder->createNamedParameter($checkTitle))
|
|
)
|
|
->executeQuery()
|
|
->fetchOne();
|
|
// Only call getCopyHeader() again, if $labelToAppend is actually filled, otherwise we execute
|
|
// superfluous calls to the DB
|
|
if ($rowCount && $labelToAppend !== '') {
|
|
return $this->getCopyHeader($table, $pid, $field, $value, $count + 1, $checkTitle);
|
|
}
|
|
}
|
|
// Default is to just return the current input title if no other was returned before:
|
|
return $checkTitle;
|
|
}
|
|
|
|
/**
|
|
* Return "copy" label for a table. Although the name is "prepend" it actually APPENDs the label (after ...)
|
|
*
|
|
* @param string $table Table name
|
|
* @return string Label to append, containing "%s" for the number
|
|
*/
|
|
protected function prependLabel($table): string
|
|
{
|
|
if ($this->tcaSchemaFactory->has($table)) {
|
|
return $this->getLanguageService()->sL($this->tcaSchemaFactory->get($table)->getCapability(TcaSchemaCapability::PrependLabelTextAtCopy)->getValue());
|
|
}
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Get the final pid based on $table and $pid ($destPid type... pos/neg)
|
|
*
|
|
* @param string $table Table name
|
|
* @param int $pid "Destination pid": If the value is >= 0 it's just returned directly (through (int)though) but if the
|
|
* value is <0 then the method looks up the record with the uid equal to abs($pid) (positive number) and
|
|
* returns the PID of that record! The idea is that negative numbers point to the record AFTER WHICH the
|
|
* position is supposed to be!
|
|
*/
|
|
protected function resolvePid($table, $pid): int
|
|
{
|
|
if ($pid >= 0) {
|
|
return (int)$pid;
|
|
}
|
|
return (int)(BackendUtility::getRecord($table, abs((int)$pid), 'pid', '', false)['pid']);
|
|
}
|
|
|
|
/**
|
|
* Removes the prependAtCopy prefix on values
|
|
*
|
|
* @param string $table Table name
|
|
* @param string $value The value to fix
|
|
* @return string Clean name
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function clearPrefixFromValue($table, $value)
|
|
{
|
|
$regex = '/\s' . sprintf(preg_quote($this->prependLabel($table)), '[0-9]*') . '$/';
|
|
return @preg_replace($regex, '', $value);
|
|
}
|
|
|
|
/**
|
|
* Determine if a record was copied or if a record is the result of a copy action.
|
|
*
|
|
* @param string $table The tablename of the record
|
|
* @param int $uid The uid of the record
|
|
* @return bool Returns TRUE if the record is copied or is the result of a copy action
|
|
* @internal should only be used from within DataHandler
|
|
*/
|
|
public function isRecordCopied($table, $uid): bool
|
|
{
|
|
// If the record was copied:
|
|
if (isset($this->copyMappingArray[$table][$uid])) {
|
|
return true;
|
|
}
|
|
if (isset($this->copyMappingArray[$table]) && in_array($uid, array_values($this->copyMappingArray[$table]))) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Clearing the cache based on a page being updated
|
|
* If the $table is 'pages' then cache is cleared for all pages on the same level (and subsequent?)
|
|
* Else just clear the cache for the parent page of the record.
|
|
*
|
|
* @param string $table Table name of record that was just updated.
|
|
* @param int $uid UID of updated / inserted record
|
|
* @param int $pid REAL PID of page of a deleted/moved record to get TSconfig in ClearCache.
|
|
* @internal This method is not meant to be called directly but only from the core itself or from hooks
|
|
*/
|
|
public function registerRecordIdForPageCacheClearing($table, $uid, $pid = null): void
|
|
{
|
|
if (!is_array(static::$recordsToClearCacheFor[$table] ?? false)) {
|
|
static::$recordsToClearCacheFor[$table] = [];
|
|
}
|
|
static::$recordsToClearCacheFor[$table][] = (int)$uid;
|
|
if ($pid !== null) {
|
|
if (!isset(static::$recordPidsForDeletedRecords[$table]) || !is_array(static::$recordPidsForDeletedRecords[$table])) {
|
|
static::$recordPidsForDeletedRecords[$table] = [];
|
|
}
|
|
static::$recordPidsForDeletedRecords[$table][$uid][] = (int)$pid;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Do the actual clear cache
|
|
*/
|
|
protected function processClearCacheQueue(): void
|
|
{
|
|
$tagsToClear = [];
|
|
$clearCacheCommands = [];
|
|
|
|
foreach (static::$recordsToClearCacheFor as $table => $uids) {
|
|
foreach (array_unique($uids) as $uid) {
|
|
if ($uid <= 0 || !$this->tcaSchemaFactory->has($table)) {
|
|
return;
|
|
}
|
|
// For move commands we may get more then 1 parent.
|
|
$pageUids = $this->getOriginalParentOfRecord($table, $uid);
|
|
foreach ($pageUids as $originalParent) {
|
|
[$tagsToClearFromPrepare, $clearCacheCommandsFromPrepare]
|
|
= $this->prepareCacheFlush($table, $uid, $originalParent);
|
|
$tagsToClear = array_merge($tagsToClear, $tagsToClearFromPrepare);
|
|
$clearCacheCommands = array_merge($clearCacheCommands, $clearCacheCommandsFromPrepare);
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->cacheManager->flushCachesInGroupByTags('pages', array_keys($tagsToClear));
|
|
|
|
// Filter duplicate cache commands from cacheQueue
|
|
$clearCacheCommands = array_unique($clearCacheCommands);
|
|
// Execute collected clear cache commands from page TSconfig
|
|
foreach ($clearCacheCommands as $command) {
|
|
$this->clear_cacheCmd($command);
|
|
}
|
|
|
|
// Reset the cache clearing array
|
|
static::$recordsToClearCacheFor = [];
|
|
|
|
// Reset the original pid array
|
|
static::$recordPidsForDeletedRecords = [];
|
|
}
|
|
|
|
/**
|
|
* Prepare the cache clearing
|
|
*
|
|
* @param string $table Table name of record that needs to be cleared
|
|
* @param int $uid UID of record for which the cache needs to be cleared
|
|
* @param int $pid Original pid of the page of the record which the cache needs to be cleared
|
|
* @return array Array with tagsToClear and clearCacheCommands
|
|
*/
|
|
protected function prepareCacheFlush(string $table, int $uid, $pid): array
|
|
{
|
|
$tagsToClear = [];
|
|
$clearCacheCommands = [];
|
|
$pageUid = 0;
|
|
$clearCacheEnabled = true;
|
|
// Get Page TSconfig relevant:
|
|
$TSConfig = BackendUtility::getPagesTSconfig($pid)['TCEMAIN.'] ?? [];
|
|
|
|
if (!empty($TSConfig['clearCache_disable'])) {
|
|
$clearCacheEnabled = false;
|
|
}
|
|
|
|
if ($clearCacheEnabled && $this->BE_USER->workspace !== 0 && $this->tcaSchemaFactory->has($table) && $this->tcaSchemaFactory->get($table)->hasCapability(TcaSchemaCapability::Workspace)) {
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable($table);
|
|
$queryBuilder->getRestrictions()
|
|
->removeAll()
|
|
->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$count = $queryBuilder
|
|
->count('uid')
|
|
->from($table)
|
|
->where(
|
|
$queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($uid, Connection::PARAM_INT)),
|
|
$queryBuilder->expr()->eq('t3ver_oid', 0)
|
|
)
|
|
->executeQuery()
|
|
->fetchOne();
|
|
if ($count === 0) {
|
|
$clearCacheEnabled = false;
|
|
}
|
|
}
|
|
|
|
if ($clearCacheEnabled) {
|
|
$pageIdsThatNeedCacheFlush = [];
|
|
if ($table === 'pages') {
|
|
// If table is "pages", Find out if the record is a localized one and get the default page
|
|
$pageUid = $this->getDefaultLanguagePageId($uid);
|
|
|
|
// Builds list of pages on the SAME level as this page (siblings)
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable('pages');
|
|
$queryBuilder->getRestrictions()
|
|
->removeAll()
|
|
->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$siblings = $queryBuilder
|
|
->select('A.pid AS pid', 'B.uid AS uid')
|
|
->from('pages', 'A')
|
|
->from('pages', 'B')
|
|
->where(
|
|
$queryBuilder->expr()->eq('A.uid', $queryBuilder->createNamedParameter($pageUid, Connection::PARAM_INT)),
|
|
$queryBuilder->expr()->eq('B.pid', $queryBuilder->quoteIdentifier('A.pid')),
|
|
$queryBuilder->expr()->gte('A.pid', $queryBuilder->createNamedParameter(0, Connection::PARAM_INT))
|
|
)
|
|
->executeQuery();
|
|
|
|
$parentPageId = 0;
|
|
while ($row_tmp = $siblings->fetchAssociative()) {
|
|
$pageIdsThatNeedCacheFlush[] = (int)$row_tmp['uid'];
|
|
$parentPageId = (int)$row_tmp['pid'];
|
|
// Add children as well:
|
|
if ($TSConfig['clearCache_pageSiblingChildren'] ?? false) {
|
|
$siblingChildrenQuery = $this->connectionPool->getQueryBuilderForTable('pages');
|
|
$siblingChildrenQuery->getRestrictions()
|
|
->removeAll()
|
|
->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$siblingChildren = $siblingChildrenQuery
|
|
->select('uid')
|
|
->from('pages')
|
|
->where($siblingChildrenQuery->expr()->eq(
|
|
'pid',
|
|
$siblingChildrenQuery->createNamedParameter($row_tmp['uid'], Connection::PARAM_INT)
|
|
))
|
|
->executeQuery();
|
|
while ($row_tmp2 = $siblingChildren->fetchAssociative()) {
|
|
$pageIdsThatNeedCacheFlush[] = (int)$row_tmp2['uid'];
|
|
}
|
|
}
|
|
}
|
|
// Finally, add the parent page as well when clearing a specific page
|
|
if ($parentPageId > 0) {
|
|
$pageIdsThatNeedCacheFlush[] = $parentPageId;
|
|
}
|
|
// Add grandparent as well if configured
|
|
if ($TSConfig['clearCache_pageGrandParent'] ?? false) {
|
|
$parentQuery = $this->connectionPool->getQueryBuilderForTable('pages');
|
|
$parentQuery->getRestrictions()
|
|
->removeAll()
|
|
->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
|
$row_tmp = $parentQuery
|
|
->select('pid')
|
|
->from('pages')
|
|
->where($parentQuery->expr()->eq(
|
|
'uid',
|
|
$parentQuery->createNamedParameter($parentPageId, Connection::PARAM_INT)
|
|
))
|
|
->executeQuery()
|
|
->fetchAssociative();
|
|
if (!empty($row_tmp)) {
|
|
$pageIdsThatNeedCacheFlush[] = (int)$row_tmp['pid'];
|
|
}
|
|
}
|
|
} else {
|
|
// For other tables than "pages", delete cache for the records "parent page".
|
|
$pageUid = (int)(BackendUtility::getRecord($table, $uid, 'pid', '', false)['pid'] ?? 0);
|
|
if ($pageUid > 0) {
|
|
$pageIdsThatNeedCacheFlush[] = $pageUid;
|
|
if ($TSConfig['clearCache_pageGrandParent'] ?? false) {
|
|
// Add the parent page as well
|
|
$grandPageUid = (int)(BackendUtility::getRecord('pages', $pageUid, 'pid')['pid'] ?? 0);
|
|
if ($grandPageUid > 0) {
|
|
$pageIdsThatNeedCacheFlush[] = $grandPageUid;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// Call pre-processing function for clearing of cache for page ids:
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['clearPageCacheEval'] ?? [] as $funcName) {
|
|
$_params = ['pageIdArray' => &$pageIdsThatNeedCacheFlush, 'table' => $table, 'uid' => $uid, 'functionID' => 'clear_cache()'];
|
|
// Returns the array of ids to clear, FALSE if nothing should be cleared! Never an empty array!
|
|
GeneralUtility::callUserFunction($funcName, $_params, $this);
|
|
}
|
|
// Delete cache for selected pages:
|
|
foreach ($pageIdsThatNeedCacheFlush as $pageId) {
|
|
$tagsToClear['pageId_' . $pageId] = true;
|
|
}
|
|
// Queue delete cache for current table and record
|
|
$tagsToClear[$table] = true;
|
|
$tagsToClear[$table . '_' . $uid] = true;
|
|
}
|
|
// Clear cache for pages entered in TSconfig:
|
|
if (!empty($TSConfig['clearCacheCmd'])) {
|
|
$commands = GeneralUtility::trimExplode(',', $TSConfig['clearCacheCmd'], true);
|
|
$clearCacheCommands = array_unique($commands);
|
|
}
|
|
// Call post-processing function for clear-cache:
|
|
$_params = ['table' => $table, 'uid' => $uid, 'uid_page' => $pageUid, 'TSConfig' => $TSConfig, 'tags' => &$tagsToClear, 'clearCacheCommands' => &$clearCacheCommands, 'clearCacheEnabled' => $clearCacheEnabled];
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['clearCachePostProc'] ?? [] as $_funcRef) {
|
|
GeneralUtility::callUserFunction($_funcRef, $_params, $this);
|
|
}
|
|
return [
|
|
$tagsToClear,
|
|
$clearCacheCommands,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Clears the cache based on the command $cacheCmd.
|
|
*
|
|
* $cacheCmd='pages'
|
|
* Clears cache for all pages and page-based caches inside the cache manager.
|
|
* Requires admin-flag to be set for BE_USER.
|
|
*
|
|
* $cacheCmd='all'
|
|
* Clears all cache_tables. This is necessary if templates are updated.
|
|
* Requires admin-flag to be set for BE_USER.
|
|
*
|
|
* The following cache_* are intentionally not cleared by 'all'
|
|
*
|
|
* - all caches inside the cache manager that are inside the group "system"
|
|
* - they are only needed to build up the core system and templates.
|
|
* If the group of system caches needs to be deleted explicitly, use
|
|
* flushCachesInGroup('system') of CacheManager directly.
|
|
*
|
|
* $cacheCmd=[integer]
|
|
* Clears cache for the page pointed to by $cacheCmd (an integer).
|
|
*
|
|
* $cacheCmd='cacheTag:[string]'
|
|
* Flush page cache by given tag
|
|
*
|
|
* Can call a list of post processing functions as defined in
|
|
* $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['clearCachePostProc']
|
|
* (numeric array with values being the function references, called by
|
|
* GeneralUtility::callUserFunction()).
|
|
*
|
|
*
|
|
* @param int|string $cacheCmd The cache command, see above description
|
|
*/
|
|
public function clear_cacheCmd($cacheCmd): void
|
|
{
|
|
$this->logEntryRepository->writeLogEntryForBackendUser(
|
|
$this->BE_USER,
|
|
SystemLogType::CACHE,
|
|
SystemLogCacheAction::CLEAR,
|
|
SystemLogErrorClassification::MESSAGE,
|
|
'User {username} has cleared the cache (cacheCmd={command})',
|
|
['username' => $this->BE_USER->user['username'], 'command' => $cacheCmd]
|
|
);
|
|
$userTsConfig = $this->BE_USER->getTSConfig();
|
|
switch (strtolower($cacheCmd)) {
|
|
case 'pages':
|
|
if ($this->BE_USER->isAdmin() || ($userTsConfig['options.']['clearCache.']['pages'] ?? false)) {
|
|
$this->cacheManager->flushCachesInGroup('pages');
|
|
}
|
|
break;
|
|
case 'all':
|
|
// allow to clear all caches if the TS config option is enabled or the option is not explicitly
|
|
// disabled for admins (which could clear all caches by default). The latter option is useful
|
|
// for big production sites where it should be possible to restrict the cache clearing for some admins.
|
|
if (($userTsConfig['options.']['clearCache.']['all'] ?? false)
|
|
|| ($this->BE_USER->isAdmin() && (bool)($userTsConfig['options.']['clearCache.']['all'] ?? true))
|
|
) {
|
|
$this->cacheManager->flushCaches();
|
|
|
|
// Delete Opcode Cache
|
|
$this->opcodeCacheService->clearAllActive();
|
|
|
|
// Delete DI Cache only on development context
|
|
if (Environment::getContext()->isDevelopment()) {
|
|
$container = GeneralUtility::makeInstance(ContainerInterface::class);
|
|
$container->get('cache.di')->getBackend()->forceFlush();
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
|
|
$tagsToFlush = [];
|
|
// Clear cache for a page ID!
|
|
if (MathUtility::canBeInterpretedAsInteger($cacheCmd)) {
|
|
$list_cache = [$cacheCmd];
|
|
// Call pre-processing function for clearing of cache for page ids:
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['clearPageCacheEval'] ?? [] as $funcName) {
|
|
$_params = ['pageIdArray' => &$list_cache, 'cacheCmd' => $cacheCmd, 'functionID' => 'clear_cacheCmd()'];
|
|
// Returns the array of ids to clear, FALSE if nothing should be cleared! Never an empty array!
|
|
GeneralUtility::callUserFunction($funcName, $_params, $this);
|
|
}
|
|
// Delete cache for selected pages:
|
|
if (is_array($list_cache)) {
|
|
foreach ($list_cache as $pageId) {
|
|
$tagsToFlush[] = 'pageId_' . (int)$pageId;
|
|
}
|
|
}
|
|
}
|
|
// flush cache by tag
|
|
if (str_starts_with(strtolower($cacheCmd), 'cachetag:')) {
|
|
$cacheTag = substr($cacheCmd, 9);
|
|
$tagsToFlush[] = $cacheTag;
|
|
}
|
|
// process caching framework operations
|
|
if (!empty($tagsToFlush)) {
|
|
$this->cacheManager->flushCachesInGroupByTags('pages', $tagsToFlush);
|
|
}
|
|
|
|
// Call post-processing function for clear-cache:
|
|
$_params = ['cacheCmd' => strtolower($cacheCmd), 'tags' => $tagsToFlush];
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['clearCachePostProc'] ?? [] as $_funcRef) {
|
|
GeneralUtility::callUserFunction($_funcRef, $_params, $this);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Logging actions from DataHandler
|
|
*
|
|
* @param string $table Table name the log entry is concerned with. Blank if NA
|
|
* @param int $recuid Record UID. Zero if NA
|
|
* @param int $action Action number: 0=No category, 1=new record, 2=update record, 3= delete record, 4= move record, 5= Check/evaluate
|
|
* @param null $_ unused
|
|
* @param int $error The severity: 0 = message, 1 = error, 2 = System Error, 3 = security notice (admin), 4 warning
|
|
* @param string $details Default error message in english
|
|
* @param null $__ unused
|
|
* @param array $data Array with special information that may go into $details by '%s' marks / sprintf() when the log is shown
|
|
* @param int $event_pid The page_uid (pid) where the event occurred. Used to select log-content for specific pages.
|
|
* @return int Log entry UID (0 if no log entry was written or logging is disabled)
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public function log($table, $recuid, $action, $_, $error, $details, $__ = null, array $data = [], $event_pid = -1)
|
|
{
|
|
if (!$this->enableLogging) {
|
|
return 0;
|
|
}
|
|
if ($error > 0) {
|
|
$detailMessage = $details;
|
|
$detailMessage = $this->formatLogDetails($detailMessage, $data);
|
|
$this->errorLog[] = '[' . SystemLogType::DB . '.' . $action . ']: ' . $detailMessage;
|
|
}
|
|
return $this->logEntryRepository->writeLogEntryForBackendUser(
|
|
$this->BE_USER,
|
|
SystemLogType::DB,
|
|
(int)$action,
|
|
(int)$error,
|
|
(string)$details,
|
|
$data,
|
|
(string)$table,
|
|
abs((int)$recuid),
|
|
(int)$event_pid
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Print log error messages from the operations of this script instance and return a list of the erroneous records
|
|
*
|
|
* @internal should only be used from within TYPO3 Core
|
|
*
|
|
* @return non-empty-string[]
|
|
*/
|
|
public function printLogErrorMessages(): array
|
|
{
|
|
$queryBuilder = $this->connectionPool->getQueryBuilderForTable('sys_log');
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
$result = $queryBuilder
|
|
->select('*')
|
|
->from('sys_log')
|
|
->where(
|
|
$queryBuilder->expr()->eq('type', $queryBuilder->createNamedParameter(SystemLogType::DB, Connection::PARAM_INT)),
|
|
$queryBuilder->expr()->eq(
|
|
'userid',
|
|
$queryBuilder->createNamedParameter($this->BE_USER->user['uid'], Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->eq(
|
|
'tstamp',
|
|
$queryBuilder->createNamedParameter($GLOBALS['EXEC_TIME'], Connection::PARAM_INT)
|
|
),
|
|
$queryBuilder->expr()->neq('error', $queryBuilder->createNamedParameter(SystemLogErrorClassification::MESSAGE, Connection::PARAM_INT))
|
|
)
|
|
->executeQuery();
|
|
|
|
$affectedRecords = [];
|
|
while ($row = $result->fetchAssociative()) {
|
|
$affectedRecords[] = $row['tablename'] . '.' . $row['recuid'];
|
|
|
|
$message = $this->formatLogDetails($row['details'], $row['log_data'] ?? '');
|
|
$message = $row['error'] . ': ' . $message;
|
|
$message = $this->getLanguageService()->translate('error_during_saving', 'core.data_handler', [$message]) ?? $message;
|
|
$flashMessage = new FlashMessage($message, '', $row['error'] === SystemLogErrorClassification::WARNING ? ContextualFeedbackSeverity::WARNING : ContextualFeedbackSeverity::ERROR, true);
|
|
$defaultFlashMessageQueue = $this->flashMessageService->getMessageQueueByIdentifier();
|
|
$defaultFlashMessageQueue->enqueue($flashMessage);
|
|
}
|
|
|
|
return $affectedRecords;
|
|
}
|
|
|
|
/**
|
|
* Find out if the record is a localization. If so, get the uid of the default language page.
|
|
* Always returns the uid of the workspace live record: No explicit workspace overlay is applied.
|
|
*
|
|
* @param int $pageId Page UID, can be the default page record, or a page translation record ID
|
|
* @return int UID of the default page record in live workspace
|
|
*/
|
|
protected function getDefaultLanguagePageId(int $pageId): int
|
|
{
|
|
$languageCapability = $this->tcaSchemaFactory->get('pages')->getCapability(TcaSchemaCapability::Language);
|
|
$localizationParentFieldName = $languageCapability->getTranslationOriginPointerField()->getName();
|
|
$row = BackendUtility::getRecord('pages', $pageId, '*', '', false);
|
|
$localizationParent = (int)($row[$localizationParentFieldName] ?? 0);
|
|
if ($localizationParent > 0) {
|
|
return $localizationParent;
|
|
}
|
|
return $pageId;
|
|
}
|
|
|
|
/**
|
|
* Preprocesses field array based on field type. Some fields must be adjusted
|
|
* before going to database. This is done on the copy of the field array because
|
|
* original values are used in remap action later.
|
|
*
|
|
* @param string $table Table name
|
|
* @param array $fieldArray Field array to check
|
|
* @return array Updated field array
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public function insertUpdateDB_preprocessBasedOnFieldType($table, $fieldArray)
|
|
{
|
|
$result = $fieldArray;
|
|
$schema = $this->tcaSchemaFactory->get($table);
|
|
foreach ($fieldArray as $field => $value) {
|
|
if (MathUtility::canBeInterpretedAsInteger($value) || !$schema->hasField($field)) {
|
|
continue;
|
|
}
|
|
$fieldType = $schema->getField($field);
|
|
if ($fieldType->isType(TableColumnType::INLINE, TableColumnType::FILE)
|
|
&& ($fieldType->getConfiguration()['foreign_field'] ?? false)
|
|
) {
|
|
$result[$field] = count(GeneralUtility::trimExplode(',', $value, true));
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Gets the automatically versionized id of a record.
|
|
*
|
|
* @param string $table Name of the table
|
|
* @param int $id Uid of the record
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public function getAutoVersionId($table, $id): ?int
|
|
{
|
|
$result = null;
|
|
if (isset($this->autoVersionIdMap[$table][$id])) {
|
|
$result = (int)trim($this->autoVersionIdMap[$table][$id]);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Overlays the automatically versionized id of a record.
|
|
*
|
|
* @param string $table Name of the table
|
|
* @param int $id Uid of the record
|
|
* @return int
|
|
*/
|
|
protected function overlayAutoVersionId($table, $id)
|
|
{
|
|
$autoVersionId = $this->getAutoVersionId($table, $id);
|
|
if ($autoVersionId !== null) {
|
|
$id = $autoVersionId;
|
|
}
|
|
return $id;
|
|
}
|
|
|
|
/**
|
|
* Resolves versioned records for the current workspace scope.
|
|
* Delete placeholders are substituted and removed.
|
|
*
|
|
* @param string $tableName Name of the table to be processed
|
|
* @param string $fieldNames List of the field names to be fetched
|
|
* @param string $sortingField Name of the sorting field to be used
|
|
* @param array $liveIds Flat array of (live) record ids
|
|
* @return array
|
|
*/
|
|
protected function resolveVersionedRecords($tableName, $fieldNames, $sortingField, array $liveIds)
|
|
{
|
|
$connection = $this->connectionPool->getConnectionForTable($tableName);
|
|
$sortingStatement = !empty($sortingField)
|
|
? [$connection->quoteIdentifier($sortingField)]
|
|
: null;
|
|
$resolver = GeneralUtility::makeInstance(
|
|
PlainDataResolver::class,
|
|
$tableName,
|
|
$liveIds,
|
|
$sortingStatement
|
|
);
|
|
|
|
$resolver->setWorkspaceId($this->BE_USER->workspace);
|
|
$resolver->setKeepDeletePlaceholder(false);
|
|
$resolver->setKeepMovePlaceholder(false);
|
|
$resolver->setKeepLiveIds(true);
|
|
$recordIds = $resolver->get();
|
|
|
|
$records = [];
|
|
foreach ($recordIds as $recordId) {
|
|
$records[$recordId] = BackendUtility::getRecord($tableName, $recordId, $fieldNames);
|
|
}
|
|
|
|
return $records;
|
|
}
|
|
|
|
/**
|
|
* Evaluates if auto creation of a version of a record is allowed.
|
|
* Auto-creation of version: In offline workspace, test if versioning is
|
|
* enabled and look for workspace version of input record.
|
|
* If there is no versionized record found we will create one and save to that.
|
|
*
|
|
* @param string $table Table of the record
|
|
* @param int $id UID of record
|
|
* @param int|null $recpid PID of record
|
|
* @return bool TRUE if ok.
|
|
*/
|
|
protected function workspaceAllowAutoCreation(string $table, $id, $recpid): bool
|
|
{
|
|
// No version can be created in live workspace
|
|
if ($this->BE_USER->workspace === 0) {
|
|
return false;
|
|
}
|
|
// No versioning support for this table, so no version can be created
|
|
if (!$this->tcaSchemaFactory->get($table)->isWorkspaceAware()) {
|
|
return false;
|
|
}
|
|
if ($recpid < 0) {
|
|
return false;
|
|
}
|
|
// There must be no existing version of this record in workspace
|
|
if (BackendUtility::getWorkspaceVersionOfRecord($this->BE_USER->workspace, $table, $id, 'uid')) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Evaluates if a user is allowed to edit the offline version
|
|
*
|
|
* @param string $table Table of record
|
|
* @param array $record array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
|
|
* @return string String error code, telling the failure state. FALSE=All ok
|
|
* @internal this method will be moved to EXT:workspaces
|
|
*/
|
|
public function workspaceCannotEditOfflineVersion(string $table, array $record)
|
|
{
|
|
$versionState = VersionState::tryFrom($record['t3ver_state'] ?? 0);
|
|
if ($versionState === VersionState::NEW_PLACEHOLDER || (int)$record['t3ver_oid'] > 0) {
|
|
return $this->workspaceCannotEditRecord($table, $record);
|
|
}
|
|
return 'Not an offline version';
|
|
}
|
|
|
|
/**
|
|
* Checking if editing of an existing record is allowed in current workspace.
|
|
*
|
|
* @return string|false Error string, else false = ok
|
|
*/
|
|
protected function workspaceCannotEditRecord(string $table, array $record): string|false
|
|
{
|
|
if ($this->BE_USER->workspace === 0) {
|
|
// Early skip if user is not in workspace
|
|
return false;
|
|
}
|
|
if ($this->tcaSchemaFactory->get($table)->isWorkspaceAware() && (int)($record['t3ver_wsid'] ?? 0) > 0) {
|
|
// This is a workspace record
|
|
if ((int)$record['t3ver_wsid'] !== $this->BE_USER->workspace) {
|
|
// Workspaces of record and current user do not match
|
|
return 'Workspace ID of record does not match current user workspace';
|
|
}
|
|
// Is user allowed to use the edit stage within the workspace?
|
|
return $this->BE_USER->workspaceCheckStageForCurrent(0) ? false : 'User missing workspace editing access';
|
|
}
|
|
if ($this->BE_USER->workspaceAllowsLiveEditingInTable($table)) {
|
|
// Live records for this table are ok in current workspace
|
|
return false;
|
|
}
|
|
return 'Editing live record is not allowed';
|
|
}
|
|
|
|
/**
|
|
* Gets the outer most instance of \TYPO3\CMS\Core\DataHandling\DataHandler
|
|
* Since \TYPO3\CMS\Core\DataHandling\DataHandler can create nested objects of itself,
|
|
* this method helps to determine the first (= outer most) one.
|
|
*
|
|
* @return DataHandler
|
|
*/
|
|
protected function getOuterMostInstance()
|
|
{
|
|
if (!isset($this->outerMostInstance)) {
|
|
$stack = array_reverse(debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT | DEBUG_BACKTRACE_IGNORE_ARGS));
|
|
foreach ($stack as $stackItem) {
|
|
if (isset($stackItem['object']) && $stackItem['object'] instanceof self) {
|
|
$this->outerMostInstance = $stackItem['object'];
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
return $this->outerMostInstance;
|
|
}
|
|
|
|
/**
|
|
* Determines whether this object is the outermost instance of itself
|
|
* Since DataHandler can create nested objects of itself,
|
|
* this method helps to determine the first (= outermost) one.
|
|
*/
|
|
public function isOuterMostInstance(): bool
|
|
{
|
|
return $this->getOuterMostInstance() === $this;
|
|
}
|
|
|
|
/**
|
|
* Determines nested element calls.
|
|
*
|
|
* @param string $table Name of the table
|
|
* @param int $id Uid of the record
|
|
* @param string $identifier Name of the action to be checked
|
|
* @return bool
|
|
*/
|
|
protected function isNestedElementCallRegistered($table, $id, $identifier): bool
|
|
{
|
|
// @todo: Stop abusing runtime cache as singleton DTO, needs explicit modeling.
|
|
$nestedElementCalls = (array)$this->runtimeCache->get(self::CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX);
|
|
return isset($nestedElementCalls[$identifier][$table][$id]);
|
|
}
|
|
|
|
/**
|
|
* Registers nested elements calls.
|
|
* This is used to track nested calls (e.g. for following m:n relations).
|
|
*
|
|
* @param string $table Name of the table
|
|
* @param int $id Uid of the record
|
|
* @param string $identifier Name of the action to be tracked
|
|
*/
|
|
protected function registerNestedElementCall($table, $id, $identifier): void
|
|
{
|
|
$nestedElementCalls = (array)$this->runtimeCache->get(self::CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX);
|
|
$nestedElementCalls[$identifier][$table][$id] = true;
|
|
$this->runtimeCache->set(self::CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX, $nestedElementCalls);
|
|
}
|
|
|
|
/**
|
|
* Resets the nested element calls.
|
|
*/
|
|
protected function resetNestedElementCalls(): void
|
|
{
|
|
$this->runtimeCache->remove(self::CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX);
|
|
}
|
|
|
|
/**
|
|
* Determines whether an element was registered to be deleted in the registry.
|
|
*
|
|
* @param string $table Name of the table
|
|
* @param int $id Uid of the record
|
|
* @return bool
|
|
* @see registerElementsToBeDeleted
|
|
* @see resetElementsToBeDeleted
|
|
* @see copyRecord_raw
|
|
* @see versionizeRecord
|
|
*/
|
|
protected function isElementToBeDeleted($table, $id)
|
|
{
|
|
// @todo: Stop abusing runtime cache as singleton DTO, needs explicit modeling.
|
|
$elementsToBeDeleted = (array)$this->runtimeCache->get(self::CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED);
|
|
return isset($elementsToBeDeleted[$table][$id]);
|
|
}
|
|
|
|
/**
|
|
* Registers elements to be deleted in the registry.
|
|
*
|
|
* @see process_datamap
|
|
*/
|
|
protected function registerElementsToBeDeleted(): void
|
|
{
|
|
$elementsToBeDeleted = (array)$this->runtimeCache->get(self::CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED);
|
|
$this->runtimeCache->set(self::CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED, array_merge($elementsToBeDeleted, $this->getCommandMapElements('delete')));
|
|
}
|
|
|
|
/**
|
|
* Resets the elements to be deleted in the registry.
|
|
*
|
|
* @see process_datamap
|
|
*/
|
|
protected function resetElementsToBeDeleted(): void
|
|
{
|
|
$this->runtimeCache->remove(self::CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED);
|
|
}
|
|
|
|
/**
|
|
* Unsets elements (e.g. of the data map) that shall be deleted.
|
|
* This avoids to modify records that will be deleted later on.
|
|
*
|
|
* @param array $elements Elements to be modified
|
|
*/
|
|
protected function unsetElementsToBeDeleted(array $elements): array
|
|
{
|
|
$elements = ArrayUtility::arrayDiffKeyRecursive($elements, $this->getCommandMapElements('delete'));
|
|
foreach ($elements as $key => $value) {
|
|
if (empty($value)) {
|
|
unset($elements[$key]);
|
|
}
|
|
}
|
|
return $elements;
|
|
}
|
|
|
|
/**
|
|
* Gets elements of the command map that match a particular command.
|
|
*
|
|
* @param string $needle The command to be matched
|
|
*/
|
|
protected function getCommandMapElements(string $needle): array
|
|
{
|
|
$elements = [];
|
|
foreach ($this->cmdmap as $tableName => $idArray) {
|
|
foreach ($idArray as $id => $commandArray) {
|
|
foreach ($commandArray as $command => $value) {
|
|
if ($value && $command == $needle) {
|
|
$elements[$tableName][$id] = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $elements;
|
|
}
|
|
|
|
/**
|
|
* Controls active elements and sets NULL values if not active.
|
|
* Datamap is modified accordant to submitted control values.
|
|
*/
|
|
protected function controlActiveElements(): void
|
|
{
|
|
if (!empty($this->control['active'])) {
|
|
$this->setNullValues(
|
|
$this->control['active'],
|
|
$this->datamap
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets NULL values in haystack array.
|
|
* The general behaviour in the user interface is to enable/activate fields.
|
|
* Thus, this method uses NULL as value to be stored if a field is not active.
|
|
*
|
|
* @param array $active hierarchical array with active elements
|
|
* @param array $haystack hierarchical array with haystack to be modified
|
|
*/
|
|
protected function setNullValues(array $active, array &$haystack): void
|
|
{
|
|
foreach ($active as $key => $value) {
|
|
// Nested data is processes recursively
|
|
if (is_array($value)) {
|
|
$this->setNullValues(
|
|
$value,
|
|
$haystack[$key]
|
|
);
|
|
} elseif ($value == 0) {
|
|
// Field has not been activated in the user interface,
|
|
// thus a NULL value shall be stored in the database
|
|
$haystack[$key] = null;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @deprecated since TYPO3 v15.0, will be removed in TYPO3 v16.0. Pass the CorrelationId to DataHandler->start() instead.
|
|
*/
|
|
public function setCorrelationId(CorrelationId $correlationId): void
|
|
{
|
|
trigger_error(
|
|
'DataHandler->setCorrelationId() is deprecated since TYPO3 v15.0 and will be removed in TYPO3 v16.0. Pass the CorrelationId to DataHandler->start() instead.',
|
|
E_USER_DEPRECATED
|
|
);
|
|
$this->correlationId = $correlationId;
|
|
}
|
|
|
|
public function getCorrelationId(): ?CorrelationId
|
|
{
|
|
return $this->correlationId;
|
|
}
|
|
|
|
/**
|
|
* Entry point to post process a database insert. Currently bails early unless a UID has been forced
|
|
* and the database platform is not MySQL.
|
|
*/
|
|
protected function postProcessDatabaseInsert(Connection $connection, string $tableName, int $suggestedUid): int
|
|
{
|
|
if ($suggestedUid !== 0 && $connection->getDatabasePlatform() instanceof PostgreSqlPlatform) {
|
|
$this->postProcessPostgresqlInsert($connection, $tableName);
|
|
// The last inserted id on postgresql is actually the last value generated by the sequence.
|
|
// On a forced UID insert this might not be the actual value or the sequence might not even
|
|
// have generated a value yet.
|
|
// Return the actual ID we forced on insert as a surrogate.
|
|
return $suggestedUid;
|
|
}
|
|
$id = $connection->lastInsertId();
|
|
return (int)$id;
|
|
}
|
|
|
|
/**
|
|
* PostgreSQL works with sequences for auto increment columns. A sequence is not updated when a value is
|
|
* written to such a column. To avoid clashes when the sequence returns an existing ID this helper will
|
|
* update the sequence to the current max value of the column.
|
|
*/
|
|
protected function postProcessPostgresqlInsert(Connection $connection, string $tableName): void
|
|
{
|
|
$queryBuilder = $connection->createQueryBuilder();
|
|
$queryBuilder->getRestrictions()->removeAll();
|
|
$row = $queryBuilder->select('PGT.schemaname', 'S.relname', 'C.attname', 'T.relname AS tablename')
|
|
->from('pg_class', 'S')
|
|
->from('pg_depend', 'D')
|
|
->from('pg_class', 'T')
|
|
->from('pg_attribute', 'C')
|
|
->from('pg_tables', 'PGT')
|
|
->where(
|
|
$queryBuilder->expr()->eq('S.relkind', $queryBuilder->quote('S')),
|
|
$queryBuilder->expr()->eq('S.oid', $queryBuilder->quoteIdentifier('D.objid')),
|
|
$queryBuilder->expr()->eq('D.refobjid', $queryBuilder->quoteIdentifier('T.oid')),
|
|
$queryBuilder->expr()->eq('D.refobjid', $queryBuilder->quoteIdentifier('C.attrelid')),
|
|
$queryBuilder->expr()->eq('D.refobjsubid', $queryBuilder->quoteIdentifier('C.attnum')),
|
|
$queryBuilder->expr()->eq('T.relname', $queryBuilder->quoteIdentifier('PGT.tablename')),
|
|
$queryBuilder->expr()->eq('PGT.tablename', $queryBuilder->quote($tableName))
|
|
)
|
|
->setMaxResults(1)
|
|
->executeQuery()
|
|
->fetchAssociative();
|
|
if ($row !== false) {
|
|
$connection->executeStatement(
|
|
sprintf(
|
|
'SELECT SETVAL(%s, COALESCE(MAX(%s), 0)+1, FALSE) FROM %s',
|
|
$connection->quote($row['schemaname'] . '.' . $row['relname']),
|
|
$connection->quoteIdentifier($row['attname']),
|
|
$connection->quoteIdentifier($row['schemaname'] . '.' . $row['tablename'])
|
|
)
|
|
);
|
|
}
|
|
}
|
|
|
|
protected function createRelationHandlerInstance(): RelationHandler
|
|
{
|
|
$isWorkspacesLoaded = ExtensionManagementUtility::isLoaded('workspaces');
|
|
$relationHandler = GeneralUtility::makeInstance(RelationHandler::class);
|
|
$relationHandler->setWorkspaceId($this->BE_USER->workspace);
|
|
$relationHandler->setUseLiveReferenceIds($isWorkspacesLoaded);
|
|
$relationHandler->setUseLiveParentIds($isWorkspacesLoaded);
|
|
$relationHandler->setReferenceIndexUpdater($this->referenceIndexUpdater);
|
|
return $relationHandler;
|
|
}
|
|
|
|
protected function getLanguageService(): LanguageService
|
|
{
|
|
return $GLOBALS['LANG'];
|
|
}
|
|
|
|
/**
|
|
* @internal should only be used from within TYPO3 Core
|
|
*/
|
|
public function getHistoryRecords(): array
|
|
{
|
|
return $this->historyRecords;
|
|
}
|
|
}
|