class.ilPCMediaObject.php

Go to the documentation of this file.

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

require_once("./Services/COPage/classes/class.ilPageContent.php");

class ilPCMediaObject extends ilPageContent
{
    protected $user;

    protected $mob_node;

    protected $ui;

    protected $mediaobject;

    protected $lng;

    public function init()
    {
        global $DIC;

        $this->user = $DIC->user();
        $this->setType("media");
        $this->ui = $DIC->ui();
        $this->lng = $DIC->language();
    }

    public function readMediaObject($a_mob_id = 0)
    {
        if ($a_mob_id > 0) {
            $mob = new ilObjMediaObject($a_mob_id);
            $this->setMediaObject($mob);
        }
    }
    
    public function setNode($a_node)
    {
        parent::setNode($a_node);               // this is the PageContent node
        $this->mob_node = $a_node->first_child();
    }

    public function setDom(&$a_dom)
    {
        $this->dom = $a_dom;
    }

    public function setHierId($a_hier_id)
    {
        $this->hier_id = $a_hier_id;
    }

    public function setMediaObject($a_mediaobject)
    {
        $this->mediaobject = $a_mediaobject;
    }

    public function getMediaObject() : ilObjMediaObject
    {
        return $this->mediaobject;
    }
    
    public function createMediaObject()
    {
        $this->setMediaObject(new ilObjMediaObject());
    }

    public function create(&$a_pg_obj, $a_hier_id)
    {
        $this->node = $this->createPageContentNode();
    }
    
    public function createAlias(&$a_pg_obj, $a_hier_id, $a_pc_id = "")
    {
        $this->node = $this->dom->create_element("PageContent");
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->mob_node = $this->dom->create_element("MediaObject");
        $this->mob_node = $this->node->append_child($this->mob_node);
        $this->mal_node = $this->dom->create_element("MediaAlias");
        $this->mal_node = $this->mob_node->append_child($this->mal_node);
        $this->mal_node->set_attribute("OriginId", "il__mob_" . $this->getMediaObject()->getId());

        // standard view
        $item_node = $this->dom->create_element("MediaAliasItem");
        $item_node = $this->mob_node->append_child($item_node);
        $item_node->set_attribute("Purpose", "Standard");
        $media_item = $this->getMediaObject()->getMediaItem("Standard");

        $layout_node = $this->dom->create_element("Layout");
        $layout_node = $item_node->append_child($layout_node);
        if ($media_item->getWidth() > 0) {
            //$layout_node->set_attribute("Width", $media_item->getWidth());
        }
        if ($media_item->getHeight() > 0) {
            //$layout_node->set_attribute("Height", $media_item->getHeight());
        }
        $layout_node->set_attribute("HorizontalAlign", "Left");

        // caption
        if ($media_item->getCaption() != "") {
            $cap_node = $this->dom->create_element("Caption");
            $cap_node = $item_node->append_child($cap_node);
            $cap_node->set_attribute("Align", "bottom");
            $cap_node->set_content($media_item->getCaption());
        }

        // text representation
        if ($media_item->getTextRepresentation() != "") {
            $tr_node = $this->dom->create_element("TextRepresentation");
            $tr_node = $item_node->append_child($tr_node);
            $tr_node->set_content($media_item->getTextRepresentation());
        }

        $pars = $media_item->getParameters();
        foreach ($pars as $par => $val) {
            $par_node = $this->dom->create_element("Parameter");
            $par_node = $item_node->append_child($par_node);
            $par_node->set_attribute("Name", $par);
            $par_node->set_attribute("Value", $val);
        }

        // fullscreen view
        $fullscreen_item = $this->getMediaObject()->getMediaItem("Fullscreen");
        if (is_object($fullscreen_item)) {
            $item_node = $this->dom->create_element("MediaAliasItem");
            $item_node = $this->mob_node->append_child($item_node);
            $item_node->set_attribute("Purpose", "Fullscreen");

            // width and height
            $layout_node = $this->dom->create_element("Layout");
            $layout_node = $item_node->append_child($layout_node);
            if ($fullscreen_item->getWidth() > 0) {
                $layout_node->set_attribute("Width", $fullscreen_item->getWidth());
            }
            if ($fullscreen_item->getHeight() > 0) {
                $layout_node->set_attribute("Height", $fullscreen_item->getHeight());
            }

            // caption
            if ($fullscreen_item->getCaption() != "") {
                $cap_node = $this->dom->create_element("Caption");
                $cap_node = $item_node->append_child($cap_node);
                $cap_node->set_attribute("Align", "bottom");
                $cap_node->set_content($fullscreen_item->getCaption());
            }

            // text representation
            if ($fullscreen_item->getTextRepresentation() != "") {
                $tr_node = $this->dom->create_element("TextRepresentation");
                $tr_node = $item_node->append_child($tr_node);
                $tr_node->set_content($fullscreen_item->getTextRepresentation());
            }

            $pars = $fullscreen_item->getParameters();
            foreach ($pars as $par => $val) {
                $par_node = $this->dom->create_element("Parameter");
                $par_node = $item_node->append_child($par_node);
                $par_node->set_attribute("Name", $par);
                $par_node->set_attribute("Value", $val);
            }
        }
    }
    
    public function updateObjectReference()
    {
        if (is_object($this->mob_node)) {
            $this->mal_node = $this->mob_node->first_child();
            if (is_object($this->mal_node) && $this->mal_node->node_name() == "MediaAlias") {
                $this->mal_node->set_attribute("OriginId", "il__mob_" . $this->getMediaObject()->getId());
            }
        }
    }

    public function dumpXML()
    {
        $xml = $this->dom->dump_node($this->node);
        return $xml;
    }
    
    public function setClass($a_class)
    {
        if (is_object($this->mob_node)) {
            $mal_node = $this->mob_node->first_child();
            if (is_object($mal_node)) {
                if (!empty($a_class)) {
                    $mal_node->set_attribute("Class", $a_class);
                } else {
                    if ($mal_node->has_attribute("Class")) {
                        $mal_node->remove_attribute("Class");
                    }
                }
            }
        }
    }

    public function getClass()
    {
        if (is_object($this->mob_node)) {
            $mal_node = $this->mob_node->first_child();
            if (is_object($mal_node)) {
                $class = $mal_node->get_attribute("Class");
                return $class;
            }
        }
    }
    
    public static function getLangVars()
    {
        return array("pc_mob");
    }

    public static function afterPageUpdate($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
    {
        if (!$a_page->getImportMode()) {
            include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
            $mob_ids = ilObjMediaObject::_getMobsOfObject(
                $a_page->getParentType() . ":pg",
                $a_page->getId(),
                0,
                $a_page->getLanguage()
            );
            self::saveMobUsage($a_page, $a_domdoc);
            foreach ($mob_ids as $mob) {        // check, whether media object can be deleted
                if (ilObject::_exists($mob) && ilObject::_lookupType($mob) == "mob") {
                    $mob_obj = new ilObjMediaObject($mob);
                    $usages = $mob_obj->getUsages(false);
                    if (count($usages) == 0) {  // delete, if no usage exists
                        $mob_obj->delete();
                    }
                }
            }
        }
    }
    
    public static function beforePageDelete($a_page)
    {
        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
        $mob_ids = ilObjMediaObject::_getMobsOfObject(
            $a_page->getParentType() . ":pg",
            $a_page->getId(),
            0,
            $a_page->getLanguage()
        );

        ilObjMediaObject::_deleteAllUsages(
            $a_page->getParentType() . ":pg",
            $a_page->getId(),
            false,
            $a_page->getLanguage()
        );

        foreach ($mob_ids as $mob) {    // check, whether media object can be deleted
            if (ilObject::_exists($mob) && ilObject::_lookupType($mob) == "mob") {
                $mob_obj = new ilObjMediaObject($mob);
                $usages = $mob_obj->getUsages(false);
                if (count($usages) == 0) {      // delete, if no usage exists
                    $mob_obj->delete();
                }
            }
        }
    }

    public static function afterPageHistoryEntry($a_page, DOMDocument $a_old_domdoc, $a_old_xml, $a_old_nr)
    {
        self::saveMobUsage($a_page, $a_old_domdoc, $a_old_nr);
    }

    public static function saveMobUsage($a_page, $a_domdoc, $a_old_nr = 0)
    {
        $usages = array();
        
        // media aliases
        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query('//MediaAlias');
        foreach ($nodes as $node) {
            $id_arr = explode("_", $node->getAttribute("OriginId"));
            $mob_id = $id_arr[count($id_arr) - 1];
            if ($mob_id > 0 && $id_arr[1] == "") {
                $usages[$mob_id] = true;
            }
        }

        // media objects
        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query('//MediaObject/MetaData/General/Identifier');
        foreach ($nodes as $node) {
            $mob_entry = $node->getAttribute("Entry");
            $mob_arr = explode("_", $mob_entry);
            $mob_id = $mob_arr[count($mob_arr) - 1];
            if ($mob_id > 0 && $mob_arr[1] == "") {
                $usages[$mob_id] = true;
            }
        }

        // internal links
        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query("//IntLink[@Type='MediaObject']");
        foreach ($nodes as $node) {
            $mob_target = $node->getAttribute("Target");
            $mob_arr = explode("_", $mob_target);
            //echo "<br>3<br>";
            //echo $mob_target."<br>";
            //var_dump($mob_arr);
            $mob_id = $mob_arr[count($mob_arr) - 1];
            if ($mob_id > 0 && $mob_arr[1] == "") {
                $usages[$mob_id] = true;
            }
        }

        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
        ilObjMediaObject::_deleteAllUsages(
            $a_page->getParentType() . ":pg",
            $a_page->getId(),
            $a_old_nr,
            $a_page->getLanguage()
        );
        foreach ($usages as $mob_id => $val) {
            // save usage, if object exists...
            if (ilObject::_lookupType($mob_id) == "mob") {
                ilObjMediaObject::_saveUsage(
                    $mob_id,
                    $a_page->getParentType() . ":pg",
                    $a_page->getId(),
                    $a_old_nr,
                    $a_page->getLanguage()
                );
            }
        }
        
        return $usages;
    }

    public function modifyPageContentPostXsl($a_html, $a_mode, $a_abstract_only = false)
    {
        $ilUser = $this->user;

        if ($a_mode == "offline") {
            $page = $this->getPage();

            $mob_ids = ilObjMediaObject::_getMobsOfObject(
                $page->getParentType() . ":pg",
                $page->getId(),
                0,
                $page->getLanguage()
            );
            foreach ($mob_ids as $mob_id) {
                $mob = new ilObjMediaObject($mob_id);
                $srts = $mob->getSrtFiles();
                foreach ($srts as $srt) {
                    if ($ilUser->getLanguage() == $srt["language"]) {
                        $srt_content = file_get_contents(ilObjMediaObject::_getDirectory($mob->getId()) . "/" . $srt["full_path"]);
                        $a_html = str_replace("[[[[[mobsubtitle;il__mob_" . $mob->getId() . "_Standard]]]]]", $srt_content, $a_html);
                    }
                }
            }
        }

        if ($a_abstract_only) {
            return $a_html;
        }

        // add fullscreen modals
        $page = $this->getPage();
        $suffix = "-" . $page->getParentType() . "-" . $page->getId();
        $modal = $this->ui->factory()->modal()->roundtrip(
            $this->lng->txt("cont_fullscreen"),
            $this->ui->factory()->legacy("<iframe class='il-copg-mob-fullscreen' id='il-copg-mob-fullscreen" . $suffix . "'></iframe>")
        );
        $show_signal = $modal->getShowSignal();

        return $a_html . "<div class='il-copg-mob-fullscreen-modal'>" . $this->ui->renderer()->render($modal) . "</div><script>$(function () { il.COPagePres.setFullscreenModalShowSignal('" .
            $show_signal . "', '" . $suffix . "'); });</script>";
    }

    public function getJavascriptFiles($a_mode)
    {
        $js_files = ilPlayerUtil::getJsFilePaths();
        $js_files[] = iljQueryUtil::getLocalMaphilightPath();
        return $js_files;
    }

    public function getCssFiles($a_mode)
    {
        $js_files = ilPlayerUtil::getCssFilePaths();

        return $js_files;
    }

    public function getStandardMediaAliasItem() : ilMediaAliasItem
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->dom,
            $this->getHierId(),
            "Standard",
            $this->getPcId()
        );
        return $std_alias_item;
    }

    public function getFullscreenMediaAliasItem() : ilMediaAliasItem
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->dom,
            $this->getHierId(),
            "Fullscreen",
            $this->getPcId()
        );
        return $std_alias_item;
    }

    public function checkInstanceEditing() : bool
    {
        // if any properties are set on the instance,
        // that are not accessible through the quick editing screen
        // -> offer instance editing
        $std_alias_item = $this->getStandardMediaAliasItem();
        if ($std_alias_item->hasAnyPropertiesSet()) {
            return true;
        }
        if ($this->getMediaObject()->hasFullScreenItem()) {
            $full_alias_item = $this->getFullscreenMediaAliasItem();
            if ($full_alias_item->hasAnyPropertiesSet()) {
                return true;
            }
        }

        // if the media object has any other use outside of the current page
        // -> offer instance editing
        $mob = $this->getMediaObject();
        $page = $this->getPage();
        if (is_object($mob)) {
            $usages = $mob->getUsages();
            $other_usages = array_filter($usages, function ($usage) use ($page) {
                return ($usage["type"] != $page->getParentType() . ":pg" || $usage["id"] != $page->getId());
            });
            if (count($other_usages) > 0) {
                return true;
            }
        }

        // see https://mantis.ilias.de/view.php?id=38582
        // we allow instance editing regardless of number of usages
        return true;
    }
}