CommandMap.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Version\DataHandler;

use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Version\Dependency\ElementEntity;

class CommandMap {

    const SCOPE_WorkspacesSwap = 'SCOPE_WorkspacesSwap';
    const SCOPE_WorkspacesSetStage = 'SCOPE_WorkspacesSetStage';
    const SCOPE_WorkspacesClear = 'SCOPE_WorkspacesClear';
    const KEY_ScopeErrorMessage = 'KEY_ScopeErrorMessage';
    const KEY_ScopeErrorCode = 'KEY_ScopeErrorCode';
    const KEY_GetElementPropertiesCallback = 'KEY_GetElementPropertiesCallback';
    const KEY_GetCommonPropertiesCallback = 'KEY_GetCommonPropertiesCallback';
    const KEY_ElementConstructCallback = 'KEY_EventConstructCallback';
    const KEY_ElementCreateChildReferenceCallback = 'KEY_ElementCreateChildReferenceCallback';
    const KEY_ElementCreateParentReferenceCallback = 'KEY_ElementCreateParentReferenceCallback';
    const KEY_PurgeWithErrorMessageGetIdCallback = 'KEY_PurgeWithErrorMessageGetIdCallback';
    const KEY_UpdateGetIdCallback = 'KEY_UpdateGetIdCallback';
    const KEY_TransformDependentElementsToUseLiveId = 'KEY_TransformDependentElementsToUseLiveId';

    protected $parent;

    protected $tceMain;

    protected $commandMap = array();

    protected $workspace;

    protected $workspacesSwapMode;

    protected $workspacesChangeStageMode;

    protected $workspacesConsiderReferences;

    protected $scopes;

    protected $elementEntityProcessor;

    public function __construct(\TYPO3\CMS\Version\Hook\DataHandlerHook $parent, \TYPO3\CMS\Core\DataHandling\DataHandler $tceMain, array $commandMap, $workspace) {
        $this->setParent($parent);
        $this->setTceMain($tceMain);
        $this->set($commandMap);
        $this->setWorkspace($workspace);
        $this->setWorkspacesSwapMode($this->getTceMain()->BE_USER->getTSConfigVal('options.workspaces.swapMode'));
        $this->setWorkspacesChangeStageMode($this->getTceMain()->BE_USER->getTSConfigVal('options.workspaces.changeStageMode'));
        $this->setWorkspacesConsiderReferences($this->getTceMain()->BE_USER->getTSConfigVal('options.workspaces.considerReferences'));
        $this->constructScopes();
    }

    public function get() {
        return $this->commandMap;
    }

    public function set(array $commandMap) {
        $this->commandMap = $commandMap;
        return $this;
    }

    public function getParent() {
        return $this->parent;
    }

    public function setParent(\TYPO3\CMS\Version\Hook\DataHandlerHook $parent) {
        $this->parent = $parent;
        return $this;
    }

    public function getTceMain() {
        return $this->tceMain;
    }

    public function setTceMain(\TYPO3\CMS\Core\DataHandling\DataHandler $tceMain) {
        $this->tceMain = $tceMain;
        return $this;
    }

    public function setWorkspace($workspace) {
        $this->workspace = (int)$workspace;
    }

    public function getWorkspace() {
        return $this->workspace;
    }

    public function setWorkspacesSwapMode($workspacesSwapMode) {
        $this->workspacesSwapMode = (string) $workspacesSwapMode;
        return $this;
    }

    public function setWorkspacesChangeStageMode($workspacesChangeStageMode) {
        $this->workspacesChangeStageMode = (string) $workspacesChangeStageMode;
        return $this;
    }

    public function setWorkspacesConsiderReferences($workspacesConsiderReferences) {
        $this->workspacesConsiderReferences = (bool) $workspacesConsiderReferences;
        return $this;
    }

    protected function getElementEntityProcessor() {
        if (!isset($this->elementEntityProcessor)) {
            $this->elementEntityProcessor = GeneralUtility::makeInstance(
                'TYPO3\\CMS\\Version\\Dependency\\ElementEntityProcessor'
            );
            $this->elementEntityProcessor->setWorkspace($this->getWorkspace());
        }
        return $this->elementEntityProcessor;
    }

    public function process() {
        $this->resolveWorkspacesSwapDependencies();
        $this->resolveWorkspacesSetStageDependencies();
        $this->resolveWorkspacesClearDependencies();
        return $this;
    }

    protected function invokeWorkspacesSwapItems($callbackMethod, array $arguments = array()) {
        // Traverses the cmd[] array and fetches the accordant actions:
        foreach ($this->commandMap as $table => $liveIdCollection) {
            foreach ($liveIdCollection as $liveId => $commandCollection) {
                foreach ($commandCollection as $command => $properties) {
                    if ($command === 'version' && isset($properties['action']) && $properties['action'] === 'swap') {
                        if (isset($properties['swapWith']) && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($properties['swapWith'])) {
                            call_user_func_array(array($this, $callbackMethod), array_merge($arguments, array($table, $liveId, $properties)));
                        }
                    }
                }
            }
        }
    }

    protected function resolveWorkspacesSwapDependencies() {
        $scope = self::SCOPE_WorkspacesSwap;
        $dependency = $this->getDependencyUtility($scope);
        if (GeneralUtility::inList('any,pages', $this->workspacesSwapMode)) {
            $this->invokeWorkspacesSwapItems('applyWorkspacesSwapBehaviour');
        }
        $this->invokeWorkspacesSwapItems('addWorkspacesSwapElements', array($dependency));
        $this->applyWorkspacesDependencies($dependency, $scope);
    }

    protected function applyWorkspacesSwapBehaviour($table, $liveId, array $properties) {
        $extendedCommandMap = array();
        $elementList = array();
        // Fetch accordant elements if the swapMode is 'any' or 'pages':
        if ($this->workspacesSwapMode === 'any' || $this->workspacesSwapMode === 'pages' && $table === 'pages') {
            $elementList = $this->getParent()->findPageElementsForVersionSwap($table, $liveId, $properties['swapWith']);
        }
        foreach ($elementList as $elementTable => $elementIdArray) {
            foreach ($elementIdArray as $elementIds) {
                $extendedCommandMap[$elementTable][$elementIds[0]]['version'] = array_merge($properties, array('swapWith' => $elementIds[1]));
            }
        }
        if (count($elementList) > 0) {
            $this->remove($table, $liveId, 'version');
            $this->mergeToBottom($extendedCommandMap);
        }
    }

    protected function addWorkspacesSwapElements(\TYPO3\CMS\Version\Dependency\DependencyResolver $dependency, $table, $liveId, array $properties) {
        $elementList = array();
        // Fetch accordant elements if the swapMode is 'any' or 'pages':
        if ($this->workspacesSwapMode === 'any' || $this->workspacesSwapMode === 'pages' && $table === 'pages') {
            $elementList = $this->getParent()->findPageElementsForVersionSwap($table, $liveId, $properties['swapWith']);
        }
        foreach ($elementList as $elementTable => $elementIdArray) {
            foreach ($elementIdArray as $elementIds) {
                $dependency->addElement($elementTable, $elementIds[1], array('liveId' => $elementIds[0], 'properties' => array_merge($properties, array('swapWith' => $elementIds[1]))));
            }
        }
        if (count($elementList) === 0) {
            $dependency->addElement($table, $properties['swapWith'], array('liveId' => $liveId, 'properties' => $properties));
        }
    }

    protected function invokeWorkspacesSetStageItems($callbackMethod, array $arguments = array()) {
        // Traverses the cmd[] array and fetches the accordant actions:
        foreach ($this->commandMap as $table => $versionIdCollection) {
            foreach ($versionIdCollection as $versionIdList => $commandCollection) {
                foreach ($commandCollection as $command => $properties) {
                    if ($command === 'version' && isset($properties['action']) && $properties['action'] === 'setStage') {
                        if (isset($properties['stageId']) && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($properties['stageId'])) {
                            call_user_func_array(array($this, $callbackMethod), array_merge($arguments, array($table, $versionIdList, $properties)));
                        }
                    }
                }
            }
        }
    }

    protected function resolveWorkspacesSetStageDependencies() {
        $scope = self::SCOPE_WorkspacesSetStage;
        $dependency = $this->getDependencyUtility($scope);
        if (GeneralUtility::inList('any,pages', $this->workspacesChangeStageMode)) {
            $this->invokeWorkspacesSetStageItems('applyWorkspacesSetStageBehaviour');
        }
        $this->invokeWorkspacesSetStageItems('explodeSetStage');
        $this->invokeWorkspacesSetStageItems('addWorkspacesSetStageElements', array($dependency));
        $this->applyWorkspacesDependencies($dependency, $scope);
    }

    protected function applyWorkspacesSetStageBehaviour($table, $versionIdList, array $properties) {
        $extendedCommandMap = array();
        $versionIds = GeneralUtility::trimExplode(',', $versionIdList, TRUE);
        $elementList = array($table => $versionIds);
        if (GeneralUtility::inList('any,pages', $this->workspacesChangeStageMode)) {
            if (count($versionIds) === 1) {
                $workspaceRecord = BackendUtility::getRecord($table, $versionIds[0], 't3ver_wsid');
                $workspaceId = $workspaceRecord['t3ver_wsid'];
            } else {
                $workspaceId = $this->getWorkspace();
            }
            if ($table === 'pages') {
                // Find all elements from the same ws to change stage
                $livePageIds = $versionIds;
                $this->getParent()->findRealPageIds($livePageIds);
                $this->getParent()->findPageElementsForVersionStageChange($livePageIds, $workspaceId, $elementList);
            } elseif ($this->workspacesChangeStageMode === 'any') {
                // Find page to change stage:
                $pageIdList = array();
                $this->getParent()->findPageIdsForVersionStateChange($table, $versionIds, $workspaceId, $pageIdList, $elementList);
                // Find other elements from the same ws to change stage:
                $this->getParent()->findPageElementsForVersionStageChange($pageIdList, $workspaceId, $elementList);
            }
        }
        foreach ($elementList as $elementTable => $elementIds) {
            foreach ($elementIds as $elementId) {
                $extendedCommandMap[$elementTable][$elementId]['version'] = $properties;
            }
        }
        $this->remove($table, $versionIds, 'version');
        $this->mergeToBottom($extendedCommandMap);
    }

    protected function addWorkspacesSetStageElements(\TYPO3\CMS\Version\Dependency\DependencyResolver $dependency, $table, $versionId, array $properties) {
        $dependency->addElement($table, $versionId, array('versionId' => $versionId, 'properties' => $properties));
    }

    protected function resolveWorkspacesClearDependencies() {
        $scope = self::SCOPE_WorkspacesClear;
        $dependency = $this->getDependencyUtility($scope);
        // Traverses the cmd[] array and fetches the accordant actions:
        foreach ($this->commandMap as $table => $versionIdCollection) {
            foreach ($versionIdCollection as $versionId => $commandCollection) {
                foreach ($commandCollection as $command => $properties) {
                    if ($command === 'version' && isset($properties['action']) && ($properties['action'] === 'clearWSID' || $properties['action'] === 'flush')) {
                        $dependency->addElement($table, $versionId, array('versionId' => $versionId, 'properties' => $properties));
                    }
                }
            }
        }
        $this->applyWorkspacesDependencies($dependency, $scope);
    }

    protected function explodeSetStage($table, $versionIdList, array $properties) {
        $extractedCommandMap = array();
        $versionIds = GeneralUtility::trimExplode(',', $versionIdList, TRUE);
        if (count($versionIds) > 1) {
            foreach ($versionIds as $versionId) {
                if (isset($this->commandMap[$table][$versionId]['version'])) {
                    throw new \RuntimeException('Command map for [' . $table . '][' . $versionId . '][version] was already set.', 1289391048);
                }
                $extractedCommandMap[$table][$versionId]['version'] = $properties;
            }
            $this->remove($table, $versionIdList, 'version');
            $this->mergeToBottom($extractedCommandMap);
        }
    }

    protected function applyWorkspacesDependencies(\TYPO3\CMS\Version\Dependency\DependencyResolver $dependency, $scope) {
        $transformDependentElementsToUseLiveId = $this->getScopeData($scope, self::KEY_TransformDependentElementsToUseLiveId);
        $elementsToBeVersioned = $dependency->getElements();
        // Use the uid of the live record instead of the workspace record:
        if ($transformDependentElementsToUseLiveId) {
            $elementsToBeVersioned = $this->getElementEntityProcessor()->transformDependentElementsToUseLiveId($elementsToBeVersioned);
        }
        $outerMostParents = $dependency->getOuterMostParents();
        foreach ($outerMostParents as $outerMostParent) {
            $dependentElements = $dependency->getNestedElements($outerMostParent);
            if ($transformDependentElementsToUseLiveId) {
                $dependentElements = $this->getElementEntityProcessor()->transformDependentElementsToUseLiveId($dependentElements);
            }
            // Gets the difference (intersection) between elements that were submitted by the user
            // and the evaluation of all dependent records that should be used for this action instead:
            $intersectingElements = array_intersect_key($dependentElements, $elementsToBeVersioned);
            if (count($intersectingElements) > 0) {
                // If at least one element intersects but not all, throw away all elements of the depdendent structure:
                if (count($intersectingElements) !== count($dependentElements) && $this->workspacesConsiderReferences === FALSE) {
                    $this->purgeWithErrorMessage($intersectingElements, $scope);
                } else {
                    $this->update(current($intersectingElements), $dependentElements, $scope);
                }
            }
        }
    }

    protected function purgeWithErrorMessage(array $elements, $scope) {
        foreach ($elements as $element) {
            $table = $element->getTable();
            $id = $this->processCallback($this->getScopeData($scope, self::KEY_PurgeWithErrorMessageGetIdCallback), array($element));
            $this->remove($table, $id, 'version');
            $this->getTceMain()->log($table, $id, 5, 0, 1, $this->getScopeData($scope, self::KEY_ScopeErrorMessage), $this->getScopeData($scope, self::KEY_ScopeErrorCode), array(
                BackendUtility::getRecordTitle($table, BackendUtility::getRecord($table, $id)),
                $table,
                $id
            ));
        }
    }

    protected function update(ElementEntity $intersectingElement, array $elements, $scope) {
        $orderedCommandMap = array();
        $commonProperties = array();
        if ($this->getScopeData($scope, self::KEY_GetCommonPropertiesCallback)) {
            $commonProperties = $this->processCallback($this->getScopeData($scope, self::KEY_GetCommonPropertiesCallback), array($intersectingElement));
        }
        foreach ($elements as $element) {
            $table = $element->getTable();
            $id = $this->processCallback($this->getScopeData($scope, self::KEY_UpdateGetIdCallback), array($element));
            $this->remove($table, $id, 'version');
            if ($element->isInvalid()) {
                continue;
            }
            $orderedCommandMap[$table][$id]['version'] = $commonProperties;
            if ($this->getScopeData($scope, self::KEY_GetElementPropertiesCallback)) {
                $orderedCommandMap[$table][$id]['version'] = array_merge($commonProperties, $this->processCallback($this->getScopeData($scope, self::KEY_GetElementPropertiesCallback), array($element)));
            }
        }
        // Ensure that ordered command map is on top of the command map:
        $this->mergeToTop($orderedCommandMap);
    }

    protected function mergeToTop(array $commandMap) {
        \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($commandMap, $this->commandMap);
        $this->commandMap = $commandMap;
    }

    protected function mergeToBottom(array $commandMap) {
        \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($this->commandMap, $commandMap);
    }

    protected function remove($table, $id, $command = NULL) {
        if (is_string($command)) {
            unset($this->commandMap[$table][$id][$command]);
        } else {
            unset($this->commandMap[$table][$id]);
        }
    }

    protected function getElementLiveIdCallback(ElementEntity $element) {
        return $element->getDataValue('liveId');
    }

    protected function getElementIdCallback(ElementEntity $element) {
        return $element->getId();
    }

    protected function getElementSwapPropertiesCallback(ElementEntity $element) {
        return array(
            'swapWith' => $element->getId()
        );
    }

    protected function getCommonClearPropertiesCallback(ElementEntity $element) {
        $commonSwapProperties = array();
        $elementProperties = $element->getDataValue('properties');
        if (isset($elementProperties['action'])) {
            $commonSwapProperties['action'] = $elementProperties['action'];
        }
        return $commonSwapProperties;
    }

    protected function getCommonSwapPropertiesCallback(ElementEntity $element) {
        $commonSwapProperties = array();
        $elementProperties = $element->getDataValue('properties');
        if (isset($elementProperties['action'])) {
            $commonSwapProperties['action'] = $elementProperties['action'];
        }
        if (isset($elementProperties['swapIntoWS'])) {
            $commonSwapProperties['swapIntoWS'] = $elementProperties['swapIntoWS'];
        }
        if (isset($elementProperties['comment'])) {
            $commonSwapProperties['comment'] = $elementProperties['comment'];
        }
        if (isset($elementProperties['notificationAlternativeRecipients'])) {
            $commonSwapProperties['notificationAlternativeRecipients'] = $elementProperties['notificationAlternativeRecipients'];
        }

        return $commonSwapProperties;
    }

    protected function getElementSetStagePropertiesCallback(ElementEntity $element) {
        return $this->getCommonSetStagePropertiesCallback($element);
    }

    protected function getCommonSetStagePropertiesCallback(ElementEntity $element) {
        $commonSetStageProperties = array();
        $elementProperties = $element->getDataValue('properties');
        if (isset($elementProperties['stageId'])) {
            $commonSetStageProperties['stageId'] = $elementProperties['stageId'];
        }
        if (isset($elementProperties['comment'])) {
            $commonSetStageProperties['comment'] = $elementProperties['comment'];
        }
        if (isset($elementProperties['action'])) {
            $commonSetStageProperties['action'] = $elementProperties['action'];
        }
        if (isset($elementProperties['notificationAlternativeRecipients'])) {
            $commonSetStageProperties['notificationAlternativeRecipients'] = $elementProperties['notificationAlternativeRecipients'];
        }
        return $commonSetStageProperties;
    }

    protected function getDependencyUtility($scope) {
        $dependency = GeneralUtility::makeInstance('TYPO3\\CMS\\Version\\Dependency\\DependencyResolver');
        $dependency->setWorkspace($this->getWorkspace());
        $dependency->setOuterMostParentsRequireReferences(TRUE);
        if ($this->getScopeData($scope, self::KEY_ElementConstructCallback)) {
            $dependency->setEventCallback(ElementEntity::EVENT_Construct, $this->getDependencyCallback($this->getScopeData($scope, self::KEY_ElementConstructCallback)));
        }
        if ($this->getScopeData($scope, self::KEY_ElementCreateChildReferenceCallback)) {
            $dependency->setEventCallback(ElementEntity::EVENT_CreateChildReference, $this->getDependencyCallback($this->getScopeData($scope, self::KEY_ElementCreateChildReferenceCallback)));
        }
        if ($this->getScopeData($scope, self::KEY_ElementCreateParentReferenceCallback)) {
            $dependency->setEventCallback(ElementEntity::EVENT_CreateParentReference, $this->getDependencyCallback($this->getScopeData($scope, self::KEY_ElementCreateParentReferenceCallback)));
        }
        return $dependency;
    }

    protected function constructScopes() {
        $this->scopes = array(
            // settings for publishing and swapping:
            self::SCOPE_WorkspacesSwap => array(
                // error message and error code
                self::KEY_ScopeErrorMessage => 'Record "%s" (%s:%s) cannot be swapped or published independently, because it is related to other new or modified records.',
                self::KEY_ScopeErrorCode => 1288283630,
                // callback functons used to modify the commandMap
                // + element properties are specific for each element
                // + common properties are the same for all elements
                self::KEY_GetElementPropertiesCallback => 'getElementSwapPropertiesCallback',
                self::KEY_GetCommonPropertiesCallback => 'getCommonSwapPropertiesCallback',
                // callback function used, when a new element to be checked is added
                self::KEY_ElementConstructCallback => 'createNewDependentElementCallback',
                // callback function used to determine whether an element is a valid child or parent reference (e.g. IRRE)
                self::KEY_ElementCreateChildReferenceCallback => 'createNewDependentElementChildReferenceCallback',
                self::KEY_ElementCreateParentReferenceCallback => 'createNewDependentElementParentReferenceCallback',
                // callback function used to get the correct record uid to be used in the error message
                self::KEY_PurgeWithErrorMessageGetIdCallback => 'getElementLiveIdCallback',
                // callback function used to fetch the correct record uid on modifying the commandMap
                self::KEY_UpdateGetIdCallback => 'getElementLiveIdCallback',
                // setting whether to use the uid of the live record instead of the workspace record
                self::KEY_TransformDependentElementsToUseLiveId => TRUE
            ),
            // settings for modifying the stage:
            self::SCOPE_WorkspacesSetStage => array(
                // error message and error code
                self::KEY_ScopeErrorMessage => 'Record "%s" (%s:%s) cannot be sent to another stage independently, because it is related to other new or modified records.',
                self::KEY_ScopeErrorCode => 1289342524,
                // callback functons used to modify the commandMap
                // + element properties are specific for each element
                // + common properties are the same for all elements
                self::KEY_GetElementPropertiesCallback => 'getElementSetStagePropertiesCallback',
                self::KEY_GetCommonPropertiesCallback => 'getCommonSetStagePropertiesCallback',
                // callback function used, when a new element to be checked is added
                self::KEY_ElementConstructCallback => NULL,
                // callback function used to determine whether an element is a valid child or parent reference (e.g. IRRE)
                self::KEY_ElementCreateChildReferenceCallback => 'createNewDependentElementChildReferenceCallback',
                self::KEY_ElementCreateParentReferenceCallback => 'createNewDependentElementParentReferenceCallback',
                // callback function used to get the correct record uid to be used in the error message
                self::KEY_PurgeWithErrorMessageGetIdCallback => 'getElementIdCallback',
                // callback function used to fetch the correct record uid on modifying the commandMap
                self::KEY_UpdateGetIdCallback => 'getElementIdCallback',
                // setting whether to use the uid of the live record instead of the workspace record
                self::KEY_TransformDependentElementsToUseLiveId => FALSE
            ),
            // settings for clearing and flushing:
            self::SCOPE_WorkspacesClear => array(
                // error message and error code
                self::KEY_ScopeErrorMessage => 'Record "%s" (%s:%s) cannot be flushed independently, because it is related to other new or modified records.',
                self::KEY_ScopeErrorCode => 1300467990,
                // callback functons used to modify the commandMap
                // + element properties are specific for each element
                // + common properties are the same for all elements
                self::KEY_GetElementPropertiesCallback => NULL,
                self::KEY_GetCommonPropertiesCallback => 'getCommonClearPropertiesCallback',
                // callback function used, when a new element to be checked is added
                self::KEY_ElementConstructCallback => NULL,
                // callback function used to determine whether an element is a valid child or parent reference (e.g. IRRE)
                self::KEY_ElementCreateChildReferenceCallback => 'createClearDependentElementChildReferenceCallback',
                self::KEY_ElementCreateParentReferenceCallback => 'createClearDependentElementParentReferenceCallback',
                // callback function used to get the correct record uid to be used in the error message
                self::KEY_PurgeWithErrorMessageGetIdCallback => 'getElementIdCallback',
                // callback function used to fetch the correct record uid on modifying the commandMap
                self::KEY_UpdateGetIdCallback => 'getElementIdCallback',
                // setting whether to use the uid of the live record instead of the workspace record
                self::KEY_TransformDependentElementsToUseLiveId => FALSE
            )
        );
    }

    protected function getScopeData($scope, $key) {
        if (!isset($this->scopes[$scope])) {
            throw new \RuntimeException('Scope "' . $scope . '" is not defined.', 1289342187);
        }
        return $this->scopes[$scope][$key];
    }

    protected function getDependencyCallback($method, array $targetArguments = array()) {
        return GeneralUtility::makeInstance(
            'TYPO3\\CMS\\Version\\Dependency\\EventCallback',
            $this->getElementEntityProcessor(), $method, $targetArguments
        );
    }

    protected function processCallback($method, array $callbackArguments) {
        return call_user_func_array(array($this, $method), $callbackArguments);
    }

}