class.ilDashboardGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once './Services/User/classes/class.ilObjUser.php';
include_once "Services/Mail/classes/class.ilMail.php";
include_once 'Services/Mail/classes/class.ilMailGlobalServices.php';
include_once 'Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';

class ilDashboardGUI
{
    const CMD_JUMP_TO_MY_STAFF = "jumpToMyStaff";

    const DISENGAGE_MAINBAR = "dash_mb_disengage";

    protected $ctrl;

    protected $main_menu;

    protected $user;

    protected $error;

    protected $settings;

    protected $rbacsystem;

    protected $plugin_admin;

    protected $help;

    public $tpl;
    public $lng;

    public $cmdClass = '';

    protected $action_menu;

    public function __construct()
    {
        global $DIC;

        $this->main_menu = $DIC["ilMainMenu"];
        $this->user = $DIC->user();
        $this->error = $DIC["ilErr"];
        $this->settings = $DIC->settings();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->plugin_admin = $DIC["ilPluginAdmin"];
        $this->help = $DIC["ilHelp"];
        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $ilMainMenu = $DIC["ilMainMenu"];
        $ilUser = $DIC->user();
        $ilErr = $DIC["ilErr"];
        
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
        
        $ilCtrl->setContext(
            $ilUser->getId(),
            "user"
        );

        $ilMainMenu->setActive("desktop");
        $this->lng->loadLanguageModule("pdesk");
        $this->lng->loadLanguageModule("pd"); // #16813
        $this->lng->loadLanguageModule("dash");
        $this->lng->loadLanguageModule("mmbr");

        // catch hack attempts
        if ($GLOBALS['DIC']['ilUser']->getId() == ANONYMOUS_USER_ID) {
            $ilErr->raiseError($this->lng->txt("msg_not_available_for_anon"), $ilErr->MESSAGE);
        }
        $this->cmdClass = $_GET['cmdClass'];

        $this->ctrl->saveParameter($this, array("view"));

        //$tree->useCache(false);

        $this->action_menu = new ilAdvancedSelectionListGUI();
    }
    
    public function executeCommand()
    {
        global $DIC;

        $context = $DIC->globalScreen()->tool()->context();
        $context->stack()->desktop();

        $ilSetting = $this->settings;
        $rbacsystem = $this->rbacsystem;
        $ilErr = $this->error;

        $next_class = $this->ctrl->getNextClass();
        $this->ctrl->setReturn($this, "show");

        // read last active subsection
        if (isset($_GET['PDHistory']) && $_GET['PDHistory']) {
            $next_class = $this->__loadNextClass();
        }
        $this->__storeLastClass($next_class);

        switch ($next_class) {

                // profile
            case "ilpersonalprofilegui":
                $this->getStandardTemplates();
                $this->setTabs();
                $profile_gui = new ilPersonalProfileGUI();
                $ret = $this->ctrl->forwardCommand($profile_gui);
                break;
                
            // settings
            case "ilpersonalsettingsgui":
                $this->getStandardTemplates();
                $this->setTabs();
                $settings_gui = new ilPersonalSettingsGUI();
                $ret = $this->ctrl->forwardCommand($settings_gui);
                break;
            
                // profile
            case "ilobjusergui":
                include_once('./Services/User/classes/class.ilObjUserGUI.php');
                $user_gui = new ilObjUserGUI("", $_GET["user"], false, false);
                $ret = $this->ctrl->forwardCommand($user_gui);
                break;
            
            case 'ilcalendarpresentationgui':
                $this->getStandardTemplates();
                $this->displayHeader();
                $this->tpl->setTitle($this->lng->txt("calendar"));
                $this->setTabs();
                include_once('./Services/Calendar/classes/class.ilCalendarPresentationGUI.php');
                $cal = new ilCalendarPresentationGUI();
                $ret = $this->ctrl->forwardCommand($cal);
                $this->tpl->printToStdout();
                break;
            
                // pd notes
            case "ilpdnotesgui":
                if ($ilSetting->get('disable_notes') && $ilSetting->get('disable_comments')) {
                    ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
                    ilUtil::redirect('ilias.php?baseClass=ilDashboardGUI');
                    return;
                }
                
                $this->getStandardTemplates();
                $this->setTabs();
                include_once("./Services/Notes/classes/class.ilPDNotesGUI.php");
                $pd_notes_gui = new ilPDNotesGUI();
                $ret = $this->ctrl->forwardCommand($pd_notes_gui);
                break;
            
            // pd news
            case "ilpdnewsgui":
                $this->getStandardTemplates();
                $this->setTabs();
                include_once("./Services/News/classes/class.ilPDNewsGUI.php");
                $pd_news_gui = new ilPDNewsGUI();
                $ret = $this->ctrl->forwardCommand($pd_news_gui);
                break;

            case "ilcolumngui":
                $this->getStandardTemplates();
                $this->setTabs();
                include_once("./Services/Block/classes/class.ilColumnGUI.php");
                $column_gui = new ilColumnGUI("pd");
                $this->initColumn($column_gui);
                $this->show();
                break;

            case "ilpdselecteditemsblockgui":
                $block = new ilPDSelectedItemsBlockGUI();
                $this->displayHeader();
                $ret = $this->ctrl->forwardCommand($block);
                if ($ret != "") {
                    $this->tpl->setContent($ret);
                    $this->tpl->printToStdout();
                }
                break;

            case "ilpdmembershipblockgui":
                $block = new ilPDMembershipBlockGUI();
                $ret = $this->ctrl->forwardCommand($block);
                if ($ret != "") {
                    $this->displayHeader();
                    $this->tpl->setContent($ret);
                    $this->tpl->printToStdout();
                }
                break;

            case 'ilcontactgui':
                require_once 'Services/Contact/BuddySystem/classes/class.ilBuddySystem.php';
                if (!ilBuddySystem::getInstance()->isEnabled()) {
                    $ilErr->raiseError($this->lng->txt('msg_no_perm_read'), $ilErr->MESSAGE);
                }

                $this->getStandardTemplates();
                $this->setTabs();
                $this->tpl->setTitle($this->lng->txt('mail_addressbook'));

                require_once 'Services/Contact/classes/class.ilContactGUI.php';
                $this->ctrl->forwardCommand(new ilContactGUI());
                break;

            case 'ilpersonalworkspacegui':
                // $this->getStandardTemplates();
                // $this->setTabs();
                include_once 'Services/PersonalWorkspace/classes/class.ilPersonalWorkspaceGUI.php';
                $wsgui = new ilPersonalWorkspaceGUI();
                $ret = $this->ctrl->forwardCommand($wsgui);
                $this->tpl->printToStdout();
                break;
            
            case 'ilportfoliorepositorygui':
                $this->getStandardTemplates();
                $this->setTabs();
                include_once 'Modules/Portfolio/classes/class.ilPortfolioRepositoryGUI.php';
                $pfgui = new ilPortfolioRepositoryGUI();
                $ret = $this->ctrl->forwardCommand($pfgui);
                $this->tpl->printToStdout();
                break;

            case 'ilachievementsgui':
                $this->getStandardTemplates();
                $this->setTabs();
                $achievegui = new ilAchievementsGUI();
                $ret = $this->ctrl->forwardCommand($achievegui);
                break;

            case strtolower(ilMyStaffGUI::class):
                $this->getStandardTemplates();
                $mstgui = new ilMyStaffGUI();
                $ret = $this->ctrl->forwardCommand($mstgui);
                break;
            case 'ilgroupuseractionsgui':
                $this->getStandardTemplates();
                $this->setTabs();
                include_once './Modules/Group/UserActions/classes/class.ilGroupUserActionsGUI.php';
                $ggui = new ilGroupUserActionsGUI();
                $ret = $this->ctrl->forwardCommand($ggui);
                $this->tpl->printToStdout();
                break;
            case 'redirect':
                $this->redirect();
                break;

            case "ildashboardrecommendedcontentgui":
                $gui = new ilDashboardRecommendedContentGUI();
                $this->ctrl->forwardCommand($gui);
                break;
            case "ilstudyprogrammedashboardviewgui":
                $gui = new ilStudyProgrammeDashboardViewGUI();
                $this->ctrl->forwardCommand($gui);
                break;
            default:
                $context->current()->addAdditionalData(self::DISENGAGE_MAINBAR, true);
                $this->getStandardTemplates();
                $this->setTabs();
                $cmd = $this->ctrl->getCmd("show");
                $this->$cmd();
                break;
        }
        $ret = null;
        return $ret;
    }

    public function getStandardTemplates()
    {
        $this->tpl->loadStandardTemplate();
    }
    
    public function show()
    {
        // preload block settings
        include_once("Services/Block/classes/class.ilBlockSetting.php");
        ilBlockSetting::preloadPDBlockSettings();

        // display infopanel if something happened
        ilUtil::infoPanel();
        
        $this->tpl->setTitle($this->lng->txt("dash_dashboard"));
        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_dshs.svg"), $this->lng->txt("dash_dashboard"));
        $this->tpl->setVariable("IMG_SPACE", ilUtil::getImagePath("spacer.png", false));
        
        $this->tpl->setContent($this->getCenterColumnHTML());
        $this->tpl->setRightContent($this->getRightColumnHTML());

        if (count($this->action_menu->getItems())) {
            $tpl = $this->tpl;
            $lng = $this->lng;

            $this->action_menu->setAsynch(false);
            $this->action_menu->setAsynchUrl('');
            $this->action_menu->setListTitle($lng->txt('actions'));
            $this->action_menu->setId('act_pd');
            $this->action_menu->setSelectionHeaderClass('small');
            $this->action_menu->setItemLinkClass('xsmall');
            $this->action_menu->setLinksMode('il_ContainerItemCommand2');
            $this->action_menu->setHeaderIcon(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK);
            $this->action_menu->setUseImages(false);

            $htpl = new ilTemplate('tpl.header_action.html', true, true, 'Services/Repository');
            $htpl->setVariable('ACTION_DROP_DOWN', $this->action_menu->getHTML());

            $tpl->setHeaderActionMenu($htpl->get());
        }
        
        $this->tpl->printToStdout();
    }
    
    
    public function getCenterColumnHTML()
    {
        $ilCtrl = $this->ctrl;
        $ilPluginAdmin = $this->plugin_admin;
        
        include_once("Services/Block/classes/class.ilColumnGUI.php");
        $column_gui = new ilColumnGUI("pd", IL_COL_CENTER);
        $this->initColumn($column_gui);

        if ($ilCtrl->getNextClass() == "ilcolumngui" &&
            $column_gui->getCmdSide() == IL_COL_CENTER) {
            $html = $ilCtrl->forwardCommand($column_gui);
        } else {
            if (!$ilCtrl->isAsynch()) {
                if ($column_gui->getScreenMode() != IL_SCREEN_SIDE) {
                    // right column wants center
                    if ($column_gui->getCmdSide() == IL_COL_RIGHT) {
                        $column_gui = new ilColumnGUI("pd", IL_COL_RIGHT);
                        $this->initColumn($column_gui);
                        $html = $ilCtrl->forwardCommand($column_gui);
                    }
                    // left column wants center
                    if ($column_gui->getCmdSide() == IL_COL_LEFT) {
                        $column_gui = new ilColumnGUI("pd", IL_COL_LEFT);
                        $this->initColumn($column_gui);
                        $html = $ilCtrl->forwardCommand($column_gui);
                    }
                } else {
                    $html = "";

                    // user interface plugin slot + default rendering
                    include_once("./Services/UIComponent/classes/class.ilUIHookProcessor.php");
                    $uip = new ilUIHookProcessor(
                        "Services/Dashboard",
                        "center_column",
                        array("personal_desktop_gui" => $this)
                    );
                    if (!$uip->replaced()) {
                        $html = $this->getMainContent();
                        //$html = $ilCtrl->getHTML($column_gui);
                    }
                    $html = $uip->getHTML($html);
                }
            }
        }
        return $html;
    }

    public function getRightColumnHTML()
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilPluginAdmin = $this->plugin_admin;
        
        include_once("Services/Block/classes/class.ilColumnGUI.php");
        $column_gui = new ilColumnGUI("pd", IL_COL_RIGHT);
        $this->initColumn($column_gui);

        if ($column_gui->getScreenMode() == IL_SCREEN_FULL) {
            return "";
        }

        if ($ilCtrl->getNextClass() == "ilcolumngui" &&
            $column_gui->getCmdSide() == IL_COL_RIGHT &&
            $column_gui->getScreenMode() == IL_SCREEN_SIDE) {
            $html = $ilCtrl->forwardCommand($column_gui);
        } else {
            if (!$ilCtrl->isAsynch()) {
                $html = "";
                
                // user interface plugin slot + default rendering
                include_once("./Services/UIComponent/classes/class.ilUIHookProcessor.php");
                $uip = new ilUIHookProcessor(
                    "Services/Dashboard",
                    "right_column",
                    array("personal_desktop_gui" => $this)
                );
                if (!$uip->replaced()) {
                    $html = $ilCtrl->getHTML($column_gui);
                }
                $html = $uip->getHTML($html);
            }
        }

        return $html;
    }

    public function getLeftColumnHTML()
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilPluginAdmin = $this->plugin_admin;

        include_once("Services/Block/classes/class.ilColumnGUI.php");
        $column_gui = new ilColumnGUI("pd", IL_COL_LEFT);
        $this->initColumn($column_gui);

        if ($column_gui->getScreenMode() == IL_SCREEN_FULL) {
            return "";
        }

        if ($ilCtrl->getNextClass() == "ilcolumngui" &&
            $column_gui->getCmdSide() == IL_COL_LEFT &&
            $column_gui->getScreenMode() == IL_SCREEN_SIDE) {
            $html = $ilCtrl->forwardCommand($column_gui);
        } else {
            if (!$ilCtrl->isAsynch()) {
                $html = "";
                
                // user interface plugin slot + default rendering
                include_once("./Services/UIComponent/classes/class.ilUIHookProcessor.php");
                $uip = new ilUIHookProcessor(
                    "Services/Dashboard",
                    "left_column",
                    array("personal_desktop_gui" => $this)
                );
                if (!$uip->replaced()) {
                    $html = $ilCtrl->getHTML($column_gui);
                }
                $html = $uip->getHTML($html);
            }
        }

        return $html;
    }

    public function prepareContentView()
    {
        $this->tpl->loadStandardTemplate();
                
        // display infopanel if something happened
        ilUtil::infoPanel();

        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_pd.svg"));
        $this->tpl->setTitle($this->lng->txt("personal_desktop"));
        $this->tpl->setVariable("IMG_SPACE", ilUtil::getImagePath("spacer.png", false));
    }

    public function multiarray_sort($array, $key_sort)
    {
        if ($array) {
            $key_sorta = explode(";", $key_sort);
            
            $multikeys = array_keys($array);
            $keys = array_keys($array[$multikeys[0]]);
            
            for ($m = 0; $m < count($key_sorta); $m++) {
                $nkeys[$m] = trim($key_sorta[$m]);
            }
            $n += count($key_sorta);
            
            for ($i = 0; $i < count($keys); $i++) {
                if (!in_array($keys[$i], $key_sorta)) {
                    $nkeys[$n] = $keys[$i];
                    $n += "1";
                }
            }
            
            for ($u = 0;$u < count($array); $u++) {
                $arr = $array[$multikeys[$u]];
                for ($s = 0; $s < count($nkeys); $s++) {
                    $k = $nkeys[$s];
                    $output[$multikeys[$u]][$k] = $array[$multikeys[$u]][$k];
                }
            }
            sort($output);
            return $output;
        }
    }
    
    public function setTabs()
    {
        $ilHelp = $this->help;
        
        $ilHelp->setScreenIdComponent("pd");
    }

    public function jumpToMemberships()
    {
        $viewSettings = new ilPDSelectedItemsBlockViewSettings($GLOBALS['DIC']->user(), (int) $_GET['view']);
        if ($viewSettings->enabledMemberships()) {
            $_GET['view'] = $viewSettings->getMembershipsView();
            $this->ctrl->setParameter($this, "view", $viewSettings->getMembershipsView());
        }
        //$this->show();
        $this->ctrl->redirect($this, "show");
    }

    public function jumpToSelectedItems()
    {
        $viewSettings = new ilPDSelectedItemsBlockViewSettings($GLOBALS['DIC']->user(), (int) $_GET['view']);
        if ($viewSettings->enabledSelectedItems()) {
            $_GET['view'] = $viewSettings->getSelectedItemsView();
            $this->ctrl->setParameter($this, "view", $viewSettings->getSelectedItemsView());
        }
        $this->show();
    }

    public function jumpToProfile()
    {
        $this->ctrl->redirectByClass("ilpersonalprofilegui");
    }

    public function jumpToPortfolio()
    {
        // incoming back link from shared resource
        $cmd = "";
        if ($_REQUEST["dsh"]) {
            $this->ctrl->setParameterByClass("ilportfoliorepositorygui", "shr_id", $_REQUEST["dsh"]);
            $cmd = "showOther";
        }
        
        // used for goto links
        if ($_GET["prt_id"]) {
            $this->ctrl->setParameterByClass("ilobjportfoliogui", "prt_id", (int) $_GET["prt_id"]);
            $this->ctrl->setParameterByClass("ilobjportfoliogui", "gtp", (int) $_GET["gtp"]);
            $this->ctrl->redirectByClass(array("ilportfoliorepositorygui", "ilobjportfoliogui"), "preview");
        } else {
            $this->ctrl->redirectByClass("ilportfoliorepositorygui", $cmd);
        }
    }
    
    public function jumpToSettings()
    {
        $this->ctrl->redirectByClass("ilpersonalsettingsgui");
    }
    

    public function jumpToNotes()
    {
        $ilSetting = $this->settings;

        if ($ilSetting->get('disable_notes')) {
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            ilUtil::redirect('ilias.php?baseClass=ilDashboardGUI');
            return;
        }
        
        $this->ctrl->redirectByClass("ilpdnotesgui");
    }

    public function jumpToComments()
    {
        $ilSetting = $this->settings;

        if ($ilSetting->get('disable_comments')) {
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            ilUtil::redirect('ilias.php?baseClass=ilDashboardGUI');
            return;
        }

        $this->ctrl->redirectByClass("ilpdnotesgui", "showPublicComments");
    }

    public function jumpToNews()
    {
        $this->ctrl->redirectByClass("ilpdnewsgui");
    }
    
    public function jumpToLP()
    {
        $this->ctrl->redirectByClass("illearningprogressgui");
    }

    public function jumpToCalendar()
    {
        global $DIC;
        $request = $DIC->http()->request();

        if ($request->getQueryParams()["cal_view"]) {
            $cal_view = $request->getQueryParams()["cal_view"];
            $this->ctrl->setParameter($this, "cal_view", $cal_view);
        }

        if (!empty($request->getQueryParams()["cal_agenda_per"])) {
            $cal_period = $request->getQueryParams()["cal_agenda_per"];
            $this->ctrl->setParameter($this, "cal_agenda_per", $cal_period);
        }

        $this->ctrl->redirectByClass("ilcalendarpresentationgui");
    }

    public function jumpToWorkspace()
    {
        // incoming back link from shared resource
        $cmd = "";
        if ($_REQUEST["dsh"]) {
            $this->ctrl->setParameterByClass("ilpersonalworkspacegui", "shr_id", $_REQUEST["dsh"]);
            $cmd = "share";
        }
        
        if ($_REQUEST["wsp_id"]) {
            $this->ctrl->setParameterByClass("ilpersonalworkspacegui", "wsp_id", (int) $_REQUEST["wsp_id"]);
        }
        
        if ($_REQUEST["gtp"]) {
            $this->ctrl->setParameterByClass("ilpersonalworkspacegui", "gtp", (int) $_REQUEST["gtp"]);
        }
        
        $this->ctrl->redirectByClass("ilpersonalworkspacegui", $cmd);
    }

    protected function jumpToMyStaff()
    {
        $this->ctrl->redirectByClass(ilMyStaffGUI::class);
    }
    
    public function jumpToBadges()
    {
        $this->ctrl->redirectByClass(["ilAchievementsGUI", "ilbadgeprofilegui"]);
    }
    
    public function jumpToSkills()
    {
        $this->ctrl->redirectByClass("ilpersonalskillsgui");
    }
    
    public function __loadNextClass()
    {
        $stored_classes = array('ildashboardgui',
                                'ilpersonalprofilegui',
                                'ilpdnotesgui',
                                'ilcalendarpresentationgui',
                                'illearningprogressgui');

        if (isset($_SESSION['il_pd_history']) and in_array($_SESSION['il_pd_history'], $stored_classes)) {
            return $_SESSION['il_pd_history'];
        } else {
            $this->ctrl->getNextClass($this);
        }
    }
    public function __storeLastClass($a_class)
    {
        $_SESSION['il_pd_history'] = $a_class;
        $this->cmdClass = $a_class;
    }

    public function initColumn($a_column_gui)
    {
        $a_column_gui->setActionMenu($this->action_menu);
    }
    
    public function displayHeader()
    {
        $this->tpl->setTitle($this->lng->txt("dash_dashboard"));
    }

    protected function toggleHelp()
    {
        if (ilSession::get("show_help_tool") == "1") {
            ilSession::set("show_help_tool", "0");
        } else {
            ilSession::set("show_help_tool", "1");
        }
        $this->ctrl->redirect($this, "show");
    }


    protected function getMainContent()
    {
        $tpl = new ilTemplate("tpl.dashboard.html", true, true, "Services/Dashboard");
        $settings = new ilPDSelectedItemsBlockViewSettings($this->user);

        if ($settings->enabledSelectedItems()) {
            $html = $this->renderFavourites();
        }
        $html .= $this->renderRecommendedContent();
        $html .= $this->renderStudyProgrammes();
        $html .= $this->renderLearningSequences();
        if ($settings->enabledMemberships()) {
            $html .= $this->renderMemberships();
        }

        $tpl->setVariable("CONTENT", $html);

        return $tpl->get();
    }

    protected function renderFavourites()
    {
        $block = new ilPDSelectedItemsBlockGUI();
        return $block->getHTML();
    }

    protected function renderRecommendedContent()
    {
        $db_rec_content = new ilDashboardRecommendedContentGUI();
        return $db_rec_content->render();
    }

    protected function renderStudyProgrammes()
    {
        $st_block = ilStudyProgrammeDIC::dic()['ilStudyProgrammeDashboardViewGUI'];
        return $st_block->getHTML();
    }

    protected function renderMemberships()
    {
        $block = new ilPDMembershipBlockGUI();
        return $block->getHTML();
    }

    protected function renderLearningSequences()
    {
        $st_block = new ilDashboardLearningSequenceGUI();
        return $st_block->getHTML();
    }
}