PlainDataResolver.php

Go to the documentation of this file.

<?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 ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Versioning\VersionState;
 
class ‪PlainDataResolver
{
    protected ‪$tableName;
 
    protected ‪$liveIds;
 
    protected ‪$sortingStatement;
 
    protected ‪$workspaceId;
 
    protected ‪$keepLiveIds = false;
 
    protected ‪$keepDeletePlaceholder = false;
 
    protected ‪$keepMovePlaceholder = true;
 
    public function ‪__construct(‪$tableName, array ‪$liveIds, array ‪$sortingStatement = null)
    {
        $this->tableName = ‪$tableName;
        $this->liveIds = $this->‪reindex($this->‪sanitizeIds($liveIds));
        $this->sortingStatement = ‪$sortingStatement;
    }
 
    public function ‪setWorkspaceId(‪$workspaceId)
    {
        $this->workspaceId = (int)‪$workspaceId;
    }
 
    public function ‪setKeepLiveIds(‪$keepLiveIds)
    {
        $this->keepLiveIds = (bool)‪$keepLiveIds;
        return $this;
    }
 
    public function ‪setKeepDeletePlaceholder(‪$keepDeletePlaceholder)
    {
        $this->keepDeletePlaceholder = (bool)‪$keepDeletePlaceholder;
        return $this;
    }
 
    public function ‪setKeepMovePlaceholder(‪$keepMovePlaceholder)
    {
        $this->keepMovePlaceholder = (bool)‪$keepMovePlaceholder;
        return $this;
    }
 
    public function get()
    {
        $resolvedIds = $this->‪processVersionOverlays($this->liveIds);
        if ($resolvedIds !== $this->liveIds) {
            $resolvedIds = $this->‪reindex($resolvedIds);
        }
 
        $tempIds = $this->‪processSorting($resolvedIds);
        if ($tempIds !== $resolvedIds) {
            $resolvedIds = $this->‪reindex($tempIds);
        }
 
        $tempIds = $this->‪applyLiveIds($resolvedIds);
        if ($tempIds !== $resolvedIds) {
            $resolvedIds = $this->‪reindex($tempIds);
        }
 
        return $resolvedIds;
    }
 
    public function ‪processVersionOverlays(array $ids)
    {
        $ids = $this->‪sanitizeIds($ids);
        if (empty($this->workspaceId) || !$this->‪isWorkspaceEnabled() || empty($ids)) {
            return $ids;
        }
 
        $ids = $this->‪reindex(
            $this->‪processVersionMovePlaceholders($ids)
        );
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($this->tableName);
 
        $queryBuilder->getRestrictions()->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
 
        $result = $queryBuilder
            ->select('uid', 't3ver_oid', 't3ver_state')
            ->from($this->tableName)
            ->where(
                $queryBuilder->expr()->in(
                    't3ver_oid',
                    $queryBuilder->createNamedParameter($ids, Connection::PARAM_INT_ARRAY)
                ),
                $queryBuilder->expr()->eq(
                    't3ver_wsid',
                    $queryBuilder->createNamedParameter($this->workspaceId, \PDO::PARAM_INT)
                )
            )
            ->execute();
 
        while ($version = $result->fetch()) {
            $liveReferenceId = $version['t3ver_oid'];
            $versionId = $version['uid'];
            if (isset($ids[$liveReferenceId])) {
                if (!$this->keepDeletePlaceholder
                    && ‪VersionState::cast($version['t3ver_state'])->equals(‪VersionState::DELETE_PLACEHOLDER)
                ) {
                    unset($ids[$liveReferenceId]);
                } else {
                    $ids[$liveReferenceId] = $versionId;
                }
            }
        }
 
        return $ids;
    }
 
    public function ‪processVersionMovePlaceholders(array $ids)
    {
        $ids = $this->‪sanitizeIds($ids);
        // Early return on insufficient data-set
        if (empty($this->workspaceId) || !$this->‪isWorkspaceEnabled() || empty($ids)) {
            return $ids;
        }
 
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($this->tableName);
 
        $queryBuilder->getRestrictions()->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
 
        $result = $queryBuilder
            ->select('uid', 't3ver_move_id')
            ->from($this->tableName)
            ->where(
                $queryBuilder->expr()->eq(
                    't3ver_state',
                    $queryBuilder->createNamedParameter((string)‪VersionState::MOVE_PLACEHOLDER, \PDO::PARAM_INT)
                ),
                $queryBuilder->expr()->eq(
                    't3ver_wsid',
                    $queryBuilder->createNamedParameter($this->workspaceId, \PDO::PARAM_INT)
                ),
                $queryBuilder->expr()->in(
                    't3ver_move_id',
                    $queryBuilder->createNamedParameter($ids, Connection::PARAM_INT_ARRAY)
                )
            )
            ->execute();
 
        while ($movePlaceholder = $result->fetch()) {
            $liveReferenceId = $movePlaceholder['t3ver_move_id'];
            $movePlaceholderId = $movePlaceholder['uid'];
            // Substitute MOVE_PLACEHOLDER and purge live reference
            if (isset($ids[$movePlaceholderId])) {
                $ids[$movePlaceholderId] = $liveReferenceId;
                unset($ids[$liveReferenceId]);
            } elseif (!$this->keepMovePlaceholder) {
                // Just purge live reference
                unset($ids[$liveReferenceId]);
            }
        }
 
        return $ids;
    }
 
    public function ‪processSorting(array $ids)
    {
        $ids = $this->‪sanitizeIds($ids);
        // Early return on missing sorting statement or insufficient data-set
        if (empty($this->sortingStatement) || count($ids) < 2) {
            return $ids;
        }
 
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($this->tableName);
 
        // @todo: DeletedRestriction should be added here, too. This however currently makes test
        // workspaces/Tests/Functional/DataHandling/FAL/Publish/ActionTest::modifyContentAndDeleteFileReference
        // fail with postgres. Suspected reason: On publish, there seems to be a missing RefenenceIndex->updateRefIndexTable()
        // call, so sys_refindex still has relations to workspace records that don't exist anymore after publish. If that
        // is solved and old sys_refindex relations are correctly dropped, the DeletedRestriction should be added here.
        $queryBuilder->getRestrictions()->removeAll();
 
        $queryBuilder
            ->select('uid')
            ->from($this->tableName)
            ->where(
                $queryBuilder->expr()->in(
                    'uid',
                    // do not use named parameter here as the list can get too long
                    array_map('intval', $ids)
                )
            );
 
        if (!empty($this->sortingStatement)) {
            foreach ($this->sortingStatement as ‪$sortingStatement) {
                $queryBuilder->add('orderBy', ‪$sortingStatement, true);
            }
        }
 
        $sortedIds = $queryBuilder->execute()->fetchAll();
 
        return array_map('intval', array_column($sortedIds, 'uid'));
    }
 
    public function ‪applyLiveIds(array $ids)
    {
        $ids = $this->‪sanitizeIds($ids);
        if (!$this->keepLiveIds || !$this->‪isWorkspaceEnabled() || empty($ids)) {
            return $ids;
        }
 
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($this->tableName);
 
        $queryBuilder->getRestrictions()->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
 
        $result = $queryBuilder
            ->select('uid', 't3ver_oid')
            ->from($this->tableName)
            ->where(
                $queryBuilder->expr()->in(
                    'uid',
                    $queryBuilder->createNamedParameter($ids, Connection::PARAM_INT_ARRAY)
                )
            )
            ->execute();
 
        $versionIds = [];
        while ($record = $result->fetch()) {
            $liveId = $record['uid'];
            $versionIds[$liveId] = $record['t3ver_oid'];
        }
 
        foreach ($ids as $id) {
            if (!empty($versionIds[$id])) {
                $ids[$id] = $versionIds[$id];
            }
        }
 
        return $ids;
    }
 
    protected function ‪reindex(array $ids)
    {
        if (empty($ids)) {
            return $ids;
        }
        $ids = array_values($ids);
        $ids = array_combine($ids, $ids);
        return $ids;
    }
 
    protected function ‪sanitizeIds(array $ids): array
    {
        return array_filter($ids);
    }
 
    protected function ‪isWorkspaceEnabled()
    {
        if (‪ExtensionManagementUtility::isLoaded('workspaces')) {
            return ‪BackendUtility::isTableWorkspaceEnabled($this->tableName);
        }
        return false;
    }
}