AbstractTreeView.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Backend\Tree\View;
 
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
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\Imaging\IconFactory;
use ‪TYPO3\CMS\Core\Imaging\IconProvider\AbstractSvgIconProvider;
use TYPO3\CMS\Core\Imaging\IconSize;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractTreeView
{
    protected string ‪$table = 'pages';
 
    protected string ‪$parentField = 'pid';
 
    protected string ‪$clause = '';
 
    public string ‪$orderByFields = '';
 
    protected array ‪$fieldArray = [
        'uid',
        'pid',
        'title',
        'is_siteroot',
        'doktype',
        'nav_title',
        'mount_pid',
        'php_tree_stop',
        't3ver_state',
        'hidden',
        'starttime',
        'endtime',
        'fe_group',
        'module',
        'extendToSubpages',
        'nav_hide',
        't3ver_wsid',
    ];
 
    protected string ‪$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate';
 
    public ‪$makeHTML = 1;
 
    // *********
    // Internal
    // *********
    // For record trees:
    // one-dim array of the uid's selected.
    public ‪$ids = [];
 
    // The hierarchy of element uids
    public ‪$ids_hierarchy = [];
 
    // The hierarchy of versioned element uids
    public ‪$orig_ids_hierarchy = [];
 
    // Temporary, internal array
    public ‪$buffer_idH = [];
 
    // For both types
    // Tree is accumulated in this variable
    public ‪$tree = [];
 
    public function ‪__construct()
    {
        $this->‪init();
    }
 
    public function ‪init($clause = '', ‪$orderByFields = '')
    {
        // Setting clause
        if (‪$clause) {
            $this->clause = ‪$clause;
        }
        if (‪$orderByFields) {
            $this->orderByFields = ‪$orderByFields;
        }
    }
 
    public function ‪addField($field, $noCheck = false)
    {
        if ($noCheck || is_array(‪$GLOBALS['TCA'][$this->table]['columns'][$field] ?? null) || ‪GeneralUtility::inList($this->defaultList, $field)) {
            $this->‪fieldArray[] = $field;
        }
    }
 
    public function ‪reset()
    {
        $this->tree = [];
        $this->ids = [];
        $this->ids_hierarchy = [];
        $this->orig_ids_hierarchy = [];
    }
 
    /*******************************************
     *
     * rendering parts
     *
     *******************************************/
    protected function ‪PMicon($row, $a, $c, $nextCount, $isOpen)
    {
        if ($nextCount) {
            return $this->‪PM_ATagWrap($row['uid'], $isOpen);
        }
        return '';
    }
 
    protected function ‪PM_ATagWrap($bMark = '', $isOpen = false)
    {
        $iconFactory = GeneralUtility::makeInstance(IconFactory::class);
 
        $anchor = $bMark ? '#' . $bMark : '';
        $name = $bMark ? ' name="' . $bMark . '"' : '';
        $aUrl = $anchor;
        if ($isOpen) {
            $class = 'treelist-control-open';
            $icon = $iconFactory->getIcon('actions-chevron-down', IconSize::SMALL);
        } else {
            $class = 'treelist-control-collapsed';
            $icon = $iconFactory->getIcon('actions-chevron-right', IconSize::SMALL);
        }
        return '<a class="treelist-control ' . $class . '" href="' . htmlspecialchars($aUrl) . '"' . $name . '>' . $icon->render(‪AbstractSvgIconProvider::MARKUP_IDENTIFIER_INLINE) . '</a>';
    }
 
    /*******************************************
     *
     * tree handling
     *
     *******************************************/
    public function ‪expandNext($id)
    {
        return false;
    }
 
    /******************************
     *
     * Functions that might be overwritten by extended classes
     *
     ********************************/
 
    protected function ‪getIcon(array $row): string
    {
        $title = $this->‪getTitleAttrib($row);
        $iconFactory = GeneralUtility::makeInstance(IconFactory::class);
        $icon = $row['is_siteroot'] ? $iconFactory->getIcon('apps-pagetree-folder-root', IconSize::SMALL) : $iconFactory->getIconForRecord($this->table, $row, IconSize::SMALL);
        return $icon->setTitle($title)->render();
    }
 
    protected function ‪getTitleStr($row, $titleLen = 30)
    {
        $title = htmlspecialchars(‪GeneralUtility::fixed_lgd_cs($row['title'], (int)$titleLen));
        return trim($title) === '' ? '<em>[' . htmlspecialchars($this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.no_title')) . ']</em>' : $title;
    }
 
    protected function ‪getTitleAttrib($row)
    {
        return htmlspecialchars($row['title']);
    }
 
    /********************************
     *
     * tree data building
     *
     ********************************/
    public function ‪getTree(‪$uid, $depth = 999, $depthData = '')
    {
        // Buffer for id hierarchy is reset:
        $this->buffer_idH = [];
        // Init vars
        $depth = (int)$depth;
        $HTML = '';
        $a = 0;
        $res = $this->‪getDataInit(‪$uid);
        $c = $res->rowCount();
        $crazyRecursionLimiter = 9999;
        $idH = [];
        // Traverse the records:
        while ($crazyRecursionLimiter > 0 && ($row = $this->‪getDataNext($res))) {
            if (!$this->‪getBackendUser()->isInWebMount($this->table === 'pages' ? $row : $row['pid'])) {
                // Current record is not within web mount => skip it
                continue;
            }
 
            $a++;
            $crazyRecursionLimiter--;
            $newID = $row['uid'];
            if ($newID == 0) {
                throw new \RuntimeException('Endless recursion detected: TYPO3 has detected an error in the database. Please fix it manually (e.g. using phpMyAdmin) and change the UID of ' . $this->table . ':0 to a new value. See https://forge.typo3.org/issues/16150 to get more information about a possible cause.', 1294586383);
            }
            // Reserve space.
            $this->tree[] = [];
            end($this->tree);
            // Get the key for this space
            $treeKey = key($this->tree);
            // Accumulate the id of the element in the internal arrays
            $this->ids[] = ($idH[$row['uid']]['uid'] = $row['uid']);
            $this->ids_hierarchy[$depth][] = $row['uid'];
            $this->orig_ids_hierarchy[$depth][] = (isset($row['_ORIG_uid']) && !empty($row['_ORIG_uid'])) ? $row['_ORIG_uid'] : $row['uid'];
 
            // Make a recursive call to the next level
            $nextLevelDepthData = $depthData . '<span class="treeline-icon treeline-icon-' . ($a === $c ? 'clear' : 'line') . '"></span>';
            $hasSub = $this->‪expandNext($newID) && !($row['php_tree_stop'] ?? false);
            if ($depth > 1 && $hasSub) {
                $nextCount = $this->‪getTree($newID, $depth - 1, $nextLevelDepthData);
                if (!empty($this->buffer_idH)) {
                    $idH[$row['uid']]['subrow'] = ‪$this->buffer_idH;
                }
                // Set "did expand" flag
                $isOpen = true;
            } else {
                $nextCount = $this->‪getCount($newID);
                // Clear "did expand" flag
                $isOpen = false;
            }
            // Set HTML-icons, if any:
            if ($this->makeHTML) {
                $HTML = $this->‪PMicon($row, $a, $c, $nextCount, $isOpen);
            }
            // Finally, add the row/HTML content to the ->tree array in the reserved key.
            $this->tree[$treeKey] = [
                'row' => $row,
                'HTML' => $HTML,
                'icon' => $this->‪getIcon($row),
                'invertedDepth' => $depth,
                'depthData' => $depthData,
                'hasSub' => $nextCount && $hasSub,
                'isFirst' => $a === 1,
                'isLast' => $a === $c,
            ];
        }
 
        $res->free();
        $this->buffer_idH = $idH;
        return $c;
    }
 
    /********************************
     *
     * Data handling
     * Works with records and arrays
     *
     ********************************/
    protected function ‪getCount(‪$uid)
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->table);
        $queryBuilder->getRestrictions()
                ->removeAll()
                ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
                ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->‪getBackendUser()->workspace));
        $count = $queryBuilder
                ->count('uid')
                ->from($this->table)
                ->where(
                    $queryBuilder->expr()->eq(
                        $this->parentField,
                        $queryBuilder->createNamedParameter(‪$uid, ‪Connection::PARAM_INT)
                    ),
                    ‪QueryHelper::stripLogicalOperatorPrefix($this->clause)
                )
                ->executeQuery()
                ->fetchOne();
 
        return (int)$count;
    }
 
    protected function ‪getDataInit($parentId)
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->table);
        $queryBuilder->getRestrictions()
                ->removeAll()
                ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
                ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->‪getBackendUser()->workspace));
        $queryBuilder
                ->select(...$this->‪fieldArray)
                ->from($this->table)
                ->where(
                    $queryBuilder->expr()->eq(
                        $this->parentField,
                        $queryBuilder->createNamedParameter($parentId, ‪Connection::PARAM_INT)
                    ),
                    ‪QueryHelper::stripLogicalOperatorPrefix($this->clause)
                );
 
        foreach (‪QueryHelper::parseOrderBy($this->orderByFields) as $orderPair) {
            [$fieldName, $order] = $orderPair;
            $queryBuilder->addOrderBy($fieldName, $order);
        }
 
        return $queryBuilder->executeQuery();
    }
 
    protected function ‪getDataNext(&$res)
    {
        while ($row = $res->fetchAssociative()) {
            BackendUtility::workspaceOL($this->table, $row, $this->‪getBackendUser()->workspace, true);
            if (is_array($row)) {
                break;
            }
        }
        return $row;
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}