class.ilObjGlossary.php

Go to the documentation of this file.

<?php

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

require_once("./Services/Object/classes/class.ilObject.php");
require_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
include_once("./Services/AdvancedMetaData/interfaces/interface.ilAdvancedMetaDataSubItems.php");

class ilObjGlossary extends ilObject implements ilAdvancedMetaDataSubItems
{

        var $auto_glossaries = array();

        function __construct($a_id = 0,$a_call_by_reference = true)
        {
                $this->type = "glo";
                parent::__construct($a_id,$a_call_by_reference);
        }

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

                parent::create();
                
                // meta data will be created by
                // import parser
                if (!$a_upload)
                {
                        $this->createMetaData();
                }
                
                $ilDB->manipulate("INSERT INTO glossary (id, is_online, glossary.virtual, pres_mode, snippet_length) VALUES (".
                        $ilDB->quote($this->getId(), "integer").",".
                        $ilDB->quote("n", "text").",".
                        $ilDB->quote($this->getVirtualMode(), "text").",".
                        $ilDB->quote("table", "text").",".
                        $ilDB->quote(200, "integer").
                        ")");
                $this->setPresentationMode("table");
                $this->setSnippetLength(200);

                $this->updateAutoGlossaries();

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

        }

        function read()
        {
                global $ilDB;
                
                parent::read();
#               echo "Glossary<br>\n";

                $q = "SELECT * FROM glossary WHERE id = ".
                        $ilDB->quote($this->getId(), "integer");
                $gl_set = $ilDB->query($q);
                $gl_rec = $ilDB->fetchAssoc($gl_set);
                $this->setOnline(ilUtil::yn2tf($gl_rec["is_online"]));
                $this->setVirtualMode($gl_rec["virtual"]);
                $this->setPublicExportFile("xml", $gl_rec["public_xml_file"]);
                $this->setPublicExportFile("html", $gl_rec["public_html_file"]);
                $this->setActiveGlossaryMenu(ilUtil::yn2tf($gl_rec["glo_menu_active"]));
                $this->setActiveDownloads(ilUtil::yn2tf($gl_rec["downloads_active"]));
                $this->setPresentationMode($gl_rec["pres_mode"]);
                $this->setSnippetLength($gl_rec["snippet_length"]);
                $this->setShowTaxonomy($gl_rec["show_tax"]);
                
                include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
                $this->setStyleSheetId((int) ilObjStyleSheet::lookupObjectStyle($this->getId()));

                // read auto glossaries
                $set = $ilDB->query("SELECT * FROM glo_glossaries ".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer")
                );
                $glos = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $glos[] = $rec["glo_id"];
                }
                $this->setAutoGlossaries($glos);


        }

        function getDescription()
        {
                return parent::getDescription();
        }

        function setDescription($a_description)
        {
                parent::setDescription($a_description);
        }

        
        function setVirtualMode($a_mode)
        {
                switch ($a_mode)
                {
                        case "level":
                        case "subtree":
                        // case "fixed":
                                $this->virtual_mode = $a_mode;
                                $this->virtual = true;
                                break;
                                
                        default:
                                $this->virtual_mode = "none";
                                $this->virtual = false;
                                break;
                }
        }
        
        function getVirtualMode()
        {
                return $this->virtual_mode;
        }
        
        function isVirtual()
        {
                return $this->virtual;
        }

        function getTitle()
        {
                return parent::getTitle();
        }

        function setTitle($a_title)
        {
                parent::setTitle($a_title);
//              $this->meta_data->setTitle($a_title);
        }

        function setPresentationMode($a_val)
        {
                $this->pres_mode = $a_val;
        }

        function getPresentationMode()
        {
                return $this->pres_mode;
        }

        function setSnippetLength($a_val)
        {
                $this->snippet_length = $a_val;
        }

        function getSnippetLength()
        {
                return ($this->snippet_length > 0)
                        ? $this->snippet_length
                        : null;
        }

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

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

        static function _lookupOnline($a_id)
        {
                global $ilDB;

                $q = "SELECT is_online FROM glossary WHERE id = ".
                        $ilDB->quote($a_id, "integer");
                $lm_set = $ilDB->query($q);
                $lm_rec = $ilDB->fetchAssoc($lm_set);

                return ilUtil::yn2tf($lm_rec["is_online"]);
        }

        static protected function lookup($a_id, $a_property)
        {
                global $ilDB;

                $set = $ilDB->query("SELECT $a_property FROM glossary WHERE id = ".
                        $ilDB->quote($a_id, "integer"));
                $rec = $ilDB->fetchAssoc($set);

                return $rec[$a_property];
        }

        static function lookupSnippetLength($a_id)
        {
                return ilObjGlossary::lookup($a_id, "snippet_length");
        }

        
        function setActiveGlossaryMenu($a_act_glo_menu)
        {
                $this->glo_menu_active = $a_act_glo_menu;
        }

        function isActiveGlossaryMenu()
        {
                return $this->glo_menu_active;
        }

        function setActiveDownloads($a_down)
        {
                $this->downloads_active = $a_down;
        }

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

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


        function setShowTaxonomy($a_val)
        {
                $this->show_tax = $a_val;
        }
        
        function getShowTaxonomy()
        {
                return $this->show_tax;
        }

        function setAutoGlossaries($a_val)
        {
                $this->auto_glossaries = array();
                if (is_array($a_val))
                {
                        foreach ($a_val as $v)
                        {
                                $v = (int) $v;
                                if ($v > 0 && ilObject::_lookupType($v) == "glo" &&
                                        !in_array($v, $this->auto_glossaries))
                                {
                                        $this->auto_glossaries[] = $v;
                                }
                        }
                }
        }

        function getAutoGlossaries()
        {
                return $this->auto_glossaries;
        }

        function removeAutoGlossary($a_glo_id)
        {
                $glo_ids = array();
                foreach($this->getAutoGlossaries() as $g)
                {
                        if ($g != $a_glo_id)
                        {
                                $glo_ids[] = $g;
                        }
                }
                $this->setAutoGlossaries($glo_ids);
        }

        function update()
        {
                global $ilDB;
                
                $this->updateMetaData();

                $ilDB->manipulate("UPDATE glossary SET ".
                        " is_online = ".$ilDB->quote(ilUtil::tf2yn($this->getOnline()), "text").",".
                        " glossary.virtual = ".$ilDB->quote($this->getVirtualMode(), "text").",".
                        " public_xml_file = ".$ilDB->quote($this->getPublicExportFile("xml"), "text").",".
                        " public_html_file = ".$ilDB->quote($this->getPublicExportFile("html"), "text").",".
                        " glo_menu_active = ".$ilDB->quote(ilUtil::tf2yn($this->isActiveGlossaryMenu()), "text").",".
                        " downloads_active = ".$ilDB->quote(ilUtil::tf2yn($this->isActiveDownloads()), "text").", ".
                        " pres_mode = ".$ilDB->quote($this->getPresentationMode(), "text").", ".
                        " show_tax = ".$ilDB->quote((int) $this->getShowTaxonomy(), "integer").", ".
                        " snippet_length = ".$ilDB->quote((int)$this->getSnippetLength(), "integer")." ".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer"));
                
                include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
                ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());

                $this->updateAutoGlossaries();
                parent::update();
        }


        function updateAutoGlossaries()
        {
                global $ilDB;

                // update auto glossaries
                $ilDB->manipulate("DELETE FROM glo_glossaries WHERE ".
                        " id = ".$ilDB->quote($this->getId(), "integer")
                );
                foreach ($this->getAutoGlossaries() as $glo_id)
                {
                        $ilDB->manipulate("INSERT INTO glo_glossaries ".
                                "(id, glo_id) VALUES (".
                                $ilDB->quote($this->getId(), "integer").",".
                                $ilDB->quote($glo_id, "integer").
                                ")");
                }
        }

        static function lookupAutoGlossaries($a_id)
        {
                global $ilDB;

                // read auto glossaries
                $set = $ilDB->query("SELECT * FROM glo_glossaries ".
                        " WHERE id = ".$ilDB->quote($a_id, "integer")
                );
                $glos = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $glos[] = $rec["glo_id"];
                }
                return $glos;
        }

        function getTermList($searchterm = "", $a_letter = "", $a_def = "", $a_tax_node = 0, $a_include_offline_childs = false,
                $a_add_amet_fields = false, array $a_amet_filter = null, $a_omit_virtual = false, $a_include_references = false)
        {
                if ($a_omit_virtual)
                {
                        $glo_ids[] = $this->getId();
                }
                else
                {
                        $glo_ids = $this->getAllGlossaryIds($a_include_offline_childs);
                }
                $list = ilGlossaryTerm::getTermList($glo_ids, $searchterm, $a_letter, $a_def, $a_tax_node,
                        $a_add_amet_fields, $a_amet_filter, $a_include_references);
                return $list;
        }

        function getFirstLetters($a_tax_node = 0)
        {
                $glo_ids = $this->getAllGlossaryIds();
                $first_letters = ilGlossaryTerm::getFirstLetters($glo_ids, $a_tax_node);
                return $first_letters;
        }

        function getAllGlossaryIds($a_include_offline_childs = false)
        {
                global $tree;

                if ($this->isVirtual())
                {       
                        $glo_ids = array();

                        $virtual_mode = $this->getRefId() ? $this->getVirtualMode() : '';
                        switch ($virtual_mode)
                        {
                                case "level":
                                        $glo_arr = $tree->getChildsByType($tree->getParentId($this->getRefId()),"glo");
                                        $glo_ids[] = $this->getId();
                                        foreach ($glo_arr as $glo)
                                        {
                                                {
                                                        $glo_ids[] = $glo['obj_id'];
                                                }
                                        }
                                        if (!$a_include_offline_childs)
                                        {
                                                $glo_ids = ilObjGlossary::removeOfflineGlossaries($glo_ids);
                                        }
                                        // always show entries of current glossary (if no permission is given, user will not come to the presentation screen)
                                        // see bug #14477
                                        if (!in_array($this->getId(), $glo_ids))
                                        {
                                                $glo_ids[] = $this->getId();
                                        }
                                        break;

                                case "subtree":
                                        $subtree_nodes = $tree->getSubTree($tree->getNodeData($tree->getParentId($this->getRefId())));

                                        foreach ($subtree_nodes as $node)
                                        {
                                                if ($node['type'] == 'glo')
                                                {
                                                        $glo_ids[] = $node['obj_id'];
                                                }
                                        }
                                        if (!$a_include_offline_childs)
                                        {
                                                $glo_ids = ilObjGlossary::removeOfflineGlossaries($glo_ids);
                                        }
                                        // always show entries of current glossary (if no permission is given, user will not come to the presentation screen)
                                        // see bug #14477
                                        if (!in_array($this->getId(), $glo_ids))
                                        {
                                                $glo_ids[] = $this->getId();
                                        }
                                        break;
                                
                                // fallback to none virtual mode in case of error
                                default:
                                        $glo_ids[] = $this->getId();
                                        break;
                        }
                }
                else
                {
                        $glo_ids = $this->getId();
                }
                
                return $glo_ids;
        }
        
        function createImportDirectory()
        {
                $glo_data_dir = ilUtil::getDataDir()."/glo_data";
                ilUtil::makeDir($glo_data_dir);
                if(!is_writable($glo_data_dir))
                {
                        $this->ilias->raiseError("Glossary Data Directory (".$glo_data_dir
                                .") not writeable.",$this->ilias->error_obj->FATAL);
                }

                // create glossary directory (data_dir/glo_data/glo_<id>)
                $glo_dir = $glo_data_dir."/glo_".$this->getId();
                ilUtil::makeDir($glo_dir);
                if(!@is_dir($glo_dir))
                {
                        $this->ilias->raiseError("Creation of Glossary Directory failed.",$this->ilias->error_obj->FATAL);
                }
                // create Import subdirectory (data_dir/glo_data/glo_<id>/import)
                $import_dir = $glo_dir."/import";
                ilUtil::makeDir($import_dir);
                if(!@is_dir($import_dir))
                {
                        $this->ilias->raiseError("Creation of Export Directory failed.",$this->ilias->error_obj->FATAL);
                }
        }

        function getImportDirectory()
        {
                $export_dir = ilUtil::getDataDir()."/glo_data"."/glo_".$this->getId()."/import";

                return $export_dir;
        }

        function createExportDirectory($a_type = "xml")
        {
                include_once("./Services/Export/classes/class.ilExport.php");
                return ilExport::_createExportDirectory($this->getId(), $a_type, $this->getType());
        }

        function getExportDirectory($a_type = "xml")
        {
                include_once("./Services/Export/classes/class.ilExport.php");
                return ilExport::_getExportDirectory($this->getId(), $a_type, $this->getType());
        }

        function getExportFiles()
        {
                include_once("./Services/Export/classes/class.ilExport.php");
                return ilExport::_getExportFiles($this->getId(), array("xml", "html"), $this->getType());
        }
        
        function setPublicExportFile($a_type, $a_file)
        {
                $this->public_export_file[$a_type] = $a_file;
        }

        function getPublicExportFile($a_type)
        {
                return $this->public_export_file[$a_type];
        }

        function exportHTML($a_target_dir, $log)
        {
                global $ilias, $tpl;

                // initialize temporary target directory
                ilUtil::delDir($a_target_dir);
                ilUtil::makeDir($a_target_dir);
                
        // init mathjax rendering for export
                include_once './Services/MathJax/classes/class.ilMathJax.php';
                ilMathJax::getInstance()->init(ilMathJax::PURPOSE_EXPORT);

                include_once("./Services/COPage/classes/class.ilCOPageHTMLExport.php");
                $this->co_page_html_export = new ilCOPageHTMLExport($a_target_dir);
                $this->co_page_html_export->createDirectories();

                // export system style sheet
                $location_stylesheet = ilUtil::getStyleSheetLocation("filesystem");
                $style_name = $ilias->account->prefs["style"].".css";
                copy($location_stylesheet, $a_target_dir."/".$style_name);
                $location_stylesheet = ilUtil::getStyleSheetLocation();
                
                if ($this->getStyleSheetId() < 1)
                {
                        $cont_stylesheet = "Services/COPage/css/content.css";
                        copy($cont_stylesheet, $a_target_dir."/content.css");
                }
                else
                {
                        $content_style_img_dir = $a_target_dir."/images";
                        ilUtil::makeDir($content_style_img_dir);
                        $style = new ilObjStyleSheet($this->getStyleSheetId());
                        $style->writeCSSFile($a_target_dir."/content.css", "images");
                        $style->copyImagesToDir($content_style_img_dir);
                }
                
                // export syntax highlighting style
                $syn_stylesheet = ilObjStyleSheet::getSyntaxStylePath();
                copy($syn_stylesheet, $a_target_dir."/syntaxhighlight.css");

                // get glossary presentation gui class
                include_once("./Modules/Glossary/classes/class.ilGlossaryPresentationGUI.php");
                $_GET["cmd"] = "nop";
                $glo_gui = new ilGlossaryPresentationGUI();
                $glo_gui->setOfflineMode(true);
                $glo_gui->setOfflineDirectory($a_target_dir);
                
                // could be implemented in the future if other export
                // formats are supported (e.g. scorm)
                //$glo_gui->setExportFormat($a_export_format);

                // export terms
                $this->exportHTMLGlossaryTerms($glo_gui, $a_target_dir);
                                
                // export all media objects
                foreach ($this->offline_mobs as $mob)
                {
                        $this->exportHTMLMOB($a_target_dir, $glo_gui, $mob, "_blank");
                }
                $_GET["obj_type"]  = "MediaObject";
                $_GET["obj_id"]  = $a_mob_id;
                $_GET["cmd"] = "";
                
                // export all file objects
                foreach ($this->offline_files as $file)
                {
                        $this->exportHTMLFile($a_target_dir, $file);
                }
                
                // export images
                $image_dir = $a_target_dir."/images";
                ilUtil::makeDir($image_dir);
                ilUtil::makeDir($image_dir."/browser");
                copy(ilUtil::getImagePath("enlarge.svg", false, "filesystem"),
                        $image_dir."/enlarge.svg");
                copy(ilUtil::getImagePath("browser/blank.png", false, "filesystem"),
                        $image_dir."/browser/plus.png");
                copy(ilUtil::getImagePath("browser/blank.png", false, "filesystem"),
                        $image_dir."/browser/minus.png");
                copy(ilUtil::getImagePath("browser/blank.png", false, "filesystem"),
                        $image_dir."/browser/blank.png");
                copy(ilUtil::getImagePath("icon_st.svg", false, "filesystem"),
                        $image_dir."/icon_st.svg");
                copy(ilUtil::getImagePath("icon_pg.svg", false, "filesystem"),
                        $image_dir."/icon_pg.svg");
                copy(ilUtil::getImagePath("nav_arr_L.png", false, "filesystem"),
                        $image_dir."/nav_arr_L.png");
                copy(ilUtil::getImagePath("nav_arr_R.png", false, "filesystem"),
                        $image_dir."/nav_arr_R.png");
                        
                // template workaround: reset of template 
                $tpl = new ilTemplate("tpl.main.html", true, true);
                $tpl->setVariable("LOCATION_STYLESHEET",$location_stylesheet);
                $tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
                
                // zip everything
                if (true)
                {
                        // zip it all
                        $date = time();
                        $zip_file = $this->getExportDirectory("html")."/".$date."__".IL_INST_ID."__".
                                $this->getType()."_".$this->getId().".zip";
//echo "zip-".$a_target_dir."-to-".$zip_file;
                        ilUtil::zip($a_target_dir, $zip_file);
                        ilUtil::delDir($a_target_dir);
                }
        }
        

        function exportHTMLGlossaryTerms(&$a_glo_gui, $a_target_dir)
        {
                global $ilUser;
                
                include_once("./Services/COPage/classes/class.ilCOPageHTMLExport.php");
                $copage_export = new ilCOPageHTMLExport($a_target_dir);
                $copage_export->exportSupportScripts();
                
                // index.html file
                $a_glo_gui->tpl = new ilTemplate("tpl.main.html", true, true);
                $style_name = $ilUser->prefs["style"].".css";;
                $a_glo_gui->tpl->setVariable("LOCATION_STYLESHEET","./".$style_name);
                $a_glo_gui->tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
                $a_glo_gui->tpl->setTitle($this->getTitle());

                $content = $a_glo_gui->listTerms();
                $file = $a_target_dir."/index.html";
                                                
                // open file
                if (!($fp = @fopen($file,"w+")))
                {
                        die ("<b>Error</b>: Could not open \"".$file."\" for writing".
                                " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
                }
                chmod($file, 0770);
                fwrite($fp, $content);
                fclose($fp);
                
                $terms = $this->getTermList();
                
                $this->offline_mobs = array();
                $this->offline_files = array();
                
                foreach($terms as $term)
                {
                        $a_glo_gui->tpl = new ilTemplate("tpl.main.html", true, true);
                        $a_glo_gui->tpl = $copage_export->getPreparedMainTemplate();
                        //$tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
                        
                        // set style
                        $style_name = $ilUser->prefs["style"].".css";;
                        $a_glo_gui->tpl->setVariable("LOCATION_STYLESHEET","./".$style_name);

                        $_GET["term_id"] = $term["id"];
                        $_GET["frame"] = "_blank";
                        $content = $a_glo_gui->listDefinitions($_GET["ref_id"],$term["id"],false);
                        $file = $a_target_dir."/term_".$term["id"].".html";
                                                        
                        // open file
                        if (!($fp = @fopen($file,"w+")))
                        {
                                die ("<b>Error</b>: Could not open \"".$file."\" for writing".
                                        " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
                        }
                        chmod($file, 0770);
                        fwrite($fp, $content);
                        fclose($fp);

                        // store linked/embedded media objects of glosssary term
                        include_once("./Modules/Glossary/classes/class.ilGlossaryDefinition.php");
                        $defs = ilGlossaryDefinition::getDefinitionList($term["id"]);
                        foreach($defs as $def)
                        {
                                $def_mobs = ilObjMediaObject::_getMobsOfObject("gdf:pg", $def["id"]);
                                foreach($def_mobs as $def_mob)
                                {
                                        $this->offline_mobs[$def_mob] = $def_mob;
                                }
                                
                                // get all files of page
                                include_once("./Modules/File/classes/class.ilObjFile.php");
                                $def_files = ilObjFile::_getFilesOfObject("gdf:pg", $def["id"]);
                                $this->offline_files = array_merge($this->offline_files, $def_files);

                        }
                }
        }
        
        function exportHTMLMOB($a_target_dir, &$a_glo_gui, $a_mob_id)
        {
                global $tpl;

                $mob_dir = $a_target_dir."/mobs";

                $source_dir = ilUtil::getWebspaceDir()."/mobs/mm_".$a_mob_id;
                if (@is_dir($source_dir))
                {
                        ilUtil::makeDir($mob_dir."/mm_".$a_mob_id);
                        ilUtil::rCopy($source_dir, $mob_dir."/mm_".$a_mob_id);
                }
                
                $tpl = new ilTemplate("tpl.main.html", true, true);
                $tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
                $_GET["obj_type"]  = "MediaObject";
                $_GET["mob_id"]  = $a_mob_id;
                $_GET["cmd"] = "";
                $content = $a_glo_gui->media();
                $file = $a_target_dir."/media_".$a_mob_id.".html";

                // open file
                if (!($fp = @fopen($file,"w+")))
                {
                        die ("<b>Error</b>: Could not open \"".$file."\" for writing".
                                " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
                }
                chmod($file, 0770);
                fwrite($fp, $content);
                fclose($fp);
                
                // fullscreen
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                $mob_obj = new ilObjMediaObject($a_mob_id);
                if ($mob_obj->hasFullscreenItem())
                {
                        $tpl = new ilTemplate("tpl.main.html", true, true);
                        $tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
                        $_GET["mob_id"]  = $a_mob_id;
                        $_GET["cmd"] = "fullscreen";
                        $content = $a_glo_gui->fullscreen();
                        $file = $a_target_dir."/fullscreen_".$a_mob_id.".html";
        
                        // open file
                        if (!($fp = @fopen($file,"w+")))
                        {
                                die ("<b>Error</b>: Could not open \"".$file."\" for writing".
                                        " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
                        }
                        chmod($file, 0770);
                        fwrite($fp, $content);
                        fclose($fp);
                }
        }

        function exportHTMLFile($a_target_dir, $a_file_id)
        {
                $file_dir = $a_target_dir."/files/file_".$a_file_id;
                ilUtil::makeDir($file_dir);
                include_once("./Modules/File/classes/class.ilObjFile.php");
                $file_obj = new ilObjFile($a_file_id, false);
                $source_file = $file_obj->getDirectory($file_obj->getVersion())."/".$file_obj->getFileName();
                if (!is_file($source_file))
                {
                        $source_file = $file_obj->getDirectory()."/".$file_obj->getFileName();
                }
                copy($source_file, $file_dir."/".$file_obj->getFileName());
        }


        function exportXML(&$a_xml_writer, $a_inst, $a_target_dir, &$expLog)
        {
                global $ilBench;

                // export glossary
                $attrs = array();
                $attrs["Type"] = "Glossary";
                $a_xml_writer->xmlStartTag("ContentObject", $attrs);

                // MetaData
                $this->exportXMLMetaData($a_xml_writer);

                // collect media objects
                $terms = $this->getTermList();
                $this->mob_ids = array();
                $this->file_ids = array();
                foreach ($terms as $term)
                {
                        include_once "./Modules/Glossary/classes/class.ilGlossaryDefinition.php";
                        
                        $defs = ilGlossaryDefinition::getDefinitionList($term[id]);

                        foreach($defs as $def)
                        {
                                $this->page_object = new ilGlossaryDefPage($def["id"]);
                                $this->page_object->buildDom();
                                $this->page_object->insertInstIntoIDs(IL_INST_ID);
                                $mob_ids = $this->page_object->collectMediaObjects(false);
                                include_once("./Services/COPage/classes/class.ilPCFileList.php");
                                $file_ids = ilPCFileList::collectFileItems($this->page_object, $this->page_object->getDomDoc());
                                foreach($mob_ids as $mob_id)
                                {
                                        $this->mob_ids[$mob_id] = $mob_id;
                                }
                                foreach($file_ids as $file_id)
                                {
                                        $this->file_ids[$file_id] = $file_id;
                                }
                        }
                }

                // export media objects
                $expLog->write(date("[y-m-d H:i:s] ")."Start Export Media Objects");
                $ilBench->start("GlossaryExport", "exportMediaObjects");
                $this->exportXMLMediaObjects($a_xml_writer, $a_inst, $a_target_dir, $expLog);
                $ilBench->stop("GlossaryExport", "exportMediaObjects");
                $expLog->write(date("[y-m-d H:i:s] ")."Finished Export Media Objects");

                // FileItems
                $expLog->write(date("[y-m-d H:i:s] ")."Start Export File Items");
                $ilBench->start("ContentObjectExport", "exportFileItems");
                $this->exportFileItems($a_target_dir, $expLog);
                $ilBench->stop("ContentObjectExport", "exportFileItems");
                $expLog->write(date("[y-m-d H:i:s] ")."Finished Export File Items");

                // Glossary
                $expLog->write(date("[y-m-d H:i:s] ")."Start Export Glossary Items");
                $ilBench->start("GlossaryExport", "exportGlossaryItems");
                $this->exportXMLGlossaryItems($a_xml_writer, $a_inst, $expLog);
                $ilBench->stop("GlossaryExport", "exportGlossaryItems");
                $expLog->write(date("[y-m-d H:i:s] ")."Finished Export Glossary Items");

                $a_xml_writer->xmlEndTag("ContentObject");
        }

        function exportXMLGlossaryItems(&$a_xml_writer, $a_inst, &$expLog)
        {
                global $ilBench;

                $attrs = array();
                $a_xml_writer->xmlStartTag("Glossary", $attrs);

                // MetaData
                $this->exportXMLMetaData($a_xml_writer);

                $terms = $this->getTermList();

                // export glossary terms
                reset($terms);
                foreach ($terms as $term)
                {
                        $ilBench->start("GlossaryExport", "exportGlossaryItem");
                        $expLog->write(date("[y-m-d H:i:s] ")."Page Object ".$page["obj_id"]);

                        // export xml to writer object
                        $ilBench->start("GlossaryExport", "exportGlossaryItem_getGlossaryTerm");
                        $glo_term = new ilGlossaryTerm($term["id"]);
                        $ilBench->stop("GlossaryExport", "exportGlossaryItem_getGlossaryTerm");
                        $ilBench->start("GlossaryExport", "exportGlossaryItem_XML");
                        $glo_term->exportXML($a_xml_writer, $a_inst);
                        $ilBench->stop("GlossaryExport", "exportGlossaryItem_XML");

                        unset($glo_term);

                        $ilBench->stop("GlossaryExport", "exportGlossaryItem");
                }

                $a_xml_writer->xmlEndTag("Glossary");
        }

        function exportXMLMetaData(&$a_xml_writer)
        {
                include_once("Services/MetaData/classes/class.ilMD2XML.php");
                $md2xml = new ilMD2XML($this->getId(), 0, $this->getType());
                $md2xml->setExportMode(true);
                $md2xml->startExport();
                $a_xml_writer->appendXML($md2xml->getXML());
        }

        function exportXMLMediaObjects(&$a_xml_writer, $a_inst, $a_target_dir, &$expLog)
        {
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");

                foreach ($this->mob_ids as $mob_id)
                {
                        $expLog->write(date("[y-m-d H:i:s] ")."Media Object ".$mob_id);
                        $media_obj = new ilObjMediaObject($mob_id);
                        $media_obj->exportXML($a_xml_writer, $a_inst);
                        $media_obj->exportFiles($a_target_dir);
                        unset($media_obj);
                }
        }

        function exportFileItems($a_target_dir, &$expLog)
        {
                include_once("./Modules/File/classes/class.ilObjFile.php");

                foreach ($this->file_ids as $file_id)
                {
                        $expLog->write(date("[y-m-d H:i:s] ")."File Item ".$file_id);
                        $file_obj = new ilObjFile($file_id, false);
                        $file_obj->export($a_target_dir);
                        unset($file_obj);
                }
        }



        function modifyExportIdentifier($a_tag, $a_param, $a_value)
        {
                if ($a_tag == "Identifier" && $a_param == "Entry")
                {
                        $a_value = "il_".IL_INST_ID."_glo_".$this->getId();
                }

                return $a_value;
        }




        function delete()
        {
                global $ilDB;
                
                // always call parent delete function first!!
                if (!parent::delete())
                {
                        return false;
                }

                // delete terms
                if (!$this->isVirtual())
                {
                        $terms = $this->getTermList();
                        foreach ($terms as $term)
                        {
                                $term_obj = new ilGlossaryTerm($term["id"]);
                                $term_obj->delete();
                        }
                }

                // delete term references
                include_once("./Modules/Glossary/classes/class.ilGlossaryTermReferences.php");
                $refs = new ilGlossaryTermReferences($this->getId());
                $refs->delete();

                // delete glossary data entry
                $q = "DELETE FROM glossary WHERE id = ".$ilDB->quote($this->getId());
                $ilDB->query($q);

                // delete meta data
                $this->deleteMetaData();

                return true;
        }

        function getXMLZip()
        {
                include_once("./Modules/Glossary/classes/class.ilGlossaryExport.php");
                $glo_exp = new ilGlossaryExport($this);
                return $glo_exp->buildExportFile();
        }

        static function getDeletionDependencies($a_obj_id)
        {
                global $lng;
                
                $dep = array();
                include_once("./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php");
                $sms = ilObjSAHSLearningModule::getScormModulesForGlossary($a_obj_id);
                foreach ($sms as $sm)
                {
                        $lng->loadLanguageModule("content");
                        $dep[$sm] = $lng->txt("glo_used_in_scorm");
                }
//echo "-".$a_obj_id."-";
//var_dump($dep);
                return $dep;    
        }
        
        function getTaxonomyId()
        {
                include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
                $tax_ids = ilObjTaxonomy::getUsageOfObject($this->getId());
                if (count($tax_ids) > 0)
                {
                        // glossaries handle max. one taxonomy
                        return $tax_ids[0];
                }
                return 0;
        }
        
        
        public function cloneObject($a_target_id,$a_copy_id = 0, $a_omit_tree = false)
        {
                global $ilDB, $ilUser, $ilias;

                $new_obj = parent::cloneObject($a_target_id,$a_copy_id, $a_omit_tree);
                $this->cloneMetaData($new_obj);

                //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->setDescription($this->getDescription());
                $new_obj->setVirtualMode($this->getVirtualMode());
                $new_obj->setPresentationMode($this->getPresentationMode());
                $new_obj->setSnippetLength($this->getSnippetLength());
                $new_obj->setAutoGlossaries($this->getAutoGlossaries());
                $new_obj->update();

                // set/copy stylesheet
                include_once("./Services/Style/Content/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 taxonomy
                if (($tax_id = $this->getTaxonomyId()) > 0)
                {
                        // clone it
                        include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
                        $tax = new ilObjTaxonomy($tax_id);
                        $new_tax = $tax->cloneObject(0,0,true);
                        $map = $tax->getNodeMapping();
                        
                        // assign new taxonomy to new glossary
                        ilObjTaxonomy::saveUsage($new_tax->getId(), $new_obj->getId());
                }
                
                // assign new tax/new glossary
                // handle mapping
                
                // prepare tax node assignments objects
                include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
                if ($tax_id > 0)
                {
                        $tax_ass = new ilTaxNodeAssignment("glo", $this->getId(), "term", $tax_id);
                        $new_tax_ass = new ilTaxNodeAssignment("glo", $new_obj->getId(), "term", $new_tax->getId());
                }
                
                // copy terms
                $term_mappings = array();
                foreach (ilGlossaryTerm::getTermList($this->getId()) as $term)
                {
                        $new_term_id = ilGlossaryTerm::_copyTerm($term["id"], $new_obj->getId());
                        $term_mappings[$term["id"]] = $new_term_id;
                        
                        // copy tax node assignments
                        if ($tax_id > 0)
                        {
                                $assignmts = $tax_ass->getAssignmentsOfItem($term["id"]);
                                foreach ($assignmts as $a)
                                {
                                        if ($map[$a["node_id"]] > 0)
                                        {
                                                $new_tax_ass->addAssignment($map[$a["node_id"]] ,$new_term_id);
                                        }
                                }
                        }
                }

                // add mapping of term_ids to copy wizard options
                if (!empty($term_mappings))
                {
                        $cp_options->appendMapping($this->getRefId().'_glo_terms', (array) $term_mappings);
                }


                return $new_obj;
        }

        function removeOfflineGlossaries($a_glo_ids)
        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT id FROM glossary ".
                        " WHERE ".$ilDB->in("id", $a_glo_ids, false, "integer").
                        " AND is_online = ".$ilDB->quote("y", "text")
                        );
                $glo_ids = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $glo_ids[] = $rec["id"];
                }
                return $glo_ids;
        }
        
        public static function getAdvMDSubItemTitle($a_obj_id, $a_sub_type, $a_sub_id)
        {
                global $lng;
                
                if($a_sub_type == "term")
                {                               
                        $lng->loadLanguageModule("glo");
                        
                        include_once "Modules/Glossary/classes/class.ilGlossaryTerm.php";
                        return $lng->txt("glo_term").' "'. ilGlossaryTerm::_lookGlossaryTerm($a_sub_id).'"';
                }
        }

        function autoLinkGlossaryTerms($a_glo_id)
        {
                // get terms of target glossary
                include_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
                $terms = ilGlossaryTerm::getTermList($a_glo_id);

                // for each get page: get content
                $source_terms = ilGlossaryTerm::getTermList($this->getId());
                $found_pages = array();
                foreach($source_terms as $source_term)
                {
                        $source_defs = ilGlossaryDefinition::getDefinitionList($source_term["id"]);

                        for ($j = 0; $j < count($source_defs); $j++)
                        {
                                $def = $source_defs[$j];
                                $pg = new ilGlossaryDefPage($def["id"]);

                                $c = $pg->getXMLContent();
                                foreach ($terms as $t)
                                {
                                        if (is_int(stripos($c, $t["term"])))
                                        {
                                                $found_pages[$def["id"]]["terms"][] = $t;
                                                if (!is_object($found_pages[$def["id"]]["page"]))
                                                {
                                                        $found_pages[$def["id"]]["page"] = $pg;
                                                }
                                        }
                                }
                                reset($terms);
                        }
                }

                // ilPCParagraph autoLinkGlossariesPage with page and terms
                include_once("./Services/COPage/classes/class.ilPCParagraph.php");
                foreach ($found_pages as $id => $fp)
                {
                        ilPCParagraph::autoLinkGlossariesPage($fp["page"], $fp["terms"]);
                }


        }

}

?>