class.tx_opendocs.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2008-2011 Benjamin Mack <mack@xnos.org>
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

require_once(PATH_typo3 . 'interfaces/interface.backend_toolbaritem.php');

    // load the language file
$GLOBALS['LANG']->includeLLFile('EXT:opendocs/locallang_opendocs.xml');


/**
 * Adding a list of all open documents of a user to the backend.php
 *
 * @author  Benjamin Mack <benni@typo3.org>
 * @author  Ingo Renner <ingo@typo3.org>
 * @package TYPO3
 * @subpackage  opendocs
 */
class tx_opendocs implements backend_toolbarItem {

    /**
     * reference back to the backend object
     *
     * @var TYPO3backend
     */
    protected $backendReference;

    protected $openDocs;
    protected $recentDocs;
    protected $EXTKEY = 'opendocs';


    /**
     * constructor, loads the documents from the user control
     *
     * @param   TYPO3backend    TYPO3 backend object reference
     */
    public function __construct(TYPO3backend &$backendReference = null) {
        $this->backendReference = $backendReference;
        $this->loadDocsFromUserSession();
    }

    /**
     * checks whether the user has access to this toolbar item
     *
     * @return  boolean  true if user has access, false if not
     */
    public function checkAccess() {
        $conf = $GLOBALS['BE_USER']->getTSConfig('backendToolbarItem.tx_opendocs.disabled');
        return ($conf['value'] == 1 ? false : true);
    }

    /**
     * loads the opened and recently opened documents from the user
     *
     * @return  void
     */
    public function loadDocsFromUserSession() {
        list($this->openDocs, )  = $GLOBALS['BE_USER']->getModuleData('alt_doc.php', 'ses');
        $this->recentDocs        = $GLOBALS['BE_USER']->getModuleData('opendocs::recent');
    }

    /**
     * renders the toolbar item and the initial menu
     *
     * @return  string      the toolbar item including the initial menu content as HTML
     */
    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[] = t3lib_iconWorks::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);
    }

    /**
     * renders the pure contents of the menu
     *
     * @return  string      the menu's content
     */
    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;
    }

    /**
     * returns the recent documents list as an array
     *
     * @return  array   all recent documents as list-items
     */
    public function renderMenuEntry($document, $md5sum, $isRecentDoc = false, $isFirstDoc = false) {
        $table  = $document[3]['table'];
        $uid    = $document[3]['uid'];
        $record = t3lib_BEfunc::getRecordWSOL($table, $uid);
        if (!is_array($record)) {
                // record seems to be deleted
            return '';
        }
        $label  = htmlspecialchars(strip_tags(t3lib_div::htmlspecialchars_decode($document[0])));
        $icon   = t3lib_iconWorks::getSpriteIconForRecord($table, $record);
        $link   = $GLOBALS['BACK_PATH'] . 'alt_doc.php?' . $document[2];

        $firstRow = '';
        if ($isFirstDoc) {
            $firstRow = ' first-row';
        }

        if (!$isRecentDoc) {
            $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:rm.closeDoc', true);

                // open document
            $closeIcon = t3lib_iconWorks::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\'); 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\'); TYPO3BackendOpenDocs.toggleMenu(); return false;" target="content">' . $label . '</a></td>
                </tr>';
        }

        return $entry;
    }

    /**
     * returns additional attributes for the list item in the toolbar
     *
     * @return  string      list item HTML attibutes
     */
    public function getAdditionalAttributes() {
        return ' id="tx-opendocs-menu"';
    }

    /**
     * adds the neccessary javascript to the backend
     *
     * @return  void
     */
    protected function addJavascriptToBackend() {
        $this->backendReference->addJavascriptFile(t3lib_extMgm::extRelPath($this->EXTKEY) . 'opendocs.js');
    }

    /**
     * adds the neccessary CSS to the backend
     *
     * @return  void
     */
    protected function addCssToBackend() {
        $this->backendReference->addCssFile('opendocs', t3lib_extMgm::extRelPath($this->EXTKEY) . 'opendocs.css');
    }


    /*******************
     ***    HOOKS    ***
     *******************/

    /**
     * called as a hook in t3lib_BEfunc::setUpdateSignal, calls a JS function to change
     * the number of opened documents
     *
     * @param   array       $params
     * @param   unknown_type        $ref
     * @return  string      list item HTML attibutes
     */
    public function updateNumberOfOpenDocsHook(&$params, $ref) {
        $params['JScode'] = '
            if (top && top.TYPO3BackendOpenDocs) {
                top.TYPO3BackendOpenDocs.updateNumberOfDocs(' . count($this->openDocs) . ', true);
            }
        ';
    }


    /******************
     *** AJAX CALLS ***
     ******************/

    /**
     * closes a document in the session and
     *
     * @param   array       array of parameters from the AJAX interface, currently unused
     * @param   TYPO3AJAX   object of type TYPO3AJAX
     * @return  string      list item HTML attibutes
     */
    public function closeDocument($params = array(), TYPO3AJAX &$ajaxObj = null) {
        $md5sum = t3lib_div::_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);
    }

    /**
     * renders the menu so that it can be returned as response to an AJAX call
     *
     * @param   array       array of parameters from the AJAX interface, currently unused
     * @param   TYPO3AJAX   object of type TYPO3AJAX
     * @return  void
     */
    public function renderAjax($params = array(), TYPO3AJAX &$ajaxObj = null) {
        $menuContent = $this->renderMenu();

        $ajaxObj->addContent('opendocsMenu', $menuContent);
    }

}


if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/opendocs/class.tx_opendocs.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/opendocs/class.tx_opendocs.php']);
}
?>