index.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2010 Georg Ringer <typo3@ringerge.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.
*
*  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!
***************************************************************/


/**
 * This class provides a taskcenter for BE users
 *
 * @author      Georg Ringer <typo3@ringerge.org>
 * @package     TYPO3
 * @subpackage  taskcenter
 *
 */


$LANG->includeLLFile('EXT:taskcenter/task/locallang.xml');


$BE_USER->modAccess($MCONF, 1);


// ***************************
// Script Classes
// ***************************
class SC_mod_user_task_index extends t3lib_SCbase {

    protected $pageinfo;

    /**
     * Initializes the Module
     *
     * @return  void
     */
    public function __construct() {
        parent::init();

            // initialize document
        $this->doc = t3lib_div::makeInstance('template');
        $this->doc->setModuleTemplate(
            t3lib_extMgm::extPath('taskcenter') . 'res/mod_template.html'
        );
        $this->doc->backPath = $GLOBALS['BACK_PATH'];
        $this->doc->getPageRenderer()->loadScriptaculous('effects,dragdrop');
        $this->doc->addStyleSheet(
            'tx_taskcenter',
            '../' . t3lib_extMgm::siteRelPath('taskcenter') . 'res/mod_styles.css'
        );
    }

    /**
     * Adds items to the ->MOD_MENU array. Used for the function menu selector.
     *
     * @return  void
     */
    public function menuConfig() {
        $this->MOD_MENU  = array('mode' => array());

        $this->MOD_MENU['mode']['information'] = $GLOBALS['LANG']->sL('LLL:EXT:taskcenter/locallang.xml:task_overview');
        $this->MOD_MENU['mode']['tasks'] = 'Tasks';

        parent::menuConfig();
    }

    /**
     * Creates the module's content. In this case it rather acts as a kind of #
     * dispatcher redirecting requests to specific tasks.
     *
     * @return  void
     */
    public function main() {
        $docHeaderButtons = $this->getButtons();
        $markers = array();

        $this->doc->JScodeArray[] = '
            script_ended = 0;
            function jumpToUrl(URL) {
                document.location = URL;
            }

            Event.observe(document, "dom:loaded", function(){
                var changeEffect;
                Sortable.create("task-list", { handles:$$("#task-list .drag"), tag: "li", ghosting:false, overlap:"vertical", constraint:false,
                 onChange: function(item) {
                     var list = Sortable.options(item).element;
                     // deactivate link
                    $$("#task-list a").each(function(link) {
                        link.writeAttribute("onclick","return false;");
                    });

                 },

                 onUpdate: function(list) {
                     new Ajax.Request("ajax.php", {
                         method: "post",
                         parameters: { ajaxID :"Taskcenter::saveSortingState", data:  Sortable.serialize(list)}
                     });
                        // activate link
                     Event.observe(window,"mouseup",function(){
                        $$("#task-list a").each(function(link) {
                            link.writeAttribute("onclick","");
                        });
                    });

                 }
                });

                $$("#taskcenter-menu .down").invoke("observe", "click", function(event){
                    var item = Event.element(event);
                    var itemParent = item.up();
                    item = item.next("div").next("div").next("div").next("div");

                    if (itemParent.hasClassName("expanded")) {
                        itemParent.removeClassName("expanded").addClassName("collapsed");
                        Effect.BlindUp(item, {duration : 0.5});
                        state = 1;
                    } else {
                        itemParent.removeClassName("collapsed").addClassName("expanded");
                        Effect.BlindDown(item, {duration : 0.5});
                        state = 0;
                    }
                    new Ajax.Request("ajax.php", {
                        parameters : "ajaxID=Taskcenter::saveCollapseState&item=" + itemParent.id + "&state=" + state
                    });
                });
            });
        ';
        $this->doc->postCode='
            <script language="javascript" type="text/javascript">
                script_ended = 1;
                if (top.fsMod) {
                    top.fsMod.recentIds["web"] = 0;
                }
            </script>
        ';

            // Render content depending on the mode
        $mode = (string)$this->MOD_SETTINGS['mode'];
        if ($mode == 'information') {
            $this->renderInformationContent();
        } else {
            $this->renderModuleContent();
        }

            // compile document
        $markers['FUNC_MENU'] = t3lib_BEfunc::getFuncMenu(
                0,
                'SET[mode]',
                $this->MOD_SETTINGS['mode'],
                $this->MOD_MENU['mode']
            );
        $markers['CONTENT'] = $this->content;

            // Build the <body> for the module
        $this->content = $this->doc->startPage($GLOBALS['LANG']->getLL('title'));
        $this->content .= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers);
        $this->content .= $this->doc->endPage();
        $this->content = $this->doc->insertStylesAndJS($this->content);
    }

    /**
     * Prints out the module's HTML
     *
     * @return  void
     */
    public function printContent() {
        echo $this->content;
    }

    /**
     * Generates the module content by calling the selected task
     *
     * @return  void
     */
    protected function renderModuleContent() {
        $title = $content = $actionContent = '';
        $chosenTask = (string)$this->MOD_SETTINGS['function'];

            // render the taskcenter task as default
        if (empty($chosenTask) || $chosenTask == 'index') {
            $chosenTask = 'taskcenter.tasks';
        }

            // remder the task
        list($extKey, $taskClass) = explode('.', $chosenTask, 2);
        $title = $GLOBALS['LANG']->sL($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter'][$extKey][$taskClass]['title']);

        if (class_exists($taskClass)) {
            $taskInstance = t3lib_div::makeInstance($taskClass, $this);

            if ($taskInstance instanceof tx_taskcenter_Task) {
                    // check if the task is restricted to admins only
                if ($this->checkAccess($extKey, $taskClass)) {
                    $actionContent .= $taskInstance->getTask();
                } else {
                    $flashMessage = t3lib_div::makeInstance(
                        't3lib_FlashMessage',
                        $GLOBALS['LANG']->getLL('error-access', TRUE),
                        $GLOBALS['LANG']->getLL('error_header'),
                        t3lib_FlashMessage::ERROR
                    );
                    $actionContent .= $flashMessage->render();
                }
            } else {
                    // error if the task is not an instance of tx_taskcenter_Task
                $flashMessage = t3lib_div::makeInstance(
                    't3lib_FlashMessage',
                    sprintf($GLOBALS['LANG']->getLL('error_no-instance', TRUE), $taskClass, 'tx_taskcenter_Task'),
                    $GLOBALS['LANG']->getLL('error_header'),
                    t3lib_FlashMessage::ERROR
                );
                $actionContent .= $flashMessage->render();
            }
        } else {
            $flashMessage = t3lib_div::makeInstance(
                't3lib_FlashMessage',
                $GLOBALS['LANG']->sL('LLL:EXT:taskcenter/task/locallang_mod.xml:mlang_labels_tabdescr'),
                $GLOBALS['LANG']->sL('LLL:EXT:taskcenter/task/locallang_mod.xml:mlang_tabs_tab'),
                t3lib_FlashMessage::INFO
            );
            $actionContent .= $flashMessage->render();
        }

        $content = '<div id="taskcenter-main">
                        <div id="taskcenter-menu">' . $this->indexAction() . '</div>
                        <div id="taskcenter-item" class="' . $extKey . '-' . $taskClass . '">' .
                            $actionContent . '
                        </div>
                    </div>';

        $this->content .= $content;
    }

    /**
     * Generates the information content
     *
     * @return  void
     */
    protected function renderInformationContent() {
        $content = $this->description (
            $GLOBALS['LANG']->getLL('mlang_tabs_tab'),
            $GLOBALS['LANG']->sL('LLL:EXT:taskcenter/task/locallang_mod.xml:mlang_labels_tabdescr')
        );

        $content .= $GLOBALS['LANG']->getLL('taskcenter-about');

        if ($GLOBALS['BE_USER']->isAdmin()) {
            $content .= '<br /><br />' . $this->description (
                $GLOBALS['LANG']->getLL('taskcenter-adminheader'),
                $GLOBALS['LANG']->getLL('taskcenter-admin')
            );
        }

        $this->content .= $content;
    }

    /**
     * Render the headline of a task including a title and an optional description.
     *
     * @param   string      $title: Title
     * @param   string      $description: Description
     * @return  string formatted title and description
     */
    public function description($title, $description='') {
        if (!empty($description)) {
            $description = '<p class="description">' .  nl2br(htmlspecialchars($description)) . '</p><br />';
        }
        $content = $this->doc->section($title, $description, FALSE, TRUE);

        return $content;
    }

    /**
     * Render a list of items as a nicely formated definition list including a
     * link, icon, title and description.
     * The keys of a single item are:
     *  - title:                Title of the item
     *  - link:                 Link to the task
     *  - icon:                 Path to the icon or Icon as HTML if it begins with <img
     *  - description:  Description of the task, using htmlspecialchars()
     *  - descriptionHtml:  Description allowing HTML tags which will override the
     *                                          description
     *
     * @param   array       $items: List of items to be displayed in the definition list.
     * @param   boolean     $mainMenu: Set it to TRUE to render the main menu
     * @return  string  definition list
     */
    public function renderListMenu($items, $mainMenu = FALSE) {
        $content = $section = '';
        $count = 0;

            // change the sorting of items to the user's one
        if ($mainMenu) {
            $userSorting = unserialize($GLOBALS['BE_USER']->uc['taskcenter']['sorting']);
            if (is_array($userSorting)) {
                $newSorting = array();
                foreach($userSorting as $item) {
                    if(isset($items[$item])) {
                        $newSorting[] = $items[$item];
                        unset($items[$item]);
                    }
                }
                $items = $newSorting + $items;
            }
        }

        if (is_array($items) && count($items) > 0) {
            foreach($items as $item) {
                $title = htmlspecialchars($item['title']);

                $icon = $additionalClass = $collapsedStyle = '';
                    // Check for custom icon
                if (!empty($item['icon'])) {
                    if (strpos($item['icon'], '<img ') === FALSE) {
                        $absIconPath = t3lib_div::getFileAbsFilename($item['icon']);
                            // If the file indeed exists, assemble relative path to it
                        if (file_exists($absIconPath)) {
                            $icon = $GLOBALS['BACK_PATH'] . '../' . str_replace(PATH_site, '', $absIconPath);
                            $icon = '<img src="' . $icon . '" title="' . $title . '" alt="' . $title . '" />';
                        }
                        if (@is_file($icon)) {
                            $icon = '<img' . t3lib_iconworks::skinImg($GLOBALS['BACK_PATH'], $icon, 'width="16" height="16"') . ' title="' . $title . '" alt="' . $title . '" />';
                        }
                    } else {
                        $icon = $item['icon'];
                    }
                }


                $description = (!empty($item['descriptionHtml'])) ? $item['descriptionHtml'] : '<p>' . nl2br(htmlspecialchars($item['description'])) . '</p>';

                $id = $this->getUniqueKey($item['uid']);

                    // collapsed & expanded menu items
                if ($mainMenu && isset($GLOBALS['BE_USER']->uc['taskcenter']['states'][$id]) && $GLOBALS['BE_USER']->uc['taskcenter']['states'][$id]) {
                    $collapsedStyle = 'style="display:none"';
                    $additionalClass = 'collapsed';
                } else {
                    $additionalClass = 'expanded';
                }

                    // first & last menu item
                if ($count == 0) {
                    $additionalClass .= ' first-item';
                } elseif ($count + 1 === count($items)) {
                    $additionalClass .= ' last-item';
                }

                    // active menu item
                $active = ((string) $this->MOD_SETTINGS['function'] == $item['uid']) ? ' active-task' : '';

                    // Main menu: Render additional syntax to sort tasks
                if ($mainMenu) {
                    $dragIcon = '<img' . t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/move.gif', 'width="16" height="16" hspace="2"') . ' title="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.move', 1) . '" alt="" />';
                    $section = '<div class="down">&nbsp;</div>
                                <div class="drag">' . $dragIcon . '</div>';
                    $backgroundClass = 't3-row-header ';
                }

                $content .= '<li class="' . $additionalClass . $active . '" id="el_' .$id . '">
                                ' . $section . '
                                <div class="image">' . $icon . '</div>
                                <div class="' . $backgroundClass . 'link"><a href="' . $item['link'] . '">' . $title . '</a></div>
                                <div class="content " ' . $collapsedStyle . '>' . $description . '</div>
                            </li>';

                $count++;
            }

            $navigationId = ($mainMenu) ? 'id="task-list"' : '';

            $content = '<ul ' . $navigationId . ' class="task-list">' . $content . '</ul>';

        }

        return $content;
    }

    /**
     * Shows an overview list of available reports.
     *
     * @return  string  list of available reports
     */
    protected function indexAction() {
        $content = '';
        $tasks = array();
        $icon = t3lib_extMgm::extRelPath('taskcenter') . 'task/task.gif';

            // render the tasks only if there are any available
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter']) && count($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter']) > 0) {
            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter'] as $extKey => $extensionReports) {
                foreach ($extensionReports as $taskClass => $task) {
                    if (!$this->checkAccess($extKey, $taskClass)) {
                        continue;
                    }
                    $link = 'mod.php?M=user_task&SET[function]=' . $extKey . '.' . $taskClass;
                    $taskTitle = $GLOBALS['LANG']->sL($task['title']);
                    $taskDescriptionHtml = '';

                        // Check for custom icon
                    if (!empty($task['icon'])) {
                        $icon = t3lib_div::getFileAbsFilename($task['icon']);
                    }

                    if (class_exists($taskClass)) {
                        $taskInstance = t3lib_div::makeInstance($taskClass, $this);
                        if ($taskInstance instanceof tx_taskcenter_Task) {
                            $taskDescriptionHtml = $taskInstance->getOverview();
                        }
                    }

                        // generate an array of all tasks
                    $uniqueKey = $this->getUniqueKey($extKey . '.' . $taskClass);
                    $tasks[$uniqueKey] = array(
                        'title'             => $taskTitle,
                        'descriptionHtml'   => $taskDescriptionHtml,
                        'description'       => $GLOBALS['LANG']->sL($task['description']),
                        'icon'              => $icon,
                        'link'              => $link,
                        'uid'               => $extKey . '.' . $taskClass
                    );
                }
            }

            $content .= $this->renderListMenu($tasks, TRUE);
        } else {
            $flashMessage = t3lib_div::makeInstance(
                't3lib_FlashMessage',
                $GLOBALS['LANG']->getLL('no-tasks', TRUE),
                '',
                t3lib_FlashMessage::INFO
            );
            $this->content .= $flashMessage->render();
        }

        return $content;
    }

    /**
     * Create the panel of buttons for submitting the form or otherwise
     * perform operations.
     *
     * @return  array   all available buttons as an assoc. array
     */
    protected function getButtons() {
        $buttons = array(
            'csh' => t3lib_BEfunc::cshItem('_MOD_web_func', '', $GLOBALS['BACK_PATH']),
            'shortcut' => '',
            'open_new_window' => $this->openInNewWindow()
        );

            // Shortcut
        if ($GLOBALS['BE_USER']->mayMakeShortcut()) {
            $buttons['shortcut'] = $this->doc->makeShortcutIcon('', 'function', $this->MCONF['name']);
        }

        return $buttons;
    }

    /**
     * Check the access to a task. Considered are:
     *  - Admins are always allowed
     *  - Tasks can be restriced to admins only
     *  - Tasks can be blinded for Users with TsConfig taskcenter.<extensionkey>.<taskName> = 0
     *
     * @param   string      $extKey: Extension key
     * @param   string      $taskClass: Name of the task
     * @return boolean      Access to the task allowed or not
     */
    protected function checkAccess($extKey, $taskClass) {
            // check if task is blinded with TsConfig (taskcenter.<extkey>.<taskName>
        $tsConfig = $GLOBALS['BE_USER']->getTSConfig('taskcenter.' . $extKey . '.' . $taskClass);
        if (isset($tsConfig['value']) && intval($tsConfig['value']) == 0) {
            return FALSE;
        }

        // admins are always allowed
        if ($GLOBALS['BE_USER']->isAdmin()) {
            return TRUE;
        }

            // check if task is restricted to admins
        if (intval($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter'][$extKey][$taskClass]['admin']) == 1) {
            return FALSE;
        }

        return TRUE;
    }

    /**
     * Returns HTML code to dislay an url in an iframe at the right side of the taskcenter
     *
     * @param   string      $url: url to display
     * @param   int     $max:
     * @return  string      code that inserts the iframe (HTML)
     */
    public function urlInIframe($url, $max=0) {
        $this->doc->JScodeArray[] =
        'function resizeIframe(frame,max) {
            var parent = $("typo3-docbody");
            var parentHeight = $(parent).getHeight() - 0;
            var parentWidth = $(parent).getWidth() - $("taskcenter-menu").getWidth() - 50;
            $("list_frame").setStyle({height: parentHeight+"px", width: parentWidth+"px"});

        }
        // event crashes IE6 so he is excluded first
        var version = parseFloat(navigator.appVersion.split(";")[1].strip().split(" ")[1]);
        if (!(Prototype.Browser.IE && version == 6)) {
            Event.observe(window, "resize", resizeIframe, false);
        }';

        return '<iframe onload="resizeIframe(this,' . $max . ');" scrolling="auto"  width="100%" src="' . $url . '" name="list_frame" id="list_frame" frameborder="no" style="margin-top:-51px;border: none;"></iframe>';
    }

    /**
     * Create a unique key from a string which can be used in Prototype's Sortable
     * Therefore '_' are replaced
     *
     * @param   string      $string: string which is used to generate the identifier
     * @return  string      modified string
     */
    protected function getUniqueKey($string) {
        $search     = array('.', '_');
        $replace    = array('-', '');

        return str_replace($search, $replace, $string);
    }

    /**
     * This method prepares the link for opening the devlog in a new window
     *
     * @return  string  Hyperlink with icon and appropriate JavaScript
     */
    protected function openInNewWindow() {
        $url = t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT');
        $onClick = "devlogWin=window.open('" . $url . "','taskcenter','width=790,status=0,menubar=1,resizable=1,location=0,scrollbars=1,toolbar=0');return false;";
        $content = '<a href="#" onclick="' . htmlspecialchars($onClick).'">' .
                    '<img' . t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'],'gfx/open_in_new_window.gif', 'width="19" height="14"') . ' title="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.openInNewWindow', 1) . '" class="absmiddle" alt="" />' .
                    '</a>';
        return $content;
    }


}


if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/taskcenter/task/index.php']) {
    include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/taskcenter/task/index.php']);
}



    // Make instance:
$SOBE = t3lib_div::makeInstance('SC_mod_user_task_index');
    // Include files?
foreach($SOBE->include_once as $INC_FILE) {
    include_once($INC_FILE);
}

$SOBE->main();
$SOBE->printContent();

?>

---