class.ilObjectGUI.php

Go to the documentation of this file.

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


class ilObjectGUI
{
        const COPY_WIZARD_NEEDS_PAGE = 1;
        
        var $ilias;

        var $objDefinition;

        var $tpl;

        var $tree;

        var $lng;

        var $data;

        var $object;
        var $ref_id;
        var $obj_id;
        var $maxcount;                  // contains number of child objects
        var $formaction;                // special formation (array "cmd" => "formaction")
        var $return_location;   // special return location (array "cmd" => "location")
        var $target_frame;      // special target frame (array "cmd" => "location")

        var $tab_target_script;
        var $actions;
        var $sub_objects;
        var $omit_locator = false;

        function ilObjectGUI($a_data, $a_id = 0, $a_call_by_reference = true, $a_prepare_output = true)
        {
                global $ilias, $objDefinition, $tpl, $tree, $ilCtrl, $ilErr, $lng, $ilTabs;

                $this->tabs_gui =& $ilTabs;

                if (!isset($ilErr))
                {
                        $ilErr = new ilErrorHandling();
                        $ilErr->setErrorHandling(PEAR_ERROR_CALLBACK,array($ilErr,'errorHandler'));
                }
                else
                {
                        $this->ilErr =& $ilErr;
                }

                $this->ilias =& $ilias;
                $this->objDefinition =& $objDefinition;
                $this->tpl =& $tpl;
                $this->html = "";
                $this->ctrl =& $ilCtrl;

                $params = array("ref_id");

                if (!$a_call_by_reference)
                {
                        $params = array("ref_id","obj_id");
                }

                $this->ctrl->saveParameter($this, $params);

                $this->lng =& $lng;
                $this->tree =& $tree;
                $this->formaction = array();
                $this->return_location = array();
                $this->target_frame = array();
                $this->actions = "";
                $this->sub_objects = "";

                $this->data = $a_data;
                $this->id = $a_id;
                $this->call_by_reference = $a_call_by_reference;
                $this->prepare_output = $a_prepare_output;
                $this->creation_mode = false;

                $this->ref_id = ($this->call_by_reference) ? $this->id : $_GET["ref_id"];
                $this->obj_id = ($this->call_by_reference) ? $_GET["obj_id"] : $this->id;

                if ($this->id != 0)
                {
                        $this->link_params = "ref_id=".$this->ref_id;
                }

                // get the object
                $this->assignObject();
                
                // set context
                if (is_object($this->object))
                {
                        if ($this->call_by_reference && $this->ref_id = $_GET["ref_id"])
                        {
                                $this->ctrl->setContext($this->object->getId(), 
                                        $this->object->getType());
                        }
                }

                // use global $lng instead, when creating new objects object is not available
                //$this->lng =& $this->object->lng;

                //prepare output
                if ($a_prepare_output)
                {
                        $this->prepareOutput();
                }
        }
        
        
        function &executeCommand()
        {
                global $rbacsystem;

                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();

                switch($next_class)
                {
                        default:
                                $this->prepareOutput();
                                if(!$cmd)
                                {
                                        $cmd = "view";
                                }
                                $cmd .= "Object";
                                $this->$cmd();
                                        
                                break;
                }

                return true;
        }


        public function withReferences()
        {
                return $this->call_by_reference;
        }
        
        public function setCreationMode($a_mode = true)
        {
                $this->creation_mode = $a_mode;
        }
        
        public function getCreationMode()
        {
                return $this->creation_mode;
        }

        protected function assignObject()
        {
                // TODO: it seems that we always have to pass only the ref_id
//echo "<br>ilObjectGUIassign:".get_class($this).":".$this->id.":<br>";
                if ($this->id != 0)
                {
                        if ($this->call_by_reference)
                        {
                                $this->object = ilObjectFactory::getInstanceByRefId($this->id);
                        }
                        else
                        {
                                $this->object = ilObjectFactory::getInstanceByObjId($this->id);
                        }
                }
        }

        protected function prepareOutput()
        {
                global $ilLocator, $tpl, $ilUser;
                
                $this->tpl->getStandardTemplate();
                // administration prepare output
                if (strtolower($_GET["baseClass"]) == "iladministrationgui")
                {
                        $this->addAdminLocatorItems();
                        $tpl->setLocator();

//                      ilUtil::sendInfo();
                        ilUtil::infoPanel();

                        $this->setTitleAndDescription();

                        if ($this->getCreationMode() != true)
                        {
                                $this->setAdminTabs();
                                $this->showUpperIcon();
                        }
                        
                        return false;
                }
                // set locator
                $this->setLocator();
                // catch feedback message
//              ilUtil::sendInfo();
                ilUtil::infoPanel();

                // in creation mode (parent) object and gui object
                // do not fit
                if ($this->getCreationMode() == true)
                {
                        // get gui class of parent and call their title and description method
                        $obj_type = ilObject::_lookupType($_GET["ref_id"],true);
                        $class_name = $this->objDefinition->getClassName($obj_type);
                        $class = strtolower("ilObj".$class_name."GUI");
                        $class_path = $this->ctrl->lookupClassPath($class);
                        include_once($class_path);
                        $class_name = $this->ctrl->getClassForClasspath($class_path);
//echo "<br>instantiating parent for title and description";
                        $this->parent_gui_obj = new $class_name("", $_GET["ref_id"], true, false);
                        $this->parent_gui_obj->setTitleAndDescription();
                }
                else
                {
                        // set title and description and title icon
                        $this->setTitleAndDescription();
        
                        // set tabs
                        $this->setTabs();
                        $this->showUpperIcon();

                        // BEGIN WebDAV: Display Mount Webfolder icon.
                        require_once 'Services/WebDAV/classes/class.ilDAVServer.php';
                        if (ilDAVServer::_isActive() && 
                                $ilUser->getId() != ANONYMOUS_USER_ID)
                        {
                                $this->showMountWebfolderIcon();
                        }
                        // END WebDAV: Display Mount Webfolder icon.
                }
                
                return true;
        }
        

        protected function setTitleAndDescription()
        {
                $this->tpl->setTitle($this->object->getPresentationTitle());
                $this->tpl->setDescription($this->object->getLongDescription());
                if (strtolower($_GET["baseClass"]) == "iladministrationgui")
                {
                        // alt text would be same as heading -> empty alt text
                        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_".$this->object->getType()."_b.gif"),
                                "");
                }
                else
                {
                        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_".$this->object->getType()."_b.gif"),
                                $this->lng->txt("obj_" . $this->object->getType()));
                }
        }
        
        protected function showUpperIcon()
        {
                global $tree, $tpl, $objDefinition;

                if ($this->object->getRefId() == "")
                {
                        return;
                }

                if (strtolower($_GET["baseClass"]) == "iladministrationgui")
                {               
                        if ($this->object->getRefId() != ROOT_FOLDER_ID &&
                                $this->object->getRefId() != SYSTEM_FOLDER_ID)
                        {
                                $par_id = $tree->getParentId($this->object->getRefId());
                                $obj_type = ilObject::_lookupType($par_id,true);
                                $class_name = $objDefinition->getClassName($obj_type);
                                $class = strtolower("ilObj".$class_name."GUI");
                                $this->ctrl->setParameterByClass($class, "ref_id", $par_id);
                                $tpl->setUpperIcon($this->ctrl->getLinkTargetByClass($class, "view"));
                                $this->ctrl->clearParametersByClass($class);
                        }
                        // link repository admin to admin settings
                        else if ($this->object->getRefId() == ROOT_FOLDER_ID)
                        {
                                $this->ctrl->setParameterByClass("iladministrationgui", "ref_id", "");
                                $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
                                $tpl->setUpperIcon($this->ctrl->getLinkTargetByClass("iladministrationgui", "frameset"),
                                        ilFrameTargetInfo::_getFrame("MainContent"));
                                $this->ctrl->clearParametersByClass("iladministrationgui");
                        }
                }
                else
                {
                        if ($this->object->getRefId() != ROOT_FOLDER_ID &&
                                $this->object->getRefId() != SYSTEM_FOLDER_ID &&
                                $_GET["obj_id"] == "")
                        {
                                if (defined("ILIAS_MODULE"))
                                {
                                        $prefix = "../";
                                }
                                $par_id = $tree->getParentId($this->object->getRefId());
                                $tpl->setUpperIcon($prefix."repository.php?cmd=frameset&ref_id=".$par_id,
                                        ilFrameTargetInfo::_getFrame("MainContent"));
                        }
                }
        }
        // BEGIN WebDAV: Show Mount Webfolder Icon.
        final private function showMountWebfolderIcon()
        {
                global $tree, $tpl, $objDefinition;

                if ($this->object->getRefId() == "")
                {
                        return;
                }

                $tpl->setMountWebfolderIcon($this->object->getRefId());
        }
        // END WebDAV: Show Mount Webfolder Icon.


        protected function setTabs()
        {
                $this->getTabs($this->tabs_gui);
        }

        protected final function setAdminTabs()
        {
                $this->getAdminTabs($this->tabs_gui);
        }

        function getAdminTabs(&$tabs_gui)
        {
                global $rbacsystem, $tree;

                if ($_GET["admin_mode"] == "repository")
                {
                        $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
                        $tabs_gui->setBackTarget($this->lng->txt("administration"),
                                $this->ctrl->getLinkTargetByClass("iladministrationgui", "frameset"),
                                ilFrameTargetInfo::_getFrame("MainContent"));
                        $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "repository");
                }
                
                if ($rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
                {
                        $tabs_gui->addTarget("view",
                                $this->ctrl->getLinkTarget($this, "view"), array("", "view"), get_class($this));
                }
                
                if ($rbacsystem->checkAccess('edit_permission',$this->object->getRefId()))
                {
                        $tabs_gui->addTarget("perm_settings",
                                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), "", "ilpermissiongui");
                }
                        
                if ($tree->getSavedNodeData($this->object->getRefId()))
                {
                        $tabs_gui->addTarget("trash",
                                $this->ctrl->getLinkTarget($this, "trash"), "trash", get_class($this));
                }
        }


        function getHTML()
        {
                return $this->html;
        }


        final private function setActions($a_actions = "")
        {
                if (is_array($a_actions))
                {
                        foreach ($a_actions as $name => $lng)
                        {
                                $this->actions[$name] = array("name" => $name, "lng" => $lng);
                        }
                }
                else
                {
                        $this->actions = "";
                }
        }

        final private function setSubObjects($a_sub_objects = "")
        {
                if (is_array($a_sub_objects))
                {
                        foreach ($a_sub_objects as $name => $options)
                        {
                                $this->sub_objects[$name] = array("name" => $name, "max" => $options["max"]);
                        }
                }
                else
                {
                        $this->sub_objects = "";
                }
        }

        protected function setLocator()
        {
                global $ilLocator, $tpl;
                
                if ($this->omit_locator)
                {
                        return;
                }
                
                // todo: admin workaround
                // in the future, objectgui classes should not be called in
                // admin section anymore (rbac/trash handling in own classes)
                $ref_id = ($_GET["ref_id"] != "")
                        ? $_GET["ref_id"]
                        : $this->object->getRefId();
                $ilLocator->addRepositoryItems($ref_id);
                
                if(!$this->creation_mode)
                {
                        $this->addLocatorItems();
                }
                
                // not so nice workaround: todo: handle $ilLocator as tabs in ilTemplate
                if ($_GET["admin_mode"] == "" &&
                        strtolower($this->ctrl->getCmdClass()) == "ilobjrolegui")
                {
                        $this->ctrl->setParameterByClass("ilobjrolegui",
                                "rolf_ref_id", $_GET["rolf_ref_id"]);
                        $this->ctrl->setParameterByClass("ilobjrolegui",
                                "obj_id", $_GET["obj_id"]);
                        $ilLocator->addItem($this->lng->txt("role"),
                                $this->ctrl->getLinkTargetByClass(array("ilpermissiongui",
                                        "ilobjrolegui"), "perm"));
                }

                $tpl->setLocator();
        }
        
        protected function addLocatorItems()
        {
        }
        
        protected function omitLocator($a_omit = true)
        {
                $this->omit_locator = $a_omit;
        }

        protected function addAdminLocatorItems()
        {
                global $ilLocator;
                
                if ($_GET["admin_mode"] == "settings")  // system settings
                {               
                        $ilLocator->addItem($this->lng->txt("administration"),
                                $this->ctrl->getLinkTargetByClass("iladministrationgui", "frameset"),
                                ilFrameTargetInfo::_getFrame("MainContent"));
                        if ($this->object->getRefId() != SYSTEM_FOLDER_ID)
                        {
                                $ilLocator->addItem($this->object->getTitle(),
                                        $this->ctrl->getLinkTarget($this, "view"));
                        }
                }
                else                                                    // repository administration
                {
                        $this->ctrl->setParameterByClass("iladministrationgui",
                                "ref_id", "");
                        $this->ctrl->setParameterByClass("iladministrationgui",
                                "admin_mode", "settings");
                        //$ilLocator->addItem($this->lng->txt("administration"),
                        //      $this->ctrl->getLinkTargetByClass("iladministrationgui", "frameset"),
                        //      ilFrameTargetInfo::_getFrame("MainContent"));
                        $this->ctrl->clearParametersByClass("iladministrationgui");
                        $ilLocator->addAdministrationItems();
                }

        }

        public function undeleteObject()
        {
                include_once("./Services/Repository/classes/class.ilRepUtilGUI.php");
                $ru = new ilRepUtilGUI($this);
                $ru->restoreObjects($_GET["ref_id"], $_POST["trash_id"]);
                $this->ctrl->redirect($this, "trash");
        }

        public function confirmedDeleteObject()
        {
                global $ilSetting, $lng;

                include_once("./Services/Repository/classes/class.ilRepUtilGUI.php");
                $ru = new ilRepUtilGUI($this);
                $ru->deleteObjects($_GET["ref_id"], $_SESSION["saved_post"]);
                session_unregister("saved_post");
                $this->ctrl->returnToParent($this);
        }

        public function cancelDeleteObject()
        {
                session_unregister("saved_post");
                $this->ctrl->returnToParent($this);
        }

        public function removeFromSystemObject()
        {
                global $rbacsystem, $log, $ilAppEventHandler, $lng;
                
                include_once("./Services/Repository/classes/class.ilRepUtilGUI.php");
                $ru = new ilRepUtilGUI($this);
                $ru->removeObjectsFromSystem($_POST["trash_id"]);
                $this->ctrl->redirect($this, "trash");
        }

        public function createObject()
        {
                global $rbacsystem;

                $new_type = $_POST["new_type"] ? $_POST["new_type"] : $_GET["new_type"];

                if (!$rbacsystem->checkAccess("create", $_GET["ref_id"], $new_type))
                {
                        $this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
                }
                else
                {
                        // fill in saved values in case of error
                        $data = array();
                        $data["fields"] = array();
                        $data["fields"]["title"] = ilUtil::prepareFormOutput($_SESSION["error_post_vars"]["Fobject"]["title"],true);
                        $data["fields"]["desc"] = ilUtil::stripSlashes($_SESSION["error_post_vars"]["Fobject"]["desc"]);

                        $this->getTemplateFile("edit",$new_type);
                        
                        // show obj type image
                        $this->tpl->setCurrentBlock("img");
                        $this->tpl->setVariable("TYPE_IMG",
                                ilUtil::getImagePath("icon_".$new_type.".gif"));
                        $this->tpl->setVariable("ALT_IMG",
                                $this->lng->txt("obj_".$new_type));
                        $this->tpl->parseCurrentBlock();

                        foreach ($data["fields"] as $key => $val)
                        {
                                $this->tpl->setVariable("TXT_".strtoupper($key), $this->lng->txt($key));
                                $this->tpl->setVariable(strtoupper($key), $val);

                                if ($this->prepare_output)
                                {
                                        $this->tpl->parseCurrentBlock();
                                }
                        }
                        $this->ctrl->setParameter($this, "new_type", $new_type);
                        $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this, "save"));
                        $this->tpl->setVariable("TXT_HEADER", $this->lng->txt($new_type."_new"));
                        $this->tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
                        $this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt($new_type."_add"));
                        $this->tpl->setVariable("CMD_SUBMIT", "save");
                        $this->tpl->setVariable("TARGET", $this->getTargetFrame("save"));
                        $this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
                }
        }
        

        public function cancelObject($in_rep = false)
        {
                session_unregister("saved_post");

                $this->ctrl->returnToParent($this);
        }

        public function saveObject()
        {
                global $rbacsystem, $objDefinition, $rbacreview;

                $new_type = $_POST["new_type"] ? $_POST["new_type"] : $_GET["new_type"];

                // create permission is already checked in createObject. This check here is done to prevent hacking attempts
                if (!$rbacsystem->checkAccess("create", $_GET["ref_id"], $new_type))
                {
                        $this->ilias->raiseError($this->lng->txt("no_create_permission"), $this->ilias->error_obj->MESSAGE);
                }
//echo ":".$_GET["new_type"].":".$_POST["new_type"].":";
                $location = $objDefinition->getLocation($new_type);

                        // create and insert object in objecttree
                $class_name = "ilObj".$objDefinition->getClassName($new_type);
                include_once($location."/class.".$class_name.".php");
                $newObj = new $class_name();
                $newObj->setType($new_type);
                $newObj->setTitle(ilUtil::stripSlashes($_POST["Fobject"]["title"]));
                $newObj->setDescription(ilUtil::stripSlashes($_POST["Fobject"]["desc"]));
                $newObj->create();
                $newObj->createReference();
                $newObj->putInTree($_GET["ref_id"]);
                $newObj->setPermissions($_GET["ref_id"]);
                //$newObj->notify("new",$_GET["ref_id"],$_GET["parent_non_rbac_id"],$_GET["ref_id"],$newObj->getRefId());

                // rbac log
                include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                $rbac_log_roles = $rbacreview->getParentRoleIds($newObj->getRefId(), false);
                $rbac_log = ilRbacLog::gatherFaPa($newObj->getRefId(), array_keys($rbac_log_roles));
                ilRbacLog::add(ilRbacLog::CREATE_OBJECT, $newObj->getRefId(), $rbac_log);

                return $newObj;
        }

        public function editObject()
        {
                global $rbacsystem;

                if (!$rbacsystem->checkAccess("write", $this->ref_id))
                {
                        $this->ilias->raiseError($this->lng->txt("msg_no_perm_write"),$this->ilias->error_obj->MESSAGE);
                }

                $fields = array();

                if ($_SESSION["error_post_vars"])
                {
                        // fill in saved values in case of error
                        $fields["title"] = ilUtil::prepareFormOutput($_SESSION["error_post_vars"]["Fobject"]["title"],true);
                        $fields["desc"] = ilUtil::stripSlashes($_SESSION["error_post_vars"]["Fobject"]["desc"]);
                }
                else
                {
                        $fields["title"] = ilUtil::prepareFormOutput($this->object->getTitle());
                        $fields["desc"] = ilUtil::stripSlashes($this->object->getLongDescription());
                }

                $this->displayEditForm($fields);
        }

        protected function displayEditForm($fields)
        {
                $this->getTemplateFile("edit");

                foreach ($fields as $key => $val)
                {
                        $this->tpl->setVariable("TXT_".strtoupper($key), $this->lng->txt($key));
                        $this->tpl->setVariable(strtoupper($key), $val);
//                      $this->tpl->parseCurrentBlock();
                }

                //$obj_str = ($this->call_by_reference) ? "" : "&obj_id=".$this->obj_id;
                if (!$this->call_by_reference)
                {
                        $this->ctrl->setParameter($this, "obj_id", $this->obj_id);
                }

                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this, "update"));
                $this->tpl->setVariable("TXT_HEADER", $this->lng->txt($this->object->getType()."_edit"));
                $this->tpl->setVariable("TARGET", $this->getTargetFrame("update"));
                $this->tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
                $this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt("save"));
                $this->tpl->setVariable("CMD_SUBMIT", "update");
                $this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));

        }


        public function updateObject()
        {
                $this->object->setTitle(ilUtil::stripSlashes($_POST["Fobject"]["title"]));
                $this->object->setDescription(ilUtil::stripSlashes($_POST["Fobject"]["desc"]));
                $this->update = $this->object->update();

                ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"),true);
                
                $this->afterUpdate();
        }
        
        protected function afterUpdate()
        {
                $this->ctrl->redirect($this);
        }


        public function getFormAction($a_cmd, $a_formaction = "")
        {
                if ($this->formaction[$a_cmd] != "")
                {
                        return $this->formaction[$a_cmd];
                }
                else
                {
                        return $a_formaction;
                }
        }

        protected function setFormAction($a_cmd, $a_formaction)
        {
                $this->formaction[$a_cmd] = $a_formaction;
        }

        protected function getReturnLocation($a_cmd, $a_location ="")
        {
                if ($this->return_location[$a_cmd] != "")
                {
                        return $this->return_location[$a_cmd];
                }
                else
                {
                        return $a_location;
                }
        }

        protected function setReturnLocation($a_cmd, $a_location)
        {
//echo "-".$a_cmd."-".$a_location."-";
                $this->return_location[$a_cmd] = $a_location;
        }

        protected function getTargetFrame($a_cmd, $a_target_frame = "")
        {
                if ($this->target_frame[$a_cmd] != "")
                {
                        return $this->target_frame[$a_cmd];
                }
                elseif (!empty($a_target_frame))
                {
                        return "target=\"".$a_target_frame."\"";
                }
                else
                {
                        return;
                }
        }

        protected function setTargetFrame($a_cmd, $a_target_frame)
        {
                $this->target_frame[$a_cmd] = "target=\"".$a_target_frame."\"";
        }

        // BEGIN Security: Hide objects which aren't accessible by the user.
        public function isVisible($a_ref_id,$a_type)
        {
                global $rbacsystem, $ilBench;
                
                $ilBench->start("Explorer", "setOutput_isVisible");
                $visible = $rbacsystem->checkAccess('visible,read',$a_ref_id);
                
                if ($visible && $a_type == 'crs') {
                        global $tree;
                        if($crs_id = $tree->checkForParentType($a_ref_id,'crs'))
                        {
                                if(!$rbacsystem->checkAccess('write',$crs_id))
                                {
                                        // Show only activated courses
                                        $tmp_obj =& ilObjectFactory::getInstanceByRefId($crs_id,false);
        
                                        if(!$tmp_obj->isActivated())
                                        {
                                                unset($tmp_obj);
                                                $visible = false;
                                        }
                                        if(($crs_id != $a_ref_id) and $tmp_obj->isArchived())
                                        {
                                                $visible = false;
                                        }
                                        // Show only activated course items
                                        include_once "./course/classes/class.ilCourseItems.php";
        
                                        if(($crs_id != $a_ref_id) and (!ilCourseItems::_isActivated($a_ref_id)))
                                        {
                                                $visible = false;
                                        }
                                }
                        }
                }
                
                $ilBench->stop("Explorer", "setOutput_isVisible");

                return $visible;
        }
        // END Security: Hide objects which aren't accessible by the user.

        public function viewObject()
        {
                global $rbacsystem, $tpl;

                if (!$rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
                {
                        $this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
                }
                // BEGIN ChangeEvent: record read event.
                require_once('Services/Tracking/classes/class.ilChangeEvent.php');
                if (ilChangeEvent::_isActive())
                {
                        global $ilUser;
                        ilChangeEvent::_recordReadEvent(
                                $this->object->getType(),
                                $this->object->getRefId(),
                                $this->object->getId(), $ilUser->getId());
                }
                // END ChangeEvent: record read event.

                include_once("./Services/Repository/classes/class.ilAdminSubItemsTableGUI.php");
                if (!$this->call_by_reference)
                {
                        $this->ctrl->setParameter($this, "obj_id", $this->obj_id); 
                }
                $itab = new ilAdminSubItemsTableGUI($this, "view", $_GET["ref_id"]);
                
                $tpl->setContent($itab->getHTML());
        }

        public function deleteObject($a_error = false)
        {
                global $tpl, $ilCtrl;
                
                if ($_GET["item_ref_id"] != "")
                {
                        $_POST["id"] = array($_GET["item_ref_id"]);
                }

                // SAVE POST VALUES (get rid of this
                $_SESSION["saved_post"] = $_POST["id"];

                include_once("./Services/Repository/classes/class.ilRepUtilGUI.php");
                $ru = new ilRepUtilGUI($this);
                if (!$ru->showDeleteConfirmation($_POST["id"], $a_error))
                {
                        $ilCtrl->returnToParent($this);
                }
        }

        public function trashObject()
        {
                global $tpl;

                include_once("./Services/Repository/classes/class.ilRepUtilGUI.php");
                $ru = new ilRepUtilGUI($this);
                $ru->showTrashTable($_GET["ref_id"]);
        }

        protected function showPossibleSubObjects()
        {
                if ($this->sub_objects == "")
                {
                        $d = $this->objDefinition->getCreatableSubObjects($this->object->getType());
                }
                else
                {
                        $d = $this->sub_objects;
                }

                $import = false;

                if (count($d) > 0)
                {
                        foreach ($d as $row)
                        {
                            $count = 0;

                                if ($row["max"] > 0)
                                {
                                        //how many elements are present?
                                        for ($i=0; $i<count($this->data["ctrl"]); $i++)
                                        {
                                                if ($this->data["ctrl"][$i]["type"] == $row["name"])
                                                {
                                                    $count++;
                                                }
                                        }
                                }

                                if ($row["max"] == "" || $count < $row["max"])
                                {
                                        $subobj[] = $row["name"];
                                }
                        }
                }

                if (is_array($subobj))
                {

                        //build form
                        $opts = ilUtil::formSelect(12,"new_type",$subobj);
                        $this->tpl->setCurrentBlock("add_object");
                        $this->tpl->setVariable("SELECT_OBJTYPE", $opts);
                        $this->tpl->setVariable("BTN_NAME", "create");
                        $this->tpl->setVariable("TXT_ADD", $this->lng->txt("add"));
                        $this->tpl->parseCurrentBlock();
                }
        }

        public function getTemplateFile($a_cmd,$a_type = "")
        {
                if (!$a_type)
                {
                        $a_type = $this->type;
                }

                $template = "tpl.".$a_type."_".$a_cmd.".html";

                if (!$this->tpl->fileExists($template) &&
                        !file_exists("./templates/default/".$template))
                {
                        $template = "tpl.obj_".$a_cmd.".html";
                }
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", $template,$a_in_module);
        }

        protected function getTitlesByRefId($a_ref_ids)
        {
                foreach ($a_ref_ids as $id)
                {
                        // GET OBJECT TITLE
                        $tmp_obj =& $this->ilias->obj_factory->getInstanceByRefId($id);
                        $title[] = $tmp_obj->getTitle();
                        unset($tmp_obj);
                }

                return $title ? $title : array();
        }

        protected function getTabs(&$tabs_gui)
        {
                // please define your tabs here

        }

        // PROTECTED
        protected function __showButton($a_cmd,$a_text,$a_target = '')
        {
                global $ilToolbar;
                
                $ilToolbar->addButton($a_text, $this->ctrl->getLinkTarget($this, $a_cmd), $a_target);
        }

        protected function hitsperpageObject()
        {
        $_SESSION["tbl_limit"] = $_POST["hitsperpage"];
        $_GET["limit"] = $_POST["hitsperpage"];
        }
        

        protected function &__initTableGUI()
        {
                include_once "./Services/Table/classes/class.ilTableGUI.php";

                return new ilTableGUI(0,false);
        }
        
        protected function __setTableGUIBasicData(&$tbl,&$result_set,$a_from = "")
        {
                switch ($a_from)
                {
                        case "clipboardObject":
                                $offset = $_GET["offset"];
                                $order = $_GET["sort_by"];
                                $direction = $_GET["sort_order"];
                                $tbl->disable("footer");
                                break;

                        default:
                                $offset = $_GET["offset"];
                                $order = $_GET["sort_by"];
                                $direction = $_GET["sort_order"];
                                break;
                }

                $tbl->setOrderColumn($order);
                $tbl->setOrderDirection($direction);
                $tbl->setOffset($offset);
                $tbl->setLimit($_GET["limit"]);
                $tbl->setFooter("tblfooter",$this->lng->txt("previous"),$this->lng->txt("next"));
                $tbl->setData($result_set);
        }
        
        protected function __showClipboardTable($a_result_set,$a_from = "")
        {
                global $ilCtrl;
                
        $tbl =& $this->__initTableGUI();
                $tpl =& $tbl->getTemplateObject();

                $tpl->setCurrentBlock("tbl_form_header");
                $tpl->setVariable("FORMACTION", $ilCtrl->getFormAction($this));
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("tbl_action_btn");
                $tpl->setVariable("BTN_NAME","paste");
                $tpl->setVariable("BTN_VALUE",$this->lng->txt("insert_object_here"));
                $tpl->parseCurrentBlock();
                
                $tpl->setCurrentBlock("tbl_action_btn");
                $tpl->setVariable("BTN_NAME","clear");
                $tpl->setVariable("BTN_VALUE",$this->lng->txt("clear_clipboard"));
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("tbl_action_row");
                $tpl->setVariable("COLUMN_COUNTS",3);
                $tpl->setVariable("IMG_ARROW",ilUtil::getImagePath("spacer.gif"));
                $tpl->parseCurrentBlock();
                
                $tbl->setTitle($this->lng->txt("clipboard"),"icon_typ_b.gif",$this->lng->txt("clipboard"));
                $tbl->setHeaderNames(array($this->lng->txt('obj_type'),
                                                                   $this->lng->txt('title'),
                                                                   $this->lng->txt('action')));
                $tbl->setHeaderVars(array('type',
                                  'title',
                                                                  'act'),
                                                        array('ref_id' => $this->object->getRefId(),
                                                                  'cmd' => 'clipboard',
                                                                  'cmdClass' => $_GET['cmdClass'],
                                                                  'cmdNode' => $_GET['cmdNode']));

                $tbl->setColumnWidth(array("","80%","19%"));


                $this->__setTableGUIBasicData($tbl,$a_result_set,$a_from);
                $tbl->render();
                
                $this->tpl->setVariable("RESULT_TABLE",$tbl->tpl->get());

                return true;
        }

        protected function redirectToRefId($a_ref_id, $a_cmd = "")
        {
                $obj_type = ilObject::_lookupType($a_ref_id,true);
                $class_name = $this->objDefinition->getClassName($obj_type);
                $class = strtolower("ilObj".$class_name."GUI");
                $this->ctrl->redirectByClass(array("ilrepositorygui", $class), $a_cmd);
        }
        
        // Object Cloning
        protected function fillCloneTemplate($a_tpl_varname,$a_type)
        {
                
                include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                $cp = new ilObjectCopyGUI($this);
                $cp->setType($a_type);
                $cp->setTarget($_GET['ref_id']);
                $cp->showSourceSearch($a_tpl_varname);
                return;
        }
        
        
        
        public function cloneAllObject()
        {
                include_once('classes/class.ilLink.php');
                include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                
                global $ilAccess,$ilErr,$rbacsystem,$ilUser;
                
                $new_type = $_REQUEST['new_type'];
                if(!$rbacsystem->checkAccess('create',(int) $_GET['ref_id'],$new_type))
                {
                        $ilErr->raiseError($this->lng->txt('permission_denied'));
                }
                if(!(int) $_REQUEST['clone_source'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        $this->createObject();
                        return false;
                }
                if(!$ilAccess->checkAccess('write','',(int) $_REQUEST['clone_source'],$new_type))
                {
                        $ilErr->raiseError($this->lng->txt('permission_denied'));
                }
                
                // Save wizard options
                $copy_id = ilCopyWizardOptions::_allocateCopyId();
                $wizard_options = ilCopyWizardOptions::_getInstance($copy_id);
                $wizard_options->saveOwner($ilUser->getId());
                $wizard_options->saveRoot((int) $_REQUEST['clone_source']);
                
                $options = $_POST['cp_options'] ? $_POST['cp_options'] : array();
                foreach($options as $source_id => $option)
                {
                        $wizard_options->addEntry($source_id,$option);
                }
                $wizard_options->read();
                
                $orig = ilObjectFactory::getInstanceByRefId((int) $_REQUEST['clone_source']);
                $new_obj = $orig->cloneObject((int) $_GET['ref_id'],$copy_id);
                
                // Delete wizard options
                $wizard_options->deleteAll();

                ilUtil::sendSuccess($this->lng->txt("object_duplicated"),true);
                ilUtil::redirect(ilLink::_getLink($new_obj->getRefId()));
        }
        
        public function copyWizardHasOptions($a_mode)
        {
                return false;
        }
        
        protected function getCenterColumnHTML()
        {
                global $ilCtrl, $ilAccess;

                include_once("Services/Block/classes/class.ilColumnGUI.php");

                $obj_id = ilObject::_lookupObjId($this->object->getRefId());
                $obj_type = ilObject::_lookupType($obj_id);

                if ($ilCtrl->getNextClass() != "ilcolumngui")
                {
                        // normal command processing    
                        return $this->getContent();
                }
                else
                {
                        if (!$ilCtrl->isAsynch())
                        {
                                //if ($column_gui->getScreenMode() != IL_SCREEN_SIDE)
                                if (ilColumnGUI::getScreenMode() != IL_SCREEN_SIDE)
                                {
                                        // right column wants center
                                        if (ilColumnGUI::getCmdSide() == IL_COL_RIGHT)
                                        {
                                                $column_gui = new ilColumnGUI($obj_type, IL_COL_RIGHT);
                                                $this->setColumnSettings($column_gui);
                                                $this->html = $ilCtrl->forwardCommand($column_gui);
                                        }
                                        // left column wants center
                                        if (ilColumnGUI::getCmdSide() == IL_COL_LEFT)
                                        {
                                                $column_gui = new ilColumnGUI($obj_type, IL_COL_LEFT);
                                                $this->setColumnSettings($column_gui);
                                                $this->html = $ilCtrl->forwardCommand($column_gui);
                                        }
                                }
                                else
                                {
                                        // normal command processing    
                                        return $this->getContent();
                                }
                        }
                }
        }
        
        protected function getRightColumnHTML()
        {
                global $ilUser, $lng, $ilCtrl, $ilAccess;
                
                $obj_id = ilObject::_lookupObjId($this->object->getRefId());
                $obj_type = ilObject::_lookupType($obj_id);

                include_once("Services/Block/classes/class.ilColumnGUI.php");
                $column_gui = new ilColumnGUI($obj_type, IL_COL_RIGHT);
                
                if ($column_gui->getScreenMode() == IL_SCREEN_FULL)
                {
                        return "";
                }
                
                $this->setColumnSettings($column_gui);
                
                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 = $ilCtrl->getHTML($column_gui);
                        }
                }

                return $html;
        }

        protected function setColumnSettings($column_gui)
        {
                global $ilAccess;

                $column_gui->setRepositoryMode(true);
                $column_gui->setEnableEdit(false);
                if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
                {
                        $column_gui->setEnableEdit(true);
                }
        }
        
        protected function checkPermission($a_perm, $a_cmd = "")
        {
                global $ilAccess, $lng, $PHP_SELF;
                
                if (!is_object($this->object))
                {
                        return;
                }

                if (!$ilAccess->checkAccess($a_perm, $a_cmd, $this->object->getRefId()))
                {
                        $_SESSION["il_rep_ref_id"] = "";
                        ilUtil::sendFailure($lng->txt("permission_denied"), true);

                        if (!is_int(strpos($PHP_SELF, "goto.php")))
                        {
                                ilUtil::redirect("goto.php?target=".$this->object->getType()."_".
                                        $this->object->getRefId());
                        }
                        else    // we should never be here
                        {
                                die("Permission Denied.");
                        }
                }
        }
        
} // END class.ilObjectGUI (3.10: 2896 loc)
?>