AbstractTreeView.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\Tree\View;

use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Backend\Utility\IconUtility;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

abstract class AbstractTreeView {

    // EXTERNAL, static:
    // If set, the first element in the tree is always expanded.
    public $expandFirst = 0;

    // If set, then ALL items will be expanded, regardless of stored settings.
    public $expandAll = 0;

    // Holds the current script to reload to.
    public $thisScript = '';

    // Which HTML attribute to use: alt/title. See init().
    public $titleAttrib = 'title';

    // If TRUE, no context menu is rendered on icons. If set to "titlelink" the
    // icon is linked as the title is.
    public $ext_IconMode = FALSE;

    // If set, the id of the mounts will be added to the internal ids array
    public $addSelfId = 0;

    // Used if the tree is made of records (not folders for ex.)
    public $title = 'no title';

    // If TRUE, a default title attribute showing the UID of the record is shown.
    // This cannot be enabled by default because it will destroy many applications
    // where another title attribute is in fact applied later.
    public $showDefaultTitleAttribute = FALSE;

    // If TRUE, pages containing child records which has versions will be
    // highlighted in yellow. This might be too expensive in terms
    // of processing power.
    public $highlightPagesWithVersions = TRUE;

    public $BE_USER = '';

    public $MOUNTS = '';

    public $table = '';

    public $parentField = 'pid';

    public $clause = '';

    public $orderByFields = '';

    public $fieldArray = array('uid', 'pid', 'title');

    public $defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id';

    public $treeName = '';

    public $domIdPrefix = 'row';

    public $backPath;

    public $iconPath = '';

    public $iconName = 'default.gif';

    public $makeHTML = 1;

    public $setRecs = 0;

    public $subLevelID = '_SUB_LEVEL';

    // *********
    // Internal
    // *********
    // For record trees:
    // one-dim array of the uid's selected.
    public $ids = array();

    // The hierarchy of element uids
    public $ids_hierarchy = array();

    // The hierarchy of versioned element uids
    public $orig_ids_hierarchy = array();

    // Temporary, internal array
    public $buffer_idH = array();

    // For FOLDER trees:
    // Special UIDs for folders (integer-hashes of paths)
    public $specUIDmap = array();

    // For arrays:
    // Holds the input data array
    public $data = FALSE;

    // Holds an index with references to the data array.
    public $dataLookup = FALSE;

    // For both types
    // Tree is accumulated in this variable
    public $tree = array();

    // Holds (session stored) information about which items in the tree are unfolded and which are not.
    public $stored = array();

    // Points to the current mountpoint key
    public $bank = 0;

    // Accumulates the displayed records.
    public $recs = array();

    protected $workspaceService = NULL;

    protected function determineScriptUrl() {
        if ($moduleName = GeneralUtility::_GP('M')) {
            $this->thisScript = \TYPO3\CMS\Backend\Utility\BackendUtility::getModuleUrl($moduleName);
        } else {
            $this->thisScript = GeneralUtility::getIndpEnv('SCRIPT_NAME');
        }
    }

    protected function getThisScript() {
        return strpos($this->thisScript, '?') === FALSE ? $this->thisScript . '?' : $this->thisScript . '&';
    }

    public function init($clause = '', $orderByFields = '') {
        // Setting BE_USER by default
        $this->BE_USER = $GLOBALS['BE_USER'];
        // Setting title attribute to use.
        $this->titleAttrib = 'title';
        // Setting backpath.
        $this->backPath = $GLOBALS['BACK_PATH'];
        // Setting clause
        if ($clause) {
            $this->clause = $clause;
        }
        if ($orderByFields) {
            $this->orderByFields = $orderByFields;
        }
        if (!is_array($this->MOUNTS)) {
            // Dummy
            $this->MOUNTS = array(0 => 0);
        }
        $this->setTreeName();
        // Setting this to FALSE disables the use of array-trees by default
        $this->data = FALSE;
        $this->dataLookup = FALSE;
    }

    public function setTreeName($treeName = '') {
        $this->treeName = $treeName ?: $this->treeName;
        $this->treeName = $this->treeName ?: $this->table;
        $this->treeName = str_replace('_', '', $this->treeName);
    }

    public function addField($field, $noCheck = 0) {
        if ($noCheck || is_array($GLOBALS['TCA'][$this->table]['columns'][$field]) || GeneralUtility::inList($this->defaultList, $field)) {
            $this->fieldArray[] = $field;
        }
    }

    public function reset() {
        $this->tree = array();
        $this->recs = array();
        $this->ids = array();
        $this->ids_hierarchy = array();
        $this->orig_ids_hierarchy = array();
    }

    /*******************************************
     *
     * output
     *
     *******************************************/
    public function getBrowsableTree() {
        // Get stored tree structure AND updating it if needed according to incoming PM GET var.
        $this->initializePositionSaving();
        // Init done:
        $treeArr = array();
        // Traverse mounts:
        foreach ($this->MOUNTS as $idx => $uid) {
            // Set first:
            $this->bank = $idx;
            $isOpen = $this->stored[$idx][$uid] || $this->expandFirst;
            // Save ids while resetting everything else.
            $curIds = $this->ids;
            $this->reset();
            $this->ids = $curIds;
            // Set PM icon for root of mount:
            $cmd = $this->bank . '_' . ($isOpen ? '0_' : '1_') . $uid . '_' . $this->treeName;
            $icon = IconUtility::getSpriteIcon('treeline-'. ($isOpen ? 'minus' : 'plus') . 'only');

            $firstHtml = $this->PM_ATagWrap($icon, $cmd);
            // Preparing rootRec for the mount
            if ($uid) {
                $rootRec = $this->getRecord($uid);
                $firstHtml .= $this->getIcon($rootRec);
            } else {
                // Artificial record for the tree root, id=0
                $rootRec = $this->getRootRecord($uid);
                $firstHtml .= $this->getRootIcon($rootRec);
            }
            if (is_array($rootRec)) {
                // In case it was swapped inside getRecord due to workspaces.
                $uid = $rootRec['uid'];
                // Add the root of the mount to ->tree
                $this->tree[] = array('HTML' => $firstHtml, 'row' => $rootRec, 'bank' => $this->bank);
                // If the mount is expanded, go down:
                if ($isOpen) {
                    // Set depth:
                    $depthD = IconUtility::getSpriteIcon('treeline-blank');
                    if ($this->addSelfId) {
                        $this->ids[] = $uid;
                    }
                    $this->getTree($uid, 999, $depthD, '', $rootRec['_SUBCSSCLASS']);
                }
                // Add tree:
                $treeArr = array_merge($treeArr, $this->tree);
            }
        }
        return $this->printTree($treeArr);
    }

    public function printTree($treeArr = '') {
        $titleLen = (int)$this->BE_USER->uc['titleLen'];
        if (!is_array($treeArr)) {
            $treeArr = $this->tree;
        }
        $out = '';
        // put a table around it with IDs to access the rows from JS
        // not a problem if you don't need it
        // In XHTML there is no "name" attribute of <td> elements -
        // but Mozilla will not be able to highlight rows if the name
        // attribute is NOT there.
        $out .= '

            <!--
              TYPO3 tree structure.
            -->
            <table cellpadding="0" cellspacing="0" border="0" id="typo3-tree">';
        foreach ($treeArr as $k => $v) {
            $idAttr = htmlspecialchars($this->domIdPrefix . $this->getId($v['row']) . '_' . $v['bank']);
            $out .= '
                <tr>
                    <td id="' . $idAttr . '"' . ($v['row']['_CSSCLASS'] ? ' class="' . $v['row']['_CSSCLASS'] . '"' : '') . '>' . $v['HTML'] . $this->wrapTitle($this->getTitleStr($v['row'], $titleLen), $v['row'], $v['bank']) . '</td>
                </tr>
            ';
        }
        $out .= '
            </table>';
        return $out;
    }

    /*******************************************
     *
     * rendering parts
     *
     *******************************************/
    public function PMicon($row, $a, $c, $nextCount, $exp) {
        $PM = $nextCount ? ($exp ? 'minus' : 'plus') : 'join';
        $BTM = $a == $c ? 'bottom' : '';
        $icon = IconUtility::getSpriteIcon('treeline-' . $PM . $BTM);
        if ($nextCount) {
            $cmd = $this->bank . '_' . ($exp ? '0_' : '1_') . $row['uid'] . '_' . $this->treeName;
            $bMark = $this->bank . '_' . $row['uid'];
            $icon = $this->PM_ATagWrap($icon, $cmd, $bMark);
        }
        return $icon;
    }

    public function PM_ATagWrap($icon, $cmd, $bMark = '') {
        if ($this->thisScript) {
            if ($bMark) {
                $anchor = '#' . $bMark;
                $name = ' name="' . $bMark . '"';
            }
            $aUrl = $this->getThisScript() . 'PM=' . $cmd . $anchor;
            return '<a href="' . htmlspecialchars($aUrl) . '"' . $name . '>' . $icon . '</a>';
        } else {
            return $icon;
        }
    }

    public function wrapTitle($title, $row, $bank = 0) {
        $aOnClick = 'return jumpTo(\'' . $this->getJumpToParam($row) . '\',this,\'' . $this->domIdPrefix . $this->getId($row) . '\',' . $bank . ');';
        return '<a href="#" onclick="' . htmlspecialchars($aOnClick) . '">' . $title . '</a>';
    }

    public function wrapIcon($icon, $row) {
        return $icon;
    }

    public function addTagAttributes($icon, $attr) {
        return preg_replace('/ ?\\/?>$/', '', $icon) . ' ' . $attr . ' />';
    }

    public function wrapStop($str, $row) {
        if ($row['php_tree_stop']) {
            $str .= '<span class="typo3-red"><a href="' . htmlspecialchars(GeneralUtility::linkThisScript(array('setTempDBmount' => $row['uid']))) . '" class="typo3-red">+</a> </span>';
        }
        return $str;
    }

    /*******************************************
     *
     * tree handling
     *
     *******************************************/
    public function expandNext($id) {
        return $this->stored[$this->bank][$id] || $this->expandAll ? 1 : 0;
    }

    public function initializePositionSaving() {
        // Get stored tree structure:
        $this->stored = unserialize($this->BE_USER->uc['browseTrees'][$this->treeName]);
        // PM action
        // (If an plus/minus icon has been clicked, the PM GET var is sent and we
        // must update the stored positions in the tree):
        // 0: mount key, 1: set/clear boolean, 2: item ID (cannot contain "_"), 3: treeName
        $PM = explode('_', GeneralUtility::_GP('PM'));
        if (count($PM) == 4 && $PM[3] == $this->treeName) {
            if (isset($this->MOUNTS[$PM[0]])) {
                // set
                if ($PM[1]) {
                    $this->stored[$PM[0]][$PM[2]] = 1;
                    $this->savePosition();
                } else {
                    unset($this->stored[$PM[0]][$PM[2]]);
                    $this->savePosition();
                }
            }
        }
    }

    public function savePosition() {
        $this->BE_USER->uc['browseTrees'][$this->treeName] = serialize($this->stored);
        $this->BE_USER->writeUC();
    }

    /******************************
     *
     * Functions that might be overwritten by extended classes
     *
     ********************************/
    public function getRootIcon($rec) {
        return $this->wrapIcon(IconUtility::getSpriteIcon('apps-pagetree-root'), $rec);
    }

    public function getIcon($row) {
        if ($this->iconPath && $this->iconName) {
            $icon = '<img' . IconUtility::skinImg('', ($this->iconPath . $this->iconName), 'width="18" height="16"') . ' alt=""' . ($this->showDefaultTitleAttribute ? ' title="UID: ' . $row['uid'] . '"' : '') . ' />';
        } else {
            $icon = IconUtility::getSpriteIconForRecord($this->table, $row, array(
                'title' => $this->showDefaultTitleAttribute ? 'UID: ' . $row['uid'] : $this->getTitleAttrib($row),
                'class' => 'c-recIcon'
            ));
        }
        return $this->wrapIcon($icon, $row);
    }

    public function getTitleStr($row, $titleLen = 30) {
        if ($this->ext_showNavTitle && strlen(trim($row['nav_title'])) > 0) {
            $title = '<span title="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_tca.xlf:title', TRUE) . ' ' . htmlspecialchars(trim($row['title'])) . '">' . htmlspecialchars(GeneralUtility::fixed_lgd_cs($row['nav_title'], $titleLen)) . '</span>';
        } else {
            $title = htmlspecialchars(GeneralUtility::fixed_lgd_cs($row['title'], $titleLen));
            if (strlen(trim($row['nav_title'])) > 0) {
                $title = '<span title="' . $GLOBALS['LANG']->sL('LLL:EXT:cms/locallang_tca.xlf:pages.nav_title', TRUE) . ' ' . htmlspecialchars(trim($row['nav_title'])) . '">' . $title . '</span>';
            }
            $title = strlen(trim($row['title'])) == 0 ? '<em>[' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.no_title', TRUE) . ']</em>' : $title;
        }
        return $title;
    }

    public function getTitleAttrib($row) {
        return htmlspecialchars($row['title']);
    }

    public function getId($row) {
        return $row['uid'];
    }

    public function getJumpToParam($row) {
        return $this->getId($row);
    }

    /********************************
     *
     * tree data buidling
     *
     ********************************/
    public function getTree($uid, $depth = 999, $depthData = '', $blankLineCode = '', $subCSSclass = '') {
        // Buffer for id hierarchy is reset:
        $this->buffer_idH = array();
        // Init vars
        $depth = (int)$depth;
        $HTML = '';
        $a = 0;
        $res = $this->getDataInit($uid, $subCSSclass);
        $c = $this->getDataCount($res);
        $crazyRecursionLimiter = 999;
        $idH = array();
        // Traverse the records:
        while ($crazyRecursionLimiter > 0 && ($row = $this->getDataNext($res, $subCSSclass))) {
            $pageUid = ($this->table === 'pages') ? $row['uid'] : $row['pid'];
            if (!$GLOBALS['BE_USER']->isInWebMount($pageUid)) {
                // 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.<br /><br />See <a href="http://forge.typo3.org/issues/16150" target="_blank">forge.typo3.org/issues/16150</a> to get more information about a possible cause.', 1294586383);
            }
            // Reserve space.
            $this->tree[] = array();
            end($this->tree);
            // Get the key for this space
            $treeKey = key($this->tree);
            $LN = $a == $c ? 'blank' : 'line';
            // If records should be accumulated, do so
            if ($this->setRecs) {
                $this->recs[$row['uid']] = $row;
            }
            // 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][] = $row['_ORIG_uid'] ?: $row['uid'];

            // Make a recursive call to the next level
            $HTML_depthData = $depthData . IconUtility::getSpriteIcon('treeline-' . $LN);
            if ($depth > 1 && $this->expandNext($newID) && !$row['php_tree_stop']) {
                $nextCount = $this->getTree($newID, $depth - 1, $this->makeHTML ? $HTML_depthData : '', $blankLineCode . ',' . $LN, $row['_SUBCSSCLASS']);
                if (count($this->buffer_idH)) {
                    $idH[$row['uid']]['subrow'] = $this->buffer_idH;
                }
                // Set "did expand" flag
                $exp = 1;
            } else {
                $nextCount = $this->getCount($newID);
                // Clear "did expand" flag
                $exp = 0;
            }
            // Set HTML-icons, if any:
            if ($this->makeHTML) {
                $HTML = $depthData . $this->PMicon($row, $a, $c, $nextCount, $exp);
                $HTML .= $this->wrapStop($this->getIcon($row), $row);
            }
            // Finally, add the row/HTML content to the ->tree array in the reserved key.
            $this->tree[$treeKey] = array(
                'row' => $row,
                'HTML' => $HTML,
                'HTML_depthData' => $this->makeHTML == 2 ? $HTML_depthData : '',
                'invertedDepth' => $depth,
                'blankLineCode' => $blankLineCode,
                'bank' => $this->bank
            );
        }
        $this->getDataFree($res);
        $this->buffer_idH = $idH;
        return $c;
    }

    /********************************
     *
     * Data handling
     * Works with records and arrays
     *
     ********************************/
    public function getCount($uid) {
        if (is_array($this->data)) {
            $res = $this->getDataInit($uid);
            return $this->getDataCount($res);
        } else {
            return $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('uid', $this->table, $this->parentField . '=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($uid, $this->table) . BackendUtility::deleteClause($this->table) . BackendUtility::versioningPlaceholderClause($this->table) . $this->clause);
        }
    }

    public function getRootRecord($uid) {
        return array('title' => $this->title, 'uid' => 0);
    }

    public function getRecord($uid) {
        if (is_array($this->data)) {
            return $this->dataLookup[$uid];
        } else {
            return BackendUtility::getRecordWSOL($this->table, $uid);
        }
    }

    public function getDataInit($parentId, $subCSSclass = '') {
        if (is_array($this->data)) {
            if (!is_array($this->dataLookup[$parentId][$this->subLevelID])) {
                $parentId = -1;
            } else {
                reset($this->dataLookup[$parentId][$this->subLevelID]);
            }
            return $parentId;
        } else {
            $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(implode(',', $this->fieldArray), $this->table, $this->parentField . '=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($parentId, $this->table) . BackendUtility::deleteClause($this->table) . BackendUtility::versioningPlaceholderClause($this->table) . $this->clause, '', $this->orderByFields);
            return $res;
        }
    }

    public function getDataCount(&$res) {
        if (is_array($this->data)) {
            return count($this->dataLookup[$res][$this->subLevelID]);
        } else {
            $c = $GLOBALS['TYPO3_DB']->sql_num_rows($res);
            return $c;
        }
    }

    public function getDataNext(&$res, $subCSSclass = '') {
        if (is_array($this->data)) {
            if ($res < 0) {
                $row = FALSE;
            } else {
                list(, $row) = each($this->dataLookup[$res][$this->subLevelID]);
                // Passing on default <td> class for subelements:
                if (is_array($row) && $subCSSclass !== '') {
                    $row['_CSSCLASS'] = ($row['_SUBCSSCLASS'] = $subCSSclass);
                }
            }
            return $row;
        } else {
            while ($row = @$GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
                BackendUtility::workspaceOL($this->table, $row, $this->BE_USER->workspace, TRUE);
                if (is_array($row)) {
                    break;
                }
            }
            // Passing on default <td> class for subelements:
            if (is_array($row) && $subCSSclass !== '') {
                if ($this->table === 'pages' && $this->highlightPagesWithVersions && !isset($row['_CSSCLASS']) && $this->hasPageRecordVersions($this->BE_USER->workspace, $row['uid'])) {
                    $row['_CSSCLASS'] = 'ver-versions';
                }
                if (!isset($row['_CSSCLASS'])) {
                    $row['_CSSCLASS'] = $subCSSclass;
                }
                if (!isset($row['_SUBCSSCLASS'])) {
                    $row['_SUBCSSCLASS'] = $subCSSclass;
                }
            }
            return $row;
        }
    }

    public function getDataFree(&$res) {
        if (!is_array($this->data)) {
            $GLOBALS['TYPO3_DB']->sql_free_result($res);
        }
    }

    public function setDataFromArray(&$dataArr, $traverse = FALSE, $pid = 0) {
        if (!$traverse) {
            $this->data = &$dataArr;
            $this->dataLookup = array();
            // Add root
            $this->dataLookup[0][$this->subLevelID] = &$dataArr;
        }
        foreach ($dataArr as $uid => $val) {
            $dataArr[$uid]['uid'] = $uid;
            $dataArr[$uid]['pid'] = $pid;
            // Gives quick access to id's
            $this->dataLookup[$uid] = &$dataArr[$uid];
            if (is_array($val[$this->subLevelID])) {
                $this->setDataFromArray($dataArr[$uid][$this->subLevelID], TRUE, $uid);
            }
        }
    }

    public function setDataFromTreeArray(&$treeArr, &$treeLookupArr) {
        $this->data = &$treeArr;
        $this->dataLookup = &$treeLookupArr;
    }

    protected function hasPageRecordVersions($workspaceId, $pageId) {
        if (!ExtensionManagementUtility::isLoaded('workspaces')) {
            return FALSE;
        }

        return $this->getWorkspaceService()->hasPageRecordVersions($workspaceId, $pageId);

    }

    protected function getWorkspaceService() {
        if ($this->workspaceService === NULL) {
            $this->workspaceService = GeneralUtility::makeInstance('TYPO3\\CMS\\Workspaces\\Service\\WorkspaceService');
        }

        return $this->workspaceService;
    }

}