class.ilContainer.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

// note: the values are derived from ilObjCourse constants
// to enable easy migration from course view setting to container view setting

require_once "./Services/Object/classes/class.ilObject.php";

class ilContainer extends ilObject
{
        protected $order_type = 0;
        protected $hiddenfilesfound = false;
        
        // container view constants
        const VIEW_SESSIONS = 0;
        const VIEW_OBJECTIVE = 1;
        const VIEW_TIMING = 2;
        const VIEW_ARCHIVE = 3;
        const VIEW_SIMPLE = 4;
        const VIEW_BY_TYPE = 5;
        const VIEW_INHERIT = 6;

        const VIEW_DEFAULT = self::VIEW_BY_TYPE;

        
        const SORT_TITLE = 0;
        const SORT_MANUAL = 1;
        const SORT_ACTIVATION = 2;
        const SORT_INHERIT = 3;
        const SORT_CREATION = 4;
        
        const SORT_DIRECTION_ASC = 0;
        const SORT_DIRECTION_DESC = 1;

        const SORT_NEW_ITEMS_POSITION_TOP = 0;
        const SORT_NEW_ITEMS_POSITION_BOTTOM = 1;

        const SORT_NEW_ITEMS_ORDER_TITLE = 0;
        const SORT_NEW_ITEMS_ORDER_CREATION = 1;
        const SORT_NEW_ITEMS_ORDER_ACTIVATION = 2;


        static $data_preloaded = false;
        
        function ilContainer($a_id = 0, $a_call_by_reference = true)
        {
                parent::__construct($a_id, $a_call_by_reference);
        }
        
        
        
        function createContainerDirectory()
        {
                $webspace_dir = ilUtil::getWebspaceDir();
                $cont_dir = $webspace_dir."/container_data";
                if (!is_dir($cont_dir))
                {
                        ilUtil::makeDir($cont_dir);
                }
                $obj_dir = $cont_dir."/obj_".$this->getId();
                if (!is_dir($obj_dir))
                {
                        ilUtil::makeDir($obj_dir);
                }
        }
        
        function getContainerDirectory()
        {
                return $this->_getContainerDirectory($this->getId());
        }
        
        function _getContainerDirectory($a_id)
        {
                return ilUtil::getWebspaceDir()."/container_data/obj_".$a_id;
        }
        
        function getBigIconPath()
        {
                return self::_lookupIconPath($this->getId());
        }

        function getSmallIconPath()
        {
                return self::_lookupIconPath($this->getId());
        }

        function getTinyIconPath()
        {
                return self::_lookupIconPath($this->getId());
        }

        function getCustomIconPath()
        {
                return self::_lookupIconPath($this->getId());
        }


        function setHiddenFilesFound($a_hiddenfilesfound)
        {
                $this->hiddenfilesfound = $a_hiddenfilesfound;
        }

        function getHiddenFilesFound()
        {
                return $this->hiddenfilesfound;
        }

        function getStyleSheetId()
        {
                return $this->style_id;
        }

        function setStyleSheetId($a_style_id)
        {
                $this->style_id = $a_style_id;
        }

        function _lookupContainerSetting($a_id, $a_keyword, $a_default_value = NULL)
        {
                global $ilDB;
                
                $q = "SELECT * FROM container_settings WHERE ".
                                " id = ".$ilDB->quote($a_id ,'integer')." AND ".
                                " keyword = ".$ilDB->quote($a_keyword ,'text');
                $set = $ilDB->query($q);
                $rec = $set->fetchRow(DB_FETCHMODE_ASSOC);
                
                if(isset($rec['value']))
                {
                        return $rec["value"];
                }
                if($a_default_value === NULL)
                {
                        return '';
                }
                return $a_default_value;
        }

        function _writeContainerSetting($a_id, $a_keyword, $a_value)
        {
                global $ilDB;
                
                $query = "DELETE FROM container_settings WHERE ".
                        "id = ".$ilDB->quote($a_id,'integer')." ".
                        "AND keyword = ".$ilDB->quote($a_keyword,'text');
                $res = $ilDB->manipulate($query);
                
                $query = "INSERT INTO container_settings (id, keyword, value) VALUES (".
                        $ilDB->quote($a_id ,'integer').", ".
                        $ilDB->quote($a_keyword ,'text').", ".
                        $ilDB->quote($a_value ,'text').
                        ")";
                $res = $ilDB->manipulate($query);
        }
        
        public static function _getContainerSettings($a_id)
        {
                global $ilDB;
                
                $res = array();
                
                $sql = "SELECT * FROM container_settings WHERE ".
                                " id = ".$ilDB->quote($a_id ,'integer');
                $set = $ilDB->query($sql);
                while($row = $ilDB->fetchAssoc($set))
                {
                        $res[$row["keyword"]] = $row["value"];                  
                }               
                
                return $res;
        }       
        
        public static function _deleteContainerSettings($a_id, $a_keyword = null, $a_keyword_like = false)
        {
                global $ilDB;
                
                if(!$a_id)
                {
                        return;
                }
                
                $sql = "DELETE FROM container_settings WHERE ".
                                " id = ".$ilDB->quote($a_id ,'integer');
                if($a_keyword)
                {
                        if(!$a_keyword_like)
                        {
                                $sql .= " AND keyword = ".$ilDB->quote($a_keyword, "text");
                        }
                        else
                        {
                                $sql .= " AND ".$ilDB->like("keyword", "text", $a_keyword);
                        }
                }               
                $ilDB->manipulate($sql);                
        }       
        
        public static function _exportContainerSettings(ilXmlWriter $a_xml, $a_obj_id)
        {
                // container settings
                $settings = self::_getContainerSettings($a_obj_id);
                if(sizeof($settings))
                {
                        $a_xml->xmlStartTag("ContainerSettings");
                        
                        foreach($settings as $keyword => $value)
                        {
                                // :TODO: proper custom icon export/import
                                if(stristr($keyword, "icon"))
                                {
                                        continue;
                                }
                                
                                $a_xml->xmlStartTag(
                                        'ContainerSetting',
                                        array(
                                                'id' => $keyword,                                               
                                        )
                                );
                                
                                $a_xml->xmlData($value);
                                $a_xml->xmlEndTag("ContainerSetting");
                        }
                        
                        $a_xml->xmlEndTag("ContainerSettings");
                }               
        }
        
        function _lookupIconPath($a_id, $a_size = "big")
        {
                if ($a_size == "")
                {
                        $a_size = "big";
                }
                $size = $a_size;
                
                if (ilContainer::_lookupContainerSetting($a_id, "icon_custom"))
                {
                        $cont_dir = ilContainer::_getContainerDirectory($a_id);

                        $file_name = $cont_dir."/icon_custom.svg";
                        if (is_file($file_name))
                        {
                                return $file_name;
                        }
                }
                
                return "";
        }

        function saveIcons($a_custom_icon)
        {
                global $ilDB;
                
                $this->createContainerDirectory();
                $cont_dir = $this->getContainerDirectory();
                
                $file_name = "";
                if ($a_custom_icon != "")
                {
                        $file_name = $cont_dir."/icon_custom.svg";
                        ilUtil::moveUploadedFile($a_custom_icon, "icon_custom.svg", $file_name);

                        if ($file_name != "" && is_file($file_name))
                        {
                                ilContainer::_writeContainerSetting($this->getId(), "icon_custom", 1);
                        }
                        else
                        {
                                ilContainer::_writeContainerSetting($this->getId(), "icon_custom", 0);
                        }
                }
        }

        function removeCustomIcon()
        {
                $cont_dir = $this->getContainerDirectory();
                $small_file_name = $cont_dir."/icon_custom.svg";
                @unlink($small_file_name);
                ilContainer::_writeContainerSetting($this->getId(), "icon_custom", 0);
        }
        
        public function cloneObject($a_target_id,$a_copy_id = 0)
        {
                global $ilLog;

                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
        
                include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
                #18624 - copy all sorting settings
                ilContainerSortingSettings::_cloneSettings($this->getId(), $new_obj->getId());
                
                // copy content page
                include_once("./Services/Container/classes/class.ilContainerPage.php");
                if (ilContainerPage::_exists("cont",
                        $this->getId()))
                {
                        $orig_page = new ilContainerPage($this->getId());
                        $orig_page->copy($new_obj->getId(), "cont", $new_obj->getId());                 
                }

                // #20614 - copy style
                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                $style_id = $this->getStyleSheetId();
                if ($style_id > 0 &&
                        !ilObjStyleSheet::_lookupStandard($style_id))
                {
                        $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
                        $new_id = $style_obj->ilClone();
                        $new_obj->setStyleSheetId($new_id);
                        $new_obj->update();
                }

                // #10271 - copy start objects page
                include_once("./Services/Container/classes/class.ilContainerStartObjectsPage.php");
                if (ilContainerStartObjectsPage::_exists("cstr",
                        $this->getId()))
                {
                        $orig_page = new ilContainerStartObjectsPage($this->getId());
                        $orig_page->copy($new_obj->getId(), "cstr", $new_obj->getId());
                }
                
                // #10271 
                foreach(self::_getContainerSettings($this->getId()) as $keyword => $value)
                {                                               
                        self::_writeContainerSetting($new_obj->getId(), $keyword, $value);
                        
                        // copy custom icons
                        if($keyword == "icon_custom" && 
                                $value)
                        {
                                // see saveIcons()
                                $new_obj->createContainerDirectory();
                                $tgt_dir = $new_obj->getContainerDirectory();
                                $src_dir = $this->getContainerDirectory();                              
                                $file = "icon_custom.svg";
                                $src_file = $src_dir."/".$file;
                                if(file_exists($src_file))
                                {
                                        copy($src_file, $tgt_dir."/".$file);
                                }
                        }
                }
                
                return $new_obj;
        }
        
        public function cloneDependencies($a_target_id,$a_copy_id)
        {
                global $ilLog;
                
                parent::cloneDependencies($a_target_id, $a_copy_id);

                include_once('./Services/Container/classes/class.ilContainerSorting.php');
                ilContainerSorting::_getInstance($this->getId())->cloneSorting($a_target_id,$a_copy_id);
                
                // fix item group references in page content
                include_once("./Modules/ItemGroup/classes/class.ilObjItemGroup.php");
                ilObjItemGroup::fixContainerItemGroupRefsAfterCloning($this, $a_copy_id);
                
                include_once('Services/Object/classes/class.ilObjectLP.php');
                $olp = ilObjectLP::getInstance($this->getId());
                $collection = $olp->getCollectionInstance();
                if($collection)
                {
                        $collection->cloneCollection($a_target_id, $a_copy_id);         
                }

                return true;
        }

        public function cloneAllObject($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call = false, $a_submode = 1)
        {
                global $ilLog;
                
                include_once('./Services/Link/classes/class.ilLink.php');
                include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                
                global $ilAccess,$ilErr,$rbacsystem,$tree,$ilUser;
                        
                // Save wizard options
                $copy_id = ilCopyWizardOptions::_allocateCopyId();
                $wizard_options = ilCopyWizardOptions::_getInstance($copy_id);
                $wizard_options->saveOwner($ilUser->getId());
                $wizard_options->saveRoot($clone_source);
                        
                // add entry for source container
                $wizard_options->initContainer($clone_source, $ref_id);
                
                foreach($options as $source_id => $option)
                {
                        $wizard_options->addEntry($source_id,$option);
                }
                $wizard_options->read();
                $wizard_options->storeTree($clone_source);
                
                include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                if($a_submode == ilObjectCopyGUI::SUBMODE_CONTENT_ONLY)
                {
                        ilLoggerFactory::getLogger('obj')->info('Copy content only...');
                        ilLoggerFactory::getLogger('obj')->debug('Added mapping, source ID: '.$clone_source.', target ID: '.$ref_id);
                        $wizard_options->read();
                        $wizard_options->dropFirstNode();
                        $wizard_options->appendMapping($clone_source,$ref_id);
                }
                
                
                #print_r($options);
                // Duplicate session to avoid logout problems with backgrounded SOAP calls
                $new_session_id = ilSession::_duplicate($session_id);
                // Start cloning process using soap call
                include_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';

                $soap_client = new ilSoapClient();
                $soap_client->setResponseTimeout(5);
                $soap_client->enableWSDL(true);

                $ilLog->write(__METHOD__.': Trying to call Soap client...');
                if($soap_client->init())
                {
                        ilLoggerFactory::getLogger('obj')->info('Calling soap clone method');
                        $res = $soap_client->call('ilClone',array($new_session_id.'::'.$client_id, $copy_id));
                }
                else
                {
                        ilLoggerFactory::getLogger('obj')->warning('SOAP clone call failed. Calling clone method manually');
                        $wizard_options->disableSOAP();
                        $wizard_options->read();                        
                        include_once('./webservice/soap/include/inc.soap_functions.php');
                        $res = ilSoapFunctions::ilClone($new_session_id.'::'.$client_id, $copy_id);
                }
                return array(
                                'copy_id' => $copy_id,
                                'ref_id' => (int) $res
                );
        }
        
        function getViewMode()
        {
                return ilContainer::VIEW_BY_TYPE;
        }
        
        function getOrderType()
        {
                return $this->order_type ? $this->order_type : ilContainer::SORT_TITLE;
        }

        function setOrderType($a_value)
        {
                $this->order_type = $a_value;
        }
        
        function getSubItems($a_admin_panel_enabled = false, $a_include_side_block = false,
                $a_get_single = 0)
        {
                global $objDefinition, $ilBench, $tree, $ilObjDataCache, $ilUser, $rbacsystem,
                        $ilSetting;

                // Caching
                if (is_array($this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block]) &&
                        !$a_get_single)
                {
                        return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
                }
                
                $type_grps = $this->getGroupedObjTypes();
                $objects = $tree->getChilds($this->getRefId(), "title");

                $objects = self::getCompleteDescriptions($objects);

                $found = false;
                $all_ref_ids = array();
                
                if(!self::$data_preloaded)
                {
                        include_once("./Services/Object/classes/class.ilObjectListGUIPreloader.php");
                        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_REPOSITORY);         
                }               

                include_once('Services/Container/classes/class.ilContainerSorting.php');
                $sort = ilContainerSorting::_getInstance($this->getId());

                // TODO: check this
                // get items attached to a session
                include_once './Modules/Session/classes/class.ilEventItems.php';
                $event_items = ilEventItems::_getItemsOfContainer($this->getRefId());
                
                foreach ($objects as $key => $object)
                {
                        if ($a_get_single > 0 && $object["child"] != $a_get_single)
                        {
                                continue;
                        }
                        
                        // hide object types in devmode
                        if ($objDefinition->getDevMode($object["type"]) || $object["type"] == "adm"
                                || $object["type"] == "rolf")
                        {
                                continue;
                        }
                        
                        // remove inactive plugins
                        if ($objDefinition->isInactivePlugin($object["type"]))
                        {
                                continue;
                        }

                        // BEGIN WebDAV: Don't display hidden Files, Folders and Categories
                        if (in_array($object['type'], array('file','fold','cat')))
                        {
                                include_once 'Modules/File/classes/class.ilObjFileAccess.php';
                                if (ilObjFileAccess::_isFileHidden($object['title']))
                                {
                                        $this->setHiddenFilesFound(true);
                                        if (!$a_admin_panel_enabled)
                                        {
                                                continue;
                                        }
                                }
                        }
                        // END WebDAV: Don't display hidden Files, Folders and Categories
                        
                        // including event items!
                        if (!self::$data_preloaded)
                        {
                                $preloader->addItem($object["obj_id"], $object["type"], $object["child"]);
                        }                       
                        
                        // filter out items that are attached to an event
                        if (in_array($object['ref_id'],$event_items))
                        {
                                continue;
                        }
                        
                        // filter side block items
                        if(!$a_include_side_block && $objDefinition->isSideBlock($object['type']))
                        {
                                continue;
                        }

                        $all_ref_ids[] = $object["child"];
                }
                                                
                // data preloader
                if (!self::$data_preloaded)
                {
                        $preloader->preload();
                        unset($preloader);
                        
                        self::$data_preloaded = true;
                }
                
                foreach($objects as $key => $object)
                {                                       
                        // see above, objects were filtered
                        if(!in_array($object["child"], $all_ref_ids))
                        {
                                continue;
                        }
                        
                        // group object type groups together (e.g. learning resources)
                        $type = $objDefinition->getGroupOfObj($object["type"]);
                        if ($type == "")
                        {
                                $type = $object["type"];
                        }
                        
                        // this will add activation properties
                        $this->addAdditionalSubItemInformation($object);
                        
                        $this->items[$type][$key] = $object;
                                                
                        $this->items["_all"][$key] = $object;
                        if ($object["type"] != "sess")
                        {
                                $this->items["_non_sess"][$key] = $object;
                        }
                }
                
                $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block]
                        = $sort->sortItems($this->items);

                return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
        }
        
        function gotItems()
        {
                if (is_array($this->items["_all"]) && count($this->items["_all"]) > 0)
                {
                        return true;
                }
                return false;
        }
        
        function addAdditionalSubItemInformation(&$object)
        {
        }
        
        function getGroupedObjTypes()
        {
                global $objDefinition;
                
                if (empty($this->type_grps))
                {
                        $this->type_grps = $objDefinition->getGroupedRepositoryObjectTypes($this->getType());
                }
                return $this->type_grps;
        }
        
        function enablePageEditing()
        {
                global $ilSetting;
                
                // @todo: this will need a more general approach
                if ($ilSetting->get("enable_cat_page_edit"))
                {
                        return true;
                }
        }
        
        function create()
        {
                $ret = parent::create();
                
                if (((int) $this->getStyleSheetId()) > 0)
                {
                        include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                        ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
                }

                return $ret;
        }
        
        function update()
        {
                $ret = parent::update();
                
                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());

                return $ret;
        }
        
        
        public function read()
        {
                parent::read();
                
                include_once("./Services/Container/classes/class.ilContainerSortingSettings.php");
                $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
                
                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                $this->setStyleSheetId((int) ilObjStyleSheet::lookupObjectStyle($this->getId()));
        }

        public static function getCompleteDescriptions(array $objects)
        {
                global $ilSetting, $ilObjDataCache;
                // using long descriptions?
                $short_desc = $ilSetting->get("rep_shorten_description");
                $short_desc_max_length = $ilSetting->get("rep_shorten_description_length");
                if(!$short_desc || $short_desc_max_length != ilObject::DESC_LENGTH)
                {
                        // using (part of) shortened description
                        if($short_desc && $short_desc_max_length && $short_desc_max_length < ilObject::DESC_LENGTH)
                        {
                                foreach($objects as $key => $object)
                                {
                                        $objects[$key]["description"] = ilUtil::shortenText($object["description"], $short_desc_max_length, true);
                                }
                        }
                        // using (part of) long description
                        else
                        {
                                $obj_ids = array();
                                foreach($objects as $key => $object)
                                {
                                        $obj_ids[] = $object["obj_id"];
                                }
                                if(sizeof($obj_ids))
                                {
                                        $long_desc = ilObject::getLongDescriptions($obj_ids);
                                        foreach($objects as $key => $object)
                                        {
                                                // #12166 - keep translation, ignore long description
                                                if($ilObjDataCache->isTranslatedDescription($object["obj_id"]))
                                                {
                                                        $long_desc[$object["obj_id"]] = $object["description"];
                                                }
                                                if($short_desc && $short_desc_max_length)
                                                {
                                                        $long_desc[$object["obj_id"]] = ilUtil::shortenText($long_desc[$object["obj_id"]], $short_desc_max_length, true);
                                                }
                                                $objects[$key]["description"] = $long_desc[$object["obj_id"]];
                                        }
                                }
                        }
                }
                return $objects;
        }
        
} // END class ilContainer
?>