class.ilPCMediaObject.php

Go to the documentation of this file.

<?php
 
use ILIAS\MediaObjects\Usage\UsageDBRepository;
 
class ilPCMediaObject extends ilPageContent
{
    protected \ILIAS\MediaObjects\MediaObjectManager $mob_manager;
    protected ilCtrlInterface $ctrl;
    protected UsageDBRepository $mob_usage_repo;
    protected DOMNode $mal_node;
    protected ilObjUser $user;
    protected DOMNode $mob_node;
    protected \ILIAS\DI\UIServices $ui;
    protected ?ilObjMediaObject $mediaobject = null;
    protected ilLanguage $lng;
    protected ilGlobalPageTemplate $global_tpl;
    protected static string $modal_show_signal = "";
    protected static string $modal_suffix = "";
 
    public function init(): void
    {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->setType("media");
        $this->ui = $DIC->ui();
        $this->lng = $DIC->language();
        $this->mob_usage_repo = $DIC->mediaObjects()
            ->internal()
            ->repo()
            ->usage();
        $this->ctrl = $DIC->ctrl();
        $this->mob_manager = $DIC->mediaObjects()->internal()->domain()->mediaObject();
    }
 
    public function readMediaObject(int $a_mob_id = 0): void
    {
        if ($a_mob_id > 0) {
            $mob = new ilObjMediaObject($a_mob_id);
            $this->setMediaObject($mob);
        }
    }
 
    public function setHierId(string $a_hier_id): void
    {
        $this->hier_id = $a_hier_id;
    }
 
    public function setMediaObject(ilObjMediaObject $a_mediaobject): void
    {
        $this->mediaobject = $a_mediaobject;
    }
 
    public function getMediaObject(): ?ilObjMediaObject
    {
        return $this->mediaobject;
    }
 
    public function createMediaObject(): void
    {
        $this->setMediaObject(new ilObjMediaObject());
    }
 
    public function create(): void
    {
        $this->createPageContentNode();
    }
 
    public function createAlias(
        ilPageObject $a_pg_obj,
        string $a_hier_id,
        string $a_pc_id = ""
    ): void {
        $this->setDomNode($this->dom_doc->createElement("PageContent"));
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $mob_node = $this->dom_doc->createElement("MediaObject");
        $mob_node = $this->getDomNode()->appendChild($mob_node);
        $this->mal_node = $this->dom_doc->createElement("MediaAlias");
        $this->mal_node = $mob_node->appendChild($this->mal_node);
        $this->mal_node->setAttribute("OriginId", "il__mob_" . $this->getMediaObject()->getId());
 
        // standard view
        $item_node = $this->dom_doc->createElement("MediaAliasItem");
        $item_node = $mob_node->appendChild($item_node);
        $item_node->setAttribute("Purpose", "Standard");
        $media_item = $this->getMediaObject()->getMediaItem("Standard");
        if (is_null($media_item)) {
            return;
        }
 
        $layout_node = $this->dom_doc->createElement("Layout");
        $layout_node = $item_node->appendChild($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->setAttribute("HorizontalAlign", "Left");
 
        // caption
        if ($media_item->getCaption() != "") {
            $cap_node = $this->dom_doc->createElement("Caption");
            $cap_node = $item_node->appendChild($cap_node);
            $cap_node->setAttribute("Align", "bottom");
            $this->dom_util->setContent($cap_node, $media_item->getCaption());
        }
 
        // text representation
        if ($media_item->getTextRepresentation() != "") {
            $tr_node = $this->dom_doc->createElement("TextRepresentation");
            $tr_node = $item_node->appendChild($tr_node);
            $this->dom_util->setContent($tr_node, $media_item->getTextRepresentation());
        }
 
        $pars = $media_item->getParameters();
        foreach ($pars as $par => $val) {
            $par_node = $this->dom_doc->createElement("Parameter");
            $par_node = $item_node->appendChild($par_node);
            $par_node->setAttribute("Name", $par);
            $par_node->setAttribute("Value", $val);
        }
 
        // fullscreen view
        $fullscreen_item = $this->getMediaObject()->getMediaItem("Fullscreen");
        if (is_object($fullscreen_item)) {
            $item_node = $this->dom_doc->createElement("MediaAliasItem");
            $item_node = $mob_node->appendChild($item_node);
            $item_node->setAttribute("Purpose", "Fullscreen");
 
            // width and height
            $layout_node = $this->dom_doc->createElement("Layout");
            $layout_node = $item_node->appendChild($layout_node);
            if ($fullscreen_item->getWidth() > 0) {
                $layout_node->setAttribute("Width", $fullscreen_item->getWidth());
            }
            if ($fullscreen_item->getHeight() > 0) {
                $layout_node->setAttribute("Height", $fullscreen_item->getHeight());
            }
 
            // caption
            if ($fullscreen_item->getCaption() != "") {
                $cap_node = $this->dom_doc->createElement("Caption");
                $cap_node = $item_node->appendChild($cap_node);
                $cap_node->setAttribute("Align", "bottom");
                $this->dom_util->setContent($cap_node, $fullscreen_item->getCaption());
            }
 
            // text representation
            if ($fullscreen_item->getTextRepresentation() != "") {
                $tr_node = $this->dom_doc->createElement("TextRepresentation");
                $tr_node = $item_node->appendChild($tr_node);
                $this->dom_util->setContent($tr_node, $fullscreen_item->getTextRepresentation());
            }
 
            $pars = $fullscreen_item->getParameters();
            foreach ($pars as $par => $val) {
                $par_node = $this->dom_doc->createElement("Parameter");
                $par_node = $item_node->appendChild($par_node);
                $par_node->setAttribute("Name", $par);
                $par_node->setAttribute("Value", $val);
            }
        }
    }
 
    protected function getMediaAliasNode(): ?DOMNode
    {
        if (is_object($this->getChildNode())) {
            $mal_node = $this->getChildNode()->firstChild;
            if (is_object($mal_node) && $mal_node->nodeName == "MediaAlias") {
                return $mal_node;
            }
        }
        return null;
    }
 
    public function updateObjectReference(): void
    {
        $this->getMediaAliasNode()?->setAttribute("OriginId", "il__mob_" . $this->getMediaObject()->getId());
    }
 
    public function dumpXML(): string
    {
        return $this->dom_util->dump($this->getDomNode());
    }
 
    public function setClass(string $a_class): void
    {
        $this->dom_util->setAttribute($this->getMediaAliasNode(), "Class", $a_class);
    }
 
    public function getClass(): string
    {
        return (string) $this->getMediaAliasNode()?->getAttribute("Class");
    }
 
    public function setCaptionClass(string $a_class): void
    {
        $this->dom_util->setAttribute($this->getMediaAliasNode(), "CaptionClass", $a_class);
    }
 
    public function getCaptionClass(): string
    {
        return (string) $this->getMediaAliasNode()?->getAttribute("CaptionClass");
    }
 
    public static function getLangVars(): array
    {
        return array("pc_mob");
    }
 
    public static function afterPageUpdate(
        ilPageObject $a_page,
        DOMDocument $a_domdoc,
        string $a_xml,
        bool $a_creation
    ): void {
        if (!$a_page->getImportMode()) {
            $mob_ids = ilObjMediaObject::_getMobsOfObject(
                $a_page->getParentType() . ":pg",
                $a_page->getId(),
                0,
                $a_page->getLanguage()
            );
        }
        self::saveMobUsage($a_page, $a_domdoc);
        if (!$a_page->getImportMode()) {
            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(
        ilPageObject $a_page
    ): void {
        $mob_ids = ilObjMediaObject::_getMobsOfObject(
            $a_page->getParentType() . ":pg",
            $a_page->getId(),
            0,
            $a_page->getLanguage()
        );
 
        ilObjMediaObject::_deleteAllUsages(
            $a_page->getParentType() . ":pg",
            $a_page->getId(),
            null,
            $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(
        ilPageObject $a_page,
        DOMDocument $a_old_domdoc,
        string $a_old_xml,
        int $a_old_nr
    ): void {
        self::saveMobUsage($a_page, $a_old_domdoc, $a_old_nr);
    }
 
    public static function saveMobUsage(
        ilPageObject $a_page,
        DOMDocument $a_domdoc,
        int $a_old_nr = 0
    ): array {
        $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;
            }
        }
 
        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(
        string $a_output,
        string $a_mode,
        bool $a_abstract_only = false
    ): string {
        global $DIC;
 
        $this->global_tpl = $DIC['tpl'];
        $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_path = ilObjMediaObject::_getDirectory($mob->getId()) . "/" . $srt["full_path"];
                        if (is_file($file_path)) {
                            $srt_content = $file_path;
                        } else {
                            $srt_content = $this->mob_manager->getLocationContent(
                                $mob->getId(),
                                $srt["full_path"]
                            );
                        }
                        if ($srt_content !== "") {
                            $a_output = str_replace(
                                "[[[[[mobsubtitle;il__mob_" . $mob->getId() . "_Standard]]]]]",
                                $srt_content,
                                $a_output
                            );
                        }
                    }
                }
            }
        }
 
        if ($a_abstract_only) {
            return $a_output;
        }
 
        if ($a_mode === "edit") {
            $a_output = str_replace(
                "{{{{{Unsupported Media Type}}}}}",
                $this->ui->renderer()->render(
                    $this->ui->factory()->messageBox()->info(
                        $this->lng->txt("copg_unsupported_media_type")
                    )
                ),
                $a_output
            );
            // currently media objects, when in translation mode
            $a_output = str_replace(
                "{{{{{No Media Type}}}}}",
                '<div class="copg-new-content-placeholder">' .
                $this->ui->renderer()->render(
                    $this->ui->factory()->symbol()->icon()->standard("pemed", "pemed", 'medium')
                ) . "</div>",
                $a_output
            );
        } else {
            $a_output = str_replace(
                "{{{{{Unsupported Media Type}}}}}",
                "",
                $a_output
            );
            $a_output = str_replace(
                "{{{{{No Media Type}}}}}",
                "",
                $a_output
            );
        }
 
        // 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()->content("<iframe class='il-copg-mob-fullscreen' id='il-copg-mob-fullscreen" . $suffix . "'></iframe>")
        );
        $show_signal = $modal->getShowSignal();
 
        $js = "
            $(function () {
                il.COPagePres.setFullscreenModalShowSignal('$show_signal', '$suffix');
            });
        ";
        self::$modal_show_signal = $show_signal;
        self::$modal_suffix = $suffix;
        $this->global_tpl->addOnloadCode($js);
 
        // async ensures to have onloadcode of modal in output
        // if other main tpl is used, see #32198
        // note: if always rendered async, $ not defined errors will be thrown in non-async cases
        if ($this->ctrl->isAsynch()) {
            $html = $this->ui->renderer()->renderAsync($modal);
        } else {
            $html = $this->ui->renderer()->render($modal);
        }
        return $a_output . "<div class='il-copg-mob-fullscreen-modal'>" . $html . "</div>";
    }
 
    public function getOnloadCode(string $a_mode): array
    {
        $onload_code = [];
        // necessary due to 32198 (other main template used)
        if (self::$modal_show_signal !== "") {
            $onload_code[] = "il.COPagePres.setFullscreenModalShowSignal('" . self::$modal_show_signal .
                "', '" . self::$modal_suffix . "');";
        }
        return $onload_code;
    }
 
    public function getJavascriptFiles(
        string $a_mode
    ): array {
        return [];
    }
 
    public function getCssFiles(
        string $a_mode
    ): array {
        return [];
    }
 
    public function getStandardMediaAliasItem(): ilMediaAliasItem
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->getPCId()
        );
        return $std_alias_item;
    }
 
    public function getFullscreenMediaAliasItem(): ilMediaAliasItem
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->getDomDoc(),
            $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;
    }
 
    public static function deleteHistoryLowerEqualThan(
        string $parent_type,
        int $page_id,
        string $lang,
        int $delete_lower_than_nr
    ): void {
        global $DIC;
 
        $mob_usage_repo = $DIC->mediaObjects()
            ->internal()
            ->repo()
            ->usage();
 
        $log = ilLoggerFactory::getLogger("copg");
 
        $mob_ids = $mob_usage_repo->getHistoryUsagesLowerEqualThan(
            $parent_type . ":pg",
            $page_id,
            $delete_lower_than_nr,
            $lang
        );
 
        $mob_usage_repo->deleteHistoryUsagesLowerEqualThan(
            $parent_type . ":pg",
            $page_id,
            $delete_lower_than_nr,
            $lang
        );
 
        foreach ($mob_ids as $mob_id) {
            $usages = ilObjMediaObject::lookupUsages($mob_id, true);
            $log->debug("...check deletion of mob $mob_id. Usages: " . count($usages));
            if (count($usages) == 0) {
                if (ilObject::_lookupType($mob_id) === "mob") {
                    $mob = new ilObjMediaObject($mob_id);
                    $log->debug("Deleting Mob ID: " . $mob_id);
                    $mob->delete();
                }
            }
        }
    }
 
    public static function handleCopiedContent(
        DOMDocument $a_domdoc,
        bool $a_self_ass = true,
        bool $a_clone_mobs = false,
        int $new_parent_id = 0,
        int $obj_copy_id = 0
    ): void {
        global $DIC;
 
        if (!$a_clone_mobs) {
            return;
        }
 
        $dom_util = $DIC->copage()->internal()->domain()->domUtil();
        $path = "//MediaObject/MediaAlias";
        $nodes = $dom_util->path($a_domdoc, $path);
        foreach ($nodes as $node) {
            $or_id = $node->getAttribute("OriginId");
 
            $inst_id = ilInternalLink::_extractInstOfTarget($or_id);
            $mob_id = ilInternalLink::_extractObjIdOfTarget($or_id);
 
            if (!($inst_id > 0)) {
                if ($mob_id > 0) {
                    $media_object = new ilObjMediaObject($mob_id);
                    $new_mob = $media_object->duplicate();
                    $node->setAttribute("OriginId", "il__mob_" . $new_mob->getId());
                }
            }
        }
    }
}