class.ilPCPlugged.php

Go to the documentation of this file.

<?php

class ilPCPlugged extends ilPageContent
{
    protected ilLanguage $lng;
    protected ?ilComponentRepository $component_repository = null;
    protected ?ilComponentFactory $component_factory = null;

    public function init(): void
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->setType("plug");
        $this->component_repository = $DIC["component.repository"] ?? null;
        $this->component_factory = $DIC["component.factory"] ?? null;
    }

    public function create(
        ilPageObject $a_pg_obj,
        string $a_hier_id,
        string $a_pc_id,
        string $a_plugin_name,
        string $a_plugin_version
    ): void {
        $this->createInitialChildNode(
            $a_hier_id,
            $a_pc_id,
            "Plugged",
            ["PluginName" => $a_plugin_name, "PluginVersion" => $a_plugin_version]
        );
    }

    public function setProperties(array $a_properties): void
    {
        if (!is_object($this->getChildNode())) {
            return;
        }

        // delete properties
        $this->dom_util->deleteAllChilds($this->getChildNode());
        // set properties
        foreach ($a_properties as $key => $value) {
            $prop_node = $this->dom_doc->createElement("PluggedProperty");
            $prop_node = $this->getChildNode()->appendChild($prop_node);
            $prop_node->setAttribute("Name", $key);
            if ($value != "") {
                $this->dom_util->setContent($prop_node, $value);
            }
        }
    }

    public function getProperties(): array
    {
        $properties = array();

        if (is_object($this->getChildNode())) {
            foreach ($this->getChildNode()->childNodes as $c) {
                if ($c->nodeName == "PluggedProperty") {
                    $properties[$c->getAttribute("Name")] =
                        $this->dom_util->getContent($c);
                }
            }
        }

        return $properties;
    }

    public function setPluginVersion(string $a_version): void
    {
        if (!empty($a_version)) {
            $this->getChildNode()->setAttribute("PluginVersion", $a_version);
        } else {
            if ($this->getChildNode()->hasAttribute("PluginVersion")) {
                $this->getChildNode()->removeAttribute("PluginVersion");
            }
        }
    }

    public function getPluginVersion(): string
    {
        if (is_object($this->getChildNode())) {
            return $this->getChildNode()->getAttribute("PluginVersion");
        }
        return "";
    }

    public function setPluginName(string $a_name): void
    {
        if (!empty($a_name)) {
            $this->getChildNode()->setAttribute("PluginName", $a_name);
        } else {
            if ($this->getChildNode()->hasAttribute("PluginName")) {
                $this->getChildNode()->removeAttribute("PluginName");
            }
        }
    }

    public function getPluginName(): string
    {
        if (is_object($this->getChildNode())) {
            return $this->getChildNode()->getAttribute("PluginName");
        }
        return "";
    }

    protected static function getActivePluginByName(string $name): ?ilPageComponentPlugin
    {
        global $DIC;
        $component_repository = $DIC['component.repository'];
        $component_factory = $DIC['component.factory'];
        $plugin_info = null;
        try {
            $plugin_info = $component_repository->getPluginByName($name);
        } catch (Exception $e) {
        }
        if (is_object($plugin_info) && $plugin_info->isActive()) {
            $plugin_obj = $component_factory->getPlugin($plugin_info->getId());
            return $plugin_obj;
        }
        return null;
    }

    public static function handleCopiedPluggedContent(
        ilPageObject $a_page,
        DOMDocument $a_domdoc
    ): void {
        global $DIC;
        $dom_util = $DIC->copage()->internal()->domain()->domUtil();
        $component_repository = $DIC['component.repository'];
        $component_factory = $DIC['component.factory'];

        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query("//Plugged");

        foreach ($nodes as $node) {
            $plugin_name = $node->getAttribute('PluginName');
            $plugin_version = $node->getAttribute('PluginVersion');

            $plugin_obj = self::getActivePluginByName($plugin_name);
            if (is_object($plugin_obj)) {
                $plugin_obj->setPageObj($a_page);

                $properties = array();
                foreach ($node->childNodes as $child) {
                    $properties[$child->getAttribute('Name')] = $child->nodeValue;
                }

                // let the plugin copy additional content
                // and allow it to modify the saved parameters
                $plugin_obj->onClone($properties, $plugin_version);

                $dom_util->deleteAllChilds($node);
                foreach ($properties as $name => $value) {
                    $child = new DOMElement(
                        'PluggedProperty',
                        str_replace("&", "&amp;", $value)
                    );
                    $node->appendChild($child);
                    $child->setAttribute('Name', $name);
                }
            }
        }
    }

    public static function afterRepositoryCopy(ilPageObject $page, array $mapping, int $source_ref_id): void
    {
        global $DIC;

        $dom_util = $DIC->copage()->internal()->domain()->domUtil();

        $ilPluginAdmin = $DIC['ilPluginAdmin'];

        $component_factory = $DIC["component.factory"];

        $component_repository = $DIC["component.repository"];

        $xpath = new DOMXPath($page->getDomDoc());
        $nodes = $xpath->query("//Plugged");

        foreach ($nodes as $node) {
            $plugin_name = $node->getAttribute('PluginName');
            $plugin_version = $node->getAttribute('PluginVersion');
            $plugin_obj = self::getActivePluginByName($plugin_name);

            if (is_object($plugin_obj)) {
                $plugin_obj->setPageObj($page);

                $properties = array();
                foreach ($node->childNodes as $child) {
                    $properties[$child->getAttribute('Name')] = $child->nodeValue;
                }

                // let the plugin copy additional content
                // and allow it to modify the saved parameters
                $plugin_obj->afterRepositoryCopy($properties, $mapping, $source_ref_id, $plugin_version);

                $dom_util->deleteAllChilds($node);
                foreach ($properties as $name => $value) {
                    $child = new DOMElement(
                        'PluggedProperty',
                        str_replace("&", "&amp;", $value)
                    );
                    $node->appendChild($child);
                    $child->setAttribute('Name', $name);
                }
            }
        }
    }

    public static function handleDeletedPluggedNode(
        ilPageObject $a_page,
        DOMNode $a_node,
        bool $move_operation = false
    ): void {
        global $DIC;
        $component_repository = $DIC['component.repository'];
        $component_factory = $DIC['component.factory'];

        $plugin_name = $a_node->getAttribute('PluginName');
        $plugin_version = $a_node->getAttribute('PluginVersion');

        $plugin_obj = self::getActivePluginByName($plugin_name);
        if (is_object($plugin_obj)) {
            $plugin_obj->setPageObj($a_page);

            $properties = array();
            foreach ($a_node->childNodes as $child) {
                $properties[$child->getAttribute('Name')] = $child->nodeValue;
            }

            // let the plugin delete additional content
            $plugin_obj->onDelete($properties, $plugin_version, $move_operation);
        }
    }

    public function modifyPageContentPostXsl(
        string $a_output,
        string $a_mode,
        bool $a_abstract_only = false
    ): string {
        $lng = $this->lng;

        $end = 0;
        $start = strpos($a_output, "{{{{{Plugged<pl");
        //echo htmlentities($a_html)."-";
        if (is_int($start)) {
            $end = strpos($a_output, "}}}}}", $start);
        }

        while ($end > 0) {
            $param = substr($a_output, $start + 5, $end - $start - 5);
            $param = str_replace(' xmlns:xhtml="http://www.w3.org/1999/xhtml"', "", $param);
            $param = explode("<pl/>", $param);
            //var_dump($param); exit;
            $plugin_name = $param[1];
            $plugin_version = $param[2];
            $properties = array();

            for ($i = 3; $i < count($param); $i += 2) {
                $properties[$param[$i]] = $param[$i + 1];
            }

            // get html from plugin
            if ($a_mode == "edit") {
                $plugin_html = '<div class="ilBox">' . $lng->txt("content_plugin_not_activated") . " (" . $plugin_name . ")</div>";
            }

            $plugin_obj = self::getActivePluginByName($plugin_name);
            $plugin_html = '';
            if (is_object($plugin_obj)) {
                $plugin_obj->setPageObj($this->getPage());
                $gui_obj = $plugin_obj->getUIClassInstance();
                $plugin_html = $gui_obj->getElementHTML($a_mode, $properties, $plugin_version);
            } else {
                if ($a_mode === "edit") {
                    $plugin_html = sprintf($this->lng->txt("copg_plugin_not_avail"), $plugin_name);
                } else {
                    $plugin_html = " ";
                }
            }

            $a_output = substr($a_output, 0, $start) .
                $plugin_html .
                substr($a_output, $end + 5);

            if (strlen($a_output) > $start + 5) {
                $start = strpos($a_output, "{{{{{Plugged<pl", $start + 5);
            } else {
                $start = false;
            }
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_output, "}}}}}", $start);
            }
        }

        return $a_output;
    }

    public function getJavascriptFiles(string $a_mode): array
    {
        $js_files = array();

        foreach ($this->component_factory->getActivePluginsInSlot("pgcp") as $plugin) {
            $plugin->setPageObj($this->getPage());
            $pl_dir = $plugin->getDirectory();

            $pl_js_files = $plugin->getJavascriptFiles($a_mode);
            foreach ($pl_js_files as $pl_js_file) {
                if (!is_int(strpos($pl_js_file, "//"))) {
                    $pl_js_file = $pl_dir . "/" . $pl_js_file;
                }
                if (!in_array($pl_js_file, $js_files)) {
                    $js_files[] = $pl_js_file;
                }
            }
        }
        //var_dump($js_files);
        return $js_files;
    }

    public function getCssFiles(string $a_mode): array
    {
        $css_files = array();

        foreach ($this->component_factory->getActivePluginsInSlot("pgcp") as $plugin) {
            $plugin->setPageObj($this->getPage());
            $pl_dir = $plugin->getDirectory();

            $pl_css_files = $plugin->getCssFiles($a_mode);
            foreach ($pl_css_files as $pl_css_file) {
                if (!is_int(strpos($pl_css_file, "//"))) {
                    $pl_css_file = $pl_dir . "/" . $pl_css_file;
                }
                if (!in_array($pl_css_file, $css_files)) {
                    $css_files[] = $pl_css_file;
                }
            }
        }

        return $css_files;
    }
}