content/classes/class.ilSAHSPresentationGUI.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program 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.                      |
        |                                                                             |
        | This program 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.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/


class ilSAHSPresentationGUI
{
        var $ilias;
        var $tpl;
        var $lng;

        function ilSAHSPresentationGUI()
        {
                global $ilias, $tpl, $lng, $ilCtrl;

                $this->ilias =& $ilias;
                $this->tpl =& $tpl;
                $this->lng =& $lng;
                $this->ctrl =& $ilCtrl;
                
                $this->ctrl->saveParameter($this, "ref_id");
        }
        
        function &executeCommand()
        {
                global $lng;

                include_once "./classes/class.ilObjectGUI.php";
                include_once "./content/classes/class.ilObjSAHSLearningModule.php";

                $lng->loadLanguageModule("content");

                // payment
                include_once './payment/classes/class.ilPaymentObject.php';
                include_once './classes/class.ilSearch.php';
                if(!ilPaymentObject::_hasAccess($_GET['ref_id']))
                {
                        ilUtil::redirect('./payment/start_purchase.php?ref_id='.$_GET['ref_id']);
                }
                
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();
                
                $obj_id = ilObject::_lookupObjectId($_GET['ref_id']);
                $type = ilObjSAHSLearningModule::_lookupSubType($obj_id);

                switch($type)
                {
                        case "scorm":
                                include_once("./content/classes/class.ilObjSCORMLearningModuleGUI.php");
                                $this->slm_gui = new ilObjSCORMLearningModuleGUI("", $_GET["ref_id"],true,false);
                                break;

                        case "aicc":
                                include_once("./content/classes/class.ilObjAICCLearningModuleGUI.php");
                                $this->slm_gui = new ilObjAICCLearningModuleGUI("", $_GET["ref_id"],true,false);
                                break;
                                
                        case "hacp":
                                include_once("./content/classes/class.ilObjHACPLearningModuleGUI.php");
                                $this->slm_gui = new ilObjHACPLearningModuleGUI("", $_GET["ref_id"],true,false);
                                break;
                }

                if ($next_class != "ilinfoscreengui" &&
                        $cmd != "infoScreen")
                {
                        switch($type)
                        {
                                case "scorm":
                                        $this->ctrl->setCmdClass("ilscormpresentationgui");
                                        $this->slm_gui = new ilObjSCORMLearningModuleGUI("", $_GET["ref_id"],true,false);
                                        break;

                                case "aicc":
                                        $this->ctrl->setCmdClass("ilaiccpresentationgui");
                                        break;
                                        
                                case "hacp":
                                        $this->ctrl->setCmdClass("ilhacppresentationgui");
                                        break;
                        }
                        $next_class = $this->ctrl->getNextClass($this);
                }

                switch($next_class)
                {
                        case "ilinfoscreengui":
                                $ret =& $this->outputInfoScreen();
                                break;
                                
                        case "ilscormpresentationgui":
                                require_once "./content/classes/SCORM/class.ilSCORMPresentationGUI.php";
                                $scorm_gui = new ilSCORMPresentationGUI();
                                $ret =& $this->ctrl->forwardCommand($scorm_gui);
                                break;

                        case "ilaiccpresentationgui":
                                require_once "./content/classes/AICC/class.ilAICCPresentationGUI.php";
                                $aicc_gui = new ilAICCPresentationGUI();
                                $ret =& $this->ctrl->forwardCommand($aicc_gui);
                                break;

                        case "ilhacppresentationgui":
                                require_once "./content/classes/HACP/class.ilHACPPresentationGUI.php";
                                $hacp_gui = new ilHACPPresentationGUI();
                                $ret =& $this->ctrl->forwardCommand($hacp_gui);
                                break;

                        default:
                                $this->$cmd();
                }
        }


        function attrib2arr(&$a_attributes)
        {
                $attr = array();
                if(!is_array($a_attributes))
                {
                        return $attr;
                }
                foreach ($a_attributes as $attribute)
                {
                        $attr[$attribute->name()] = $attribute->value();
                }
                return $attr;
        }


        function frameset()
        {
                $this->tpl = new ilTemplate("tpl.sahs_pres_frameset.html", false, false, "content");
                $this->tpl->setVariable("REF_ID",$this->slm->getRefId());
                $this->tpl->show("DEFAULT", false);
                exit;
        }


        function explorer($a_target = "sahs_content")
        {
                global $ilBench;

                $ilBench->start("SAHSExplorer", "initExplorer");
                
                $this->tpl = new ilTemplate("tpl.sahs_exp_main.html", true, true, true);
                //$this->tpl->setVariable("LOCATION_JAVASCRIPT", "./scorm_functions.js");
                
                require_once("./content/classes/SCORM/class.ilSCORMExplorer.php");
                $exp = new ilSCORMExplorer("sahs_presentation.php?cmd=view&ref_id=".$this->slm->getRefId(), $this->slm);
                $exp->setTargetGet("obj_id");
                $exp->setFrameTarget($a_target);
                
                //$exp->setFiltered(true);

                if ($_GET["scexpand"] == "")
                {
                        $mtree = new ilSCORMTree($this->slm->getId());
                        $expanded = $mtree->readRootId();
                }
                else
                {
                        $expanded = $_GET["scexpand"];
                }
                $exp->setExpand($expanded);
                
                $exp->forceExpandAll(true, false);

                // build html-output
                //666$exp->setOutput(0);
                $ilBench->stop("SAHSExplorer", "initExplorer");
                
                // set output
                $ilBench->start("SAHSExplorer", "setOutput");
                $exp->setOutput(0);
                $ilBench->stop("SAHSExplorer", "setOutput");

                $ilBench->start("SAHSExplorer", "getOutput");
                $output = $exp->getOutput();
                $ilBench->stop("SAHSExplorer", "getOutput");

                $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
                $this->tpl->addBlockFile("CONTENT", "content", "tpl.sahs_explorer.html", "content");
                //$this->tpl->setVariable("TXT_EXPLORER_HEADER", $this->lng->txt("cont_content"));
                $this->tpl->setVariable("EXP_REFRESH", $this->lng->txt("refresh"));
                $this->tpl->setVariable("EXPLORER",$output);
                $this->tpl->setVariable("ACTION", "sahs_presentation.php?cmd=".$_GET["cmd"]."&frame=".$_GET["frame"].
                        "&ref_id=".$this->slm->getRefId()."&scexpand=".$_GET["scexpand"]);
                $this->tpl->parseCurrentBlock();
                $this->tpl->show();
        }


        function view()
        {
                $sc_gui_object =& ilSCORMObjectGUI::getInstance($_GET["obj_id"]);

                if(is_object($sc_gui_object))
                {
                        $sc_gui_object->view();
                }

                $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
                $this->tpl->show();
        }

        function api()
        {
                global $ilias;

                $slm_obj =& new ilObjSCORMLearningModule($_GET["ref_id"]);

                $this->tpl = new ilTemplate("tpl.sahs_api.html", true, true, true);
                $this->tpl->setVariable("USER_ID",$ilias->account->getId());
                $this->tpl->setVariable("USER_FIRSTNAME",$ilias->account->getFirstname());
                $this->tpl->setVariable("USER_LASTNAME",$ilias->account->getLastname());
                $this->tpl->setVariable("REF_ID",$_GET["ref_id"]);
                $this->tpl->setVariable("SESSION_ID",session_id());

                $this->tpl->setVariable("CODE_BASE", "http://".$_SERVER['SERVER_NAME'].substr($_SERVER['PHP_SELF'], 0, strpos ($_SERVER['PHP_SELF'], "/sahs_presentation.php")));
                $this->tpl->parseCurrentBlock();

                $this->tpl->show(false);
                exit;
        }

        function launchSahs()
        {
                global $ilUser, $ilDB;

                $sco_id = ($_GET["sahs_id"] == "")
                        ? $_POST["sahs_id"]
                        : $_GET["sahs_id"];
                $ref_id = ($_GET["ref_id"] == "")
                        ? $_POST["ref_id"]
                        : $_GET["ref_id"];

                $this->slm =& new ilObjSCORMLearningModule($ref_id, true);

                include_once("content/classes/SCORM/class.ilSCORMItem.php");
                include_once("content/classes/SCORM/class.ilSCORMResource.php");
                $item =& new ilSCORMItem($sco_id);

                $id_ref = $item->getIdentifierRef();
                $resource =& new ilSCORMResource();
                $resource->readByIdRef($id_ref, $item->getSLMId());
                //$slm_obj =& new ilObjSCORMLearningModule($_GET["ref_id"]);
                $href = $resource->getHref();
                $this->tpl = new ilTemplate("tpl.sahs_launch_cbt.html", true, true, true);
                $this->tpl->setVariable("HREF", $this->slm->getDataDirectory("output")."/".$href);

                // set item data
                $this->tpl->setVariable("LAUNCH_DATA", $item->getDataFromLms());
                $this->tpl->setVariable("MAST_SCORE", $item->getMasteryScore());
                $this->tpl->setVariable("MAX_TIME", $item->getMaxTimeAllowed());
                $this->tpl->setVariable("LIMIT_ACT", $item->getTimeLimitAction());

                // set alternative API name
                if ($this->slm->getAPIAdapterName() != "API")
                {
                        $this->tpl->setCurrentBlock("alt_api_ref");
                        $this->tpl->setVariable("API_NAME", $this->slm->getAPIAdapterName());
                        $this->tpl->parseCurrentBlock();
                }

                $query = "SELECT * FROM scorm_tracking WHERE".
                        " user_id = ".$ilDB->quote($ilUser->getId()).
                        " AND sco_id = ".$ilDB->quote($sco_id);


                $val_set = $ilDB->query($query);
                $re_value = array();
                while($val_rec = $val_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $val_rec["rvalue"] = str_replace("\r\n", "\n", $val_rec["rvalue"]);
                        $val_rec["rvalue"] = str_replace("\r", "\n", $val_rec["rvalue"]);
                        $val_rec["rvalue"] = str_replace("\n", "\\n", $val_rec["rvalue"]);
                        $re_value[$val_rec["lvalue"]] = $val_rec["rvalue"];
                }

                foreach($re_value as $var => $value)
                {
                        switch ($var)
                        {
                                case "cmi.core.lesson_location":
                                case "cmi.core.lesson_status":
                                case "cmi.core.entry":
                                case "cmi.core.score.raw":
                                case "cmi.core.score.max":
                                case "cmi.core.score.min":
                                case "cmi.core.total_time":
                                case "cmi.core.exit":
                                case "cmi.suspend_data":
                                case "cmi.comments":
                                case "cmi.student_preference.audio":
                                case "cmi.student_preference.language":
                                case "cmi.student_preference.speed":
                                case "cmi.student_preference.text":
                                        $this->setSingleVariable($var, $value);
                                        break;

                                case "cmi.objectives._count":
                                        $this->setSingleVariable($var, $value);
                                        $this->setArray("cmi.objectives", $value, "id", $re_value);
                                        $this->setArray("cmi.objectives", $value, "score.raw", $re_value);
                                        $this->setArray("cmi.objectives", $value, "score.max", $re_value);
                                        $this->setArray("cmi.objectives", $value, "score.min", $re_value);
                                        $this->setArray("cmi.objectives", $value, "status", $re_value);
                                        break;

                                case "cmi.interactions._count":
                                        $this->setSingleVariable($var, $value);
                                        $this->setArray("cmi.interactions", $value, "id", $re_value);
                                        for($i=0; $i<$value; $i++)
                                        {
                                                $var2 = "cmi.interactions.".$i.".objectives._count";
                                                if (isset($v_array[$var2]))
                                                {
                                                        $cnt = $v_array[$var2];
                                                        $this->setArray("cmi.interactions.".$i.".objectives",
                                                                $cnt, "id", $re_value);
                                                        /*
                                                        $this->setArray("cmi.interactions.".$i.".objectives",
                                                                $cnt, "score.raw", $re_value);
                                                        $this->setArray("cmi.interactions.".$i.".objectives",
                                                                $cnt, "score.max", $re_value);
                                                        $this->setArray("cmi.interactions.".$i.".objectives",
                                                                $cnt, "score.min", $re_value);
                                                        $this->setArray("cmi.interactions.".$i.".objectives",
                                                                $cnt, "status", $re_value);*/
                                                }
                                        }
                                        $this->setArray("cmi.interactions", $value, "time", $re_value);
                                        $this->setArray("cmi.interactions", $value, "type", $re_value);
                                        for($i=0; $i<$value; $i++)
                                        {
                                                $var2 = "cmi.interactions.".$i.".correct_responses._count";
                                                if (isset($v_array[$var2]))
                                                {
                                                        $cnt = $v_array[$var2];
                                                        $this->setArray("cmi.interactions.".$i.".correct_responses",
                                                                $cnt, "pattern", $re_value);
                                                        $this->setArray("cmi.interactions.".$i.".correct_responses",
                                                                $cnt, "weighting", $re_value);
                                                }
                                        }
                                        $this->setArray("cmi.interactions", $value, "student_response", $re_value);
                                        $this->setArray("cmi.interactions", $value, "result", $re_value);
                                        $this->setArray("cmi.interactions", $value, "latency", $re_value);
                                        break;
                        }
                }

                global $lng;
                $this->tpl->setCurrentBlock("switch_icon");
                $this->tpl->setVariable("SCO_ID", $_GET["sahs_id"]);
                $this->tpl->setVariable("SCO_ICO", ilUtil::getImagePath("scorm/running.gif"));
                $this->tpl->setVariable("SCO_ALT",
                         $lng->txt("cont_status").": "
                        .$lng->txt("cont_sc_stat_running")
                );
                $this->tpl->parseCurrentBlock();

                // lesson mode
                $lesson_mode = $this->slm->getDefaultLessonMode();
                if ($this->slm->getAutoReview())
                {
                        if ($re_value["cmi.core.lesson_status"] == "completed" ||
                                $re_value["cmi.core.lesson_status"] == "passed" ||
                                $re_value["cmi.core.lesson_status"] == "failed")
                        {
                                $lesson_mode = "review";
                        }
                }
                $this->tpl->setVariable("LESSON_MODE", $lesson_mode);

                // credit mode
                if ($lesson_mode == "normal")
                {
                        $this->tpl->setVariable("CREDIT_MODE",
                                str_replace("_", "-", $this->slm->getCreditMode()));
                }
                else
                {
                        $this->tpl->setVariable("CREDIT_MODE", "no-credit");
                }

                // init cmi.core.total_time, cmi.core.lesson_status and cmi.core.entry
                $sahs_obj_id = ilObject::_lookupObjId($_GET["ref_id"]);
                if (!isset($re_value["cmi.core.total_time"]))
                {
                        $item->insertTrackData("cmi.core.total_time", "0000:00:00", $sahs_obj_id);
                }
                if (!isset($re_value["cmi.core.lesson_status"]))
                {
                        $item->insertTrackData("cmi.core.lesson_status", "not attempted", $sahs_obj_id);
                }
                if (!isset($re_value["cmi.core.entry"]))
                {
                        $item->insertTrackData("cmi.core.entry", "", $sahs_obj_id);
                }

                $this->tpl->show();
        }

        function finishSahs ()
        {
                global $lng;
                $this->tpl = new ilTemplate("tpl.sahs_finish_cbt.html", true, true, true);
                $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());

                $this->tpl->setCurrentBlock("switch_icon");
                $this->tpl->setVariable("SCO_ID", $_GET["sahs_id"]);
                $this->tpl->setVariable("SCO_ICO", ilUtil::getImagePath(
                        "scorm/".str_replace(" ", "_", $_GET["status"]).'.gif')
                );
                $this->tpl->setVariable("SCO_ALT",
                         $lng->txt("cont_status").": "
                        .$lng->txt("cont_sc_stat_".str_replace(" ", "_", $_GET["status"])).", "
                        .$lng->txt("cont_total_time").  ": "
                        .$_GET["totime"]
                );
                $this->tpl->setVariable("SCO_LAUNCH_ID", $_GET["launch"]);
                $this->tpl->parseCurrentBlock();
                $this->tpl->show();
        }

        function unloadSahs ()
        {
                $this->tpl = new ilTemplate("tpl.sahs_unload_cbt.html", true, true, true);
                $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
                $this->tpl->setVariable("SCO_ID", $_GET["sahs_id"]);
                $this->tpl->show();
        }


        function launchAsset()
        {
                global $ilUser, $ilDB;

                $sco_id = ($_GET["asset_id"] == "")
                        ? $_POST["asset_id"]
                        : $_GET["asset_id"];
                $ref_id = ($_GET["ref_id"] == "")
                        ? $_POST["ref_id"]
                        : $_GET["ref_id"];

                $this->slm =& new ilObjSCORMLearningModule($ref_id, true);

                include_once("content/classes/SCORM/class.ilSCORMItem.php");
                include_once("content/classes/SCORM/class.ilSCORMResource.php");
                $item =& new ilSCORMItem($sco_id);

                $id_ref = $item->getIdentifierRef();
                $resource =& new ilSCORMResource();
                $resource->readByIdRef($id_ref, $item->getSLMId());
                $href = $resource->getHref();
                $this->tpl->setVariable("HREF", $this->slm->getDataDirectory("output")."/".$href);
                $this->tpl = new ilTemplate("tpl.scorm_launch_asset.html", true, true, true);
                $this->tpl->setVariable("HREF", $this->slm->getDataDirectory("output")."/".$href);
                $this->tpl->show();
        }


        function setSingleVariable($a_var, $a_value)
        {
                $this->tpl->setCurrentBlock("set_value");
                $this->tpl->setVariable("VAR", $a_var);
                $this->tpl->setVariable("VALUE", $a_value);
                $this->tpl->parseCurrentBlock();
        }

        function setArray($a_left, $a_value, $a_name, &$v_array)
        {
                for($i=0; $i<$a_value; $i++)
                {
                        $var = $a_left.".".$i.".".$a_name;
                        if (isset($v_array[$var]))
                        {
                                $this->tpl->setCurrentBlock("set_value");
                                $this->tpl->setVariable("VAR", $var);
                                $this->tpl->setVariable("VALUE", $v_array[$var]);
                                $this->tpl->parseCurrentBlock();
                        }
                }
        }
        
        function infoScreen()
        {
                $this->ctrl->setCmd("showSummary");
                $this->ctrl->setCmdClass("ilinfoscreengui");
                $this->outputInfoScreen();
        }
        
        function outputInfoScreen($a_standard_locator = false)
        {
                global $ilBench, $ilLocator, $ilAccess, $tpl;

                //$this->tpl->setHeaderPageTitle("PAGETITLE", " - ".$this->lm->getTitle());

                // set style sheets
                /*
                if (!$this->offlineMode())
                {
                        $this->tpl->setStyleSheetLocation(ilUtil::getStyleSheetLocation());
                }
                else
                {
                        $style_name = $this->ilias->account->prefs["style"].".css";;
                        $this->tpl->setStyleSheetLocation("./".$style_name);
                }*/

                $this->tpl->getStandardTemplate();
                $this->tpl->setTitle($this->slm_gui->object->getTitle());
                $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_slm_b.gif"));
                
                // Full locator, if read permission is given
                //if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
                //{
                //      $this->ilLocator();
                //}
                //else
                //{
                        $ilLocator->addRepositoryItems();
                        $this->tpl->setLocator();
                //}
                
                $this->lng->loadLanguageModule("meta");

                include_once("classes/class.ilInfoScreenGUI.php");

                $info = new ilInfoScreenGUI($this->slm_gui);
                $info->enablePrivateNotes();
                //$info->enableLearningProgress();

                // add read / back button
                if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
                {
                        $info->addButton($this->lng->txt("view"),
                                $this->ctrl->getLinkTarget($this, ""),
                                ' target="ilContObj'.$this->slm_gui->object->getId().'" ');
                }
                
                // show standard meta data section
                $info->addMetaDataSections($this->slm_gui->object->getId(),0,
                        $this->slm_gui->object->getType());

                /*
                if ($this->offlineMode())
                {
                        $this->tpl->setContent($info->getHTML());
                        return $this->tpl->get();
                }
                else
                {*/
                        // forward the command
                        $this->ctrl->forwardCommand($info);
                        //$this->tpl->setContent("aa");
                        $this->tpl->show();
                //}
        }


}
?>