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
{
    public $got_data = false;

    public static $active_plugins = array();

    public static $plugin_objects = array();


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

    final private function getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname)
    {
        //Can not use DIC because it is not initialized if plugin is activated
        global $lng;
        $this->lng = $lng;

        if (!isset($this->got_data[$a_ctype][$a_cname][$a_slot_id][$a_pname])) {
            include_once "./Services/Component/classes/class.ilPluginSlot.php";
            $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 (is_object($this->lng)) {
                $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 (is_object($this->lng)) {
                $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 (is_object($this->lng)) {
                $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;
        } elseif (ilComponent::isVersionGreaterString($last_update_version, $plugin_data["version"])) {
            $plugin_data["is_active"] = false;
            if (is_object($this->lng)) {
                $inactive_reason = $this->lng->txt("cmps_needs_upgrade");
            } else {
                $inactive_reason = "Upgrade needed.";
            }
            $plugin_data["inactive_reason"] = $inactive_reason;
            $plugin_data["activation_possible"] = false;
        } elseif ($last_update_version != $plugin_data["version"]) {
            $plugin_data["is_active"] = false;
            if (is_object($this->lng)) {
                $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 (is_object($this->lng)) {
            $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_once($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,
            "supports_export" => (bool) $supports_export
        ];

        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 $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 $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])) {
            include_once "./Services/Component/classes/class.ilPlugin.php";

            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()
    {
        $cached_component = ilCachedComponentData::getInstance();
        return $cached_component->getIlPluginById();
    }

    public static function getActivePlugins()
    {
        $cached_component = ilCachedComponentData::getInstance();
        $plugins = $cached_component->getIlPluginActive();
        $buf = array();
        foreach ($plugins as $slot => $plugs) {
            $buf = array_merge($buf, $plugs);
        }
        return $buf;
    }

    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']
        );
    }
}