class.ilPluginAdmin.php

Go to the documentation of this file.

<?php

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

include_once("./Services/Component/classes/class.ilComponent.php");

class ilPluginAdmin
{

    protected $data;
    protected $got_data = false;
    public static $active_plugins = array();
    protected static $plugin_objects = array();
    protected $lng;


    public function __construct()
    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("cmps");
    }


    private function getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        if (!isset($this->got_data[$a_ctype][$a_cname][$a_slot_id][$a_pname])) {
            $slot_name = ilPluginSlot::lookupSlotName($a_ctype, $a_cname, $a_slot_id);

            $plugin_php_file = "./Customizing/global/plugins/" . $a_ctype . "/" . $a_cname . "/" . $slot_name . "/" . $a_pname . "/plugin.php";

            if (!is_file($plugin_php_file)) {
                throw new ilPluginException("No plugin.php file found for Plugin :" . $a_pname . ".");
            }
            $plugin_db_data = ilPlugin::getPluginRecord($a_ctype, $a_cname, $a_slot_id, $a_pname);
            $plugin_data = $this->parsePluginPhp($plugin_php_file);

            if ($plugin_db_data["plugin_id"] === null) {
                $this->setMustInstall($plugin_data);
            } else {
                $this->setCurrentState($plugin_data, (bool) $plugin_db_data["active"]);
                if ($this->pluginSupportCurrentILIAS($plugin_data)) {
                    $this->updateRequired($plugin_data, $plugin_db_data["last_update_version"]);
                }
            }

            $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname] = $plugin_data;
            $this->got_data[$a_ctype][$a_cname][$a_slot_id][$a_pname] = true;
        }
    }


    protected function pluginSupportCurrentILIAS(array &$plugin_data)
    {
        if (ilComponent::isVersionGreaterString($plugin_data["ilias_min_version"], ILIAS_VERSION_NUMERIC)) {
            $plugin_data["is_active"] = false;
            $plugin_data["needs_update"] = false;
            $plugin_data["activation_possible"] = false;

            if ($this->lng instanceof ilLanguage) {
                $inactive_reason = $this->lng->txt("cmps_needs_newer_ilias_version");
            } else {
                $inactive_reason = "Plugin needs a newer version of ILIAS.";
            }
            $plugin_data["inactive_reason"] = $inactive_reason;

            return false;
        }

        if (ilComponent::isVersionGreaterString(ILIAS_VERSION_NUMERIC, $plugin_data["ilias_max_version"])) {
            $plugin_data["is_active"] = false;
            $plugin_data["needs_update"] = false;
            $plugin_data["activation_possible"] = false;
            if ($this->lng instanceof ilLanguage) {
                $inactive_reason = $this->lng->txt("cmps_needs_newer_plugin_version");
            } else {
                $inactive_reason = "Plugin does not support current version of ILIAS. Newer version of plugin needed.";
            }
            $plugin_data["inactive_reason"] = $inactive_reason;

            return false;
        }

        return true;
    }


    protected function updateRequired(array &$plugin_data, $last_update_version)
    {
        if ($last_update_version == "") {
            $plugin_data["is_active"] = false;
            if ($this->lng instanceof ilLanguage) {
                $inactive_reason = $this->lng->txt("cmps_needs_update");
            } else {
                $inactive_reason = "Update needed.";
            }
            $plugin_data["inactive_reason"] = $inactive_reason;
            $plugin_data["needs_update"] = true;
            $plugin_data["activation_possible"] = false;
        } else {
            if (ilComponent::isVersionGreaterString($last_update_version, $plugin_data["version"])) {
                $plugin_data["is_active"] = false;
                if ($this->lng instanceof ilLanguage) {
                    $inactive_reason = $this->lng->txt("cmps_needs_upgrade");
                } else {
                    $inactive_reason = "Upgrade needed.";
                }
                $plugin_data["inactive_reason"] = $inactive_reason;
                $plugin_data["activation_possible"] = false;
            } else {
                if ($last_update_version != $plugin_data["version"]) {
                    $plugin_data["is_active"] = false;
                    if ($this->lng instanceof ilLanguage) {
                        $inactive_reason = $this->lng->txt("cmps_needs_update");
                    } else {
                        $inactive_reason = "Update needed.";
                    }
                    $plugin_data["inactive_reason"] = $inactive_reason;
                    $plugin_data["needs_update"] = true;
                    $plugin_data["activation_possible"] = false;
                }
            }
        }
    }


    protected function setMustInstall(array &$plugin_data)
    {
        $plugin_data["must_install"] = true;
        $plugin_data["is_active"] = false;
        $plugin_data["needs_update"] = false;
        $plugin_data["activation_possible"] = false;

        if ($this->lng instanceof ilLanguage) {
            $inactive_reason = $this->lng->txt("cmps_must_installed");
        } else {
            $inactive_reason = "Plugin must be installed.";
        }
        $plugin_data["inactive_reason"] = $inactive_reason;
    }


    protected function setCurrentState(array &$plugin_data, $active)
    {
        $plugin_data["is_active"] = $active;
        $plugin_data["activation_possible"] = !$active;
        $plugin_data["must_install"] = false;
        $plugin_data["needs_update"] = false;
        $plugin_data["inactive_reason"] = "";
    }


    protected function parsePluginPhp($plugin_php_file)
    {
        include($plugin_php_file);

        $values = [
            "version" => $version,
            "id" => $id,
            "ilias_min_version" => $ilias_min_version,
            "ilias_max_version" => $ilias_max_version,
            "responsible" => $responsible,
            "responsible_mail" => $responsible_mail,
            "learning_progress" => (bool) ($learning_progress ?? false),
            "supports_export" => (bool) ($supports_export ?? false),
            "supports_cli_setup" => (bool) ($supports_cli_setup ?? true)
        ];

        return $values;
    }


    public function getVersion($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["version"];
    }


    public function getIliasMinVersion($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["ilias_min_version"];
    }


    public function getIliasMaxVersion($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["ilias_max_version"];
    }


    public function getId($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["id"];
    }


    public function isActive($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        try {
            $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);
        } catch (ilPluginException $e) {
            return false;
        }

        return (bool) $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["is_active"];
    }


    public function exists($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return isset($this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]);
    }


    public function needsUpdate($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return (bool) $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["needs_update"];
    }


    public function getAllData($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname];
    }


    public static function getActivePluginsForSlot($a_ctype, $a_cname, $a_slot_id)
    {
        // cache the list of active plugins
        if (!isset(self::$active_plugins[$a_ctype][$a_cname][$a_slot_id])) {
            self::$active_plugins[$a_ctype][$a_cname][$a_slot_id]
                = ilPlugin::getActivePluginsForSlot($a_ctype, $a_cname, $a_slot_id);
        }

        return self::$active_plugins[$a_ctype][$a_cname][$a_slot_id];
    }


    public static function getPluginObject($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        // cache the plugin objects
        if (!isset(self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname])) {
            self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname]
                = ilPlugin::getPluginObject($a_ctype, $a_cname, $a_slot_id, $a_pname);
        }

        return self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname];
    }


    public static function includeClass($a_ctype, $a_cname, $a_slot_id, $a_pname, $a_class_file_name)
    {
        // cache the plugin objects
        if (!isset(self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname])) {
            self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname]
                = ilPlugin::getPluginObject($a_ctype, $a_cname, $a_slot_id, $a_pname);
        }
        $pl = self::$plugin_objects[$a_ctype][$a_cname][$a_slot_id][$a_pname];
        $pl->includeClass($a_class_file_name);
    }


    public function hasLearningProgress($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["learning_progress"];
    }


    public function supportsExport($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        $this->getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname);

        return $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["supports_export"];
    }

    public static function getAllPlugins()
    {
        static $all_plugins;
        if (!isset($all_plugins)) {
            $cached_component = ilCachedComponentData::getInstance();
            $all_plugins = $cached_component->getIlPluginById();
        }

        return $all_plugins;
    }


    public static function getActivePlugins()
    {
        static $active_plugins;
        if (!isset($active_plugins)) {
            $cached_component = ilCachedComponentData::getInstance();
            $plugins = $cached_component->getIlPluginActive();
            $buf = array();
            foreach ($plugins as $slot => $plugs) {
                $buf[] = $plugs;
            }

            $active_plugins = array_merge([], ...$buf);
        }

        return $active_plugins;
    }


    public static function isPluginActive($id)
    {
        assert(is_string($id));
        $cached_component = ilCachedComponentData::getInstance();
        $plugs = $cached_component->getIlPluginById();
        if (array_key_exists($id, $plugs) && $plugs[$id]['active']) {
            return true;
        }

        return false;
    }


    public static function getPluginObjectById($id)
    {
        assert(is_string($id));
        $plugs = self::getAllPlugins();
        if (!array_key_exists($id, $plugs)) {
            throw new \InvalidArgumentException("Plugin does not exist: " . $id, 1);
        }
        $pdata = $plugs[$id];

        return self::getPluginObject(
            $pdata['component_type'],
            $pdata['component_name'],
            $pdata['slot_id'],
            $pdata['name']
        );
    }


    public static function getAllGlobalScreenProviders() : array
    {
        $providers = array();
        // return array(); // current fix
        foreach (self::getActivePlugins() as $plugin) {
            $pl = self::getPluginObjectById($plugin['plugin_id']);
            if ($pl->isActive()) {
                array_push($providers, $pl->promoteGlobalScreenProvider());
            }
        }

        return $providers;
    }


    public static function getGlobalScreenProviderCollections() : Generator
    {
        foreach (self::getActivePlugins() as $plugin) {
            $pl = self::getPluginObjectById($plugin['plugin_id']);
            if ($pl->isActive()) {
                yield $pl->getGlobalScreenProviderCollection();
            }
        }
    }

    public function getRawPluginDataFor(string $name) : ?array
    {
        $this->clearCachedData();

        $modules = ilModule::getAvailableCoreModules();
        $services = ilService::getAvailableCoreServices();

        foreach ($this->getPluginSlots($modules, IL_COMP_MODULE) as $plugin_slot) {
            $plugin = $plugin_slot->getPluginInformationFor($name);
            if (!is_null($plugin)) {
                return $plugin;
            }
        }

        foreach ($this->getPluginSlots($services, IL_COMP_SERVICE) as $plugin_slot) {
            $plugin = $plugin_slot->getPluginInformationFor($name);
            if (!is_null($plugin)) {
                return $plugin;
            }
        }

        return null;
    }

    protected function getPluginSlots(array $components, string $type) : \Iterator
    {
        foreach ($this->getComponentSlotsByType($components, $type) as $slot) {
            $subdir = (explode('/', $slot['component']))[1];
            yield new ilPluginSlot($type, $subdir, $slot['id']);
        }
    }

    protected function getComponentSlotsByType(array $components, string $type) : \Iterator
    {
        foreach ($components as $component) {
            $component_slots = ilComponent::lookupPluginSlots($type, $component["subdir"]);
            foreach ($component_slots as $component_slot) {
                if (count($component_slot) > 0) {
                    yield $component_slot;
                }
            }
        }
    }

    final public function clearCachedData()
    {
        unset($this->data);
        unset($this->got_data);
        ilCachedComponentData::flush();
    }
}