class.ilCtrl.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2012 ILIAS open source, Extended GPL, see docs/LICENSE */
require_once('class.ilCachedCtrl.php');
class ilCtrl
{
        const IL_RTOKEN_NAME = 'rtoken';
        
        var $target_script;
        var $forward;                   // forward array
        var $parent;                    // parent array (reverse forward)
        var $save_parameter;    // save parameter array
        var $return;                    // return commmands
        var $call_hist = array();       // calling history
        var $debug = array();
        var $calls = array();
        var $rtoken = false;

        function __construct()
        {
                global $ilBench;

                $this->bench = $ilBench;
                
                // initialisation
                $this->init();
                
                // this information should go to xml files one day
                $this->stored_trees = array
                        ("ilrepositorygui", "ilpersonaldesktopgui",
                        "illmpresentationgui", "illmeditorgui",
                        "iladministrationgui");
        }
        
        function debug($str)
        {
                $this->debug[] = $str;
        }
        
        function getDebug()
        {
                return $this->debug;
        }
        
        function init()
        {
                $this->transit = array();
                $this->forward = array();                       // forward array
                $this->forwards = array();                      // forward array
                $this->parent = array();                        // parent array (reverse forward)
                $this->save_parameter = array();        // save parameter array
                $this->parameter = array();                     // save parameter array
                $this->return = array();                        // return commmands
                $this->location = array();
                $this->tab = array();
                $this->current_node = 0;
                $this->module_dir = "";
                $this->service_dir = "";
                $this->call_node = array();
                $this->root_class = "";
        }

        function callBaseClass()
        {
                global $ilDB;
                
                $baseClass = strtolower($_GET["baseClass"]);

                $module_class = ilCachedCtrl::getInstance();
                $mc_rec = $module_class->lookupModuleClass($baseClass);
                // get class information
//              $mc_set = $ilDB->query("SELECT * FROM module_class WHERE LOWER(class) = ".
//                      $ilDB->quote($baseClass, "text"));
//              $mc_rec = $ilDB->fetchAssoc($mc_set);

                $module = $mc_rec["module"];
                $class = $mc_rec["class"];
                $class_dir = $mc_rec["dir"];
                
                if ($module != "")
                {
                        $m_set = $ilDB->query("SELECT * FROM il_component WHERE name = ".
                                $ilDB->quote($module, "text"));
                        $m_rec = $ilDB->fetchAssoc($m_set);
                        $this->module_dir = $m_rec["type"]."/".$m_rec["name"];
                        include_once $this->module_dir."/".$class_dir."/class.".$class.".php";
                }
                else            // check whether class belongs to a service
                {
//                      $mc_set = $ilDB->query("SELECT * FROM service_class WHERE LOWER(class) = ".
//                              $ilDB->quote($baseClass, "text"));
//                      $mc_rec = $ilDB->fetchAssoc($mc_set);

                        $mc_rec = $module_class->lookupServiceClass($baseClass);

                        $service = $mc_rec["service"];
                        $class = $mc_rec["class"];
                        $class_dir = $mc_rec["dir"];
                        
                        if ($service == "")
                        {
                                include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                                throw new ilCtrlException("Could not find entry in modules.xml or services.xml for ".
                                        $baseClass." <br/>".str_replace("&", "<br />&", htmlentities($_SERVER["REQUEST_URI"])));
                        }

                        // get service information
//                      $m_set = $ilDB->query("SELECT * FROM il_component WHERE name = ".
//                              $ilDB->quote($service, "text"));
//                      $m_rec = $ilDB->fetchAssoc($m_set);

                        $m_rec = ilComponent::getComponentInfo('Services', $service);

                        $this->service_dir = $m_rec["type"]."/".$m_rec["name"];
                        
                        include_once $this->service_dir."/".$class_dir."/class.".$class.".php";;
                }
                
                // forward processing to base class
                $this->getCallStructure(strtolower($baseClass));
                $base_class_gui = new $class();
                $this->forwardCommand($base_class_gui);
        }

        function getModuleDir()
        {
                return $this->module_dir;
        }
        
        function forwardCommand($a_gui_object)
        {
                $class = strtolower(get_class($a_gui_object));
//echo "<br>class:".$class.":";
                $nr = $this->getNodeIdForTargetClass($this->current_node, $class);
                $nr = $nr["node_id"];
                if ($nr != "")
                {
                        $current_node = $this->current_node;
                        
                        $this->current_node = $nr;

                        // always populate the call history
                        // it will only be displayed in DEVMODE but is needed for UI plugins, too
                        $this->call_hist[] = array("class" => get_class($a_gui_object),
                                        "mode" => "execComm", "cmd" => $this->getCmd());

//echo "<br>class:".get_class($a_gui_object).":";
                        $html = $a_gui_object->executeCommand();
                        
                        // reset current node
                        $this->current_node = $current_node;
                        
                        return $html;

                }
                
                include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                throw new ilCtrlException("ERROR: Can't forward to class $class.");
        }

        function getHTML($a_gui_object)
        {
                $class = strtolower(get_class($a_gui_object));

                $nr = $this->getNodeIdForTargetClass($this->current_node, $class);
                $nr = $nr["node_id"];
                if ($nr != "")
                {
                        $current_node = $this->current_node;
                        
                        // set current node to new gui class
                        $this->current_node = $nr;
                        
                        // always populate the call history
                        // it will only be displayed in DEVMODE but is needed for UI plugins, too
                        $this->call_hist[] = array("class" => get_class($a_gui_object),
                                        "mode" => "getHtml", "cmd" => $this->getCmd());
                        
                        // get block
                        $html = $a_gui_object->getHTML();
                        
                        // reset current node
                        $this->current_node = $current_node;
                        
                        // return block
                        return $html;
                }

                include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                throw new ilCtrlException("ERROR: Can't getHTML from class $class.");

        }
        
        function setContext($a_obj_id, $a_obj_type, $a_sub_obj_id = 0, $a_sub_obj_type = "")
        {
                $this->context_obj_id = $a_obj_id;
                $this->context_obj_type = $a_obj_type;
                $this->context_sub_obj_id = $a_sub_obj_id;
                $this->context_sub_obj_type = $a_sub_obj_type;
        }

        public function getContextObjId()
        {
                return $this->context_obj_id;
        }

        public function getContextObjType()
        {
                return $this->context_obj_type;
        }

        public function getContextSubObjId()
        {
                return $this->context_sub_obj_id;
        }

        public function getContextSubObjType()
        {
                return $this->context_sub_obj_type;
        }

        private function getNodeIdForTargetClass($a_par_node, $a_class, $a_check = false)
        {
                $class = strtolower($a_class);
                $this->readClassInfo($class);
                
                if ($a_par_node === 0 || $a_par_node == "")
                {
                        return array("node_id" => $this->getCidForClass($class),
                                "base_class" => "");
                }
                
                $this->readNodeInfo($a_par_node);
                
                $node_cid = $this->getCurrentCidOfNode($a_par_node);

                // target class is class of current node id
                if ($class == $this->getClassForCid($node_cid))
                {
                        return array("node_id" => $a_par_node,
                                "base_class" => "");
                }

                // target class is child of current node id
                if (isset($this->calls[$this->getClassForCid($node_cid)]) &&
                        is_array($this->calls[$this->getClassForCid($node_cid)]) &&
                        in_array($a_class, $this->calls[$this->getClassForCid($node_cid)]))
                {
                        return array("node_id" => $a_par_node.":".$this->getCidForClass($class),
                                "base_class" => "");
                }

                // target class is sibling
                $par_cid = $this->getParentCidOfNode($a_par_node);
                if ($par_cid != "")
                {
                        if (is_array($this->calls[$this->getClassForCid($par_cid)]) &&
                                in_array($a_class, $this->calls[$this->getClassForCid($par_cid)]))
                        {
                                return array("node_id" =>
                                        $this->removeLastCid($a_par_node).":".$this->getCidForClass($class),
                                        "base_class" => "");
                        }
                }

                // target class is parent
                $temp_node = $this->removeLastCid($a_par_node);
                while($temp_node != "")
                {
                        $temp_cid = $this->getCurrentCidOfNode($temp_node);
                        if ($this->getClassForCid($temp_cid) == $a_class)
                        {
                                return array("node_id" => $temp_node,
                                        "base_class" => "");
                        }
                        $temp_node = $this->removeLastCid($temp_node);
                }
                
                // target class is another base class
                $n_class = "";
                if ($a_class != "")
                {
                        $module_class = ilCachedCtrl::getInstance();
                        $mc_rec = $module_class->lookupModuleClass($class);
                        $n_class = $mc_rec['lower_class'];
//                      global $ilDB;
//
//                       get class information
//                      $mc_set = $ilDB->query("SELECT * FROM module_class WHERE LOWER(class) = ".
//                              $ilDB->quote($class, "text"));
//                      $mc_rec = $ilDB->fetchAssoc($mc_set);
//                      $n_class = strtolower($mc_rec["class"]);

                        if ($n_class == "")
                        {
                                $mc_rec =  $module_class->lookupServiceClass($class);
                                $n_class = $mc_rec['lower_class'];

//                              $mc_set = $ilDB->query("SELECT * FROM service_class WHERE LOWER(class) = ".
//                                      $ilDB->quote($class, "text"));
//                              $mc_rec = $ilDB->fetchAssoc($mc_set);
//                              $n_class = strtolower($mc_rec["class"]);

                        }
                        
                        if ($n_class != "")
                        {
                                $this->getCallStructure($n_class);
                                return array("node_id" => $this->getCidForClass($n_class),
                                        "base_class" => $class);
                        }
                }

                if ($a_check)
                {
                        return false;
                }
                
                // Please do NOT change these lines.
                // Developers must be aware, if they use classes unknown to the controller
                // otherwise certain problem will be extremely hard to track down...
                
//              echo "ERROR: Can't find target class $a_class for node $a_par_node ".
//                      "(".$this->cid_class[$this->getParentCidOfNode($a_par_node)].").<br>";
                error_log( "ERROR: Can't find target class $a_class for node $a_par_node ".
                        "(".$this->cid_class[$this->getParentCidOfNode($a_par_node)].")");
                        
                if (DEVMODE == 1)
                {
//                      ilUtil::printBacktrace();
                }

                include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                throw new ilCtrlException("ERROR: Can't find target class $a_class for node $a_par_node ".
                        "(".$this->cid_class[$this->getParentCidOfNode($a_par_node)].").");
        }

        function checkTargetClass($a_class)
        {
                if (!is_array($a_class))
                {
                        $a_class = array($a_class);
                }

                $nr = $this->current_node;
                foreach ($a_class as $class)
                {
                        $class = strtolower($class);

                        if (!$this->getCidForClass($class, true))
                        {
                                return false;
                        }

                        $nr = $this->getNodeIdForTargetClass($nr, $class, true);
                        $nr = $nr["node_id"];
                        if ($nr === false)
                        {
                                return false;
                        }
                }
                return true;
        }

        function getCmdNode()
        {
                return $_GET["cmdNode"];
        }

        function addLocation($a_title, $a_link, $a_target = "", $a_ref_id = 0)
        {
                $this->location[] = array("title" => $a_title,
                        "link" => $a_link, "target" => $a_target, "ref_id" => $a_ref_id);
        }

        function getLocations()
        {
                return $this->location;
        }

        function addTab($a_lang_var, $a_link, $a_cmd, $a_class)
        {
                $a_class = strtolower($a_class);

                $this->tab[] = array("lang_var" => $a_lang_var,
                        "link" => $a_link, "cmd" => $a_cmd, "class" => $a_class);
        }

        function getTabs()
        {
                return $this->tab;
        }

        function getCallHistory()
        {
                return $this->call_hist;
        }
        
        function getCallStructure($a_class)
        {
                $this->readClassInfo($a_class);
        }

/*      function storeCommonStructures()
        {
                global $ilDB;
                
                $ilDB->manipulate("DELETE FROM ctrl_structure");
                
                foreach ($this->stored_trees as $root_gui_class)
                {
                        $this->call_node = array();
                        $this->forward = array();
                        $this->parent = array();
                        $this->readCallStructure($root_gui_class);
                        $ilDB->insert("ctrl_structure", array(
                                "root_class" => array("text", $root_gui_class),
                                "call_node" => array("text", serialize($this->call_node)),
                                "forward" => array("text", serialize($this->forward)),
                                "parent" => array("clob", serialize($this->parent))));
                }
        }
*/
        
        function readCallStructure($a_class, $a_nr = 0, $a_parent = 0)
        {
                global $ilDB;

                $a_class = strtolower($a_class);

                $a_nr++;
                
                // determine call node structure
                $this->call_node[$a_nr] = array("class" => $a_class, "parent" => $a_parent);

//echo "<br>nr:$a_nr:class:$a_class:parent:$a_parent:";
                $call_set = $ilDB->query("SELECT * FROM ctrl_calls WHERE parent = ".
                        $ilDB->quote(strtolower($a_class), "text").
                        " ORDER BY child", array("text"));
                $a_parent = $a_nr;
                while ($call_rec = $ilDB->fetchAssoc($call_set))
                {
                        $a_nr = $this->readCallStructure($call_rec["child"], $a_nr, $a_parent);
                        $forw[] = $call_rec["child"];
                }
                
                // determin forward and parent array
                $this->forwards($a_class, $forw);
//echo "<br>forwards:".$a_class."<br>"; var_dump($forw);

                // determine root class
                $this->root_class = $a_class;
                return $a_nr;
        }


        private function forwards($a_from_class, $a_to_class)
        {
                $a_from_class = strtolower($a_from_class);

                if (is_array($a_to_class))
                {
                        foreach($a_to_class as $to_class)
                        {
                                if ($a_from_class != "" && $to_class != "")
                                {
                                        if (!is_array($this->forward[$a_from_class]) || !in_array(strtolower($to_class), $this->forward[$a_from_class]))
                                        {
                                                $this->forward[$a_from_class][] = strtolower($to_class);
                                        }
                                        if (!is_array($this->parent[strtolower($to_class)]) || !in_array($a_from_class, $this->parent[strtolower($to_class)]))
                                        {
                                                $this->parent[strtolower($to_class)][] = $a_from_class;
                                        }
                                }
                        }
                }
                else
                {
                        $to_class = $a_to_class;
                        if ($a_from_class != "" && $to_class != "")
                        {
                                if (!is_array($this->forward[$a_from_class]) || !in_array(strtolower($to_class), $this->forward[$a_from_class]))
                                {
                                        $this->forward[$a_from_class][] = strtolower($to_class);
                                }
                                if (!is_array($this->parent[strtolower($to_class)]) || !in_array($a_from_class, $this->parent[strtolower($to_class)]))
                                {
                                        $this->parent[strtolower($to_class)][] = $a_from_class;
                                }
                        }
                }
        }


        public function saveParameter($a_obj, $a_parameter)
        {
                if (is_object($a_obj))
                {
                        $this->saveParameterByClass(get_class($a_obj), $a_parameter);
                }
        }
        
        function saveParameterByClass($a_class, $a_parameter)
        {
                if (is_array($a_parameter))
                {
                        foreach($a_parameter as $parameter)
                        {
                                $this->save_parameter[strtolower($a_class)][] = $parameter;
                        }
                }
                else
                {
                        $this->save_parameter[strtolower($a_class)][] = $a_parameter;
                }
        }


        public function setParameter($a_obj, $a_parameter, $a_value)
        {
                $this->parameter[strtolower(get_class($a_obj))][$a_parameter] = $a_value;
        }


        public function setParameterByClass($a_class, $a_parameter, $a_value)
        {
                $this->parameter[strtolower($a_class)][$a_parameter] = $a_value;
        }
        
        
        public function clearParameters($a_obj)
        {
                $this->clearParametersByClass(strtolower(get_class($a_obj)));
        }

        public function clearParametersByClass($a_class)
        {
                $this->parameter[strtolower($a_class)] = array();
        }
        
        protected function checkLPSettingsForward($a_gui_obj, $a_cmd_node)
        {                       
                global $objDefinition;
                
                // forward to learning progress settings if possible and accessible                     
                if($_GET["gotolp"] &&
                        $a_gui_obj)
                {                                               
                        $ref_id = $_GET["ref_id"];
                        if(!$ref_id)
                        {
                                $ref_id = $_REQUEST["ref_id"];
                        }               
                        
                        $gui_class = get_class($a_gui_obj);
                        
                        if($gui_class == "ilSAHSEditGUI")
                        {
                                // #1625 - because of scorm "sub-types" this is all very special
                                include_once "./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php";
                                $obj_id = ilObject::_lookupObjectId($ref_id);
                                switch(ilObjSAHSLearningModule::_lookupSubType($obj_id))
                                {
                                        case "scorm2004":
                                                $class = "ilObjSCORM2004LearningModuleGUI";
                                                break;
                                
                                        case "scorm":
                                                $class = "ilObjSCORMLearningModuleGUI";
                                                break;

                                        case "aicc":
                                                $class = "ilObjAICCLearningModuleGUI";
                                                break;

                                        case "hacp":
                                                $class = "ilObjHACPLearningModuleGUI";
                                                break;
                                }
                                if($GLOBALS["ilAccess"]->checkAccess("edit_learning_progress", "", $ref_id))
                                {
                                        $this->redirectByClass(array($gui_class, $class, "illearningprogressgui", "illplistofsettingsgui"), "");
                                }
                        }
                        // special case: cannot use any presentation GUIs
                        else if($gui_class == "ilLMPresentationGUI")
                        {
                                $this->setParameterByClass("ilObjLearningModuleGUI", "gotolp", 1);
                                $this->redirectByClass(array("ilLMEditorGUI", "ilObjLearningModuleGUI"), "");                   
                        }
                                                
                        include_once "Services/Object/classes/class.ilObjectLP.php";    
                        $type = ilObject::_lookupType($ref_id, true);
                        $class = "ilObj".$objDefinition->getClassName($type)."GUI";             
                        
                        if($gui_class == $class &&
                                ilObjectLP::isSupportedObjectType($type) &&
                                $GLOBALS["ilAccess"]->checkAccess("edit_learning_progress", "", $ref_id))
                        {                                       
                                // add path to repository object gui if missing from cmdNode
                                if(!$a_cmd_node)
                                {
                                        $repo_node = $this->getNodeIdForTargetClass(null, "ilrepositorygui");                                                   
                                        $obj_node = $this->getNodeIdForTargetClass($repo_node["node_id"], $gui_class);  
                                        $a_cmd_node = $obj_node["node_id"];
                                }                       
                                // find path to lp settings
                                $lp_node = $this->getNodeIdForTargetClass($a_cmd_node, "illearningprogressgui");                                                                                                
                                $lp_settings_node = $this->getNodeIdForTargetClass($lp_node["node_id"], "illplistofsettingsgui");                                                                                                                                               
                                $_GET["cmdNode"] = $lp_settings_node["node_id"];                                                                
                                $_GET["cmdClass"] = "ilLPListOfSettingsGUI";                                                            
                                $_GET["cmd"] = "";                                                      
                                return "illearningprogressgui";                         
                        }
                }                                               
        }

        function getNextClass($a_gui_class = null)
        {
                $cmdNode = $this->getCmdNode();
//echo "<br>getNextClass (current node: ".$this->current_node."; cmd node: ".$cmdNode.") ";
                if ($cmdNode == "")
                {
                        return ($class = $this->checkLPSettingsForward($a_gui_class, $cmdNode))
                                ? $class
                                : false;
                }
                else
                {
                        if ($this->current_node == $cmdNode)
                        {
//echo "1:".$this->call_node[$cmdNode]["class"]."<br>";
                                //return $this->call_node[$cmdNode]["class"];
                                return ($class = $this->checkLPSettingsForward($a_gui_class, $cmdNode))
                                        ? $class
                                        : "";
                        }
                        else
                        {
                                $path = $this->getPathNew($this->current_node, $cmdNode);
//var_dump($path);
//echo " - Next Node: ".$path[1];
                                $this->readCidInfo($this->getCurrentCidOfNode($path[1]));
//echo ":".$this->cid_class[$this->getCurrentCidOfNode($path[1])].":".$this->getCurrentCidOfNode($path[1]).":";
                                return $this->cid_class[$this->getCurrentCidOfNode($path[1])];
                        }
                }
        }

        function lookupClassPath($a_class_name)
        {
                global $ilDB;
                $a_class_name = strtolower($a_class_name);

                $cached_ctrl = ilCachedCtrl::getInstance();
                $class_rec = $cached_ctrl->lookupClassFile($a_class_name);

                //$class_set = $ilDB->query("SELECT * FROM ctrl_classfile WHERE class = ".
                //      $ilDB->quote($a_class_name, "text"));
                //$class_rec = $ilDB->fetchAssoc($class_set);

                if ($class_rec["plugin_path"] != "")
                {
                        return $class_rec["plugin_path"]."/".$class_rec["filename"];
                }
                else
                {
                        return $class_rec["filename"];
                }
        }

        function getClassForClasspath($a_class_path)
        {
                $path = pathinfo($a_class_path);
                $file = $path["basename"];
                $class = substr($file, 6, strlen($file) - 10);

                return $class;
        }

        private function getPathNew($a_source_node, $a_target_node)
        {
//if ($this->getCmdClass() == "ilmailfoldergui") echo "-".$a_source_node."-".$a_target_node."-";
//echo "-".$a_source_node."-".$a_target_node."-";
//echo "<br>:::$a_source_node:::";
                if ($a_source_node == "1")
                {
                        $a_source_node = "";
                }
                if (substr($a_target_node, 0, strlen($a_source_node)) != $a_source_node)
                {
                        $failure =  "ERROR: Path not found. Source:".$a_source_node.
                                ", Target:".$a_target_node;
                        if (DEVMODE == 1)
                        {
                                include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                                throw new ilCtrlException($failure);
                        }
                        $GLOBALS['ilLog']->write(__METHOD__.' '.$failure);
                        ilUtil::redirect('./ilias.php?baseClass=ilRepositoryGUI');
                }
//echo "<br>:::$a_source_node:::";
                $temp_node = $a_source_node;
                
                $path = array();
                if ($a_source_node != "")
                {
                        $path = array($a_source_node);
                }
                
                $diffstart = ($a_source_node == "")
                        ? 0
                        : strlen($a_source_node) + 1;
                $diff = substr($a_target_node, $diffstart);
//echo "=$diff=$diffstart=";
                $diff_arr = explode(":", $diff);
                foreach($diff_arr as $cid)
                {
                        if ($temp_node != "")
                        {
                                $temp_node.= ":";
                        }
                        $temp_node.= $cid;
                        $path[] = $temp_node;
                }
//if ($this->getCmdClass() == "ilmailfoldergui") var_dump($path);
//var_dump($path);
                return $path;
        }

        public function setTargetScript($a_target_script)
        {
                $this->target_script = $a_target_script;
        }


        public function getTargetScript()
        {
                return $this->target_script;
        }


        public function initBaseClass($a_base_class)
        {
                $_GET["baseClass"] = $a_base_class;
                $_GET["cmd"] = "";
                $_GET["cmdClass"] = "";
                $_GET["cmdNode"] = "";
                $this->init();
        }
        
        public function getCmd($a_default_cmd = "", $a_safe_commands = "")
        {
                $cmd = "";
                if (isset($_GET["cmd"]))
                {
                        $cmd = $_GET["cmd"];
                }
                if($cmd == "post")
                {
                        if (isset($_POST["cmd"]) && is_array($_POST["cmd"]))
                        {
                                reset($_POST["cmd"]);
                        }
                        $cmd = @key($_POST["cmd"]);

                        // verify command
                        if ($this->verified_cmd != "")
                        {
                                return $this->verified_cmd;
                        }
                        else
                        {
                                if (!$this->verifyToken() &&
                                        (!is_array($a_safe_commands) || !in_array($cmd, $a_safe_commands)))
                                {
                                        return $a_default_cmd;
                                }
                        }
                        
                        $this->verified_cmd = $cmd;
                        if($cmd == "" && isset($_POST["table_top_cmd"]))                // selected command in multi-list (table2)
                        {
                                $cmd = @key($_POST["table_top_cmd"]);
                                $this->verified_cmd = $cmd;
                                $_POST[$_POST["cmd_sv"][$cmd]] = $_POST[$_POST["cmd_sv"][$cmd]."_2"];
                        }
                        if($cmd == "" && isset($_POST["select_cmd2"]))          // selected command in multi-list (table2)
                        {
                                if(isset($_POST["select_cmd_all2"]))
                                {
                                        $_POST["select_cmd_all"] = $_POST["select_cmd_all2"];
                                }
                                else
                                {
                                        $_POST["select_cmd_all"] = $_POST["select_cmd_all2"] = null;
                                }                               
                                $cmd = $_POST["selected_cmd2"];
                                $this->verified_cmd = $cmd;
                        }
                        if($cmd == "" && isset($_POST["select_cmd"]))           // selected command in multi-list (table2)
                        {
                                if(isset($_POST["select_cmd_all"]))
                                {
                                        $_POST["select_cmd_all2"] = $_POST["select_cmd_all"];
                                }
                                else
                                {
                                        $_POST["select_cmd_all"] = $_POST["select_cmd_all2"] = null;
                                }                               
                                $cmd = $_POST["selected_cmd"];
                                $this->verified_cmd = $cmd;
                        }
                        if($cmd == "")
                        {
                                $cmd = $_GET["fallbackCmd"];
                                $this->verified_cmd = $cmd;
                        }
                }
                if($cmd == "")
                {
                        $cmd = $a_default_cmd;
                }
                return $cmd;
        }

        function setCmd($a_cmd)
        {
                $_GET["cmd"] = $a_cmd;
        }

        public function setCmdClass($a_cmd_class)
        {
                $a_cmd_class = strtolower($a_cmd_class);
                $nr = $this->getNodeIdForTargetClass($this->current_node, $a_cmd_class);
                $nr = $nr["node_id"];
                $_GET["cmdClass"] = $a_cmd_class;
                $_GET["cmdNode"] = $nr;
        }

        function getCmdClass()
        {
                return strtolower($_GET["cmdClass"]);
        }

        function getFormAction($a_gui_obj, $a_fallback_cmd = "", $a_anchor = "", $a_asynch = false,
                $xml_style = true)
        {
                $script =  $this->getFormActionByClass(strtolower(get_class($a_gui_obj)),
                        $a_fallback_cmd, $a_anchor, $a_asynch, $xml_style);
                return $script;
        }

        function getFormActionByClass($a_class, $a_fallback_cmd = "", $a_anchor = "", $a_asynch = false,
                $xml_style = true)
        {
                if(!is_array($a_class))
                {
                        $a_class = strtolower($a_class);
                }
                
                $tok = $this->getRequestToken();

                if ($a_asynch)
                {
                        $xml_style = false;
                }

                $script = $this->getLinkTargetByClass($a_class, "post", "", $a_asynch);
                if ($a_fallback_cmd != "")
                {
                        $script = ilUtil::appendUrlParameterString($script, "fallbackCmd=".$a_fallback_cmd, $xml_style);
                }
                $script = ilUtil::appendUrlParameterString($script, self::IL_RTOKEN_NAME.'='.$this->getRequestToken(),
                        $xml_style);
                if ($a_anchor != "")
                {
                        $script = $script."#".$a_anchor;
                }

                return $script;
        }
        
        public function appendRequestTokenParameterString($a_url, $xml_style = true)
        {
                return ilUtil::appendUrlParameterString($a_url, self::IL_RTOKEN_NAME.'='.$this->getRequestToken(),
                        $xml_style);
        }
        
        public function getRequestToken()
        {
                global $ilDB, $ilUser;
                
                if ($this->rtoken != "")
                {
                        return $this->rtoken;
                }
                else
                {
                        if (is_object($ilDB) && is_object($ilUser) && $ilUser->getId() > 0 &&
                                $ilUser->getId() != ANONYMOUS_USER_ID)
                        {
                                $res = $ilDB->query("SELECT token FROM il_request_token WHERE user_id = ".
                                        $ilDB->quote($ilUser->getId(), "integer").
                                        " AND session_id = ".$ilDB->quote(session_id(), "text"));
                                $rec = $ilDB->fetchAssoc($res);
//echo session_id();
                                if ($rec["token"] != "")
                                {
                                        $this->rtoken = $rec["token"];
                                        return $rec["token"];
                                }
//echo "new rtoken, new entry for :".$ilUser->getId().":".session_id().":"; exit;
                                $this->rtoken = md5(uniqid(rand(), true));
                                
                                // delete entries older than one and a half days
                                if (rand(1, 200) == 2)
                                {
                                        $dt = new ilDateTime(time(),IL_CAL_UNIX);
                                        $dt->increment(IL_CAL_DAY, -1);
                                        $dt->increment(IL_CAL_HOUR, -12);
                                        $dq = "DELETE FROM il_request_token WHERE ".
                                                " stamp < ".$ilDB->quote($dt->get(IL_CAL_DATETIME), "timestamp");
                                        $ilDB->manipulate($dq);
                                }
                                
                                // IMPORTANT: Please do NOT try to move this implementation to a
                                // session basis. This will fail due to framesets that are used
                                // occasionally in ILIAS, e.g. in the chat, where multiple
                                // forms are loaded in different frames.
                                $ilDB->manipulate("INSERT INTO il_request_token (user_id, token, stamp, session_id) VALUES ".
                                        "(".
                                        $ilDB->quote($ilUser->getId(), "integer").",".
                                        $ilDB->quote($this->rtoken, "text").",".
                                        $ilDB->now().",".
                                        $ilDB->quote(session_id(), "text").")");
                                return $this->rtoken;
                        }
                        //$this->rtoken = md5(uniqid(rand(), true));
                }
                return "";
        }
        
        private function verifyToken()
        {
                global $ilDB, $ilUser;

                if (is_object($ilUser) && is_object($ilDB) && $ilUser->getId() > 0 &&
                        $ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        if ($_GET["rtoken"] == "")
                        {
                                #echo "ilCtrl::No Request Token Given!";                // for debugging, maybe changed later
                                return false;
                        }

                        $set = $ilDB->query("SELECT * FROM il_request_token WHERE ".
                                " user_id = ".$ilDB->quote($ilUser->getId(), "integer")." AND ".                 
                                " token = ".$ilDB->quote($_GET[self::IL_RTOKEN_NAME]), "text");                  
                        if ($ilDB->numRows($set) > 0)            
                        {
                                // remove used token
                                /*
                                $ilDB->query("DELETE FROM il_request_token WHERE ".              
                                        " user_id = ".$ilDB->quote($ilUser->getId())." AND ".            
                                        " token = ".$ilDB->quote($_GET[self::IL_RTOKEN_NAME]));
                                */

                                // remove tokens from older sessions
                                // if we do this immediately, working with multiple windows does not work:
                                // - window one: open form (with token a)
                                // - window two: open form (with token b)
                                // - submit window one: a is verified, but b must not be deleted immediately, otherwise
                                // - window two: submit results in invalid token
                                // see also bug #13551
                                $dt = new ilDateTime(time(),IL_CAL_UNIX);
                                $dt->increment(IL_CAL_DAY, -1);
                                $dt->increment(IL_CAL_HOUR, -12);
                                $ilDB->manipulate("DELETE FROM il_request_token WHERE ".
                                        " user_id = ".$ilDB->quote($ilUser->getId(), "integer")." AND ".                 
                                        " session_id != ".$ilDB->quote(session_id(), "text")." AND ".
                                        " stamp < ".$ilDB->quote($dt->get(IL_CAL_DATETIME), "timestamp"));
                                return true;             
                        }                
                        else
                        {
                                return false;
                        }
                        
                        if ($_SESSION["rtokens"][$_GET[self::IL_RTOKEN_NAME]] != "")
                        {
                                // remove used token
                                unset($_SESSION["rtokens"][$_GET[self::IL_RTOKEN_NAME]]);
                                
                                // remove old tokens
                                if (count($_SESSION["rtokens"]) > 100)
                                {
                                        $to_remove = array();
                                        $sec = 7200;                    // two hours

                                        foreach($_SESSION["rtokens"] as $tok => $time)
                                        {
                                                if (time() - $time > $sec)
                                                {
                                                        $to_remove[] = $tok;
                                                }
                                        }
                                        foreach($to_remove as $tok)
                                        {
                                                unset($_SESSION["rtokens"][$tok]);
                                        }
                                }
                                
                                return true;
                        }
                        return false;
                }
                else
                {
                        return true;            // do not verify, if user or db object is missing
                }
                
                return false;
        }

        public function redirect($a_gui_obj, $a_cmd = "", $a_anchor = "", $a_asynch = false)
        {
                global $ilBench;
                
                $script = $this->getLinkTargetByClass(strtolower(get_class($a_gui_obj)), $a_cmd,
                        "", $a_asynch, false);
                if  (is_object($ilBench))
                {
                        $ilBench->save();
                }
                if ($a_anchor != "")
                {
                        $script = $script."#".$a_anchor;
                }
                ilUtil::redirect($script);
        }


        public function redirectByClass($a_class, $a_cmd = "", $a_anchor = "", $a_asynch = false)
        {
                $script = $this->getLinkTargetByClass($a_class, $a_cmd, "", $a_asynch, false);
                if ($a_anchor != "")
                {
                        $script = $script."#".$a_anchor;
                }
                ilUtil::redirect($script);
        }
        
        public function isAsynch()
        {
                if (isset($_GET["cmdMode"]) && $_GET["cmdMode"] == "asynch")
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }


        function getLinkTarget($a_gui_obj, $a_cmd = "", $a_anchor = "", $a_asynch = false,
                $xml_style = true)
        {
                $script = $this->getLinkTargetByClass(strtolower(get_class($a_gui_obj)), $a_cmd, $a_anchor, $a_asynch,
                        $xml_style);
                return $script;
        }


        function getLinkTargetByClass($a_class, $a_cmd  = "", $a_anchor = "", $a_asynch = false,
                $xml_style = true)
        {
                if ($a_asynch)
                {
                        $xml_style = false;
                }
                
                // note: $a_class may be an array
                //$a_class = strtolower($a_class);

//echo "<br>getLinkTargetByClass";
                $script = $this->getTargetScript();
                $script = $this->getUrlParameters($a_class, $script, $a_cmd, $xml_style);

                if ($a_asynch)
                {
                        //$amp = $xml_style
                        //      ? "&amp;"
                        //      : "&";
                        $amp = "&";
                        $script.= $amp."cmdMode=asynch";
                }
                
                if ($a_anchor != "")
                {
                        $script = $script."#".$a_anchor;
                }

                return $script;
        }

        function setReturn($a_gui_obj, $a_cmd)
        {
                $script = $this->getTargetScript();
                $script = $this->getUrlParameters(strtolower(get_class($a_gui_obj)), $script, $a_cmd);
//echo "<br>setReturn:".get_class($a_gui_obj).":".$script.":<br>";
                $this->return[strtolower(get_class($a_gui_obj))] = $script;
        }

        function setReturnByClass($a_class, $a_cmd)
        {
                // may not be an array!
                $a_class = strtolower($a_class);

                $script = $this->getTargetScript();
                $script = $this->getUrlParameters($a_class, $script, $a_cmd);
//echo "<br>setReturn:".get_class($a_gui_obj).":".$script.":<br>";
                $this->return[strtolower($a_class)] = $script;
        }

        function returnToParent($a_gui_obj, $a_anchor = "")
        {
                $script = $this->getParentReturn($a_gui_obj);

                $script = ilUtil::appendUrlParameterString($script,
                        "redirectSource=".strtolower(get_class($a_gui_obj)));
                $script = ilUtil::appendUrlParameterString($script,
                        "cmdMode=".$_GET["cmdMode"]);
                if ($a_anchor != "")
                {
                        $script = $script."#".$a_anchor;
                }

                ilUtil::redirect($script);
        }


        function getRedirectSource()
        {
                return $_GET["redirectSource"];
        }

        function getParentReturn($a_gui_obj)
        {
                return $this->getParentReturnByClass(strtolower(get_class($a_gui_obj)));
        }


        function getParentReturnByClass($a_class)
        {
                $a_class = strtolower($a_class);
                $ret_class = $this->searchReturnClass($a_class);
//echo ":$ret_class:";
                if($ret_class)
                {
//echo ":".$this->return[$ret_class].":";
                        return $this->return[$ret_class];
                }
        }

        function getReturnClass($a_class)
        {
                if (is_object($a_class))
                {
                        $class = strtolower(get_class($a_class));
                }
                else
                {
                        $class = strtolower($a_class);
                }
                return $this->searchReturnClass($class);
        }
        
        
        private function searchReturnClass($a_class)
        {
                $a_class = strtolower($a_class);

                $node = $this->getNodeIdForTargetClass($this->current_node, $a_class);
                $node = $node["node_id"];
                $n_arr = explode(":", $node);
                for($i = count($n_arr)-2; $i>=0; $i--)
                {
                        if ($this->return[$this->getClassForCid($n_arr[$i])] != "")
                        {
                                return $this->getClassForCid($n_arr[$i]);
                        }
                }

                return false;
        }

        public function getUrlParameters($a_class, $a_str, $a_cmd = "", $xml_style = false)
        {
                // note: $a_class may be an array!
                //$a_class = strtolower($a_class);
 
                $params = $this->getParameterArrayByClass($a_class, $a_cmd);

                foreach ($params as $par => $value)
                {
                        if (strlen((string) $value))
                        {
                                $a_str = ilUtil::appendUrlParameterString($a_str, $par."=".$value, $xml_style);
                        }
                }

                return $a_str;
        }

        public function getParameterArray($a_gui_obj, $a_cmd = "")
        {
                $par_arr = $this->getParameterArrayByClass(strtolower(get_class($a_gui_obj)), $a_cmd);

                return $par_arr;
        }

        public function getParameterArrayByClass($a_class, $a_cmd = "")
        {
                if ($a_class == "")
                {
                        return array();
                }

                if (!is_array($a_class))
                {
                        $a_class = array($a_class);
                }

                $nr = $this->current_node;
                foreach ($a_class as $class)
                {
                        $class = strtolower($class);
                        $nr = $this->getNodeIdForTargetClass($nr, $class);
                        if ($nr["base_class"] != "")
                        {
                                $new_baseclass = $nr["base_class"];
                        }
                        $nr = $nr["node_id"]; 
                        $target_class = $class;
                }

                $path = $this->getPathNew(1, $nr);
                $params = array();

                // append parameters of parent classes
                foreach($path as $node_id)
                {
                        $class = ($node_id == "")
                                ? strtolower($_GET["baseClass"])
                                : $this->getClassForCid($this->getCurrentCidOfNode($node_id));
                        if (isset($this->save_parameter[$class]) && is_array($this->save_parameter[$class]))
                        {
                                foreach($this->save_parameter[$class] as $par)
                                {
                                        if (isset($_GET[$par]))
                                        {
                                                $params[$par] = $_GET[$par];
                                        }
                                        else if (isset($_POST[$par]))
                                        {
                                                $params[$par] = ilUtil::stripSlashesRecursive($_POST[$par]);
                                        }
                                }
                        }

                        if (isset($this->parameter[$class]) && is_array($this->parameter[$class]))
                        {
                                foreach($this->parameter[$class] as $par => $value)
                                {
                                        $params[$par] = $value;
                                }
                        }
                }

                if ($a_cmd != "")
                {
                        $params["cmd"] = $a_cmd;
                }

                $params["cmdClass"] = $target_class;
                $params["cmdNode"] = $nr;
                if($new_baseclass == "")
                {
                        $params["baseClass"] = $_GET["baseClass"];
                }
                else
                {
                        $params["baseClass"] = $new_baseclass;
                }

                return $params;
        }
        
        private function getCidForClass($a_class, $a_check = false)
        {
                if ($this->class_cid[$a_class] == "")
                {
                        $this->readClassInfo($a_class);
                }
                if ($this->class_cid[$a_class] == "")
                {
                        if ($a_check)
                        {
                                return false;
                        }
                        if (DEVMODE == 1)
                        {
                                $add = "<br><br>Please make sure your GUI class name ends with 'GUI' and that the filename is 'class.[YourClassName].php'. In exceptional cases you
                                        may solve the issue by putting an empty * @ilCtrl_Calls [YourClassName]: into your class header.".
                                        " In both cases you need to reload the control structure in the setup.";
                        }
                        include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                        throw new ilCtrlException("Cannot find cid for class ".$a_class.".".$add);
                }
                return $this->class_cid[$a_class];
        }

        private function getClassForCid($a_cid)
        {
                if ($this->cid_class[$a_cid] == "")
                {
                        $this->readCidInfo($a_cid);
                }
                if ($this->cid_class[$a_cid] == "")
                {
                        include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                        throw new ilCtrlException("Cannot find class for cid ".$a_cid.".");
                }
                return $this->cid_class[$a_cid];
        }

        private function readCidInfo($a_cid)
        {
                global $ilDB;

                if (isset($this->info_read_cid[$a_cid]))
                {
                        return;
                }

                $cached_ctrl = ilCachedCtrl::getInstance();
                $rec = $cached_ctrl->lookupCid($a_cid);

//              $set = $ilDB->query("SELECT * FROM ctrl_classfile ".
//                      " WHERE cid = ".$ilDB->quote($a_cid, "text")
//                      );
//              if ($rec  = $ilDB->fetchAssoc($set))
                if($rec)
                {
                        $this->cid_class[$a_cid] = $rec["class"];
                        $this->class_cid[$rec["class"]] = $a_cid;

                        $calls = $cached_ctrl->lookupCall($rec["class"]);

                        //                      $set = $ilDB->query("SELECT * FROM ctrl_calls ".
                        //                              " WHERE parent = ".$ilDB->quote($rec["class"], "text")
                        //                              );
                        //                      while ($rec2  = $ilDB->fetchAssoc($set))
                        foreach($calls as $rec2)
                        {
                                if (!isset($this->calls[$rec["class"]]) || !is_array($this->calls[$rec["class"]]) || !in_array($rec2["child"], $this->calls[$rec["class"]]))
                                {
                                        if ($rec2["child"] != "")
                                        {
                                                $this->calls[$rec["class"]][] = $rec2["child"];
                                        }
                                }
                        }
                        $this->info_read_class[$rec["class"]] = true;
                }
                
                $this->info_read_cid[$a_cid] = true;
        }

        private function readNodeInfo($a_node)
        {
                $n_arr = explode(":", $a_node);
                foreach ($n_arr as $cid)
                {
                        $this->readCidInfo($cid);
                }
        }

        private function readClassInfo($a_class)
        {
                global $ilDB;

                $a_class = strtolower($a_class);
                if (isset($this->info_read_class[$a_class]))
                {
                        return;
                }

                $cached_ctrl = ilCachedCtrl::getInstance();
                $rec = $cached_ctrl->lookupClassFile($a_class);


//              $set = $ilDB->query("SELECT * FROM ctrl_classfile ".
//                      " WHERE class = ".$ilDB->quote($a_class, "text")
//                      );
//              if ($rec  = $ilDB->fetchAssoc($set))
                if($rec)
                {
                        $this->cid_class[$rec["cid"]] = $a_class;
                        $this->class_cid[$a_class] = $rec["cid"];
                }
                
//              $set = $ilDB->query("SELECT * FROM ctrl_calls ".
//                      " WHERE parent = ".$ilDB->quote($a_class, "text")
//                      );
                $recs = $cached_ctrl->lookupCall($a_class);
//              while ($rec  = $ilDB->fetchAssoc($set))
                foreach($recs as $rec)
                {
                        if (!isset($this->calls[$a_class]) || !is_array($this->calls[$a_class]) || !in_array($rec["child"], $this->calls[$a_class]))
                        {
                                if ($rec["child"] != "")
                                {
                                        $this->calls[$a_class][] = $rec["child"];
                                }
                        }
                }
                
                $this->info_read_class[$a_class] = true;
                $this->info_read_cid[$this->class_cid[$a_class]] = true;
        }

        private function getParentCidOfNode($a_node)
        {
                $n_arr = explode(":", $a_node);
                return $n_arr[count($n_arr) - 2];
        }

        private function removeLastCid($a_node)
        {
                $lpos = strrpos($a_node, ":");
                return substr($a_node, 0, $lpos);
        }

        private function getCurrentCidOfNode($a_node)
        {
                $n_arr = explode(":", $a_node);
                return $n_arr[count($n_arr) - 1];
        }

        function insertCtrlCalls($a_parent, $a_child, $a_comp_prefix)
        {
                global $ilDB;

                $a_parent = strtolower($a_parent);
                $a_child = strtolower($a_child);
                $a_comp_prefix = strtolower($a_comp_prefix);

                $set = $ilDB->query("SELECT * FROM ctrl_calls WHERE ".
                        " parent = ".$ilDB->quote($a_parent, "text")." AND ".
                        " child = ".$ilDB->quote($a_child, "text")." AND ".
                        " comp_prefix = ".$ilDB->quote($a_comp_prefix, "text")
                        );
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return;
                }
                $ilDB->manipulate("INSERT INTO ctrl_calls ".
                        "(parent, child, comp_prefix) VALUES (".
                        $ilDB->quote($a_parent, "text").",".
                        $ilDB->quote($a_child, "text").",".
                        $ilDB->quote($a_comp_prefix, "text").
                        ")");
        }

}
?>