class.ilCOPageHTMLExport.php

Go to the documentation of this file.

<?php

use ILIAS\components\Export\HTML\ExportCollector;

class ilCOPageHTMLExport
{
    protected \ILIAS\MediaObjects\MediaObjectManager $media_manager;
    protected \ILIAS\Style\Content\InternalDomainService $content_style;
    protected \ILIAS\COPage\Xsl\XslManager $xsl;
    protected string $css_dir = "";
    protected string $js_yahoo_dir = "";
    protected string $js_dir = "";
    protected string $media_service_dir = "";
    protected string $services_dir = "";
    protected string $content_style_img_dir = "";
    protected string $content_style_dir = "";
    protected string $tex_dir = "";
    protected string $files_dir = "";
    protected string $mobs_dir = "";
    protected array $mobs = [];
    protected array $glossary_terms = [];
    protected array $files = [];
    protected array $files_direct = [];
    protected array $int_links = [];
    protected array $q_ids = [];
    protected string $exp_dir = "";
    protected int $content_style_id = 0;
    protected ilObjUser $user;
    protected ilLogger $log;
    protected \ILIAS\GlobalScreen\Services $global_screen;
    protected \ILIAS\Skill\Service\SkillTreeService $skill_tree_service;
    protected \ILIAS\Skill\Service\SkillPersonalService $skill_personal_service;
    protected \ILIAS\COPage\PageLinker $page_linker;
    protected int $ref_id;

    public function __construct(
        string $a_exp_dir,
        \ILIAS\COPage\PageLinker $linker = null,
        int $ref_id = 0,
        protected ?ExportCollector $export_collector = null
    ) {
        global $DIC;
        $this->log = ilLoggerFactory::getLogger('copg');
        $this->user = $DIC->user();
        $this->global_screen = $DIC->globalScreen();
        $this->skill_tree_service = $DIC->skills()->tree();
        $this->skill_personal_service = $DIC->skills()->personal();
        $this->page_linker = is_null($linker)
            ? new ilPageLinker("", true)
            : $linker;
        $this->ref_id = $ref_id;

        $this->exp_dir = $a_exp_dir;
        $this->mobs_dir = $a_exp_dir . "/mobs";
        $this->files_dir = $a_exp_dir . "/files";
        $this->tex_dir = $a_exp_dir . "/teximg";
        $this->content_style_dir = $a_exp_dir . "/content_style";
        $this->content_style_img_dir = $a_exp_dir . "/content_style/images";

        $this->services_dir = $a_exp_dir . "/components/ILIAS";
        $this->media_service_dir = $this->services_dir . "/MediaObjects";

        $this->js_dir = $a_exp_dir . '/js';
        $this->js_yahoo_dir = $a_exp_dir . '/js/yahoo';
        $this->css_dir = $a_exp_dir . '/css';
        $this->xsl = $DIC->copage()->internal()->domain()->xsl();
        $this->content_style = $DIC->contentStyle()->internal()->domain();
        $this->media_manager = $DIC->mediaObjects()->internal()->domain()->mediaObject();
    }

    public function setContentStyleId(int $a_val): void
    {
        $this->content_style_id = $a_val;
    }

    public function getContentStyleId(): int
    {
        return $this->content_style_id;
    }

    public function createDirectories(): void
    {
        ilFileUtils::makeDir($this->mobs_dir);
        ilFileUtils::makeDir($this->files_dir);
        ilFileUtils::makeDir($this->tex_dir);
        ilFileUtils::makeDir($this->content_style_dir);
        ilFileUtils::makeDir($this->content_style_img_dir);
        ilFileUtils::makeDir($this->services_dir);
        ilFileUtils::makeDir($this->media_service_dir);

        ilFileUtils::makeDirParents($this->js_dir);
        ilFileUtils::makeDirParents($this->js_yahoo_dir);
        ilFileUtils::makeDirParents($this->css_dir);
        ilFileUtils::makeDirParents($this->css_dir . "/yahoo");
    }

    public function exportStyles(): void
    {
        $this->log->debug("export styles");

        // export content style sheet
        if ($this->getContentStyleId() < 1) {     // basic style
            if (is_null($this->export_collector)) {
                ilFileUtils::rCopy(
                    ilObjStyleSheet::getBasicImageDir(),
                    $this->exp_dir . "/" . ilObjStyleSheet::getBasicImageDir()
                );
                ilFileUtils::makeDirParents($this->exp_dir . "/components/ILIAS/COPage/css");
                copy("../components/ILIAS/COPage/resources/content.css",
                    $this->exp_dir . "/components/ILIAS/COPage/css/content.css");
            } else {
                $this->export_collector->addDirectory(
                    ilObjStyleSheet::getBasicImageDir(),
                    "/basic_style/images"
                );
                $this->export_collector->addFile(
                    "../components/ILIAS/COPage/css/content.css",
                    ilObjStyleSheet::getExportContentStylePath()
                );
            }
        } else {
            $style = new ilObjStyleSheet($this->getContentStyleId());
            if (is_null($this->export_collector)) {
                $style->copyImagesToDir($this->exp_dir . "/" . $style->getImagesDirectory());
                $this->exportResourceFile(
                    $this->exp_dir,
                    ilObjStyleSheet::getContentStylePath($this->getContentStyleId(), false, false)
                );
            } else {
                $res_id = $this->content_style->style($this->getContentStyleId())->getResourceIdentification();
                if ($res_id) {
                    $this->export_collector->addContainerDirectory(
                        $res_id->serialize(),
                        "",
                        "content_style"
                    );
                }
            }
        }

        // export syntax highlighting style
        $syn_stylesheet = ilObjStyleSheet::getSyntaxStylePath();
        $this->exportResourceFile($this->exp_dir, $syn_stylesheet);

        // export print style
        $print_stylesheet = ilObjStyleSheet::getContentPrintStyle();
        $this->exportResourceFile($this->exp_dir, $print_stylesheet);
    }

    public function exportSupportScripts(): void
    {
        $this->log->debug("export scripts");

        $collector = new \ILIAS\COPage\ResourcesCollector(ilPageObjectGUI::OFFLINE);

        foreach ($collector->getJavascriptFiles() as $js) {
            $this->exportResourceFile($this->exp_dir, $js);
        }

        foreach ($collector->getCssFiles() as $css) {
            $this->exportResourceFile($this->exp_dir, $css);
        }
    }

    protected function exportResourceFile(
        string $target_dir,
        string $file
    ): void {
        if (is_int(strpos($file, "?"))) {
            $file = substr($file, 0, strpos($file, "?"));
        }
        if (is_file($file)) {
            if (is_null($this->export_collector)) {
                $dir = dirname($file);
                ilFileUtils::makeDirParents($target_dir . "/" . $dir);
                if (!is_file($target_dir . "/" . $file)) {
                    copy($file, $target_dir . "/" . $file);
                }
            } else {
                $this->export_collector->addFile($file, $file);
            }
        }
    }

    public function getPreparedMainTemplate(
        ilGlobalTemplateInterface $a_tpl = null
    ): ilGlobalTemplateInterface {
        global $DIC;
        $this->log->debug("get main template");


        $resource_collector = new \ILIAS\COPage\ResourcesCollector(ilPageObjectGUI::OFFLINE);
        $resource_injector = new \ILIAS\COPage\ResourcesInjector($resource_collector);

        if (!is_null($a_tpl)) {
            $tpl = $a_tpl;
        } else {
            // template workaround: reset of template
            $tpl = new ilGlobalPageTemplate($DIC->globalScreen(), $DIC->ui(), $DIC->http());
        }

        // scripts needed
        /* @todo check
        $scripts = [];
        $scripts = array_merge($scripts, ilPlayerUtil::getJsFilePaths());

        $mathJaxSetting = new ilSetting("MathJax");
        $use_mathjax = $mathJaxSetting->get("enable");
        if ($use_mathjax) {
            $scripts[] = $mathJaxSetting->get("path_to_mathjax");
        }
        */

        $tpl->addCss(\ilUtil::getStyleSheetLocation());
        // important, we pass 0 here, since the export will use the standard directory
        $tpl->addCss(ilObjStyleSheet::getExportContentStylePath());
        $tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());

        $resource_injector->inject($tpl);

        return $tpl;
    }

    public function collectPageElements(
        string $a_type,
        int $a_id,
        string $lang = ""
    ): void {
        $this->log->debug("collect page elements");

        // collect all dependent pages (only one level deep)
        $pages[] = [
            "type" => $a_type,
            "id" => $a_id
        ];

        // ... content includes
        $pcs = ilPageContentUsage::getUsagesOfPage($a_id, $a_type, 0, false, $lang);
        foreach ($pcs as $pc) {
            // content includes
            if ($pc["type"] == "incl") {
                $pages[] = [
                    "type" => "mep:pg",
                    "id" => $pc["id"]
                ];
            }
        }

        // ... internal links
        $pg_links = \ilInternalLink::_getTargetsOfSource($a_type, $a_id, $lang);
        $this->int_links = array_merge($this->int_links, $pg_links);
        $this->glossary_terms = [];

        // ... glossary pages of internal links
        foreach ($this->int_links as $int_link) {
            if ($int_link["type"] == "git") {
                $this->glossary_terms[] = $int_link["id"];
                // store linked/embedded media objects of glosssary term
                $pages[] = [
                    "type" => "term:pg",
                    "id" => $int_link["id"]
                ];
            }
        }

        // resources of pages
        foreach ($pages as $page) {
            $page_id = $page["id"];
            $page_type = $page["type"];

            // collect media objects
            $pg_mobs = ilObjMediaObject::_getMobsOfObject($page_type, $page_id, 0, $lang);
            foreach ($pg_mobs as $pg_mob) {
                $this->mobs[$pg_mob] = $pg_mob;
                $this->log->debug("HTML Export: Add media object $pg_mob (" . \ilObject::_lookupTitle($pg_mob) . ") " .
                    " due to page $page_id, $page_type ).");
            }

            // collect all files
            $files = ilObjFile::_getFilesOfObject($page_type, $page_id, 0, $lang);
            foreach ($files as $f) {
                $this->files[$f] = $f;
            }

            // collect all questions
            $q_ids = \ilPCQuestion::_getQuestionIdsForPage($a_type, $a_id, $lang);
            foreach ($q_ids as $q_id) {
                $this->q_ids[$q_id] = $q_id;
            }
        }

        // collect page content items
        $skill_tree = $ws_tree = null;

        // skills
        foreach ($pcs as $pc) {
            if ($pc["type"] == "skmg") {
                $skill_id = $pc["id"];

                // trying to find user id
                $user_id = null;
                switch ($a_type) {
                    case "prtf:pg":
                        $page = new ilPortfolioPage($a_id);
                        $user_id = $page->getCreationUserId();
                        break;

                    default:
                        // :TODO:
                        break;
                }

                if ($user_id) {
                    // we only need 1 instance each
                    if (!$skill_tree) {
                        $skill_tree = $this->skill_tree_service->getGlobalSkillTree();

                        $ws_tree = new ilWorkspaceTree($user_id);
                    }

                    // walk skill tree
                    $skill_id = (int) $skill_id;
                    $vtree = $this->skill_tree_service->getVirtualSkillTreeForNodeId($skill_id);
                    $tref_id = 0;
                    if (ilSkillTreeNode::_lookupType($skill_id) == "sktr") {
                        $tref_id = $skill_id;
                        $skill_id = ilSkillTemplateReference::_lookupTemplateId($skill_id);
                    }
                    $b_skills = $vtree->getSubTreeForCSkillId($skill_id . ":" . $tref_id, true);

                    foreach ($b_skills as $bs) {
                        $skill = ilSkillTreeNodeFactory::getInstance($bs["skill_id"]);
                        $level_data = $skill->getLevelData();
                        foreach ($level_data as $k => $v) {
                            // get assigned materials from personal skill
                            $mat = $this->skill_personal_service->getAssignedMaterials($user_id, $bs["tref_id"], $v["id"]);
                            if (count($mat)) {
                                foreach ($mat as $item) {
                                    $wsp_id = $item->getWorkspaceId();
                                    $obj_id = $ws_tree->lookupObjectId($wsp_id);

                                    // all possible material types for now
                                    switch (ilObject::_lookupType($obj_id)) {
                                        case "file":
                                            $this->files[$obj_id] = $obj_id;
                                            break;

                                        case "tstv":
                                            $obj = new ilObjTestVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "excv":
                                            $obj = new ilObjExerciseVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "crsv":
                                            $obj = new ilObjCourseVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "cmxv":
                                            $obj = new ilObjCmiXapiVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "ltiv":
                                            $obj = new ilObjLTIConsumerVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "scov":
                                            $obj = new ilObjSCORMVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }

    public function exportPageElements(
        callable $a_update_callback = null
    ): void {
        $this->log->debug("export page elements");

        $total = count($this->mobs) + count($this->files) + count($this->files_direct);
        $cnt = 0;
        // export all media objects
        $linked_mobs = array();
        foreach ($this->mobs as $mob) {
            if (ilObject::_exists($mob) && ilObject::_lookupType($mob) == "mob") {
                $this->exportHTMLMOB($mob, $linked_mobs);
            }
            if (is_callable($a_update_callback)) {
                $cnt++;
                $a_update_callback($total, $cnt);
            }
        }
        $linked_mobs2 = array();                                // mobs linked in link areas
        foreach ($linked_mobs as $mob) {
            if (ilObject::_exists($mob)) {
                $this->exportHTMLMOB($mob, $linked_mobs2);
            }
        }

        // export all file objects
        foreach ($this->files as $file) {
            $this->exportHTMLFile($file);
            if (is_callable($a_update_callback)) {
                $cnt++;
                $a_update_callback($total, $cnt);
            }
        }

        // export all files (which are not objects
        foreach ($this->files_direct as $file_id => $attr) {
            $this->exportHTMLFileDirect($file_id, $attr[0], $attr[1]);
            if (is_callable($a_update_callback)) {
                $cnt++;
                $a_update_callback($total, $cnt);
            }
        }

        $this->exportQuestionFiles();

        // export all glossary terms
        $this->exportHTMLGlossaryTerms();
    }

    protected function initResourceTemplate(
        string $template_file
    ): ilGlobalTemplateInterface {
        $this->global_screen->layout()->meta()->reset();
        $tpl = new ilGlobalTemplate($template_file, true, true, "components/ILIAS/COPage");
        $this->getPreparedMainTemplate($tpl);
        $tpl->addCss(\ilUtil::getStyleSheetLocation());
        $tpl->addCss(ilObjStyleSheet::getContentStylePath($this->getContentStyleId()));
        $tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
        return $tpl;
    }

    public function exportHTMLMOB(
        int $a_mob_id,
        array &$a_linked_mobs
    ): void {
        $this->log->debug("export html mobs");

        if (is_null($this->export_collector)) {
            $source_dir = ilFileUtils::getWebspaceDir() . "/mobs/mm_" . $a_mob_id;
            if (is_dir($source_dir)) {
                ilFileUtils::makeDir($this->mobs_dir . "/mm_" . $a_mob_id);
                ilFileUtils::rCopy($source_dir, $this->mobs_dir . "/mm_" . $a_mob_id);
            }
        } else {
            $mob_res_id = $this->media_manager->getContainerResourceId($a_mob_id);
            if ($mob_res_id) {
                $this->export_collector->addContainerDirectory(
                    $mob_res_id->serialize(),
                    "",
                    "/mobs/mm_" . $a_mob_id,
                );
            }
        }

        $mob_obj = new ilObjMediaObject($a_mob_id);

        $tpl = $this->initResourceTemplate("tpl.fullscreen.html");
        $med_links = ilMediaItem::_getMapAreasIntLinks($a_mob_id);
        $link_xml = $this->page_linker->getLinkXML($med_links);

        $params = [
            "mode" => "media",
            'enlarge_path' => ilUtil::getImagePath("media/enlarge.svg", false, "output", true),
            'enable_html_mob' => ilObjMediaObject::isTypeAllowed("html") ? "y" : "n",
            'fullscreen_link' => $this->page_linker->getFullScreenLink()
        ];
        if ($this->ref_id > 0) {
            $params["ref_id"] = $this->ref_id;
            $params["link_params"] = "ref_id=" . $this->ref_id;
        }

        $tpl->setVariable("MEDIA_CONTENT", $this->renderMob($mob_obj, $link_xml, $params));
        $html = $tpl->printToString();
        if (is_null($this->export_collector)) {
            $file = $this->exp_dir . "/media_" . $a_mob_id . ".html";
            $fp = fopen($file, "w+");
            fwrite($fp, $html);
            fclose($fp);
            unset($fp);
        } else {
            $this->export_collector->addString($html, "/media_" . $a_mob_id . ".html");
        }

        if ($mob_obj->hasFullscreenItem()) {
            $tpl = $this->initResourceTemplate("tpl.fullscreen.html");
            $params["mode"] = "fullscreen";
            $tpl->setVariable("MEDIA_CONTENT", $this->renderMob($mob_obj, $link_xml, $params));
            $html = $tpl->printToString();
            if (is_null($this->export_collector)) {
                $file = $this->exp_dir . "/fullscreen_" . $a_mob_id . ".html";
                $fp = fopen($file, "w+");
                fwrite($fp, $html);
                fclose($fp);
                unset($fp);
            } else {
                $this->export_collector->addString($html, "/fullscreen_" . $a_mob_id . ".html");
            }
        }

        $linked_mobs = $mob_obj->getLinkedMediaObjects();
        $a_linked_mobs = array_merge($a_linked_mobs, $linked_mobs);
    }

    protected function renderMob(
        \ilObjMediaObject $mob_obj,
        string $link_xml,
        array $params
    ): string {
        $xml = "<dummy>" .
            $mob_obj->getXML(IL_MODE_ALIAS) .
            $mob_obj->getXML(IL_MODE_OUTPUT) .
            $link_xml .
            "</dummy>";

        return $this->xsl->process($xml, $params);
    }


    public function exportHTMLFile(string $a_file_id): void
    {
        $file_dir = $this->files_dir . "/file_" . $a_file_id;
        ilFileUtils::makeDir($file_dir);

        $file_obj = new ilObjFile($a_file_id, false);
        $source_file = $file_obj->getFile($file_obj->getVersion());
        if (!is_file($source_file)) {
            $source_file = $file_obj->getFile();
        }
        if (is_file($source_file)) {
            copy($source_file, $file_dir . "/" . $file_obj->getFileName());
        }
    }

    public function exportHTMLFileDirect(
        string $a_file_id,
        string $a_source_file,
        string $a_file_name
    ): void {
        $file_dir = $this->files_dir . "/file_" . $a_file_id;
        ilFileUtils::makeDir($file_dir);

        if (is_file($a_source_file)) {
            copy(
                $a_source_file,
                $file_dir . "/" . ilFileUtils::getASCIIFilename($a_file_name)
            );
        }
    }

    protected function exportQuestionFiles(): void
    {
        // export questions (images)
        if (count($this->q_ids) > 0) {
            foreach ($this->q_ids as $q_id) {
                ilFileUtils::makeDirParents($this->exp_dir . "/assessment/0/" . $q_id . "/images");
                ilFileUtils::rCopy(
                    ilFileUtils::getWebspaceDir() . "/assessment/0/" . $q_id . "/images",
                    $this->exp_dir . "/assessment/0/" . $q_id . "/images"
                );
            }
        }
    }

    public function exportHTMLGlossaryTerms(): void
    {
        foreach ($this->glossary_terms as $term_id) {
            if (!ilGlossaryTerm::_exists($term_id)) {
                continue;
            }
            $tpl = $this->initResourceTemplate("tpl.glossary_term_output.html");

            $term_gui = new ilGlossaryTermGUI($term_id);
            $term_gui->setPageLinker($this->page_linker);
            $term_gui->setOfflineDirectory($this->exp_dir);
            $term_gui->output(true, $tpl);

            // write file
            $html = $tpl->printToString();
            $file = $this->exp_dir . "/term_" . $term_id . ".html";
            $fp = fopen($file, "w+");
            fwrite($fp, $html);
            fclose($fp);
        }
    }
}