class.ilWikiPage.php

Go to the documentation of this file.

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

include_once("./Services/COPage/classes/class.ilPageObject.php");
include_once("./Modules/Wiki/classes/class.ilWikiUtil.php");
class ilWikiPage extends ilPageObject
{
        protected $blocked = false;

        function getParentType()
        {
                return "wpg";
        }       

        function afterConstructor()
        {
                $this->getPageConfig()->configureByObjectId($this->getParentId());
        }

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

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

        function setWikiId($a_wikiid)
        {
                $this->setParentId($a_wikiid);
        }

        function getWikiId()
        {
                return $this->getParentId();
        }

        function setWikiRefId($a_wiki_ref_id)
        {
                $this->parent_ref_id = $a_wiki_ref_id;
        }

        function getWikiRefId()
        {
                return $this->parent_ref_id;
        }

        public function setBlocked($a_val)
        {
                $this->blocked = $a_val;
        }

        public function getBlocked()
        {
                return $this->blocked;
        }
        
        public function setRating($a_val)
        {
                $this->rating = (bool)$a_val;
        }

        public function getRating()
        {
                return $this->rating;
        }

        function createFromXML()
        {
                global $ilDB;

                // ilWikiDataset creates wiki pages without copage objects
                // (see create function in this class, parameter $a_prevent_page_creation)
                // The ilCOPageImporter will call createFromXML without running through the read
                // method -> we will miss the important wiki id, thus we read it now
                // see also bug #12224
                $set = $ilDB->query("SELECT id FROM il_wiki_page ".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer")
                        );
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        $this->read(true);
                }

                parent::createFromXML();
        }

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

                $id = $ilDB->nextId("il_wiki_page");
                $this->setId($id);
                $query = "INSERT INTO il_wiki_page (".
                        "id".
                        ", title".
                        ", wiki_id".
                        ", blocked".
                        ", rating".
                        " ) VALUES (".
                        $ilDB->quote($this->getId(), "integer")
                        .",".$ilDB->quote($this->getTitle(), "text")
                        .",".$ilDB->quote((int) $this->getWikiId(), "integer")
                        .",".$ilDB->quote((int) $this->getBlocked(), "integer")
                        .",".$ilDB->quote((int) $this->getRating(), "integer")
                        .")";
                $ilDB->manipulate($query);

                // create page object
                if (!$a_prevent_page_creation)
                {
                        parent::create();
                        $this->saveInternalLinks($this->getDomDoc());

                        include_once "./Services/Notification/classes/class.ilNotification.php";
                        ilWikiUtil::sendNotification("new", ilNotification::TYPE_WIKI, $this->getWikiRefId(), $this->getId());
                }

                $this->updateNews();
        }

        function update($a_validate = true, $a_no_history = false)
        {
                global $ilDB;
                
                // update wiki page data
                $query = "UPDATE il_wiki_page SET ".
                        " title = ".$ilDB->quote($this->getTitle(), "text").
                        ",wiki_id = ".$ilDB->quote((int) $this->getWikiId(), "integer").
                        ",blocked = ".$ilDB->quote((int) $this->getBlocked(), "integer").
                        ",rating = ".$ilDB->quote((int) $this->getRating(), "integer").
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($query);
                $updated = parent::update($a_validate, $a_no_history);

                if ($updated === true)
                {
                        include_once "./Services/Notification/classes/class.ilNotification.php";
                        ilWikiUtil::sendNotification("update", ilNotification::TYPE_WIKI_PAGE, $this->getWikiRefId(), $this->getId());  
                        $this->updateNews(true);
                }
                else
                {
                        return $updated;
                }

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

                $this->setTitle($rec["title"]);
                $this->setWikiId($rec["wiki_id"]);
                $this->setBlocked($rec["blocked"]);
                $this->setRating($rec["rating"]);
                
                // get co page
                if (!$a_omit_page_read)
                {
                        parent::read();
                }
        }


        function delete()
        {
                global $ilDB;
                
                // get other pages that link to this page
                $linking_pages = ilWikiPage::getLinksToPage($this->getWikiId(),
                        $this->getId());

                // delete internal links information to this page
                include_once("./Services/COPage/classes/class.ilInternalLink.php");
                ilInternalLink::_deleteAllLinksToTarget("wpg", $this->getId());

                include_once "./Services/Notification/classes/class.ilNotification.php";
                ilWikiUtil::sendNotification("delete", ilNotification::TYPE_WIKI_PAGE, $this->getWikiRefId(), $this->getId());

                // remove all notifications
                include_once "./Services/Notification/classes/class.ilNotification.php";
                ilNotification::removeForObject(ilNotification::TYPE_WIKI_PAGE, $this->getId());
                
                // delete record of table il_wiki_data
                $query = "DELETE FROM il_wiki_page".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($query);
                
                // delete co page
                parent::delete();

                // make links of other pages to this page a missing link
                foreach($linking_pages as $lp)
                {
                        $ilDB->manipulateF("DELETE FROM il_wiki_missing_page ".
                                " WHERE wiki_id = %s AND source_id = %s AND target_name = %s ",
                                array("integer", "integer", "text"),
                                array($this->getWikiId(), $lp["id"], $this->getTitle()));
                        $ilDB->manipulateF("INSERT INTO il_wiki_missing_page ".
                                "(wiki_id, source_id, target_name) VALUES ".
                                "(%s,%s,%s)",
                                array("integer", "integer", "text"),
                                array($this->getWikiId(), $lp["id"], $this->getTitle()));
                }

                return true;
        }

        static function deleteAllPagesOfWiki($a_wiki_id)
        {
                global $ilDB;
                
                // delete record of table il_wiki_data
                $query = "SELECT * FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer");
                $set = $ilDB->query($query);

                while($rec = $ilDB->fetchAssoc($set))
                {
                        $wiki_page = new ilWikiPage($rec["id"]);
                        $wiki_page->delete();

                        
                }
        }
        
        static function exists($a_wiki_id, $a_title)
        {
                global $ilDB;
                
                $a_title = ilWikiUtil::makeDbTitle($a_title);
                
                $query = "SELECT id FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                        " AND title = ".$ilDB->quote($a_title, "text");
                $set = $ilDB->query($query);
                if($rec = $ilDB->fetchAssoc($set))
                {
                        return true;
                }
                
                return false;
        }

        static function getIdForPageTitle($a_wiki_id, $a_title)
        {
                global $ilDB;

                $a_title = ilWikiUtil::makeDbTitle($a_title);

                $query = "SELECT id FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                        " AND title = ".$ilDB->quote($a_title, "text");
                $set = $ilDB->query($query);
                if($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["id"];
                }

                return false;
        }

        static function getPageIdForTitle($a_wiki_id, $a_title)
        {
                global $ilDB;
                
                $a_title = ilWikiUtil::makeDbTitle($a_title);
                
                $query = "SELECT * FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                        " AND title = ".$ilDB->quote($a_title, "text");
                $set = $ilDB->query($query);
                if($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["id"];
                }
                
                return false;
        }
        
        static function lookupTitle($a_page_id)
        {
                global $ilDB;
                
                $query = "SELECT * FROM il_wiki_page".
                        " WHERE id = ".$ilDB->quote($a_page_id, "integer");
                $set = $ilDB->query($query);
                if($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["title"];
                }
                
                return false;
        }

        static function lookupWikiId($a_page_id)
        {
                global $ilDB;

                $query = "SELECT wiki_id FROM il_wiki_page".
                        " WHERE id = ".$ilDB->quote($a_page_id, "integer");
                $set = $ilDB->query($query);
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["wiki_id"];
                }

                return false;
        }

        static function getAllPages($a_wiki_id)
        {
                global $ilDB;
                
                $pages = parent::getAllPages("wpg", $a_wiki_id);
                
                $query = "SELECT * FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                        " ORDER BY title";
                $set = $ilDB->query($query);

                $pg = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        if (isset($pages[$rec["id"]]))
                        {
                                $pg[$rec["id"]] = $pages[$rec["id"]];
                                $pg[$rec["id"]]["title"] = $rec["title"];
                        }
                }

                return $pg;
        }

        static function getLinksToPage($a_wiki_id, $a_page_id)
        {
                global $ilDB;
                
                include_once("./Services/COPage/classes/class.ilInternalLink.php");
                $sources = ilInternalLink::_getSourcesOfTarget("wpg", $a_page_id, 0);
                
                $ids = array();
                foreach ($sources as $source)
                { 
                        if ($source["type"] == "wpg:pg")
                        {
                                $ids[] = $source["id"];
                        }
                }
                // get wiki page record
                $query = "SELECT * FROM il_wiki_page wp, page_object p".
                        " WHERE ".$ilDB->in("wp.id", $ids, false, "integer").
                        " AND wp.id = p.page_id AND p.parent_type = ".$ilDB->quote("wpg", "text").
                        " AND wp.wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                        " ORDER BY title";
                $set = $ilDB->query($query);
                
                $pages = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $pages[] = array_merge($rec, array("user" => $rec["last_change_user"],
                                "date" => $rec["last_change"]));
                }

                return $pages;
        }

        static function getOrphanedPages($a_wiki_id)
        {
                global $ilDB;
                
                $pages = ilWikiPage::getAllPages($a_wiki_id);
                
                include_once("./Services/COPage/classes/class.ilInternalLink.php");
                
                $orphaned = array();
                foreach ($pages as $k => $page)
                {
                        $sources = ilInternalLink::_getSourcesOfTarget("wpg", $page["id"], 0);
                        
                        $ids = array();
                        foreach ($sources as $source)
                        { 
                                if ($source["type"] == "wpg:pg")
                                {
                                        $ids[] = $source["id"];
                                }
                        }
                        $query = "SELECT count(*) cnt FROM il_wiki_page".
                                " WHERE ".$ilDB->in("id", $ids, false, "integer").
                                " AND wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                                " GROUP BY wiki_id";
                        $set = $ilDB->query($query);
                        $rec = $ilDB->fetchAssoc($set);
                        if ($rec["cnt"] == 0 &&
                                ilObjWiki::_lookupStartPage($a_wiki_id) != $page["title"])
                        {
                                $orphaned[] = $page;
                        }
                }
                
                return $orphaned;
        }

        static function _wikiPageExists($a_wiki_id, $a_title)
        {
                global $ilDB;
                
                $a_title = ilWikiUtil::makeDbTitle($a_title);
                
                $query = "SELECT id FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                        " AND title = ".$ilDB->quote($a_title, "text");
                $set = $ilDB->query($query);
                
                $pages = array();
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return true;
                }
                
                return false;
        }
        
        static function getParentObjectContributors($a_wiki_id)
        {
                global $ilDB;
                
                $contributors = parent::getParentObjectContributors("wpg", $a_wiki_id);
                
                return $contributors;
        }
        
        static function getPageContributors($a_page_id)
        {
                global $ilDB;
                
                $contributors = parent::getPageContributors("wpg", $a_page_id);
                
                return $contributors;
        }


        function saveInternalLinks($a_domdoc)
        {
                global $ilDB;
                
                
                // *** STEP 1: Standard Processing ***
                
                parent::saveInternalLinks($a_domdoc);
                
                
                // *** STEP 2: Other Pages -> This Page ***
                
                // Check, whether ANOTHER page links to this page as a "missing" page
                // (this is the case, when this page is created newly)
                $set = $ilDB->queryF("SELECT * FROM il_wiki_missing_page WHERE ".
                        " wiki_id = %s AND target_name = %s",
                        array("integer", "text"),
                        array($this->getWikiId(), ilWikiUtil::makeDbTitle($this->getTitle())));
                while ($anmiss = $ilDB->fetchAssoc($set))       // insert internal links instead 
                {
//echo "adding link";
                        ilInternalLink::_saveLink("wpg:pg", $anmiss["source_id"], "wpg",
                                $this->getId(), 0);
                }
//exit;
                // now remove the missing page entries
                $ilDB->manipulateF("DELETE FROM il_wiki_missing_page WHERE ".
                        " wiki_id = %s AND target_name = %s",
                        array("integer", "text"),
                        array($this->getWikiId(), $this->getTitle()));
                
                
                // *** STEP 3: This Page -> Other Pages ***
                
                // remove the exising "missing page" links for THIS page (they will be re-inserted below)
                $ilDB->manipulateF("DELETE FROM il_wiki_missing_page WHERE ".
                        " wiki_id = %s AND source_id = %s",
                        array("integer", "integer"),
                        array($this->getWikiId(), $this->getId()));
                
                // collect the wiki links of the page
                include_once("./Modules/Wiki/classes/class.ilWikiUtil.php");
                $xml = $a_domdoc->saveXML();
                $int_wiki_links = ilWikiUtil::collectInternalLinks($xml, $this->getWikiId(), true);
                foreach($int_wiki_links as $wlink)
                {
                        $page_id = ilWikiPage::_getPageIdForWikiTitle($this->getWikiId(), $wlink);
                        
                        if ($page_id > 0)               // save internal link for existing page
                        {
                                ilInternalLink::_saveLink("wpg:pg", $this->getId(), "wpg",
                                        $page_id, 0);
                        }
                        else            // save missing link for non-existing page
                        {
                                $ilDB->manipulateF("DELETE FROM il_wiki_missing_page WHERE".
                                        " wiki_id = %s AND source_id = %s AND target_name = %s",
                                        array("integer", "integer", "text"),
                                        array($this->getWikiId(), $this->getId(), $wlink));
                                $ilDB->manipulateF("INSERT INTO il_wiki_missing_page (wiki_id, source_id, target_name)".
                                        " VALUES (%s,%s,%s)",
                                        array("integer", "integer", "text"),
                                        array($this->getWikiId(), $this->getId(), $wlink));
                        }
                }
        }

        static function _getPageIdForWikiTitle($a_wiki_id, $a_title)
        {
                global $ilDB;
                
                $query = "SELECT id FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                        " AND title = ".$ilDB->quote($a_title, "text");
                $set = $ilDB->query($query);
                if($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["id"];
                }
                
                return false;
        }

        static function getPopularPages($a_wiki_id)
        {
                global $ilDB;
                
                $query = "SELECT wp.*, po.view_cnt as cnt FROM il_wiki_page wp, page_object po".
                        " WHERE wp.wiki_id = ".$ilDB->quote($a_wiki_id, "integer").
                        " AND wp.id = po.page_id ".
                        " AND po.parent_type = ".$ilDB->quote("wpg", "text")." ".
                        " ORDER BY po.view_cnt";
                $set = $ilDB->query($query);
                
                $pages = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $pages[] = $rec;
                }
                
                return $pages;
        }

        static function countPages($a_wiki_id)
        {
                global $ilDB;
                
                // delete record of table il_wiki_data
                $query = "SELECT count(*) as cnt FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer");
                $s = $ilDB->query($query);
                $r = $ilDB->fetchAssoc($s);
                
                return $r["cnt"];
        }

        static function getRandomPage($a_wiki_id)
        {
                global $ilDB;
                
                $cnt = ilWikiPage::countPages($a_wiki_id);
                
                if ($cnt < 1)
                {
                        return "";
                }
                
                $rand = rand(1, $cnt);
                
                // delete record of table il_wiki_data
                $ilDB->setLimit(1, $rand);
                $query = "SELECT title FROM il_wiki_page".
                        " WHERE wiki_id = ".$ilDB->quote($a_wiki_id, "integer");
                $s = $ilDB->query($query);
                $r = $ilDB->fetchAssoc($s);
                
                return $r["title"];
        }

        static function getNewPages($a_wiki_id)
        {
                global $ilDB;
                
                $pages = parent::getNewPages("wpg", $a_wiki_id);
                
                foreach($pages as $k => $page)
                {
                        $pages[$k]["title"] = ilWikiPage::lookupTitle($page["id"]);
                }
                
                return $pages;
        }


        public static function lookupObjIdByPage($a_page_id)
        {
                global $ilDB;
                
                $query = "SELECT wiki_id FROM il_wiki_page".
                        " WHERE id = ".$ilDB->quote($a_page_id, "integer");
                $set = $ilDB->query($query);
                if($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["wiki_id"];
                }
                
                return false;           
        }

        function rename($a_new_name)
        {
                global $ilDB;
                
                // replace unallowed characters
                $a_new_name = str_replace(array("<", ">"), '', $a_new_name);

                // replace multiple whitespace characters by one single space
                $a_new_name = trim(preg_replace('!\s+!', ' ', $a_new_name));
                                
                $page_title = ilWikiUtil::makeDbTitle($a_new_name);
                $pg_id = ilWikiPage::_getPageIdForWikiTitle($this->getWikiId(), $page_title);
                
                $xml_new_name = str_replace("&", "&amp;", $a_new_name);

                if ($pg_id == 0 || $pg_id == $this->getId())
                {
                        include_once("./Services/COPage/classes/class.ilInternalLink.php");
                        $sources = ilInternalLink::_getSourcesOfTarget("wpg", $this->getId(), 0);

                        foreach ($sources as $s)
                        {
                                if ($s["type"] == "wpg:pg" && ilPageObject::_exists("wpg", $s["id"]))
                                {
                                        $wpage = new ilWikiPage($s["id"]);
                                        
                                        $col = ilWikiUtil::processInternalLinks($wpage->getXmlContent(), 0,
                                                IL_WIKI_MODE_EXT_COLLECT);
                                        $new_content = $wpage->getXmlContent();
                                        foreach ($col as $c)
                                        {

                                                // this complicated procedure is needed due to the fact
                                                // that depending on the collation e = é is true
                                                // in the (mysql) database
                                                // see bug http://www.ilias.de/mantis/view.php?id=11227
                                                $t1 = ilWikiUtil::makeDbTitle($c["nt"]->mTextform);
                                                $t2 = ilWikiUtil::makeDbTitle($this->getTitle());
                                                
                                                // this one replaces C2A0 (&nbsp;) by a usual space
                                                // otherwise the comparision will fail, since you
                                                // get these characters from tiny if more than one
                                                // space is repeated in a string. This may not be
                                                // 100% but we do not store $t1 anywhere and only
                                                // modify it for the comparison
                                                $t1 = preg_replace('/\xC2\xA0/', ' ', $t1);
                                                $t2 = preg_replace('/\xC2\xA0/', ' ', $t2);
                                                
                                                $set = $ilDB->query($q = "SELECT ".$ilDB->quote($t1, "text")." = ".$ilDB->quote($t2, "text")." isequal");
                                                $rec = $ilDB->fetchAssoc($set);
                                                
                                                if ($rec["isequal"])
                                                {
                                                        $new_content = 
                                                                str_replace("[[".$c["nt"]->mTextform."]]",
                                                                "[[".$xml_new_name."]]", $new_content);
                                                        if ($c["text"] != "")
                                                        {
                                                                $new_content = 
                                                                        str_replace("[[".$c["text"]."]]",
                                                                        "[[".$xml_new_name."]]", $new_content);
                                                        }
                                                        $add = ($c["text"] != "")
                                                                ? "|".$c["text"]
                                                                : "";
                                                        $new_content = 
                                                                str_replace("[[".$c["nt"]->mTextform.$add."]]",
                                                                "[[".$xml_new_name.$add."]]", $new_content);
                                                }
                                        }
                                        $wpage->setXmlContent($new_content);
//echo htmlentities($new_content);
                                        $wpage->update();
                                }
                        }

                        include_once("./Modules/Wiki/classes/class.ilObjWiki.php");
                        if (ilObjWiki::_lookupStartPage($this->getWikiId()) == $this->getTitle())
                        {
                                ilObjWiki::writeStartPage($this->getWikiId(), $a_new_name);
                        }

                        $this->setTitle($a_new_name);

                        $this->update();
                }
                
                return $a_new_name;
        }


        function updateNews($a_update = false)
        {
                global $ilUser;

                $news_set = new ilSetting("news");
                $default_visibility = ($news_set->get("default_visibility") != "")
                                ? $news_set->get("default_visibility")
                                : "users";

                include_once("./Services/News/classes/class.ilNewsItem.php");
                if (!$a_update)
                {
                        $news_item = new ilNewsItem();
                        $news_item->setContext(
                                $this->getWikiId(), "wiki",
                                $this->getId(), "wpg");
                        $news_item->setPriority(NEWS_NOTICE);
                        $news_item->setTitle($this->getTitle());
                        $news_item->setContentTextIsLangVar(true);
                        $news_item->setContent("wiki_news_page_created");
                        $news_item->setUserId($ilUser->getId());
                        $news_item->setVisibility($default_visibility);
                        $news_item->create();
                }
                else
                {
                        // get last news item of the day (if existing)
                        $news_id = ilNewsItem::getLastNewsIdForContext(
                                $this->getWikiId(), "wiki",
                                $this->getId(), "wpg", true);

                        if ($news_id > 0)
                        {
                                $news_item = new ilNewsItem($news_id);
                                $news_item->setContent("wiki_news_page_changed");
                                $news_item->setUserId($ilUser->getId());
                                $news_item->setTitle($this->getTitle());
                                $news_item->setContentTextIsLangVar(true);
                                $news_item->update(true);
                        }
                        else
                        {
                                $news_item = new ilNewsItem();
                                $news_item->setContext(
                                        $this->getWikiId(), "wiki",
                                        $this->getId(), "wpg");
                                $news_item->setPriority(NEWS_NOTICE);
                                $news_item->setTitle($this->getTitle());
                                $news_item->setContentTextIsLangVar(true);
                                $news_item->setContent("wiki_news_page_changed");
                                $news_item->setUserId($ilUser->getId());
                                $news_item->setVisibility($default_visibility);
                                $news_item->create();
                        }
                }
        }

        function getNewsContent()
        {
                return "12.1.1: Test User, Max";
        }

        static function getGotoForWikiPageTarget($a_target, $a_offline = false)
        {
                if (!$a_offline)
                {
                        $href = "./goto.php?target=wiki_wpage_".$a_target;
                }
                else
                {
                        $href = ILIAS_HTTP_PATH."/goto.php?target=wiki_wpage_".$a_target;
                }
                return $href;
        }
        
}
?>