Modules/LearningModule/classes/class.ilLMObject.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2008 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. |
        +-----------------------------------------------------------------------------+
*/

require_once("Services/MetaData/classes/class.ilMDLanguageItem.php");

class ilLMObject
{
        var $ilias;
        var $lm_id;
        var $type;
        var $id;
        var $meta_data;
        var $data_record;               // assoc array of lm_data record
        var $content_object;
        var $title;
        var $description;
        var $active = true;

        function ilLMObject(&$a_content_obj, $a_id = 0)
        {
                global $ilias;

                $this->ilias =& $ilias;
                $this->id = $a_id;
                $this->setContentObject($a_content_obj);
                $this->setLMId($a_content_obj->getId());
                if($a_id != 0)
                {
                        $this->read();
                }
        }

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

                switch($a_element)
                {
                        case 'General':

                                // Update Title and description
                                $md = new ilMD($this->getLMId(), $this->getId(), $this->getType());
                                $md_gen = $md->getGeneral();

                                ilLMObject::_writeTitle($this->getId(),$md_gen->getTitle());

                                foreach($md_gen->getDescriptionIds() as $id)
                                {
                                        $md_des = $md_gen->getDescription($id);
//                                      ilLMObject::_writeDescription($this->getId(),$md_des->getDescription());
                                        break;
                                }

                                break;

                        default:
                }
                return true;
        }


        function _lookupNID($a_lm_id, $a_lm_obj_id, $a_type)
        {
                include_once 'Services/MetaData/classes/class.ilMD.php';
//echo "-".$a_lm_id."-".$a_lm_obj_id."-".$a_type."-";
                $md = new ilMD($a_lm_id, $a_lm_obj_id, $a_type);
                $md_gen = $md->getGeneral();
                foreach($md_gen->getIdentifierIds() as $id)
                {
                        $md_id = $md_gen->getIdentifier($id);
                        if ($md_id->getCatalog() == "ILIAS_NID")
                        {
                                return $md_id->getEntry();
                        }
                }
                
                return false;
        }


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

                global $ilUser;

                $md_creator = new ilMDCreator($this->getLMId(), $this->getId(), $this->getType());
                $md_creator->setTitle($this->getTitle());
                $md_creator->setTitleLanguage($ilUser->getPref('language'));
                $md_creator->setDescription($this->getDescription());
                $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->getLMId(), $this->getId(), $this->getType());
                $md_gen =& $md->getGeneral();
                $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->getDescription());
                        $md_des->update();
                }
                $md_gen->update();

        }


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



        function setDataRecord($a_record)
        {
                $this->data_record = $a_record;
        }

        function read()
        {
                global $ilBench, $ilDB;

                $ilBench->start("ContentPresentation", "ilLMObject_read");

                if(!isset($this->data_record))
                {
                        $ilBench->start("ContentPresentation", "ilLMObject_read_getData");
                        $query = "SELECT * FROM lm_data WHERE obj_id = ".$ilDB->quote($this->id);
                        $obj_set = $this->ilias->db->query($query);
                        $this->data_record = $obj_set->fetchRow(DB_FETCHMODE_ASSOC);
                        $ilBench->stop("ContentPresentation", "ilLMObject_read_getData");
                }

                $this->type = $this->data_record["type"];
                $this->setImportId($this->data_record["import_id"]);
                $this->setTitle($this->data_record["title"]);
                $this->setActive(ilUtil::yn2tf($this->data_record["active"]));

                $ilBench->stop("ContentPresentation", "ilLMObject_read");
        }

        function setTitle($a_title)
        {
                $this->title = $a_title;
        }

        function getTitle()
        {
                return $this->title;
        }


        function _lookupTitle($a_obj_id)
        {
                global $ilDB;

                $query = "SELECT * FROM lm_data WHERE obj_id = ".$ilDB->quote($a_obj_id);
                $obj_set = $ilDB->query($query);
                $obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC);

                return $obj_rec["title"];
        }
        
        function _lookupType($a_obj_id)
        {
                global $ilDB;

                $query = "SELECT * FROM lm_data WHERE obj_id = ".$ilDB->quote($a_obj_id);
                $obj_set = $ilDB->query($query);
                $obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC);

                return $obj_rec["type"];
        }


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

                $query = "UPDATE lm_data SET ".
                        " title = ".$ilDB->quote($a_title).
                        " WHERE obj_id = ".$ilDB->quote($a_obj_id);
                $ilDB->query($query);
        }


        function setDescription($a_description)
        {
                $this->description = $a_description;
        }

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

        function setType($a_type)
        {
                $this->type = $a_type;
        }

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

        function setLMId($a_lm_id)
        {
                $this->lm_id = $a_lm_id;

        }

        function getLMId()
        {
                return $this->lm_id;
        }

        function setContentObject(&$a_content_obj)
        {
                $this->content_object =& $a_content_obj;
        }

        function &getContentObject()
        {
                return $this->content_object;
        }

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

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

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

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

        function setActive($a_active)
        {
                $this->active = $a_active;
        }

        function getActive()
        {
                return $this->active;
        }

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

                $q = "UPDATE lm_data ".
                        "SET ".
                        "import_id = ".$ilDB->quote($a_import_id).",".
                        "last_update = now() ".
                        "WHERE obj_id = ".$ilDB->quote($a_id);

                $ilDB->query($q);
        }

        function create($a_upload = false)
        {
                global $ilDB;

                // insert object data
                $query = "INSERT INTO lm_data (title, type, lm_id, import_id, create_date, active) ".
                        "VALUES (".$ilDB->quote($this->getTitle()).",".$ilDB->quote($this->getType()).", ".
                        $ilDB->quote($this->getLMId()).",".$ilDB->quote($this->getImportId()).
                        ", now(),".$ilDB->quote(ilUtil::tf2yn($this->getActive())).")";
                $this->ilias->db->query($query);
                $this->setId($this->ilias->db->getLastInsertId());

                // create history entry
                include_once("classes/class.ilHistory.php");
                ilHistory::_createEntry($this->getId(), "create", "",
                        $this->content_object->getType().":".$this->getType());

                if (!$a_upload)
                {
                        $this->createMetaData();
                }

        }

        function update()
        {
                global $ilDB;

                $this->updateMetaData();

                $query = "UPDATE lm_data SET ".
                        " lm_id = ".$ilDB->quote($this->getLMId()).
                        " ,title = ".$ilDB->quote($this->getTitle()).
                        " ,active = ".$ilDB->quote(ilUtil::tf2yn($this->getActive())).
                        " WHERE obj_id = ".$ilDB->quote($this->getId());

                $ilDB->query($query);
        }


        function _writePublicAccessStatus($a_pages,$a_cont_obj_id)
        {
                global $ilDB,$ilLog,$ilErr,$ilTree;
                
                if (!is_array($a_pages))
                {$a_pages = array(0);
                        /*$message = sprintf('ilLMObject::_writePublicAccessStatus(): Invalid parameter! $a_pages must be an array');
                        $ilLog->write($message,$ilLog->WARNING);
                        $ilErr->raiseError($message,$ilErr->MESSAGE);
                        return false;*/
                }
                
                if (empty($a_cont_obj_id))
                {
                        $message = sprintf('ilLMObject::_writePublicAccessStatus(): Invalid parameter! $a_cont_obj_id is empty');
                        $ilLog->write($message,$ilLog->WARNING);
                        $ilErr->raiseError($message,$ilErr->MESSAGE);
                        return false;
                }
                
                // update structure entries: if at least one page of a chapter is public set chapter to public too
                $lm_tree = new ilTree($a_cont_obj_id);
                $lm_tree->setTableNames('lm_tree','lm_data');
                $lm_tree->setTreeTablePK("lm_id");
                $lm_tree->readRootId();
                
                // get all st entries of cont_obj
                $q = "SELECT obj_id FROM lm_data " . 
                         "WHERE lm_id = ".$ilDB->quote($a_cont_obj_id)." " .
                         "AND type = 'st'";
                $r = $ilDB->query($q);
                
                // add chapters with a public page to a_pages
                while ($row = $r->fetchRow())
                {
                        $childs = $lm_tree->getChilds($row[0]);
                        
                        foreach ($childs as $page)
                        {
                                if ($page["type"] == "pg" and in_array($page["obj_id"],$a_pages))
                                {
                                        array_push($a_pages, $row[0]);
                                        break;
                                }
                        }
                }
                
                // update public access status of all pages of cont_obj
                $q = "UPDATE lm_data SET " .
                         "public_access = CASE " .
                         "WHEN obj_id IN (".implode(',',ilUtil::quoteArray($a_pages)).") " .
                         "THEN 'y' ".
                         "ELSE 'n' ".
                         "END " .
                         "WHERE lm_id = ".$ilDB->quote($a_cont_obj_id)." " .
                         "AND type IN ('pg','st')";
                $ilDB->query($q);
                
                return true;
        }
        
        function _isPagePublic($a_node_id,$a_check_public_mode = false)
        {
                global $ilDB,$ilLog;

                if (empty($a_node_id))
                {
                        $message = sprintf('ilLMObject::_isPagePublic(): Invalid parameter! $a_node_id is empty');
                        $ilLog->write($message,$ilLog->WARNING);
                        return false;
                }
                
                if ($a_check_public_mode === true)
                {
                        $lm_id = ilLMObject::_lookupContObjId($a_node_id);

                        $q = "SELECT public_access_mode FROM content_object WHERE id=".$ilDB->quote($lm_id);
                        $r = $ilDB->query($q);
                        $row = $r->fetchRow();
                        
                        if ($row[0] == "complete")
                        {
                                return true;
                        }
                }

                $q = "SELECT public_access FROM lm_data WHERE obj_id=".$ilDB->quote($a_node_id);
                $r = $ilDB->query($q);
                $row = $r->fetchRow();
                
                return ilUtil::yn2tf($row[0]);
        }

        function delete($a_delete_meta_data = true)
        {
                global $ilDB;
                
                $query = "DELETE FROM lm_data WHERE obj_id= ".$ilDB->quote($this->getId());
                $this->ilias->db->query($query);

                $this->deleteMetaData();
        }

        function _getIdForImportId($a_import_id)
        {
                global $ilDB;
                
                $q = "SELECT * FROM lm_data WHERE import_id = ".$ilDB->quote($a_import_id)." ".
                        " ORDER BY create_date DESC LIMIT 1";
                $obj_set = $ilDB->query($q);
                while ($obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $lm_id = ilLMObject::_lookupContObjID($obj_rec["obj_id"]);

                        // link only in learning module, that is not trashed
                        if (ilObject::_hasUntrashedReference($lm_id))
                        {
                                return $obj_rec["obj_id"];
                        }
                }

                return 0;
        }

        function _getAllObjectsForImportId($a_import_id)
        {
                global $ilDB;
                
                $q = "SELECT * FROM lm_data WHERE import_id = ".$ilDB->quote($a_import_id)." ".
                        " ORDER BY create_date DESC";
                $obj_set = $ilDB->query($q);
                
                $items = array();
                while ($obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        // check, whether lm is not trashed
                        if (ilObject::_hasUntrashedReference($obj_rec["lm_id"]))
                        {
                                $items[] = $obj_rec;
                        }
                }

                return $items;
        }

        function _exists($a_id)
        {
                global $ilDB;
                
                include_once("./Services/COPage/classes/class.ilInternalLink.php");
                if (is_int(strpos($a_id, "_")))
                {
                        $a_id = ilInternalLink::_extractObjIdOfTarget($a_id);
                }
                
                $q = "SELECT * FROM lm_data WHERE obj_id = ".$ilDB->quote($a_id);
                $obj_set = $ilDB->query($q);
                if ($obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        return true;
                }
                else
                {
                        return false;
                }

        }

        function getObjectList($lm_id, $type = "")
        {
                global $ilDB;
                
                $type_str = ($type != "")
                        ? "AND type = ".$ilDB->quote($type)." "
                        : "";
                $query = "SELECT * FROM lm_data ".
                        "WHERE lm_id= ".$ilDB->quote($lm_id)." ".
                        $type_str." ".
                        "ORDER BY title";
                $obj_set = $ilDB->query($query);
                $obj_list = array();
                while($obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $obj_list[] = array("obj_id" => $obj_rec["obj_id"],
                                                                "title" => $obj_rec["title"],
                                                                "type" => $obj_rec["type"]);
                }
                return $obj_list;
        }


        function _deleteAllObjectData(&$a_cobj)
        {
                global $ilDB;
                
                include_once './classes/class.ilNestedSetXML.php';

                $query = "SELECT * FROM lm_data ".
                        "WHERE lm_id= ".$ilDB->quote($a_cobj->getId())." ";
                $obj_set = $this->ilias->db->query($query);

                require_once("./Modules/LearningModule/classes/class.ilLMObjectFactory.php");
                while($obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $lm_obj =& ilLMObjectFactory::getInstance($a_cobj, $obj_rec["obj_id"],false);

                        if (is_object($lm_obj))
                        {
                                $lm_obj->delete(true);
                        }
                }

                return true;
        }

        function _lookupContObjID($a_id)
        {
                global $ilDB;

                $query = "SELECT * FROM lm_data WHERE obj_id = ".$ilDB->quote($a_id)."";
                $obj_set = $ilDB->query($query);
                $obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC);

                return $obj_rec["lm_id"];
        }

        function _lookupActive($a_id)
        {
                global $ilDB;

                $query = "SELECT * FROM lm_data WHERE obj_id = ".$ilDB->quote($a_id);
                $obj_set = $ilDB->query($query);
                $obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC);

                return ilUtil::yn2tf($obj_rec["active"]);
        }

        function _writeActive($a_id, $a_active)
        {
                global $ilDB;

                $query = "UPDATE lm_data ".
                        " SET active = ".$ilDB->quote(ilUtil::tf2yn($a_active)).
                        " WHERE obj_id = ".$ilDB->quote($a_id);
                $ilDB->query($query);
        }

        static function updateInternalLinks($a_copied_nodes, $a_parent_type = "lm")
        {
                foreach($a_copied_nodes as $original_id => $copied_id)
                {
                        if (ilLMObject::_lookupType($copied_id) == "pg")
                        {
                                //
                                // 1. Outgoing links from the copied page.
                                //
                                $targets = ilInternalLink::_getTargetsOfSource($a_parent_type.":pg", $copied_id);
                                $copy_lm = ilLMObject::_lookupContObjID($copied_id);
                                $fix = array();
                                foreach($targets as $target)
                                {
                                        if (($target["inst"] == 0 || $target["inst"] = IL_INST_ID) &&
                                                ($target["type"] == "pg" || $target["type"] == "st"))
                                        {
                                                // first check, whether target is also within the copied set
                                                if ($a_copied_nodes[$target["id"]] > 0)
                                                {
                                                        $fix[$target["id"]] = $a_copied_nodes[$target["id"]];
                                                }
                                                else
                                                {
                                                        // now check, if a copy if the target is already in the same lm
                                                        $lm_data = ilLMObject::_getAllObjectsForImportId("il__".$target["type"]."_".$target["id"]);
                                                        $found = false;

                                                        foreach($lm_data as $item)
                                                        {
                                                                if (!$found && ($item["lm_id"] == $copy_lm))
                                                                {
                                                                        $fix[$target["id"]] = $item["obj_id"];
                                                                }
                                                        }
                                                        
                                                        if (!$found)
                                                        {
                                                                // we now could look for copies next to the copy lm
                                                        }
                                                }
                                        }
                                }
                                
                                // outgoing links to be fixed
                                if (count($fix) > 0)
                                {
                                        $page = new ilPageObject(ilObject::_lookupType($copy_lm), $copied_id);
                                        $page->moveIntLinks($fix);
                                        $page->update();
                                }
                                
                                //
                                // 2. Incoming links to the original pages
                                //
                                // A->B                 A2                      (A+B currently copied)
                                // A->C                 B2
                                // B->A
                                // C->A                 C2->A           (C already copied)
                                $original_lm = ilLMObject::_lookupContObjID($original_id);
                                $original_type = ilObject::_lookupType($original_lm);
                                
                                // This gets sources that link to A+B (so we have C here)
                                $sources = ilInternalLink::_getSourcesOfTarget("pg", $original_id, 0);
                                $fix = array();
                                foreach($sources as $source)
                                {
                                        $stype = explode(":", $source["type"]);
                                        $source_type = $stype[1];

                                        if ($source_type == "pg" || $source_type == "st")
                                        {
                                                // check, if a copy if the source is already in the same lm
                                                // now we look for the latest copy of C in LM2
                                                $lm_data = ilLMObject::_getAllObjectsForImportId("il__".$source_type."_".$source["id"]);
                                                $found = false;
                                                foreach($lm_data as $item)
                                                {
                                                        if (!$found && ($item["lm_id"] == $copy_lm))
                                                        {
                                                                $fix[$item["obj_id"]][$original_id] = $copied_id;
                                                        }
                                                }
                                                
                                                if (!$found)
                                                {
                                                        // we now could look for copies next to the copy lm
                                                }
                                        }
                                }

                                // outgoing links to be fixed
                                if (count($fix) > 0)
                                {
                                        foreach ($fix as $page_id => $fix_array)
                                        {
                                                $page = new ilPageObject(ilObject::_lookupType($copy_lm), $page_id);
                                                $page->moveIntLinks($fix_array);
                                                $page->update();
                                        }
                                }
                        }
                }
        }
}
?>