OpendocsController.php

Go to the documentation of this file.

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

class OpendocsController implements \TYPO3\CMS\Backend\Toolbar\ToolbarItemHookInterface {

    protected $backendReference;

    protected $openDocs;

    protected $recentDocs;

    protected $EXTKEY = 'opendocs';

    public function __construct(\TYPO3\CMS\Backend\Controller\BackendController &$backendReference = NULL) {
        $GLOBALS['LANG']->includeLLFile('EXT:opendocs/locallang_opendocs.xlf');
        $this->backendReference = $backendReference;
        $this->loadDocsFromUserSession();
    }

    public function checkAccess() {
        $conf = $GLOBALS['BE_USER']->getTSConfig('backendToolbarItem.tx_opendocs.disabled');
        return $conf['value'] != 1;
    }

    public function loadDocsFromUserSession() {
        list($this->openDocs, ) = $GLOBALS['BE_USER']->getModuleData('alt_doc.php', 'ses');
        $this->recentDocs = $GLOBALS['BE_USER']->getModuleData('opendocs::recent');
    }

    public function render() {
        $this->addJavascriptToBackend();
        $this->addCssToBackend();
        $numDocs = count($this->openDocs);
        $opendocsMenu = array();
        $title = $GLOBALS['LANG']->getLL('toolbaritem', TRUE);

        // Toolbar item icon
        $opendocsMenu[] = '<a href="#" class="toolbar-item">';
        $opendocsMenu[] = '<input type="text" id="tx-opendocs-counter" disabled="disabled" value="' . $numDocs . '" />';
        $opendocsMenu[] = \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIcon('apps-toolbar-menu-opendocs', array('title' => $title)) . '</a>';

        // Toolbar item menu and initial content
        $opendocsMenu[] = '<div class="toolbar-item-menu" style="display: none;">';
        $opendocsMenu[] = $this->renderMenu();
        $opendocsMenu[] = '</div>';
        return implode(LF, $opendocsMenu);
    }

    public function renderMenu() {
        $openDocuments = $this->openDocs;
        $recentDocuments = $this->recentDocs;
        $entries = array();
        $content = '';
        if (count($openDocuments)) {
            $entries[] = '<tr><th colspan="3">' . $GLOBALS['LANG']->getLL('open_docs', TRUE) . '</th></tr>';
            $i = 0;
            foreach ($openDocuments as $md5sum => $openDocument) {
                $i++;
                $entries[] = $this->renderMenuEntry($openDocument, $md5sum, FALSE, $i == 1);
            }
        }
        // If there are "recent documents" in the list, add them
        if (count($recentDocuments)) {
            $entries[] = '<tr><th colspan="3">' . $GLOBALS['LANG']->getLL('recent_docs', TRUE) . '</th></tr>';
            $i = 0;
            foreach ($recentDocuments as $md5sum => $recentDocument) {
                $i++;
                $entries[] = $this->renderMenuEntry($recentDocument, $md5sum, TRUE, $i == 1);
            }
        }
        if (count($entries)) {
            $content = '<table class="list" cellspacing="0" cellpadding="0" border="0">' . implode('', $entries) . '</table>';
        } else {
            $content = '<div class="no-docs">' . $GLOBALS['LANG']->getLL('no_docs', TRUE) . '</div>';
        }
        return $content;
    }

    public function renderMenuEntry($document, $md5sum, $isRecentDoc = FALSE, $isFirstDoc = FALSE) {
        $table = $document[3]['table'];
        $uid = $document[3]['uid'];
        $record = \TYPO3\CMS\Backend\Utility\BackendUtility::getRecordWSOL($table, $uid);
        if (!is_array($record)) {
            // Record seems to be deleted
            return '';
        }
        $label = htmlspecialchars(strip_tags(htmlspecialchars_decode($document[0])));
        $icon = \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIconForRecord($table, $record);
        $link = $GLOBALS['BACK_PATH'] . 'alt_doc.php?' . $document[2];
        $pageId = (int)$document[3]['uid'];
        if ($document[3]['table'] !== 'pages') {
            $pageId = (int)$document[3]['pid'];
        }
        $firstRow = '';
        if ($isFirstDoc) {
            $firstRow = ' first-row';
        }
        if (!$isRecentDoc) {
            $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:rm.closeDoc', TRUE);
            // Open document
            $closeIcon = \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIcon('actions-document-close');
            $entry = '
                <tr class="opendoc' . $firstRow . '">
                    <td class="icon">' . $icon . '</td>
                    <td class="label"><a href="#" onclick="jump(unescape(\'' . htmlspecialchars($link) . '\'), \'web_list\', \'web\', ' . $pageId . '); TYPO3BackendOpenDocs.toggleMenu(); return false;" target="content">' . $label . '</a></td>
                    <td class="close" onclick="return TYPO3BackendOpenDocs.closeDocument(\'' . $md5sum . '\');">' . $closeIcon . '</td>
                </tr>';
        } else {
            // Recently used document
            $entry = '
                <tr class="recentdoc' . $firstRow . '">
                    <td class="icon">' . $icon . '</td>
                    <td class="label" colspan="2"><a href="#" onclick="jump(unescape(\'' . htmlspecialchars($link) . '\'), \'web_list\', \'web\', ' . $pageId . '); TYPO3BackendOpenDocs.toggleMenu(); return false;" target="content">' . $label . '</a></td>
                </tr>';
        }
        return $entry;
    }

    public function getAdditionalAttributes() {
        return 'id="tx-opendocs-menu"';
    }

    protected function addJavascriptToBackend() {
        $this->backendReference->addJavascriptFile(
            \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath($this->EXTKEY) . 'Resources/Public/JavaScript/opendocs.js'
        );
    }

    protected function addCssToBackend() {
        $this->backendReference->addCssFile(
            'opendocs',
                \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath($this->EXTKEY) . '/Resources/Public/Css/opendocs.css'
        );
    }

    /*******************
     ***    HOOKS    ***
     *******************/
    public function updateNumberOfOpenDocsHook(&$params, $ref) {
        $params['JScode'] = '
            if (top && top.TYPO3BackendOpenDocs) {
                top.TYPO3BackendOpenDocs.updateNumberOfDocs(' . count($this->openDocs) . ', true);
            }
        ';
    }

    /******************
     *** AJAX CALLS ***
     ******************/
    public function closeDocument($params = array(), \TYPO3\CMS\Core\Http\AjaxRequestHandler &$ajaxObj = NULL) {
        $md5sum = \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('md5sum');
        if ($md5sum && isset($this->openDocs[$md5sum])) {
            // Add the document to be closed to the recent documents
            $this->recentDocs = array_merge(array($md5sum => $this->openDocs[$md5sum]), $this->recentDocs);
            // Allow a maximum of 8 recent documents
            if (count($this->recentDocs) > 8) {
                $this->recentDocs = array_slice($this->recentDocs, 0, 8);
            }
            // Remove it from the list of the open documents, and store the status
            unset($this->openDocs[$md5sum]);
            list(, $docDat) = $GLOBALS['BE_USER']->getModuleData('alt_doc.php', 'ses');
            $GLOBALS['BE_USER']->pushModuleData('alt_doc.php', array($this->openDocs, $docDat));
            $GLOBALS['BE_USER']->pushModuleData('opendocs::recent', $this->recentDocs);
        }
        $this->renderAjax($params, $ajaxObj);
    }

    public function renderAjax($params = array(), \TYPO3\CMS\Core\Http\AjaxRequestHandler &$ajaxObj = NULL) {
        $menuContent = $this->renderMenu();
        $ajaxObj->addContent('opendocsMenu', $menuContent);
    }

}