class.ilObject.php

Go to the documentation of this file.

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


class ilObject
{
        const TITLE_LENGTH = 128;


        var $ilias;

        var $lng;

        var $id;        // true object_id!!!!
        var $ref_id;// reference_id
        var $type;
        var $title;
        // BEGIN WebDAV: WebDAV needs to access the untranslated title of an object
        var $untranslatedTitle;
        // END WebDAV: WebDAV needs to access the untranslated title of an object
        var $desc;
        var $long_desc;
        var $owner;
        var $create_date;
        var $last_update;
        var $import_id;
        var $register = false;          // registering required for object? set to true to implement a subscription interface

        var $referenced;

        var $objectList;

        var $max_title;

        var $max_desc;

        var $add_dots;

        var $obj_data_record;

        function ilObject($a_id = 0, $a_reference = true)
        {
                global $ilias, $lng, $ilBench;

                $ilBench->start("Core", "ilObject_Constructor");

                if (DEBUG)
                {
                        echo "<br/><font color=\"red\">type(".$this->type.") id(".$a_id.") referenced(".$a_reference.")</font>";
                }

                $this->ilias =& $ilias;
                $this->lng =& $lng;

                $this->max_title = MAXLENGTH_OBJ_TITLE;
                $this->max_desc = MAXLENGTH_OBJ_DESC;
                $this->add_dots = true;

                $this->referenced = $a_reference;
                $this->call_by_reference = $a_reference;

                if ($a_id == 0)
                {
                        $this->referenced = false;              // newly created objects are never referenced
                }                                                                       // they will get referenced if createReference() is called

                if ($this->referenced)
                {
                        $this->ref_id = $a_id;
                }
                else
                {
                        $this->id = $a_id;
                }
                // read object data
                if ($a_id != 0)
                {
                        $this->read();
                }

                $ilBench->stop("Core", "ilObject_Constructor");
        }

        function withReferences()
        {
                // both vars could differ. this method should always return true if one of them is true without changing their status
                return ($this->call_by_reference) ? true : $this->referenced;
        }


        function read($a_force_db = false)
        {
                global $objDefinition, $ilBench, $ilDB, $log;

                $ilBench->start("Core", "ilObject_read");

                if (isset($this->obj_data_record) && !$a_force_db)
                {
                        $obj = $this->obj_data_record;
                }
                else if ($this->referenced)
                {
                        // check reference id
                        if (!isset($this->ref_id))
                        {
                                $message = "ilObject::read(): No ref_id given! (".$this->type.")";
                                $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                        }

                        // read object data
                        $ilBench->start("Core", "ilObject_read_readData");

                        $q = "SELECT * FROM object_data, object_reference WHERE object_data.obj_id=object_reference.obj_id ".
                                 "AND object_reference.ref_id= ".$ilDB->quote($this->ref_id, "integer");
                        $object_set = $ilDB->query($q);
                        $ilBench->stop("Core", "ilObject_read_readData");

                        // check number of records
                        if ($ilDB->numRows($object_set) == 0)
                        {
                                $message = "ilObject::read(): Object with ref_id ".$this->ref_id." not found! (".$this->type.")";
                                $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                        }

                        $obj = $ilDB->fetchAssoc($object_set);
                }
                else
                {
                        // check object id
                        if (!isset($this->id))
                        {
                                $message = "ilObject::read(): No obj_id given! (".$this->type.")";
                                $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                        }

                        // read object data
                        $q = "SELECT * FROM object_data ".
                                 "WHERE obj_id = ".$ilDB->quote($this->id, "integer");
                        $object_set = $ilDB->query($q);

                        // check number of records
                        if ($ilDB->numRows($object_set) == 0)
                        {
                                $message = "ilObject::read(): Object with obj_id: ".$this->id." (".$this->type.") not found!";
                                $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                        }

                        $obj = $ilDB->fetchAssoc($object_set);
                }

                $this->id = $obj["obj_id"];
                
                // check type match (the "xxx" type is used for the unit test)
                if ($this->type != $obj["type"] && $obj["type"] != "xxx")
                {
                        $message = "ilObject::read(): Type mismatch. Object with obj_id: ".$this->id." ".
                                "was instantiated by type '".$this->type."'. DB type is: ".$obj["type"];

                        // write log entry
                        $log->write($message);
                                
                        // raise error
                        $this->ilias->raiseError("ilObject::read(): Type mismatch. (".$this->type."/".$this->id.")",$this->ilias->error_obj->WARNING);
                }
                
                $this->type = $obj["type"];
                $this->title = $obj["title"];
                // BEGIN WebDAV: WebDAV needs to access the untranslated title of an object
                $this->untranslatedTitle = $obj["title"];
                // END WebDAV: WebDAV needs to access the untranslated title of an object
                $this->desc = $obj["description"];
                $this->owner = $obj["owner"];
                $this->create_date = $obj["create_date"];
                $this->last_update = $obj["last_update"];
                $this->import_id = $obj["import_id"];
                
                if($objDefinition->isRBACObject($this->getType()))
                {
                        // Read long description
                        $query = "SELECT * FROM object_description WHERE obj_id = ".$ilDB->quote($this->id,'integer');
                        $res = $this->ilias->db->query($query);
                        while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                        {
                                if(strlen($row->description))
                                {
                                        $this->setDescription($row->description);
                                }
                        }
                }

                // multilingual support systemobjects (sys) & categories (db)
                $ilBench->start("Core", "ilObject_Constructor_getTranslation");
                $translation_type = $objDefinition->getTranslationType($this->type);

                if ($translation_type == "sys")
                {
                        $this->title = $this->lng->txt("obj_".$this->type);
                        $this->desc = $this->lng->txt("obj_".$this->type."_desc");
                }
                elseif ($translation_type == "db")
                {
                        $q = "SELECT title,description FROM object_translation ".
                                 "WHERE obj_id = ".$ilDB->quote($this->id,'integer')." ".
                                 "AND lang_code = ".$ilDB->quote($this->ilias->account->getCurrentLanguage(),'text')." ".
                                 "AND NOT lang_default = 1";
                        $r = $this->ilias->db->query($q);
                        $row = $r->fetchRow(DB_FETCHMODE_OBJECT);

                        if ($row)
                        {
                                $this->title = $row->title;
                                $this->setDescription($row->description);
                                #$this->desc = $row->description;
                        }
                }

                $ilBench->stop("Core", "ilObject_Constructor_getTranslation");

                $ilBench->stop("Core", "ilObject_read");
        }

        function getId()
        {
                return $this->id;
        }

        function setId($a_id)
        {
                $this->id = $a_id;
        }

        function setRefId($a_id)
        {
                $this->ref_id = $a_id;
                $this->referenced = true;
        }

        function getRefId()
        {
                return $this->ref_id;
        }

        function getType()
        {
                return $this->type;
        }

        function setType($a_type)
        {
                $this->type = $a_type;
        }
        
        public function getPresentationTitle()
        {
                return $this->getTitle();
        }
        

        function getTitle()
        {
                return $this->title;
        }
        // BEGIN WebDAV: WebDAV needs to access the untranslated title of an object
        function getUntranslatedTitle()
        {
                return $this->untranslatedTitle;
        }
        // END WebDAV: WebDAV needs to access the untranslated title of an object

        function setTitle($a_title)
        {
                $this->title = ilUtil::shortenText($a_title, $this->max_title, $this->add_dots);
                // BEGIN WebDAV: WebDAV needs to access the untranslated title of an object
                $this->untranslatedTitle = $this->title;
                // END WebDAV: WebDAV needs to access the untranslated title of an object
        }

        function getDescription()
        {
                return $this->desc;
        }

        function setDescription($a_desc)
        {
                // Shortened form is storted in object_data. Long form is stored in object_description
                $this->desc = ilUtil::shortenText($a_desc, $this->max_desc, $this->add_dots);

                $this->long_desc = $a_desc;

                return true;
        }

        function getLongDescription()
        {
                return strlen($this->long_desc) ? $this->long_desc : $this->desc;
        }

        function getImportId()
        {
                return $this->import_id;
        }

        function setImportId($a_import_id)
        {
                $this->import_id = $a_import_id;
        }

        function _lookupObjIdByImportId($a_import_id)
        {
                global $ilDB;

                $query = "SELECT * FROM object_data ".
                        "WHERE import_id = ".$ilDB->quote($a_import_id, "text")." ".
                        "ORDER BY create_date DESC";
                $res = $ilDB->query($query);
                while($row = $ilDB->fetchObject($res))
                {
                        return $row->obj_id;
                }
                return 0;
        }

        function getOwner()
        {
                return $this->owner;
        }

        /*
        * get full name of object owner
        *
        * @access       public
        * @return       string  owner name or unknown
        */
        function getOwnerName()
        {
                return ilObject::_lookupOwnerName($this->getOwner());
        }

        function _lookupOwnerName($a_owner_id)
        {
                global $lng;

                if ($a_owner_id != -1)
                {
                        if (ilObject::_exists($a_owner_id))
                        {
                                $owner = new ilObjUser($a_owner_id);
                        }
                }

                if (is_object($owner))
                {
                        $own_name = $owner->getFullname();
                }
                else
                {
                        $own_name = $lng->txt("unknown");
                }

                return $own_name;
        }

        function setOwner($a_owner)
        {
                $this->owner = $a_owner;
        }



        function getCreateDate()
        {
                return $this->create_date;
        }

        function getLastUpdateDate()
        {
                return $this->last_update;
        }


        function getDiskUsage()
        {
                return null;
        }

        function setObjDataRecord($a_record)
        {
                $this->obj_data_record = $a_record;
        }

        function create()
        {
                global $ilDB, $log,$ilUser,$objDefinition;

                if (!isset($this->type))
                {
                        $message = get_class($this)."::create(): No object type given!";
                        $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                }

                // write log entry
                $log->write("ilObject::create(), start");

                $this->title = ilUtil::shortenText($this->getTitle(), $this->max_title, $this->add_dots);
                $this->desc = ilUtil::shortenText($this->getDescription(), $this->max_desc, $this->add_dots);
                
                // determine owner
                if ($this->getOwner() > 0)
                {
                        $owner = $this->getOwner();
                }
                elseif(is_object($ilUser))
                {
                        $owner = $ilUser->getId();
                }
                else
                {
                        $owner = 0;
                }
                $this->id = $ilDB->nextId("object_data");
                $q = "INSERT INTO object_data ".
                         "(obj_id,type,title,description,owner,create_date,last_update,import_id) ".
                         "VALUES ".
                         "(".
                         $ilDB->quote($this->id, "integer").",".
                         $ilDB->quote($this->type, "text").",".
                         $ilDB->quote($this->getTitle(), "text").",".
                         $ilDB->quote($this->getDescription(), "text").",".
                         $ilDB->quote($owner, "integer").",".
                         $ilDB->now().",".
                         $ilDB->now().",".
                         $ilDB->quote($this->getImportId(), "text").")";

                $ilDB->manipulate($q);

                //$this->id = $ilDB->getLastInsertId();

                
                // Save long form of description if is rbac object
                if($objDefinition->isRBACObject($this->getType()))
                {
                        $values = array(
                                'obj_id'                => array('integer',$this->id),
                                'description'   => array('clob', $this->getLongDescription()));
//var_dump($values);
                        $ilDB->insert('object_description',$values);
                }
                

                // the line ($this->read();) messes up meta data handling: meta data,
                // that is not saved at this time, gets lost, so we query for the dates alone
                //$this->read();
                $q = "SELECT last_update, create_date FROM object_data".
                         " WHERE obj_id = ".$ilDB->quote($this->id, "integer");
                $obj_set = $ilDB->query($q);
                $obj_rec = $ilDB->fetchAssoc($obj_set);
                $this->last_update = $obj_rec["last_update"];
                $this->create_date = $obj_rec["create_date"];

                // set owner for new objects
                $this->setOwner($owner);

                // write log entry
                $log->write("ilObject::create(), finished, obj_id: ".$this->id.", type: ".
                        $this->type.", title: ".$this->getTitle());

                $GLOBALS['ilAppEventHandler']->raise(
                        'Services/Object',
                        'create',
                        array('obj_id' => $this->id,'obj_type' => $this->type));

                return $this->id;
        }

        function update()
        {
                global $objDefinition, $ilDB;

                $q = "UPDATE object_data ".
                        "SET ".
                        "title = ".$ilDB->quote($this->getTitle(), "text").",".
                        "description = ".$ilDB->quote($this->getDescription(), "text").", ".
                        "import_id = ".$ilDB->quote($this->getImportId(), "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($q);

                // the line ($this->read();) messes up meta data handling: meta data,
                // that is not saved at this time, gets lost, so we query for the dates alone
                //$this->read();
                $q = "SELECT last_update FROM object_data".
                         " WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
                $obj_set = $ilDB->query($q);
                $obj_rec = $ilDB->fetchAssoc($obj_set);
                $this->last_update = $obj_rec["last_update"];

                if($objDefinition->isRBACObject($this->getType()))
                {
                        // Update long description
                        $res = $this->ilias->db->query("SELECT * FROM object_description WHERE obj_id = ".
                                $ilDB->quote($this->getId(),'integer'));
                        if($res->numRows())
                        {
                                $values = array(
                                        'description'   => array('clob',$this->getLongDescription())
                                        );
                                $ilDB->update('object_description',$values,array('obj_id' => array('integer',$this->getId())));
                        }
                        else
                        {
                                $values = array(
                                        'description'   => array('clob',$this->getLongDescription()),
                                        'obj_id'                => array('integer',$this->getId()));
                                $ilDB->insert('object_description',$values);
                        }
                }
                $GLOBALS['ilAppEventHandler']->raise(
                        'Services/Object',
                        'update',
                        array('obj_id' => $this->getId(),
                                'obj_type' => $this->getType(),
                                'ref_id' => $this->getRefId()));

                return true;
        }

        function MDUpdateListener($a_element)
        {
                include_once 'Services/MetaData/classes/class.ilMD.php';

                $GLOBALS['ilAppEventHandler']->raise(
                        'Services/Object',
                        'update',
                        array('obj_id' => $this->getId(),
                                'obj_type' => $this->getType(),
                                'ref_id' => $this->getRefId()));

                switch($a_element)
                {
                        case 'General':

                                // Update Title and description
                                $md = new ilMD($this->getId(),0, $this->getType());
                                if(!is_object($md_gen = $md->getGeneral()))
                                {
                                        return false;
                                }
                                $this->setTitle($md_gen->getTitle());

                                foreach($md_gen->getDescriptionIds() as $id)
                                {
                                        $md_des = $md_gen->getDescription($id);
                                        $this->setDescription($md_des->getDescription());
                                        break;
                                }
                                $this->update();
                                break;

                        default:
                }
                
                return true;
        }

        function createMetaData()
        {
                include_once 'Services/MetaData/classes/class.ilMDCreator.php';

                global $ilUser;

                $md_creator = new ilMDCreator($this->getId(),0,$this->getType());
                $md_creator->setTitle($this->getTitle());
                $md_creator->setTitleLanguage($ilUser->getPref('language'));
                $md_creator->setDescription($this->getLongDescription());
                $md_creator->setDescriptionLanguage($ilUser->getPref('language'));
                $md_creator->setKeywordLanguage($ilUser->getPref('language'));
                $md_creator->setLanguage($ilUser->getPref('language'));
                $md_creator->create();

                return true;
        }

        function updateMetaData()
        {
                include_once("Services/MetaData/classes/class.ilMD.php");
                include_once("Services/MetaData/classes/class.ilMDGeneral.php");
                include_once("Services/MetaData/classes/class.ilMDDescription.php");

                $md =& new ilMD($this->getId(), 0, $this->getType());
                $md_gen =& $md->getGeneral();
                // BEGIN WebDAV: meta data can be missing sometimes.
                if ($md_gen == null)
                {
                        $this->createMetaData();
                        $md =& new ilMD($this->getId(), 0, $this->getType());
                        $md_gen =& $md->getGeneral();
                }
                // END WebDAV: meta data can be missing sometimes.
                $md_gen->setTitle($this->getTitle());

                // sets first description (maybe not appropriate)
                $md_des_ids =& $md_gen->getDescriptionIds();
                if (count($md_des_ids) > 0)
                {
                        $md_des =& $md_gen->getDescription($md_des_ids[0]);
                        $md_des->setDescription($this->getLongDescription());
                        $md_des->update();
                }
                $md_gen->update();

        }

        function deleteMetaData()
        {
                // Delete meta data
                include_once('Services/MetaData/classes/class.ilMD.php');
                $md = new ilMD($this->getId(), 0, $this->getType());
                $md->deleteAll();
        }

    function updateOwner()
    {
                global $ilDB;
                
        $q = "UPDATE object_data ".
            "SET ".
            "owner = ".$ilDB->quote($this->getOwner(), "integer").", ".
            "last_update = ".$ilDB->now()." ".
            "WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);

        $q = "SELECT last_update FROM object_data".
             " WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
        $obj_set = $ilDB->query($q);
        $obj_rec = $ilDB->fetchAssoc($obj_set);
        $this->last_update = $obj_rec["last_update"];

        return true;
    }

        function _getIdForImportId($a_import_id)
        {
                global $ilDB;
                
                $ilDB->setLimit(1,0);
                $q = "SELECT * FROM object_data WHERE import_id = ".$ilDB->quote($a_import_id, "text").
                        " ORDER BY create_date DESC";
                $obj_set = $ilDB->query($q);

                if ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        return $obj_rec["obj_id"];
                }
                else
                {
                        return 0;
                }
        }

        public static function _getAllReferences($a_id)
        {
                global $ilDB;

                $query = "SELECT * FROM object_reference WHERE obj_id = ".
                        $ilDB->quote($a_id,'integer');
                        
                $res = $ilDB->query($query);
                $ref = array();
                while($obj_rec = $ilDB->fetchAssoc($res))
                {
                        $ref[$obj_rec["ref_id"]] = $obj_rec["ref_id"];
                }

                return $ref;
        }

        public static function _lookupTitle($a_id)
        {
                global $ilObjDataCache;

                $tit = $ilObjDataCache->lookupTitle($a_id);
//echo "<br>LOOKING-$a_id-:$tit";               
                return $tit;
        }
        
        function _lookupOwner($a_id)
        {
                global $ilObjDataCache;

                $owner = $ilObjDataCache->lookupOwner($a_id);
                return $owner;
        }

        public static function _getIdsForTitle($title, $type = '', $partialmatch = false)
        {
                global $ilDB;
                
                $query = (!$partialmatch)
                        ? "SELECT obj_id FROM object_data WHERE title = ".$ilDB->quote($title, "text")
                        : "SELECT obj_id FROM object_data WHERE ".$ilDB->like("title", "text", '%'.$title.'%');
                if($type != '')
                {
                        $query .= " AND type = ".$ilDB->quote($type, "text");
                }
                
                $result = $ilDB->query($query);
                
                $object_ids = array();
                while($row = $ilDB->fetchAssoc($result))
                {
                        $object_ids[] = $row['obj_id'];
                }
                
                return is_array($object_ids) ? $object_ids : array();
        }

        function _lookupDescription($a_id)
        {
                global $ilObjDataCache;

                return $ilObjDataCache->lookupDescription($a_id);
        }

        function _lookupLastUpdate($a_id, $a_as_string = false)
        {
                global $ilObjDataCache;
                
                if ($a_as_string)
                {
                        return ilDatePresentation::formatDate(new ilDateTime($ilObjDataCache->lookupLastUpdate($a_id),IL_CAL_DATETIME));
                }
                else
                {
                        return $ilObjDataCache->lookupLastUpdate($a_id);
                }
        }

        function _getLastUpdateOfObjects($a_objs)
        {
                global $ilDB;
                
                if (!is_array($a_objs))
                {
                        $a_objs = array($a_objs);
                }
                $types = array();
                $set = $ilDB->query("SELECT max(last_update) as last_update FROM object_data ".
                        "WHERE ".$ilDB->in("obj_id", $a_objs, false, "integer")." ");
                $rec = $ilDB->fetchAssoc($set);
                
                return ($rec["last_update"]);
        }

        public static function _lookupObjId($a_id)
        {
                global $ilObjDataCache;

                return (int) $ilObjDataCache->lookupObjId($a_id);
        }
        
        function _setDeletedDate($a_ref_id)
        {
                global $ilDB;
                
                $query = "UPDATE object_reference SET deleted= ".$ilDB->now().' '.
                        "WHERE ref_id = ".$ilDB->quote($a_ref_id,'integer');
                $res = $ilDB->manipulate($query);
        }

        function _resetDeletedDate($a_ref_id)
        {
                global $ilDB;
                
                $query = "UPDATE object_reference SET deleted = ".$ilDB->quote(null,'timestamp').
                        " WHERE ref_id = ".$ilDB->quote($a_ref_id,'integer');
                $res = $ilDB->manipulate($query);
        }
        
        function _lookupDeletedDate($a_ref_id)
        {
                global $ilDB;
                
                $query = "SELECT deleted FROM object_reference".
                        " WHERE ref_id = ".$ilDB->quote($a_ref_id, "integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);

                return $rec["deleted"];
        }


        function _writeTitle($a_obj_id, $a_title)
        {
                global $ilDB;

                $q = "UPDATE object_data ".
                        "SET ".
                        "title = ".$ilDB->quote($a_title, "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer");

                $ilDB->manipulate($q);
        }

        function _writeDescription($a_obj_id, $a_desc)
        {
                global $ilDB,$objDefinition;


                $desc = ilUtil::shortenText($a_desc,MAXLENGTH_OBJ_DESC,true);

                $q = "UPDATE object_data ".
                        "SET ".
                        "description = ".$ilDB->quote($desc, "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer");

                $ilDB->manipulate($q);

                if($objDefinition->isRBACObject($this->getType()))
                {
                        // Update long description
                        $res = $ilDB->query("SELECT * FROM object_description WHERE obj_id = ".
                                $ilDB->quote($a_obj_id,'integer'));

                        if($res->numRows())
                        {
                                $values = array(
                                        'description'   => array('clob',$this->getLongDescription())
                                        );
                                $ilDB->update('object_description',$values,array('obj_id' => array('integer',$this->getId())));
                        }
                        else
                        {
                                $values = array(
                                        'description'   => array('clob',$this->getLongDescription()),
                                        'obj_id'                => array('integer',$this->getId()));
                                $ilDB->insert('object_description',$values);
                        }
                }
        }

        function _writeImportId($a_obj_id, $a_import_id)
        {
                global $ilDB;

                $q = "UPDATE object_data ".
                        "SET ".
                        "import_id = ".$ilDB->quote($a_import_id, "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer");

                $ilDB->manipulate($q);
        }

        public static function _lookupType($a_id,$a_reference = false)
        {
                global $ilObjDataCache;

                if($a_reference)
                {
                        return $ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($a_id));
                }
                return $ilObjDataCache->lookupType($a_id);

                global $ilDB;

                if ($a_reference === true)
                {
                        $q = "SELECT type FROM object_reference obr, object_data obd ".
                                "WHERE obr.ref_id = ".$ilDB->quote($a_id, "integer")." ".
                                "AND obr.obj_id = obd.obj_id ";
                }
                else
                {
                        $q = "SELECT type FROM object_data WHERE obj_id = ".$ilDB->quote($a_id, "integer");
                }

                $obj_set = $ilDB->query($q);
                $obj_rec = $ilDB->fetchAssoc($obj_set);

                return $obj_rec["type"];
        }

        function _isInTrash($a_ref_id)
        {
                global $tree;

                return $tree->isSaved($a_ref_id);
        }

        function _hasUntrashedReference($a_obj_id)
        {
                $ref_ids  = ilObject::_getAllReferences($a_obj_id);
                foreach($ref_ids as $ref_id)
                {
                        if(!ilObject::_isInTrash($ref_id))
                        {
                                return true;
                        }
                }

                return false;
        }

        function _lookupObjectId($a_ref_id)
        {
                global $ilObjDataCache;

                return (int) $ilObjDataCache->lookupObjId($a_ref_id);
        }

        function _getObjectsDataForType($a_type, $a_omit_trash = false)
        {
                global $ilDB;

                $q = "SELECT * FROM object_data WHERE type = ".$ilDB->quote($a_type, "text");
                $obj_set = $ilDB->query($q);

                $objects = array();
                while ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        if ((!$a_omit_trash) || ilObject::_hasUntrashedReference($obj_rec["obj_id"]))
                        {
                                $objects[$obj_rec["title"].".".$obj_rec["obj_id"]] = array("id" => $obj_rec["obj_id"],
                                        "type" => $obj_rec["type"], "title" => $obj_rec["title"],
                                        "description" => $obj_rec["description"]);
                        }
                }
                ksort($objects);
                return $objects;
        }

        function putInTree($a_parent_ref)
        {
                global $tree, $log;

                $tree->insertNode($this->getRefId(), $a_parent_ref);
                
                // write log entry
                $log->write("ilObject::putInTree(), parent_ref: $a_parent_ref, ref_id: ".
                        $this->getRefId().", obj_id: ".$this->getId().", type: ".
                        $this->getType().", title: ".$this->getTitle());

        }

        function setPermissions($a_parent_ref)
        {
                global $rbacadmin, $rbacreview;

                $parentRoles = $rbacreview->getParentRoleIds($a_parent_ref);

                foreach ($parentRoles as $parRol)
                {
                        $ops = $rbacreview->getOperationsOfRole($parRol["obj_id"], $this->getType(), $parRol["parent"]);
                        $rbacadmin->grantPermission($parRol["obj_id"], $ops, $this->getRefId());
                }

                $this->initDefaultRoles();
        }

        function createReference()
        {
                global $ilDB;

                if (!isset($this->id))
                {
                        $message = "ilObject::createNewReference(): No obj_id given!";
                        $this->raiseError($message,$this->ilias->error_obj->WARNING);
                }

                $next_id = $ilDB->nextId('object_reference');
                $query = "INSERT INTO object_reference ".
                         "(ref_id, obj_id) VALUES (".$ilDB->quote($next_id,'integer').','.$ilDB->quote($this->id ,'integer').")";
                $this->ilias->db->query($query);

                $this->ref_id = $next_id;
                $this->referenced = true;

                return $this->ref_id;
        }


        function countReferences()
        {
                global $ilDB;
                
                if (!isset($this->id))
                {
                        $message = "ilObject::countReferences(): No obj_id given!";
                        $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                }

                $query = "SELECT COUNT(ref_id) num FROM object_reference ".
                        "WHERE obj_id = ".$ilDB->quote($this->id,'integer')." ";
                $res = $ilDB->query($query);
                $row = $ilDB->fetchObject($res);

                return $row->num;
        }




        function delete()
        {
                global $rbacadmin, $log, $ilDB;

                $remove = false;

                // delete object_data entry
                if ((!$this->referenced) || ($this->countReferences() == 1))
                {
                        // check type match
                        $db_type = ilObject::_lookupType($this->getId());
                        if ($this->type != $db_type)
                        {
                                $message = "ilObject::delete(): Type mismatch. Object with obj_id: ".$this->id." ".
                                        "was instantiated by type '".$this->type."'. DB type is: ".$db_type;
                                        
                                // write log entry
                                $log->write($message);
                                        
                                // raise error
                                $this->ilias->raiseError("ilObject::delete(): Type mismatch. (".$this->type."/".$this->id.")",$this->ilias->error_obj->WARNING);
                        }

                        // delete entry in object_data
                        $q = "DELETE FROM object_data ".
                                "WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
                        $ilDB->manipulate($q);

                        // delete long description
                        $query = "DELETE FROM object_description WHERE obj_id = ".
                                $ilDB->quote($this->getId(), "integer");
                        $ilDB->manipulate($query);

                        // write log entry
                        $log->write("ilObject::delete(), deleted object, obj_id: ".$this->getId().", type: ".
                                $this->getType().", title: ".$this->getTitle());
                        
                        // remove news
                        include_once("./Services/News/classes/class.ilNewsItem.php");
                        $news_item = new ilNewsItem();
                        $news_item->deleteNewsOfContext($this->getId(), $this->getType());
                        include_once("./Services/Block/classes/class.ilBlockSetting.php");
                        ilBlockSetting::_deleteSettingsOfBlock($this->getId(), "news");

                        $remove = true;
                }
                else
                {
                        // write log entry
                        $log->write("ilObject::delete(), object not deleted, number of references: ".
                                $this->countReferences().", obj_id: ".$this->getId().", type: ".
                                $this->getType().", title: ".$this->getTitle());
                }

                // delete object_reference entry
                if ($this->referenced)
                {
                        // delete entry in object_reference
                        $query = "DELETE FROM object_reference ".
                                "WHERE ref_id = ".$ilDB->quote($this->getRefId(),'integer');
                        $res = $ilDB->manipulate($query);
                        
                        // write log entry
                        $log->write("ilObject::delete(), reference deleted, ref_id: ".$this->getRefId().
                                ", obj_id: ".$this->getId().", type: ".
                                $this->getType().", title: ".$this->getTitle());

                        // DELETE PERMISSION ENTRIES IN RBAC_PA
                        // DONE: method overwritten in ilObjRole & ilObjUser.
                        // this call only applies for objects in rbac (not usr,role,rolt)
                        // TODO: Do this for role templates too
                        $rbacadmin->revokePermission($this->getRefId(),0,false);

                        include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                        ilRbacLog::delete($this->getRefId());

                        // Remove desktop items
                        ilUtil::removeItemFromDesktops($this->getRefId());
                }

                // remove conditions
                if ($this->referenced)
                {
                        $ch =& new ilConditionHandler();
                        $ch->delete($this->getRefId());
                        unset($ch);
                }

                // BEGIN WebDAV: Delete WebDAV properties
                $query = "DELETE FROM dav_property ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(),'integer');
                $res = $ilDB->manipulate($query);
                // END WebDAV: Delete WebDAV properties

                include_once './Services/Tracking/classes/class.ilChangeEvent.php';
                ilChangeEvent::_delete($this->getId());

                return $remove;
        }

        function initDefaultRoles()
        {
                return array();
        }
        
        function createRoleFolder()
        {
                global $rbacreview;
                
                // does a role folder already exists?
                // (this check is only 'to be sure' that no second role folder is created under one object.
                // the if-construct should never return true)
                if ($rolf_data = $rbacreview->getRoleFolderofObject($this->getRefId()))
                {
                        $rfoldObj = $this->ilias->obj_factory->getInstanceByRefId($rolf_data["ref_id"]);
                }
                else
                {
                        include_once ("./Services/AccessControl/classes/class.ilObjRoleFolder.php");
                        $rfoldObj = new ilObjRoleFolder();
                        $rfoldObj->setTitle($this->getId());
                        $rfoldObj->setDescription(" (ref_id ".$this->getRefId().")");
                        $rfoldObj->create();
                        $rfoldObj->createReference();
                        $rfoldObj->putInTree($this->getRefId());
                        $rfoldObj->setPermissions($this->getRefId());
                }
                
                return $rfoldObj;
        }

        function _exists($a_id, $a_reference = false)
        {
                global $ilias, $ilDB;
                
                if ($a_reference)
                {
                        $q = "SELECT * FROM object_data ".
                                 "LEFT JOIN object_reference ON object_reference.obj_id=object_data.obj_id ".
                                 "WHERE object_reference.ref_id= ".$ilDB->quote($a_id, "integer");
                }
                else
                {
                        $q = "SELECT * FROM object_data WHERE obj_id=".$ilDB->quote($a_id, "integer");
                }
                
                $r = $ilDB->query($q);

                return $ilDB->numRows($r) ? true : false;
        }

        function notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params = 0)
        { 
                global $tree;
                
                $parent_id = (int) $tree->getParentId($a_node_id);
                
                if ($parent_id != 0)
                {
                        $obj_data =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                        $obj_data->notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$parent_id,$a_params);
                }
                                
                return true;
        }
        
        // toggle subscription interface
        function setRegisterMode($a_bool)
        {
                $this->register = (bool) $a_bool;
        }
        
        // check register status of current user
        // abstract method; overwrite in object type class
        function isUserRegistered($a_user_id = 0)
        {
                return false;
        }

        function requireRegistration()
        {
                return $this->register;
        }


        function getXMLZip()
        {
                return false;
        }
        function getHTMLDirectory()
        {
                return false;
        }

        static function _getObjectsByType($a_obj_type = "", $a_owner = "")
        {
                global $ilDB;
                                
                $order = " ORDER BY title";

                // where clause
                if ($a_obj_type)
                {
                        $where_clause = "WHERE type = ".
                                $ilDB->quote($a_obj_type, "text");
                                
                        if ($a_owner != "")
                        {
                                $where_clause.= " AND owner = ".$ilDB->quote($a_owner, "integer");
                        }
                }
        
                $q = "SELECT * FROM object_data ".$where_clause.$order;
                $r = $ilDB->query($q);

                $arr = array();
                if ($ilDB->numRows($r) > 0)
                {
                        while ($row = $ilDB->fetchAssoc($r))
                        {
                                $row["desc"] = $row["description"];
                                $arr[$row["obj_id"]] = $row;
                        }
                }
        
                return $arr;
        }
        
        public static function _prepareCloneSelection($a_ref_ids,$new_type)
        {
                global $ilDB,$lng,$objDefinition;
                
                $query = "SELECT obj_data.title obj_title,path_data.title path_title,child FROM tree ".
                        "JOIN object_reference obj_ref ON child = obj_ref.ref_id ".
                        "JOIN object_data obj_data ON obj_ref.obj_id = obj_data.obj_id ".
                        "JOIN object_reference path_ref ON parent = path_ref.ref_id ".
                        "JOIN object_data path_data ON path_ref.obj_id = path_data.obj_id ".
                        "WHERE ".$ilDB->in("child", $a_ref_ids, false, "integer")." ".
                        "ORDER BY obj_data.title ";
                $res = $ilDB->query($query);
                
                if (!$objDefinition->isPlugin($new_type))
                {
                        $options[0] = $lng->txt('obj_'.$new_type.'_select');
                }
                else
                {
                        include_once("./Services/Component/classes/class.ilPlugin.php");
                        $options[0] = ilPlugin::lookupTxt("rep_robj", $new_type, "obj_".$new_type."_select");
                }

                while($row = $ilDB->fetchObject($res))
                {
                        if(strlen($title = $row->obj_title) > 40)
                        {
                                $title = substr($title,0,40).'...';
                        }
                        if(strlen($path = $row->path_title) > 40)
                        {
                                $path = substr($path,0,40).'...';
                        }
                        
                        
                        $options[$row->child] = ($title.' ('.$lng->txt('path').': '.$path.')');
                }
                return $options ? $options : array();
        }

        public function cloneObject($a_target_id,$a_copy_id = 0)
        {
                global $objDefinition,$ilUser,$rbacadmin, $ilDB;
                
                $location = $objDefinition->getLocation($this->getType());
                $class_name = ('ilObj'.$objDefinition->getClassName($this->getType()));
                
                $title = $this->appendCopyInfo($a_target_id,$a_copy_id);

                // create instance
                include_once($location."/class.".$class_name.".php");
                $new_obj = new $class_name(0, false);
                $new_obj->setOwner($ilUser->getId());
                $new_obj->setTitle($title);
                $new_obj->setDescription($this->getLongDescription());
                $new_obj->setType($this->getType());
                // Choose upload mode to avoid creation of additional settings, db entries ...
                $new_obj->create(true);
                $new_obj->createReference();
                $new_obj->putInTree($a_target_id);
                $new_obj->setPermissions($a_target_id);
                
                // copy local roles
                $rbacadmin->copyLocalRoles($this->getRefId(),$new_obj->getRefId());
                
                include_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                ilAdvancedMDValues::_cloneValues($this->getId(),$new_obj->getId());

                // BEGIN WebDAV: Clone WebDAV properties
                $query = "INSERT INTO dav_property (obj_id,node_id,ns,name,value) ".
                        "SELECT ".$ilDB->quote($new_obj->getId(),'integer').",node_id,ns,name,value ".
                        "FROM dav_property ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(),'integer');
                $res = $ilDB->manipulate($query);
                // END WebDAV: Clone WebDAV properties
                
                return $new_obj;
        }
        
        public function appendCopyInfo($a_target_id,$a_copy_id)
        {
                global $tree;
                
                include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
                if(!$cp_options->isRootNode($this->getRefId()))
                {
                        return $this->getTitle();
                }
                $nodes = $tree->getChilds($a_target_id);
                
                $title_unique = false;
                require_once 'Modules/File/classes/class.ilObjFileAccess.php';
                $numberOfCopy = 1;
                $title = ilObjFileAccess::_appendNumberOfCopyToFilename($this->getTitle(), $numberOfCopy);
                while(!$title_unique)
                {
                        $found = 0;
                        foreach($nodes as $node)
                        {
                                if(($title == $node['title']) and ($this->getType() == $node['type']))
                                {
                                        $found++;
                                }
                        }
                        if($found > 0)
                        {
                                $title = ilObjFileAccess::_appendNumberOfCopyToFilename($this->getTitle(), ++$numberOfCopy);
                        }
                        else
                        {
                                break;
                        }
                }
                return $title;
        }       
        
        public function cloneDependencies($a_target_id,$a_copy_id)
        {
                return true;
                
                //include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                //$cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
                //$mappings = $cwo->getMappings();

        }
        
        public function cloneMetaData($target_obj)
        {
                include_once "./Services/MetaData/classes/class.ilMD.php";
                $md = new ilMD($this->getId(),0,$this->getType());
                $md->cloneMD($target_obj->getId(),0,$target_obj->getType());
                return true;            
        }
        
        public static function _getIcon($a_obj_id = "", $a_size = "big", $a_type = "",
                $a_offline = false)
        {
                global $ilSetting, $objDefinition;
                
                if ($a_obj_id == "" && $a_type == "")
                {
                        return "";
                }
                
                if ($a_type == "")
                {
                        $a_type = ilObject::_lookupType($a_obj_id);
                }
                
                if ($a_size == "")
                {
                        $a_size = "big";
                }
                
                if ($ilSetting->get("custom_icons") &&
                        in_array($a_type, array("cat","grp","crs", "root")))
                {
                        require_once("./Services/Container/classes/class.ilContainer.php");
                        if (ilContainer::_lookupContainerSetting($a_obj_id, "icon_".$a_size))
                        {
                                $cont_dir = ilContainer::_getContainerDirectory($a_obj_id);
                                $file_name = $cont_dir."/icon_".$a_size.".gif";
        
                                if (is_file($file_name))
                                {
                                        return $file_name;
                                }
                        }
                }
                
                switch($a_size)
                {
                        case "small": $suff = ""; break;
                        case "tiny": $suff = "_s"; break;
                        default: $suff = "_b"; break;
                }
                if (!$a_offline)
                {
                        if ($objDefinition->isRBACObject($a_type))
                        {
                                if (!$objDefinition->isPlugin($a_type))
                                {
                                        return ilUtil::getImagePath("icon_".$a_type.$suff.".gif");
                                }
                                else
                                {
                                        include_once("./Services/Repository/classes/class.ilRepositoryObjectPlugin.php");
                                        return ilRepositoryObjectPlugin::_getIcon($a_type, $a_size);
                                }
                        }
                        return ilUtil::getImagePath("icon_".$a_type.$suff.".gif");
                }
                else
                {
                        return "./images/icon_".$a_type.$suff.".gif";
                }
        }

        static final function collectDeletionDependencies(&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth = 0)
        {
                global $objDefinition, $tree;

                if ($a_depth == 0)
                {
                        $deps["dep"] = array();
                }
                
                $deps["del_ids"][$a_obj_id] = $a_obj_id;
                
                if (!$objDefinition->isPlugin($type))
                {
                        $class_name = "ilObj".$objDefinition->getClassName($a_type);
                        $location = $objDefinition->getLocation($a_type);
                        include_once($location."/class.".$class_name.".php");
                        $odeps = call_user_func(array($class_name, "getDeletionDependencies"), $a_obj_id);
                        if (is_array($odeps))
                        {
                                foreach ($odeps as $id => $message)
                                {
                                        $deps["dep"][$id][$a_obj_id][] = $message;
                                }
                        }
                        
                        // get deletion dependency of childs
                        foreach ($tree->getChilds($a_ref_id) as $c)
                        {
                                ilObject::collectDeletionDependencies($deps, $c["child"], $c["obj_id"], $c["type"], $a_depth + 1);
                        }
                }
                
                // delete all dependencies to objects that will be deleted, too
                if ($a_depth == 0)
                {
                        foreach ($deps["del_ids"] as $obj_id)
                        {
                                unset($deps["dep"][$obj_id]);
                        }
                        $deps = $deps["dep"];
                }               
        }
        
        static function getDeletionDependencies($a_obj_id)
        {
                return false;   
        }
} // END class.ilObject
?>