TreeController.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace ‪TYPO3\CMS\Backend\Controller\Page;
 
/*
 * 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!
 */
 
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\Configuration\BackendUserConfiguration;
use ‪TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository;
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DocumentTypeExclusionRestriction;
use ‪TYPO3\CMS\Core\Exception\Page\RootLineException;
use ‪TYPO3\CMS\Core\Exception\SiteNotFoundException;
use ‪TYPO3\CMS\Core\Http\JsonResponse;
use ‪TYPO3\CMS\Core\Imaging\Icon;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Site\PseudoSiteFinder;
use ‪TYPO3\CMS\Core\Site\SiteFinder;
use ‪TYPO3\CMS\Core\Type\Bitmask\JsConfirmation;
use ‪TYPO3\CMS\Core\Type\Bitmask\Permission;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\RootlineUtility;
use ‪TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
class ‪TreeController
{
    protected ‪$useNavTitle = false;
 
    protected ‪$addIdAsPrefix = false;
 
    protected ‪$addDomainName = false;
 
    protected ‪$showMountPathAboveMounts = false;
 
    protected ‪$backgroundColors = [];
 
    protected ‪$hiddenRecords = [];
 
    protected ‪$expandedState = [];
 
    protected ‪$iconFactory;
 
    protected ‪$levelsToFetch = 2;
 
    protected ‪$expandAllNodes = false;
 
    public function ‪__construct()
    {
        $this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);
    }
 
    protected function ‪initializeConfiguration()
    {
        $userTsConfig = $this->‪getBackendUser()->‪getTSConfig();
        $this->hiddenRecords = GeneralUtility::intExplode(
            ',',
            $userTsConfig['options.']['hideRecords.']['pages'] ?? '',
            true
        );
        $this->backgroundColors = $userTsConfig['options.']['pageTree.']['backgroundColor.'] ?? [];
        $this->addIdAsPrefix = (bool)($userTsConfig['options.']['pageTree.']['showPageIdWithTitle'] ?? false);
        $this->addDomainName = (bool)($userTsConfig['options.']['pageTree.']['showDomainNameWithTitle'] ?? false);
        $this->useNavTitle = (bool)($userTsConfig['options.']['pageTree.']['showNavTitle'] ?? false);
        $this->showMountPathAboveMounts = (bool)($userTsConfig['options.']['pageTree.']['showPathAboveMounts'] ?? false);
        $backendUserConfiguration = GeneralUtility::makeInstance(BackendUserConfiguration::class);
        $this->expandedState = $backendUserConfiguration->get('BackendComponents.States.Pagetree');
        if (is_object($this->expandedState) && is_object($this->expandedState->stateHash)) {
            $this->expandedState = (array)$this->expandedState->stateHash;
        } else {
            $this->expandedState = $this->expandedState['stateHash'] ?: [];
        }
    }
 
    public function ‪fetchConfigurationAction(): ResponseInterface
    {
        $configuration = [
            'allowRecursiveDelete' => !empty($this->‪getBackendUser()->uc['recursiveDelete']),
            'allowDragMove' => $this->‪isDragMoveAllowed(),
            'doktypes' => $this->‪getDokTypes(),
            'displayDeleteConfirmation' => $this->‪getBackendUser()->‪jsConfirmation(‪JsConfirmation::DELETE),
            'temporaryMountPoint' => $this->‪getMountPointPath((int)($this->‪getBackendUser()->uc['pageTree_temporaryMountPoint'] ?? 0)),
        ];
 
        return new JsonResponse($configuration);
    }
 
    protected function ‪getDokTypes(): array
    {
        $backendUser = $this->‪getBackendUser();
        $doktypeLabelMap = [];
        foreach (‪$GLOBALS['TCA']['pages']['columns']['doktype']['config']['items'] as $doktypeItemConfig) {
            if ($doktypeItemConfig[1] === '--div--') {
                continue;
            }
            $doktypeLabelMap[$doktypeItemConfig[1]] = $doktypeItemConfig[0];
        }
        $doktypes = GeneralUtility::intExplode(',', $backendUser->getTSConfig()['options.']['pageTree.']['doktypesToShowInNewPageDragArea'] ?? '', true);
        ‪$output = [];
        $allowedDoktypes = GeneralUtility::intExplode(',', $backendUser->groupData['pagetypes_select'], true);
        $isAdmin = $backendUser->isAdmin();
        // Early return if backend user may not create any doktype
        if (!$isAdmin && empty($allowedDoktypes)) {
            return ‪$output;
        }
        foreach ($doktypes as $doktype) {
            if (!$isAdmin && !in_array($doktype, $allowedDoktypes, true)) {
                continue;
            }
            $label = htmlspecialchars($this->‪getLanguageService()->sL($doktypeLabelMap[$doktype]));
            ‪$output[] = [
                'nodeType' => $doktype,
                'icon' => ‪$GLOBALS['TCA']['pages']['ctrl']['typeicon_classes'][$doktype] ?? '',
                'title' => $label,
                'tooltip' => $label
            ];
        }
        return ‪$output;
    }
 
    public function ‪fetchDataAction(ServerRequestInterface $request): ResponseInterface
    {
        $this->‪initializeConfiguration();
 
        $items = [];
        if (!empty($request->getQueryParams()['pid'])) {
            // Fetching a part of a page tree
            $entryPoints = $this->‪getAllEntryPointPageTrees((int)$request->getQueryParams()['pid']);
            $mountPid = (int)($request->getQueryParams()['mount'] ?? 0);
            $parentDepth = (int)($request->getQueryParams()['pidDepth'] ?? 0);
            $this->levelsToFetch = $parentDepth + ‪$this->levelsToFetch;
            foreach ($entryPoints as $page) {
                $items = array_merge($items, $this->‪pagesToFlatArray($page, $mountPid, $parentDepth));
            }
        } else {
            $entryPoints = $this->‪getAllEntryPointPageTrees();
            foreach ($entryPoints as $page) {
                $items = array_merge($items, $this->‪pagesToFlatArray($page, (int)$page['uid']));
            }
        }
 
        return new ‪JsonResponse($items);
    }
 
    public function ‪filterDataAction(ServerRequestInterface $request): ResponseInterface
    {
        $searchQuery = $request->getQueryParams()['q'] ?? '';
        if (trim($searchQuery) === '') {
            return new ‪JsonResponse([]);
        }
 
        $this->‪initializeConfiguration();
        $this->expandAllNodes = true;
 
        $items = [];
        $entryPoints = $this->‪getAllEntryPointPageTrees(0, $searchQuery);
 
        foreach ($entryPoints as $page) {
            if (!empty($page)) {
                $items = array_merge($items, $this->‪pagesToFlatArray($page, (int)$page['uid']));
            }
        }
 
        return new ‪JsonResponse($items);
    }
 
    public function ‪setTemporaryMountPointAction(ServerRequestInterface $request): ResponseInterface
    {
        if (empty($request->getParsedBody()['pid'])) {
            throw new \RuntimeException(
                'Required "pid" parameter is missing.',
                1511792197
            );
        }
        $pid = (int)$request->getParsedBody()['pid'];
 
        $this->‪getBackendUser()->uc['pageTree_temporaryMountPoint'] = $pid;
        $this->‪getBackendUser()->‪writeUC();
        $response = [
            'mountPointPath' => $this->‪getMountPointPath($pid)
        ];
        return new ‪JsonResponse($response);
    }
 
    protected function ‪pagesToFlatArray(array $page, int $entryPoint, int $depth = 0, array $inheritedData = []): array
    {
        $backendUser = $this->‪getBackendUser();
        $pageId = (int)$page['uid'];
        if (in_array($pageId, $this->hiddenRecords, true)) {
            return [];
        }
        if ($pageId === 0 && !$backendUser->isAdmin()) {
            return [];
        }
 
        $stopPageTree = !empty($page['php_tree_stop']) && $depth > 0;
        $identifier = $entryPoint . '_' . $pageId;
        $expanded = !empty($page['expanded'])
            || (isset($this->expandedState[$identifier]) && $this->expandedState[$identifier])
            || $this->expandAllNodes;
 
        $backgroundColor = !empty($this->backgroundColors[$pageId]) ? $this->backgroundColors[$pageId] : ($inheritedData['backgroundColor'] ?? '');
 
        $suffix = '';
        $prefix = '';
        $nameSourceField = 'title';
        $visibleText = $page['title'];
        $tooltip = ‪BackendUtility::titleAttribForPages($page, '', false);
        if ($pageId !== 0) {
            $icon = $this->iconFactory->getIconForRecord('pages', $page, ‪Icon::SIZE_SMALL);
        } else {
            $icon = $this->iconFactory->getIcon('apps-pagetree-root', ‪Icon::SIZE_SMALL);
        }
 
        if ($this->useNavTitle && trim($page['nav_title'] ?? '') !== '') {
            $nameSourceField = 'nav_title';
            $visibleText = $page['nav_title'];
        }
        if (trim($visibleText) === '') {
            $visibleText = htmlspecialchars('[' . $this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.no_title') . ']');
        }
 
        if ($this->addDomainName && $page['is_siteroot']) {
            $domain = $this->‪getDomainNameForPage($pageId);
            $suffix = $domain !== '' ? ' [' . $domain . ']' : '';
        }
 
        $lockInfo = ‪BackendUtility::isRecordLocked('pages', $pageId);
        if (is_array($lockInfo)) {
            $tooltip .= ' - ' . $lockInfo['msg'];
        }
        if ($this->addIdAsPrefix) {
            $prefix = htmlspecialchars('[' . $pageId . '] ');
        }
 
        $items = [];
        $item = [
            // Used to track if the tree item is collapsed or not
            'stateIdentifier' => $identifier,
            'identifier' => $pageId,
            'depth' => $depth,
            'tip' => htmlspecialchars($tooltip),
            'icon' => $icon->getIdentifier(),
            'name' => $visibleText,
            'nameSourceField' => $nameSourceField,
            'alias' => htmlspecialchars($page['alias'] ?? ''),
            'selectable' => true,
            'checked' => false,
            'mountPoint' => $entryPoint,
            'workspaceId' => !empty($page['t3ver_oid']) ? $page['t3ver_oid'] : $pageId,
            'allowDelete' => $backendUser->doesUserHaveAccess($page, ‪Permission::PAGE_DELETE),
            'allowEdit' => $backendUser->doesUserHaveAccess($page, ‪Permission::PAGE_EDIT)
                && $backendUser->check('tables_modify', 'pages')
                && $backendUser->checkLanguageAccess(0)
        ];
 
        if (!empty($page['_children']) || $this->‪getPageTreeRepository()->hasChildren($pageId)) {
            $item['hasChildren'] = true;
            if ($depth >= $this->levelsToFetch) {
                $page = $this->‪getPageTreeRepository()->getTreeLevels($page, 1);
            }
        }
        if (!empty($prefix)) {
            $item['prefix'] = htmlspecialchars($prefix);
        }
        if (!empty($suffix)) {
            $item['suffix'] = htmlspecialchars($suffix);
        }
        if (is_array($lockInfo)) {
            $item['locked'] = true;
        }
        if ($icon->getOverlayIcon()) {
            $item['overlayIcon'] = $icon->getOverlayIcon()->getIdentifier();
        }
        if ($expanded && is_array($page['_children']) && !empty($page['_children'])) {
            $item['expanded'] = $expanded;
        }
        if ($backgroundColor) {
            $item['backgroundColor'] = htmlspecialchars($backgroundColor);
        }
        if ($stopPageTree) {
            $item['stopPageTree'] = $stopPageTree;
        }
        $class = $this->‪resolvePageCssClassNames($page);
        if (!empty($class)) {
            $item['class'] = $class;
        }
        if ($depth === 0) {
            $item['isMountPoint'] = true;
 
            if ($this->showMountPathAboveMounts) {
                $item['readableRootline'] = $this->‪getMountPointPath($pageId);
            }
        }
 
        $items[] = $item;
        if (!$stopPageTree && is_array($page['_children']) && !empty($page['_children']) && ($depth < $this->levelsToFetch || $expanded)) {
            $items[key($items)]['loaded'] = true;
            foreach ($page['_children'] as $child) {
                $items = array_merge($items, $this->‪pagesToFlatArray($child, $entryPoint, $depth + 1, ['backgroundColor' => $backgroundColor]));
            }
        }
        return $items;
    }
 
    protected function ‪getPageTreeRepository(): PageTreeRepository
    {
        $backendUser = $this->‪getBackendUser();
        $userTsConfig = $backendUser->getTSConfig();
        $excludedDocumentTypes = GeneralUtility::intExplode(',', $userTsConfig['options.']['pageTree.']['excludeDoktypes'] ?? '', true);
 
        $additionalQueryRestrictions = [];
        if (!empty($excludedDocumentTypes)) {
            $additionalQueryRestrictions[] = GeneralUtility::makeInstance(DocumentTypeExclusionRestriction::class, $excludedDocumentTypes);
        }
 
        return GeneralUtility::makeInstance(
            PageTreeRepository::class,
            (int)$backendUser->workspace,
            [],
            $additionalQueryRestrictions
        );
    }
 
    protected function ‪getAllEntryPointPageTrees(int $startPid = 0, string $query = ''): array
    {
        $backendUser = $this->‪getBackendUser();
        $entryPointId = $startPid > 0 ? $startPid : (int)($backendUser->uc['pageTree_temporaryMountPoint'] ?? 0);
        if ($entryPointId > 0) {
            $entryPointIds = [$entryPointId];
        } else {
            //watch out for deleted pages returned as webmount
            $entryPointIds = array_map('intval', $backendUser->returnWebmounts());
            $entryPointIds = array_unique($entryPointIds);
            if (empty($entryPointIds)) {
                // use a virtual root
                // the real mount points will be fetched in getNodes() then
                // since those will be the "sub pages" of the virtual root
                $entryPointIds = [0];
            }
        }
        if (empty($entryPointIds)) {
            return [];
        }
        $repository = $this->‪getPageTreeRepository();
 
        $permClause = $this->‪getBackendUser()->‪getPagePermsClause(‪Permission::PAGE_SHOW);
        if ($query !== '') {
            $this->levelsToFetch = 999;
            $repository->fetchFilteredTree(
                $query,
                $this->‪getAllowedMountPoints(),
                $permClause
            );
        }
 
        $entryPointRecords = [];
        foreach ($entryPointIds as $k => $entryPointId) {
            if (in_array($entryPointId, $this->hiddenRecords, true)) {
                continue;
            }
 
            if (!empty($this->backgroundColors) && is_array($this->backgroundColors)) {
                try {
                    $entryPointRootLine = GeneralUtility::makeInstance(RootlineUtility::class, $entryPointId)->get();
                } catch (RootLineException $e) {
                    $entryPointRootLine = [];
                }
                foreach ($entryPointRootLine as $rootLineEntry) {
                    $parentUid = $rootLineEntry['uid'];
                    if (!empty($this->backgroundColors[$parentUid]) && empty($this->backgroundColors[$entryPointId])) {
                        $this->backgroundColors[$entryPointId] = $this->backgroundColors[$parentUid];
                    }
                }
            }
            if ($entryPointId === 0) {
                $entryPointRecord = [
                    'uid' => 0,
                    'title' => ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] ?: 'TYPO3'
                ];
            } else {
                $entryPointRecord = ‪BackendUtility::getRecordWSOL('pages', $entryPointId, '*', $permClause);
 
                if ($entryPointRecord !== null && !$this->‪getBackendUser()->isInWebMount($entryPointId)) {
                    $entryPointRecord = null;
                }
            }
            if ($entryPointRecord) {
                $entryPointRecord['uid'] = (int)$entryPointRecord['uid'];
                if ($query === '') {
                    $entryPointRecord = $repository->getTreeLevels($entryPointRecord, $this->levelsToFetch);
                } else {
                    $entryPointRecord = $repository->getTree((int)$entryPointRecord['uid'], null, $entryPointIds, true);
                }
            }
 
            if (is_array($entryPointRecord) && !empty($entryPointRecord)) {
                $entryPointRecords[$k] = $entryPointRecord;
            }
        }
 
        return $entryPointRecords;
    }
 
    protected function ‪getDomainNameForPage(int $pageId): string
    {
        $domain = '';
        $siteFinder = GeneralUtility::makeInstance(SiteFinder::class);
        try {
            $site = $siteFinder->getSiteByRootPageId($pageId);
            $domain = (string)$site->getBase();
        } catch (‪SiteNotFoundException $e) {
            // No site found, let's see if it is a legacy-pseudo-site
            $pseudoSiteFinder = GeneralUtility::makeInstance(PseudoSiteFinder::class);
            try {
                $site = $pseudoSiteFinder->getSiteByRootPageId($pageId);
                $domain = trim((string)$site->getBase(), '/');
            } catch (SiteNotFoundException $e) {
                // No pseudo-site found either
            }
        }
 
        return $domain;
    }
 
    protected function ‪getMountPointPath(int $uid): string
    {
        if ($uid <= 0) {
            return '';
        }
        $rootline = array_reverse(‪BackendUtility::BEgetRootLine($uid));
        array_shift($rootline);
        $path = [];
        foreach ($rootline as $rootlineElement) {
            $record = ‪BackendUtility::getRecordWSOL('pages', $rootlineElement['uid'], 'title, nav_title', '', true, true);
            $text = $record['title'];
            if ($this->useNavTitle && trim($record['nav_title'] ?? '') !== '') {
                $text = $record['nav_title'];
            }
            $path[] = htmlspecialchars($text);
        }
        return '/' . implode('/', $path);
    }
 
    protected function ‪resolvePageCssClassNames(array $page): string
    {
        $classes = [];
 
        if ($page['uid'] === 0) {
            return '';
        }
        $workspaceId = (int)$this->‪getBackendUser()->workspace;
        if ($workspaceId > 0 && ‪ExtensionManagementUtility::isLoaded('workspaces')) {
            if ($page['t3ver_oid'] > 0 && (int)$page['t3ver_wsid'] === $workspaceId) {
                $classes[] = 'ver-element';
                $classes[] = 'ver-versions';
            } elseif (
                $this->‪getWorkspaceService()->hasPageRecordVersions(
                    $workspaceId,
                    $page['t3ver_oid'] ?: $page['uid']
                )
            ) {
                $classes[] = 'ver-versions';
            }
        }
 
        return implode(' ', $classes);
    }
 
    protected function ‪isDragMoveAllowed(): bool
    {
        $backendUser = $this->‪getBackendUser();
        return $backendUser->isAdmin()
            || ($backendUser->check('tables_modify', 'pages') && $backendUser->checkLanguageAccess(0));
    }
 
    protected function ‪getAllowedMountPoints(): array
    {
        $mountPoints = (int)($this->‪getBackendUser()->uc['pageTree_temporaryMountPoint'] ?? 0);
        if (!$mountPoints) {
            $mountPoints = array_map('intval', $this->‪getBackendUser()->returnWebmounts());
            return array_unique($mountPoints);
        }
        return [$mountPoints];
    }
 
    protected function ‪getWorkspaceService(): WorkspaceService
    {
        return GeneralUtility::makeInstance(WorkspaceService::class);
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪getLanguageService(): ?LanguageService
    {
        return ‪$GLOBALS['LANG'] ?? null;
    }
}