PageTreeNavigationController.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\Controller;

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

class PageTreeNavigationController {

    // Internal:
    public $content;

    public $pagetree;

    public $doc;

    // Temporary mount point (record), if any
    public $active_tempMountPoint = 0;

    public $backPath;

    // Internal, static: GPvar:
    public $currentSubScript;

    public $cMR;

    // If not '' (blank) then it will clear (0) or set (>0) Temporary DB mount.
    public $setTempDBmount;

    public $template;

    // Depends on userTS-setting
    public $hasFilterBox;

    public function __construct() {
        $GLOBALS['SOBE'] = $this;
        $GLOBALS['BACK_PATH'] = '';

        $this->init();
    }

    protected function init() {
        // Setting backPath
        $this->backPath = $GLOBALS['BACK_PATH'];
        // Setting GPvars:
        $this->cMR = GeneralUtility::_GP('cMR');
        $this->currentSubScript = GeneralUtility::_GP('currentSubScript');
        $this->setTempDBmount = GeneralUtility::_GP('setTempDBmount');
        // look for User setting
        $this->hasFilterBox = !$GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.hideFilter');
        // Create page tree object:
        $this->pagetree = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\View\\PageTreeView');
        $this->pagetree->ext_IconMode = $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.disableIconLinkToContextmenu');
        $this->pagetree->ext_showPageId = $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.showPageIdWithTitle');
        $this->pagetree->ext_showNavTitle = $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.showNavTitle');
        $this->pagetree->ext_separateNotinmenuPages = $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.separateNotinmenuPages');
        $this->pagetree->ext_alphasortNotinmenuPages = $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.alphasortNotinmenuPages');
        $this->pagetree->thisScript = 'alt_db_navframe.php';
        $this->pagetree->addField('alias');
        $this->pagetree->addField('shortcut');
        $this->pagetree->addField('shortcut_mode');
        $this->pagetree->addField('mount_pid');
        $this->pagetree->addField('mount_pid_ol');
        $this->pagetree->addField('nav_hide');
        $this->pagetree->addField('nav_title');
        $this->pagetree->addField('url');
        // Temporary DB mounts:
        $this->initializeTemporaryDBmount();
    }

    public function initPage() {
        // Setting highlight mode:
        $this->doHighlight = !$GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.disableTitleHighlight');
        // If highlighting is active, define the CSS class for the active item depending on the workspace
        if ($this->doHighlight) {
            $hlClass = $GLOBALS['BE_USER']->workspace === 0 ? 'active' : 'active active-ws wsver' . $GLOBALS['BE_USER']->workspace;
        }
        // Create template object:
        $this->doc = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Template\\DocumentTemplate');
        $this->doc->backPath = $GLOBALS['BACK_PATH'];
        $this->doc->setModuleTemplate('EXT:backend/Resources/Private/Templates/alt_db_navframe.html');
        $this->doc->showFlashMessages = FALSE;
        // Get HTML-Template
        // Adding javascript code for AJAX (prototype), drag&drop and the pagetree as well as the click menu code
        $this->doc->getDragDropCode('pages');
        $this->doc->getContextMenuCode();
        $pageRenderer = $this->doc->getPageRenderer();
        $pageRenderer->loadScriptaculous('effects');
        $pageRenderer->loadExtJS();
        if ($this->hasFilterBox) {
            $pageRenderer->addJsFile('sysext/backend/Resources/Public/JavaScript/pagetreefiltermenu.js');
        }
        $this->doc->JScode .= $this->doc->wrapScriptTags(($this->currentSubScript ? 'top.currentSubScript=unescape("' . rawurlencode($this->currentSubScript) . '");' : '') . '
        // setting prefs for pagetree and drag & drop
        ' . ($this->doHighlight ? 'Tree.highlightClass = "' . $hlClass . '";' : '') . '

        // Function, loading the list frame from navigation tree:
        function jumpTo(id, linkObj, highlightID, bank) { //
            var theUrl = top.TS.PATH_typo3 + top.currentSubScript ;
            if (theUrl.indexOf("?") != -1) {
                theUrl += "&id=" + id
            } else {
                theUrl += "?id=" + id
            }
            top.fsMod.currentBank = bank;
            top.TYPO3.Backend.ContentContainer.setUrl(theUrl);

            ' . ($this->doHighlight ? 'Tree.highlightActiveItem("web", highlightID + "_" + bank);' : '') . '
            if (linkObj) { linkObj.blur(); }
            return false;
        }
        ' . ($this->cMR ? 'jumpTo(top.fsMod.recentIds[\'web\'],\'\');' : '') . ($this->hasFilterBox ? 'var TYPO3PageTreeFilter = new PageTreeFilter();' : '') . '

        ');
        $this->doc->bodyTagId = 'typo3-pagetree';
    }

    public function main() {
        // Produce browse-tree:
        $tree = $this->pagetree->getBrowsableTree();
        // Outputting Temporary DB mount notice:
        if ($this->active_tempMountPoint) {
            $flashText = '
                <a href="' . htmlspecialchars(GeneralUtility::linkThisScript(array('setTempDBmount' => 0))) . '">' . $GLOBALS['LANG']->sl('LLL:EXT:lang/locallang_core.xlf:labels.temporaryDBmount', TRUE) . '</a>      <br />' . $GLOBALS['LANG']->sl('LLL:EXT:lang/locallang_core.xlf:labels.path', TRUE) . ': <span title="' . htmlspecialchars($this->active_tempMountPoint['_thePathFull']) . '">' . htmlspecialchars(GeneralUtility::fixed_lgd_cs($this->active_tempMountPoint['_thePath'], -50)) . '</span>
            ';
            $flashMessage = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Messaging\\FlashMessage', $flashText, '', \TYPO3\CMS\Core\Messaging\FlashMessage::INFO);
            $this->content .= $flashMessage->render();
        }
        // Outputting page tree:
        $this->content .= '<div id="PageTreeDiv">' . $tree . '</div>';
        // Adding javascript for drag & drop activation and highlighting
        $this->content .= $this->doc->wrapScriptTags('
            ' . ($this->doHighlight ? 'Tree.highlightActiveItem("",top.fsMod.navFrameHighlightedID["web"]);' : '') . '
            Tree.registerDragDropHandlers();');
        // Setting up the buttons and markers for docheader
        $docHeaderButtons = $this->getButtons();
        $markers = array(
            'IMG_RESET' => IconUtility::getSpriteIcon('actions-document-close', array(
                'id' => 'treeFilterReset',
                'alt' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.resetFilter'),
                'title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.resetFilter')
            )),
            'WORKSPACEINFO' => $this->getWorkspaceInfo(),
            'CONTENT' => $this->content
        );
        $subparts = array();
        if (!$this->hasFilterBox) {
            $subparts['###SECOND_ROW###'] = '';
        }
        // Build the <body> for the module
        $this->content = $this->doc->startPage('TYPO3 Page Tree');
        $this->content .= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers, $subparts);
        $this->content .= $this->doc->endPage();
        $this->content = $this->doc->insertStylesAndJS($this->content);
    }

    public function printContent() {
        echo $this->content;
    }

    protected function getButtons() {
        $buttons = array(
            'csh' => '',
            'new_page' => '',
            'refresh' => '',
            'filter' => ''
        );
        // New Page
        $onclickNewPageWizard = 'top.content.list_frame.location.href=top.TS.PATH_typo3+\'db_new.php?pagesOnly=1&amp;id=\'+Tree.pageID;';
        $buttons['new_page'] = '<a href="#" onclick="' . $onclickNewPageWizard . '" title="' . $GLOBALS['LANG']->sL('LLL:EXT:cms/layout/locallang.xlf:newPage', TRUE) . '">' . IconUtility::getSpriteIcon('actions-page-new') . '</a>';
        // Refresh
        $buttons['refresh'] = '<a href="' . htmlspecialchars(GeneralUtility::getIndpEnv('REQUEST_URI')) . '" title="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.refresh', TRUE) . '">' . IconUtility::getSpriteIcon('actions-system-refresh') . '</a>';
        // CSH
        $buttons['csh'] = str_replace('typo3-csh-inline', 'typo3-csh-inline show-right', BackendUtility::cshItem('xMOD_csh_corebe', 'pagetree', $GLOBALS['BACK_PATH'], '', TRUE));
        // Filter
        if ($this->hasFilterBox) {
            $buttons['filter'] = '<a href="#" id="tree-toolbar-filter-item">' . IconUtility::getSpriteIcon('actions-system-tree-search-open', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:cms/layout/locallang.xlf:labels.filter', TRUE))) . '</a>';
        }
        return $buttons;
    }

    protected function getWorkspaceInfo() {
        if (\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('workspaces') && ($GLOBALS['BE_USER']->workspace !== 0 || $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.onlineWorkspaceInfo'))) {
            $wsTitle = htmlspecialchars(\TYPO3\CMS\Workspaces\Service\WorkspaceService::getWorkspaceTitle($GLOBALS['BE_USER']->workspace));
            $workspaceInfo = '
                <div class="bgColor4 workspace-info">' . IconUtility::getSpriteIcon('apps-toolbar-menu-workspace', array(
                'title' => $wsTitle,
                'onclick' => 'top.goToModule(\'web_WorkspacesWorkspaces\');',
                'style' => 'cursor:pointer;'
            )) . $wsTitle . '</div>
            ';
        }
        return $workspaceInfo;
    }

    /**********************************
     *
     * Temporary DB mounts
     *
     **********************************/
    public function initializeTemporaryDBmount() {
        // Set/Cancel Temporary DB Mount:
        if (strlen($this->setTempDBmount)) {
            $set = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange($this->setTempDBmount, 0);
            if ($set > 0 && $GLOBALS['BE_USER']->isInWebMount($set)) {
                // Setting...:
                $this->settingTemporaryMountPoint($set);
            } else {
                // Clear:
                $this->settingTemporaryMountPoint(0);
            }
        }
        // Getting temporary mount point ID:
        $temporaryMountPoint = (int)$GLOBALS['BE_USER']->getSessionData('pageTree_temporaryMountPoint');
        // If mount point ID existed and is within users real mount points, then set it temporarily:
        if ($temporaryMountPoint > 0 && $GLOBALS['BE_USER']->isInWebMount($temporaryMountPoint)) {
            if ($this->active_tempMountPoint = BackendUtility::readPageAccess($temporaryMountPoint, $GLOBALS['BE_USER']->getPagePermsClause(1))) {
                $this->pagetree->MOUNTS = array($temporaryMountPoint);
            } else {
                // Clear temporary mount point as we have no access to it any longer
                $this->settingTemporaryMountPoint(0);
            }
        }
    }

    public function settingTemporaryMountPoint($pageId) {
        $GLOBALS['BE_USER']->setAndSaveSessionData('pageTree_temporaryMountPoint', (int)$pageId);
    }

    /**********************************
     *
     * AJAX Calls
     *
     **********************************/
    public function ajaxExpandCollapse($params, $ajaxObj) {
        $this->init();
        $tree = $this->pagetree->getBrowsableTree();
        if (!$this->pagetree->ajaxStatus) {
            $ajaxObj->setError($tree);
        } else {
            $ajaxObj->addContent('tree', $tree);
        }
    }

}