class.ilObjWiki.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "./Services/Object/classes/class.ilObject.php";
include_once "./Modules/Wiki/classes/class.ilWikiUtil.php";
include_once "./Services/AdvancedMetaData/interfaces/interface.ilAdvancedMetaDataSubItems.php";

class ilObjWiki extends ilObject implements ilAdvancedMetaDataSubItems
{
        protected $online = false;
        protected $public_notes = true;
        protected $empty_page_templ = true;

        function ilObjWiki($a_id = 0,$a_call_by_reference = true)
        {
                $this->type = "wiki";
                $this->ilObject($a_id,$a_call_by_reference);
        }

        function setOnline($a_online)
        {
                $this->online = $a_online;
        }

        function getOnline()
        {
                return $this->online;
        }

        function setRatingOverall($a_rating)
        {
                $this->rating_overall = (bool)$a_rating;
        }

        function getRatingOverall()
        {
                return $this->rating_overall;
        }
        
        function setRating($a_rating)
        {
                $this->rating = (bool)$a_rating;
        }

        function getRating()
        {
                return $this->rating;
        }
        
        function setRatingAsBlock($a_rating)
        {
                $this->rating_block = (bool)$a_rating;
        }

        function getRatingAsBlock()
        {
                return $this->rating_block;
        }
        
        function setRatingForNewPages($a_rating)
        {
                $this->rating_new_pages = (bool)$a_rating;
        }

        function getRatingForNewPages()
        {
                return $this->rating_new_pages;
        }
                
        function setRatingCategories($a_rating)
        {
                $this->rating_categories = (bool)$a_rating;
        }

        function getRatingCategories()
        {
                return $this->rating_categories;
        }
        
        public function setPublicNotes($a_val)
        {
                $this->public_notes = $a_val;
        }

        public function getPublicNotes()
        {
                return $this->public_notes;
        }

        public function setImportantPages($a_val)
        {
                $this->imp_pages = $a_val;
        }

        public function getImportantPages()
        {
                return $this->imp_pages;
        }

        function setStartPage($a_startpage)
        {
                $this->startpage = ilWikiUtil::makeDbTitle($a_startpage);
        }

        function getStartPage()
        {
                return $this->startpage;
        }

        function setShortTitle($a_shorttitle)
        {
                $this->shorttitle = $a_shorttitle;
        }

        function getShortTitle()
        {
                return $this->shorttitle;
        }

        function setIntroduction($a_introduction)
        {
                $this->introduction = $a_introduction;
        }

        function getIntroduction()
        {
                return $this->introduction;
        }

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

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

        public function setPageToc($a_val)
        {
                $this->page_toc = $a_val;
        }

        public function getPageToc()
        {
                return $this->page_toc;
        }

        function setEmptyPageTemplate($a_val)
        {
                $this->empty_page_templ = $a_val;
        }
        
        function getEmptyPageTemplate()
        {
                return $this->empty_page_templ;
        }
        
        static function isOnlineHelpWiki($a_ref_id)
        {
                if ($a_ref_id > 0 && $a_ref_id == OH_REF_ID)
                {
//                      return true;
                }
                return false;
        }

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

                parent::create();
                
                $ilDB->insert("il_wiki_data", array(
                        "id" => array("integer", $this->getId()),
                        "is_online" => array("integer", (int) $this->getOnline()),
                        "startpage" => array("text", $this->getStartPage()),
                        "short" => array("text", $this->getShortTitle()),
                        "rating" => array("integer", (int) $this->getRating()),
                        "public_notes" => array("integer", (int) $this->getPublicNotes()),
                        "introduction" => array("clob", $this->getIntroduction()),
                        "empty_page_templ" => array("integer", (int) $this->getEmptyPageTemplate()),
                        ));

                // create start page
                if ($this->getStartPage() != "" && !$a_prevent_start_page_creation)
                {
                        include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                        $start_page = new ilWikiPage();
                        $start_page->setWikiId($this->getId());
                        $start_page->setTitle($this->getStartPage());
                        $start_page->create();
                }

                if (((int) $this->getStyleSheetId()) > 0)
                {
                        include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                        ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
                }
        }

        function update($a_prevent_start_page_creation = false)
        {
                global $ilDB;
                
                if (!parent::update())
                {                       
                        return false;
                }
                
                $ilDB->update("il_wiki_data", array(
                        "is_online" => array("integer", $this->getOnline()),
                        "startpage" => array("text", $this->getStartPage()),
                        "short" => array("text", $this->getShortTitle()),
                        "rating_overall" => array("integer", $this->getRatingOverall()),
                        "rating" => array("integer", $this->getRating()),
                        "rating_side" => array("integer", (bool)$this->getRatingAsBlock()), // #13455
                        "rating_new" => array("integer", $this->getRatingForNewPages()),
                        "rating_ext" => array("integer", $this->getRatingCategories()),
                        "public_notes" => array("integer", $this->getPublicNotes()),
                        "introduction" => array("clob", $this->getIntroduction()),
                        "imp_pages" => array("integer", $this->getImportantPages()),
                        "page_toc" => array("integer", $this->getPageToc()),
                        "empty_page_templ" => array("integer", $this->getEmptyPageTemplate())
                        ), array(
                        "id" => array("integer", $this->getId())
                        ));

                // check whether start page exists
                include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                if (!ilWikiPage::exists($this->getId(), $this->getStartPage())
                        && !$a_prevent_start_page_creation)
                {
                        $start_page = new ilWikiPage();
                        $start_page->setWikiId($this->getId());
                        $start_page->setTitle($this->getStartPage());
                        $start_page->create();
                }

                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());

                return true;
        }
        
        function read()
        {
                global $ilDB;
                
                parent::read();
                
                $query = "SELECT * FROM il_wiki_data WHERE id = ".
                        $ilDB->quote($this->getId(), "integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);

                $this->setOnline($rec["is_online"]);
                $this->setStartPage($rec["startpage"]);
                $this->setShortTitle($rec["short"]);
                $this->setRatingOverall($rec["rating_overall"]);
                $this->setRating($rec["rating"]);
                $this->setRatingAsBlock($rec["rating_side"]);
                $this->setRatingForNewPages($rec["rating_new"]);
                $this->setRatingCategories($rec["rating_ext"]);
                $this->setPublicNotes($rec["public_notes"]);
                $this->setIntroduction($rec["introduction"]);
                $this->setImportantPages($rec["imp_pages"]);
                $this->setPageToc($rec["page_toc"]);
                $this->setEmptyPageTemplate($rec["empty_page_templ"]);

                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                $this->setStyleSheetId((int) ilObjStyleSheet::lookupObjectStyle($this->getId()));

        }


        function delete()
        {
                global $ilDB;
                
                // always call parent delete function first!!
                if (!parent::delete())
                {
                        return false;
                }
                                
                // delete record of table il_wiki_data
                $query = "DELETE FROM il_wiki_data".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($query);

                // remove all notifications
                include_once "./Services/Notification/classes/class.ilNotification.php";
                ilNotification::removeForObject(ilNotification::TYPE_WIKI, $this->getId());
                
                include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                ilWikiPage::deleteAllPagesOfWiki($this->getId());
                
                return true;
        }

        static function checkShortTitleAvailability($a_short_title)
        {
                global $ilDB;
                
                $res = $ilDB->queryF("SELECT id FROM il_wiki_data WHERE short = %s",
                        array("text"), array($a_short_title));
                if ($ilDB->fetchAssoc($res))
                {
                        return false;
                }
                
                return true;
        }
        

        function notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params = 0)
        {
                global $tree;
                
                switch ($a_event)
                {
                        case "link":
                                
                                //var_dump("<pre>",$a_params,"</pre>");
                                //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
                                //exit;
                                break;
                        
                        case "cut":
                                
                                //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
                                //exit;
                                break;
                                
                        case "copy":
                        
                                //var_dump("<pre>",$a_params,"</pre>");
                                //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
                                //exit;
                                break;

                        case "paste":
                                
                                //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
                                //exit;
                                break;
                        
                        case "new":
                                
                                //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
                                //exit;
                                break;
                }

                // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
                if ($a_node_id==$_GET["ref_id"])
                {
                        $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                        $parent_type = $parent_obj->getType();
                        if($parent_type == $this->getType())
                        {
                                $a_node_id = (int) $tree->getParentId($a_node_id);
                        }
                }
                
                parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
        }
        
        static function _lookupRatingOverall($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "rating_overall");
        }
        
        static function _lookupRating($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "rating");
        }
        
        static function _lookupRatingCategories($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "rating_ext");
        }
        
        static function _lookupRatingAsBlock($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "rating_side");
        }

        static function _lookupPublicNotes($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "public_notes");
        }

        private static function _lookup($a_wiki_id, $a_field)
        {
                global $ilDB;

                $query = "SELECT $a_field FROM il_wiki_data WHERE id = ".
                        $ilDB->quote($a_wiki_id, "integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);
                return $rec[$a_field];
        }

        static function _lookupStartPage($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "startpage");
        }

        static function writeStartPage($a_id, $a_name)
        {
                global $ilDB;

                include_once("./Modules/Wiki/classes/class.ilWikiUtil.php");
                $ilDB->manipulate("UPDATE il_wiki_data SET ".
                        " startpage = ".$ilDB->quote(ilWikiUtil::makeDbTitle($a_name), "text").
                        " WHERE id = ".$ilDB->quote($a_id, "integer")
                        );
        }

        static function _performSearch($a_wiki_id, $a_searchterm)
        {
                // query parser
                include_once 'Services/Search/classes/class.ilQueryParser.php';

                $query_parser = new ilQueryParser($a_searchterm);
                $query_parser->setCombination("or");
                $query_parser->parse();

                include_once 'Services/Search/classes/class.ilSearchResult.php';
                $search_result = new ilSearchResult();
                if($query_parser->validate())
                {

                        include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
                        $wiki_search =& ilObjectSearchFactory::_getWikiContentSearchInstance($query_parser);
                        $wiki_search->setFilter(array('wpg'));
                        $search_result->mergeEntries($wiki_search->performSearch());
                }
                
                $entries = $search_result->getEntries();
                
                $found_pages = array();
                foreach($entries as $entry)
                {
                        if ($entry["obj_id"] == $a_wiki_id && is_array($entry["child"]))
                        {
                                foreach($entry["child"] as $child)
                                {
                                        $found_pages[] = array("page_id" => $child);
                                }
                        }
                }

                return $found_pages;
        }

        //
        // Important pages
        //

        static function _lookupImportantPages($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "imp_pages");
        }

        static function _lookupImportantPagesList($a_wiki_id)
        {
                global $ilDB;

                $set = $ilDB->query("SELECT * FROM il_wiki_imp_pages WHERE ".
                        " wiki_id = ".$ilDB->quote($a_wiki_id, "integer")." ORDER BY ord ASC "
                        );

                $imp_pages = array();

                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $imp_pages[] = $rec;
                }
                return $imp_pages;
        }

        static function _lookupMaxOrdNrImportantPages($a_wiki_id)
        {
                global $ilDB;

                $set = $ilDB->query("SELECT MAX(ord) as m FROM il_wiki_imp_pages WHERE ".
                        " wiki_id = ".$ilDB->quote($a_wiki_id, "integer")
                        );

                $rec = $ilDB->fetchAssoc($set);
                return (int) $rec["m"];
        }


        function addImportantPage($a_page_id, $a_nr = 0, $a_indent = 0)
        {
                global $ilDB;

                if (!$this->isImportantPage($a_page_id))
                {
                        if ($a_nr == 0)
                        {
                                $a_nr = ilObjWiki::_lookupMaxOrdNrImportantPages($this->getId()) + 10;
                        }

                        $ilDB->manipulate("INSERT INTO il_wiki_imp_pages ".
                                "(wiki_id, ord, indent, page_id) VALUES (".
                                $ilDB->quote($this->getId(), "integer").",".
                                $ilDB->quote($a_nr, "integer").",".
                                $ilDB->quote($a_indent, "integer").",".
                                $ilDB->quote($a_page_id, "integer").
                                ")");
                }
        }

        function isImportantPage($a_page_id)
        {
                global $ilDB;

                $set = $ilDB->query("SELECT * FROM il_wiki_imp_pages WHERE ".
                        " wiki_id = ".$ilDB->quote($this->getId(), "integer")." AND ".
                        " page_id = ".$ilDB->quote($a_page_id, "integer")
                );
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return true;
                }
                return false;
        }

        function removeImportantPage($a_id)
        {
                global $ilDB;

                $ilDB->manipulate("DELETE FROM il_wiki_imp_pages WHERE "
                        ." wiki_id = ".$ilDB->quote($this->getId(), "integer")
                        ." AND page_id = ".$ilDB->quote($a_id, "integer")
                        );

                $this->fixImportantPagesNumbering();
        }

        function saveOrderingAndIndentation($a_ord, $a_indent)
        {
                global $ilDB;

                $ipages = ilObjWiki::_lookupImportantPagesList($this->getId());

                foreach ($ipages as $k => $v)
                {
                        if (isset($a_ord[$v["page_id"]]))
                        {
                                $ipages[$k]["ord"] = (int) $a_ord[$v["page_id"]];
                        }
                        if (isset($a_indent[$v["page_id"]]))
                        {
                                $ipages[$k]["indent"] = (int) $a_indent[$v["page_id"]];
                        }
                }
                $ipages = ilUtil::sortArray($ipages, "ord", "asc", true);

                // fix indentation: no 2 is allowed after a 0
                $c_indent = 0;
                $fixed = false;
                foreach ($ipages as $k => $v)
                {
                        if ($ipages[$k]["indent"] == 2 && $c_indent == 0)
                        {
                                $ipages[$k]["indent"] = 1;
                                $fixed = true;
                        }
                        $c_indent = $ipages[$k]["indent"];
                }
                
                $ord = 10;
                reset($ipages);
                foreach ($ipages as $k => $v)
                {
                        $ilDB->manipulate($q = "UPDATE il_wiki_imp_pages SET ".
                                " ord = ".$ilDB->quote($ord, "integer").",".
                                " indent = ".$ilDB->quote($v["indent"], "integer").
                                " WHERE wiki_id = ".$ilDB->quote($v["wiki_id"], "integer").
                                " AND page_id = ".$ilDB->quote($v["page_id"], "integer")
                                );
                        $ord+=10;
                }
                
                return $fixed;
        }

        function fixImportantPagesNumbering()
        {
                global $ilDB;

                $ipages = ilObjWiki::_lookupImportantPagesList($this->getId());

                // fix indentation: no 2 is allowed after a 0
                $c_indent = 0;
                $fixed = false;
                foreach ($ipages as $k => $v)
                {
                        if ($ipages[$k]["indent"] == 2 && $c_indent == 0)
                        {
                                $ipages[$k]["indent"] = 1;
                                $fixed = true;
                        }
                        $c_indent = $ipages[$k]["indent"];
                }

                $ord = 10;
                foreach ($ipages as $k => $v)
                {
                        $ilDB->manipulate($q = "UPDATE il_wiki_imp_pages SET ".
                                " ord = ".$ilDB->quote($ord, "integer").
                                ", indent = ".$ilDB->quote($v["indent"], "integer").
                                " WHERE wiki_id = ".$ilDB->quote($v["wiki_id"], "integer").
                                " AND page_id = ".$ilDB->quote($v["page_id"], "integer")
                                );
                        $ord+=10;
                }

        }

        //
        // Page TOC
        //

        static function _lookupPageToc($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "page_toc");
        }

        public function cloneObject($a_target_id,$a_copy_id = 0)
        {
                global $ilDB, $ilUser, $ilias;

                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);

                //copy online status if object is not the root copy object
                $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);

                if(!$cp_options->isRootNode($this->getRefId()))
                {
                        $new_obj->setOnline($this->getOnline());
                }
                
                $new_obj->setTitle($this->getTitle());
                $new_obj->setStartPage($this->getStartPage());
                $new_obj->setShortTitle($this->getShortTitle());
                $new_obj->setRatingOverall($this->getRatingOverall());
                $new_obj->setRating($this->getRating());
                $new_obj->setRatingAsBlock($this->getRatingAsBlock());
                $new_obj->setRatingForNewPages($this->getRatingForNewPages());
                $new_obj->setRatingCategories($this->getRatingCategories());
                $new_obj->setPublicNotes($this->getPublicNotes());
                $new_obj->setIntroduction($this->getIntroduction());
                $new_obj->setImportantPages($this->getImportantPages());
                $new_obj->setPageToc($this->getPageToc());
                $new_obj->update();

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

                // copy content
                include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                $pages = ilWikiPage::getAllPages($this->getId());
                if (count($pages) > 0)
                {
                        // if we have any pages, delete the start page first
                        $pg_id = ilWikiPage::getPageIdForTitle($new_obj->getId(), $new_obj->getStartPage());
                        $start_page = new ilWikiPage($pg_id);
                        $start_page->delete();
                }
                $map = array();
                foreach ($pages as $p)
                {
                        $page = new ilWikiPage($p["id"]);
                        $new_page = new ilWikiPage();
                        $new_page->setTitle($page->getTitle());
                        $new_page->setWikiId($new_obj->getId());
                        $new_page->setTitle($page->getTitle());
                        $new_page->setBlocked($page->getBlocked());
                        $new_page->setRating($page->getRating());
                        $new_page->hideAdvancedMetadata($page->isAdvancedMetadataHidden());
                        $new_page->create();

                        $page->copy($new_page->getId(), "", 0, true);
                        //$new_page->setXMLContent($page->copyXMLContent(true));
                        //$new_page->buildDom(true);
                        //$new_page->update();
                        $map[$p["id"]] = $new_page->getId();
                }
                
                // copy important pages
                foreach (ilObjWiki::_lookupImportantPagesList($this->getId()) as $ip)
                {
                        $new_obj->addImportantPage($map[$ip["page_id"]], $ip["ord"], $ip["indent"]);
                }

                // copy rating categories
                include_once("./Services/Rating/classes/class.ilRatingCategory.php");
                foreach (ilRatingCategory::getAllForObject($this->getId()) as $rc)
                {
                        $new_rc = new ilRatingCategory();
                        $new_rc->setParentId($new_obj->getId());
                        $new_rc->setTitle($rc["title"]);
                        $new_rc->setDescription($rc["description"]);
                        $new_rc->save();
                }
                
                return $new_obj;
        }

        function getTemplateSelectionOnCreation()
        {
                $num = (int) $this->getEmptyPageTemplate();
                include_once("./Modules/Wiki/classes/class.ilWikiPageTemplate.php");
                $wt = new ilWikiPageTemplate($this->getId());
                $ts = $wt->getAllInfo(ilWikiPageTemplate::TYPE_NEW_PAGES);
                $num += count($ts);
                if ($num > 1)
                {
                        return true;
                }
                return false;
        }

        function createWikiPage($a_page_title, $a_template_page = 0)
        {
                // check if template has to be used
                if ($a_template_page == 0)
                {
                        if (!$this->getEmptyPageTemplate())
                        {
                                include_once("./Modules/Wiki/classes/class.ilWikiPageTemplate.php");
                                $wt = new ilWikiPageTemplate($this->getId());
                                $ts = $wt->getAllInfo(ilWikiPageTemplate::TYPE_NEW_PAGES);
                                if (count($ts) == 1)
                                {
                                        $t = current($ts);
                                        $a_template_page = $t["wpage_id"];
                                }
                        }
                }

                // create the page
                $page = new ilWikiPage();
                $page->setWikiId($this->getId());
                $page->setTitle(ilWikiUtil::makeDbTitle($a_page_title));
                if($this->getRating() && $this->getRatingForNewPages())
                {
                        $page->setRating(true);
                }

                // needed for notification
                $page->setWikiRefId($this->getRefId());
                $page->create();

                // copy template into new page
                if ($a_template_page > 0)
                {
                        $orig = new ilWikiPage($a_template_page);
                        $orig->copy($page->getId());
                        
                        // #15718
                        include_once "Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php";
                        ilAdvancedMDValues::_cloneValues(
                                $this->getId(),
                                $this->getId(),
                                "wpg",
                                $a_template_page,
                                $page->getId()
                        );
                }

                return $page;
        }

        public static function getAdvMDSubItemTitle($a_obj_id, $a_sub_type, $a_sub_id)
        {
                global $lng;
        
                if($a_sub_type == "wpg")
                {
                        $lng->loadLanguageModule("wiki");
                        include_once "./Modules/Wiki/classes/class.ilWikiPage.php";                                             
                        return $lng->txt("wiki_wpg").' "'.ilWikiPage::lookupTitle($a_sub_id).'"';
                }
        }
}
?>